Class UIOutcomeTarget
- All Implemented Interfaces:
EventListener
,PartialStateHolder
,StateHolder
,TransientStateHolder
,ValueHolder
,ComponentSystemEventListener
,FacesListener
,SystemEventListenerHolder
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
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The standard component family for this component.static final String
The standard component type for this component.Fields inherited from class javax.faces.component.UIComponent
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 Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturn the identifier of the component family to which this component belongs.Returns theoutcome
property of theUIOutcomeTarget
.boolean
Return whether or not the client window should be encoded into the target url.boolean
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
(String outcome) Sets theoutcome
property of theUIOutcomeTarget
.Methods inherited from class javax.faces.component.UIOutput
clearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, restoreState, saveState, setConverter, setValue
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, 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, unsubscribeFromEvent
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree
-
Field Details
-
COMPONENT_TYPE
The standard component type for this component.
- See Also:
-
COMPONENT_FAMILY
The standard component family for this component.
- See Also:
-
-
Constructor Details
-
UIOutcomeTarget
public UIOutcomeTarget()Create a new
UIOutcomeTarget
instance with default property values.
-
-
Method Details
-
getFamily
Description copied from class: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 appropriateRenderer
for this component instance. -
isIncludeViewParams
public boolean isIncludeViewParams()Return whether or not the view parameters should be encoded into the target url.
- Since:
- 2.0
-
setIncludeViewParams
public void setIncludeViewParams(boolean includeViewParams) Set whether or not the page parameters should be encoded into the target url.
- Parameters:
includeViewParams
- The state of the switch for encoding page parameters- Since:
- 2.0
-
isDisableClientWindow
public boolean isDisableClientWindow()Return whether or not the client window should be encoded into the target url.
- Since:
- 2.0
-
setDisableClientWindow
public void setDisableClientWindow(boolean disableClientWindow) Set whether or not the client window should be encoded into the target url.
- Parameters:
disableClientWindow
- if @{code true}, the client window will not be included in this outcome target.- Since:
- 2.2
-
getOutcome
Returns the
outcome
property of theUIOutcomeTarget
. This value is passed to theNavigationHandler
when resolving the target url of this component.- Since:
- 2.0
-
setOutcome
Sets the
outcome
property of theUIOutcomeTarget
. This value is passed to the NavigationHandler when resolving the target url of this component.- Parameters:
outcome
- the navigation outcome- Since:
- 2.0
-