Class UIOutcomeTarget
- java.lang.Object
-
- jakarta.faces.component.UIComponent
-
- jakarta.faces.component.UIComponentBase
-
- jakarta.faces.component.UIOutput
-
- jakarta.faces.component.UIOutcomeTarget
-
- All Implemented Interfaces:
PartialStateHolder
,StateHolder
,TransientStateHolder
,ValueHolder
,ComponentSystemEventListener
,FacesListener
,SystemEventListenerHolder
,EventListener
- Direct Known Subclasses:
HtmlOutcomeTargetButton
,HtmlOutcomeTargetLink
public class UIOutcomeTarget extends UIOutput
This component is paired with the
jakarta.faces.Button
orjakarta.faces.Link
renderers and encapsulates properties relating to the rendering of outcomes directly to the response. This enables bookmarkability in Jakarta Faces applications.- Since:
- 2.0
-
-
Field Summary
Fields Modifier and Type Field Description static String
COMPONENT_FAMILY
The standard component family for this component.static String
COMPONENT_TYPE
The standard component type for this component.-
Fields inherited from class jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
-
-
Constructor Summary
Constructors Constructor Description UIOutcomeTarget()
Create a newUIOutcomeTarget
instance with default property values.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getFamily()
Return the identifier of the component family to which this component belongs.String
getOutcome()
Returns theoutcome
property of theUIOutcomeTarget
.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(String outcome)
Sets theoutcome
property of theUIOutcomeTarget
.-
Methods inherited from class jakarta.faces.component.UIOutput
clearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, restoreState, saveState, setConverter, setValue
-
Methods inherited from class jakarta.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, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent
-
Methods inherited from class jakarta.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 Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
The standard component type for this component.
- See Also:
- Constant Field Values
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
The standard component family for this component.
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
UIOutcomeTarget
public UIOutcomeTarget()
Create a new
UIOutcomeTarget
instance with default property values.
-
-
Method Detail
-
getFamily
public String 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. Note this method should NOT returnnull
-
isIncludeViewParams
public boolean isIncludeViewParams()
Return whether or not the view parameters should be encoded into the target url.
- Returns:
true
if the view parameters should be encoded in the url,false
otherwise.- 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.
- Returns:
true
if the client window should NOT be encoded in the url,false
otherwise.- 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
public String getOutcome()
Returns the
outcome
property of theUIOutcomeTarget
. This value is passed to theNavigationHandler
when resolving the target url of this component.- Returns:
- the outcome.
- Since:
- 2.0
-
setOutcome
public void setOutcome(String outcome)
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
-
-