javax.faces.component: public class: UIOutcomeTarget

javax.faces.component
public class: UIOutcomeTarget [javadoc | source]

java.lang.Object
   javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
         javax.faces.component.UIOutput
            javax.faces.component.UIOutcomeTarget

All Implemented Interfaces:
ValueHolder, PartialStateHolder, ComponentSystemEventListener, SystemEventListenerHolder

Direct Known Subclasses:
HtmlOutcomeTargetLink, HtmlOutcomeTargetButton

This component is paired with the javax.faces.Button or javax.faces.Link renderers and encapsulates properties relating to the rendering of outcomes directly to the response. This enables bookmarkability in JSF applications.

since: 2.0 -

Nested Class Summary:
enum class	UIOutcomeTarget.PropertyKeys

Field Summary
public static final String	COMPONENT_TYPE	The standard component type for this component.
public static final String	COMPONENT_FAMILY	The standard component family for this component.

Fields inherited from javax.faces.component.UIOutput:
COMPONENT_TYPE, COMPONENT_FAMILY

Fields inherited from javax.faces.component.UIComponent:
CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, BEANINFO_KEY, FACETS_KEY, VIEW_LOCATION_KEY, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, attributesThatAreSet, stateHelper, compositeParent, bindings, initialState, listenersByEventClass

Constructor:
public UIOutcomeTarget() { super(); setRendererType("javax.faces.Link"); } Create a new UIOutcomeTarget instance with default property values.

Constructor:

 public UIOutcomeTarget() {
        super();
        setRendererType("javax.faces.Link");
}

Create a new UIOutcomeTarget instance with default property values.

Method from javax.faces.component.UIOutcomeTarget Summary:
getFamily, getOutcome, isIncludeViewParams, setIncludeViewParams, setOutcome

Methods from javax.faces.component.UIOutput:
clearInitialState, getConverter, getFamily, getLocalValue, getValue, markInitialState, restoreState, saveState, setConverter, setValue

Methods from javax.faces.component.UIComponentBase:
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getDescriptorMap, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods from javax.faces.component.UIComponentBase:

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getDescriptorMap, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods from javax.faces.component.UIComponent:
addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getFamily, getId, getListenersForEventClass, getNamingContainer, getParent, getRenderer, getRendererType, getRendersChildren, getResourceBundleMap, getStateHelper, getStateHelper, getValueBinding, getValueExpression, initialStateMarked, invokeOnComponent, isCompositeComponent, isInView, isRendered, isVisitable, markInitialState, popComponentFromEL, processDecodes, processEvent, processRestoreState, processSaveState, processUpdates, processValidators, pushComponentToEL, queueEvent, removeFacesListener, setId, setInView, setParent, setRendered, setRendererType, setValueBinding, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

Methods from javax.faces.component.UIComponent:

addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getFamily, getId, getListenersForEventClass, getNamingContainer, getParent, getRenderer, getRendererType, getRendersChildren, getResourceBundleMap, getStateHelper, getStateHelper, getValueBinding, getValueExpression, initialStateMarked, invokeOnComponent, isCompositeComponent, isInView, isRendered, isVisitable, markInitialState, popComponentFromEL, processDecodes, processEvent, processRestoreState, processSaveState, processUpdates, processValidators, pushComponentToEL, queueEvent, removeFacesListener, setId, setInView, setParent, setRendered, setRendererType, setValueBinding, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.faces.component.UIOutcomeTarget Detail:
public String getFamily() { return COMPONENT_FAMILY; }
public String getOutcome() { return (String) getStateHelper().eval(PropertyKeys.outcome); } Returns the `outcome` property of the `UIOutcomeTarget`. This value is passed to the javax.faces.application.NavigationHandler when resolving the target url of this component.
public boolean isIncludeViewParams() { return (Boolean) getStateHelper().eval(PropertyKeys.includeViewParams, false); } Return whether or not the view parameters should be encoded into the target url.
public void setIncludeViewParams(boolean includeViewParams) { getStateHelper().put(PropertyKeys.includeViewParams, includeViewParams); } Set whether or not the page parameters should be encoded into the target url.
public void setOutcome(String outcome) { getStateHelper().put(PropertyKeys.outcome, outcome); } Sets the `outcome` property of the `UIOutcomeTarget`. This value is passed to the NavigationHandler when resolving the target url of this component.

Method from javax.faces.component.UIOutcomeTarget Detail:

 public String getFamily() {
        return COMPONENT_FAMILY;
}

 public String getOutcome() {
        return (String) getStateHelper().eval(PropertyKeys.outcome);
}

Returns the outcome property of the UIOutcomeTarget. This value is passed to the javax.faces.application.NavigationHandler when resolving the target url of this component.

 public boolean isIncludeViewParams() {
        return (Boolean) getStateHelper().eval(PropertyKeys.includeViewParams, false);
}

Return whether or not the view parameters should be encoded into the target url.

 public  void setIncludeViewParams(boolean includeViewParams) {
        getStateHelper().put(PropertyKeys.includeViewParams, includeViewParams);
}

Set whether or not the page parameters should be encoded into the target url.

 public  void setOutcome(String outcome) {
        getStateHelper().put(PropertyKeys.outcome, outcome);
}

Sets the outcome property of the UIOutcomeTarget. This value is passed to the NavigationHandler when resolving the target url of this component.