public class UIOutcomeTarget extends UIOutput
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 Jakarta Server Faces applications.
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
COMPONENT_FAMILY
The standard component family for this component.
|
static java.lang.String |
COMPONENT_TYPE
The standard component type for this component.
|
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY| Constructor and Description |
|---|
UIOutcomeTarget()
Create a new
UIOutcomeTarget instance with default property values. |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getFamily()
Return the identifier of the component family to which this component belongs. |
java.lang.String |
getOutcome()
Returns the |
boolean |
isDisableClientWindow()
Return whether or not the client window should be encoded into the target url. |
boolean |
isIncludeViewParams()
Return whether or not the view parameters should be encoded into the target url. |
void |
setDisableClientWindow(boolean disableClientWindow)
Set whether or not the client window should be encoded into the target url. |
void |
setIncludeViewParams(boolean includeViewParams)
Set whether or not the page parameters should be encoded into the target url. |
void |
setOutcome(java.lang.String outcome)
Sets the |
clearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, restoreState, saveState, setConverter, setValueaddClientBehavior, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTreepublic static final java.lang.String COMPONENT_TYPE
The standard component type for this component.
public static final java.lang.String COMPONENT_FAMILY
The standard component family for this component.
public UIOutcomeTarget()
Create a new UIOutcomeTarget instance with default property values.
public java.lang.String getFamily()
UIComponent
Return the identifier of the component family to which this component belongs. This
identifier, in conjunction with the value of the rendererType
property, may be used to select the appropriate Renderer for this component
instance. Note this method should NOT return null
public boolean isIncludeViewParams()
Return whether or not the view parameters should be encoded into the target url.
true if the view parameters should be encoded in the url,
false otherwise.public void setIncludeViewParams(boolean includeViewParams)
Set whether or not the page parameters should be encoded into the target url.
includeViewParams - The state of the switch for encoding page parameterspublic boolean isDisableClientWindow()
Return whether or not the client window should be encoded into the target url.
true if the client window should NOT be encoded in the url,
false otherwise.public void setDisableClientWindow(boolean disableClientWindow)
Set whether or not the client window should be encoded into the target url.
disableClientWindow - if @{code true}, the client window will not be included in this
outcome target.public java.lang.String getOutcome()
Returns the outcome property of the UIOutcomeTarget. This value is
passed to the NavigationHandler when resolving the target url
of this component.
public void setOutcome(java.lang.String outcome)
Sets the outcome property of the UIOutcomeTarget. This value is
passed to the NavigationHandler when resolving the target url of this component.
outcome - the navigation outcome