Modifier and Type	Class and Description
pack-priv static enum	UIOutcomeTarget.PropertyKeys

Modifier and Type	Field and Description
public static final String	COMPONENT_FAMILY Hides jakarta.faces.component.UIOutput.COMPONENT_FAMILY. The standard component family for this component.
public static final String	COMPONENT_TYPE Hides jakarta.faces.component.UIOutput.COMPONENT_TYPE. The standard component type for this component.

Access	Constructor and Description
public	UIOutcomeTarget() Create a new `UIOutcomeTarget` instance with default property values.

Method Summary

Modifier and Type	Method and Description
public String	getFamily() Overrides jakarta.faces.component.UIOutput.getFamily. Return the identifier of the component family to which this component belongs.
public String	Returns: the outcome. getOutcome() Returns the `outcome` property of the `UIOutcomeTarget`.
public boolean	Returns: `true` if the client window should NOT be encoded in the url, `false` otherwise. isDisableClientWindow() Return whether or not the client window should be encoded into the target url.
public boolean	Returns: `true` if the view parameters should be encoded in the url, `false` otherwise. isIncludeViewParams() Return whether or not the view parameters should be encoded into the target url.
public void	setDisableClientWindow(boolean if @{code true}, the client window will not be included in this outcome target. disableClientWindow) Set whether or not the client window should be encoded into the target url.
public void	setIncludeViewParams(boolean The state of the switch for encoding page parameters includeViewParams) Set whether or not the page parameters should be encoded into the target url.
public void	setOutcome(String the navigation outcome outcome) Sets the `outcome` property of the `UIOutcomeTarget`.

Inherited from jakarta.faces.component.UIOutput:: clearInitialState getConverter getLocalValue getValue markInitialState resetValue restoreState saveState setConverter setValue

Field Detail

COMPONENT_FAMILY	back to summary
public static final String COMPONENT_FAMILY Hides jakarta.faces.component.UIOutput.COMPONENT_FAMILY. The standard component family for this component.

COMPONENT_FAMILY

back to summary

public static final String COMPONENT_FAMILY

Hides jakarta.faces.component.UIOutput.COMPONENT_FAMILY.

The standard component family for this component.

COMPONENT_TYPE	back to summary
public static final String COMPONENT_TYPE Hides jakarta.faces.component.UIOutput.COMPONENT_TYPE. The standard component type for this component.

COMPONENT_TYPE

back to summary

public static final String COMPONENT_TYPE

Hides jakarta.faces.component.UIOutput.COMPONENT_TYPE.

The standard component type for this component.

Constructor Detail

UIOutcomeTarget	back to summary
public UIOutcomeTarget() Create a new `UIOutcomeTarget` instance with default property values.

Method Detail

getFamily back to summary

getFamily	back to summary
public String getFamily() Overrides jakarta.faces.component.UIOutput.getFamily. Doc from jakarta.faces.component.UIComponent.getFamily. 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` Returns:String the component family (not null). Annotations @Override

public String getFamily()

Overrides jakarta.faces.component.UIOutput.getFamily.

Doc from jakarta.faces.component.UIComponent.getFamily.

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

Returns:String

the component family (not null).

Annotations

@Override

getOutcome back to summary

getOutcome	back to summary
public String getOutcome() Returns the `outcome` property of the `UIOutcomeTarget`. This value is passed to the `jakarta.faces.application.NavigationHandler` when resolving the target url of this component. Returns:String the outcome. Since 2.0

public String getOutcome()

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

Returns:String: the outcome.
Since: 2.0

isDisableClientWindow back to summary

isDisableClientWindow	back to summary
public boolean isDisableClientWindow() Return whether or not the client window should be encoded into the target url. Returns:boolean `true` if the client window should NOT be encoded in the url, `false` otherwise. Since 2.0

public boolean isDisableClientWindow()

Return whether or not the client window should be encoded into the target url.

Returns:boolean: true if the client window should NOT be encoded in the url, false otherwise.
Since: 2.0

isIncludeViewParams back to summary

isIncludeViewParams	back to summary
public boolean isIncludeViewParams() Return whether or not the view parameters should be encoded into the target url. Returns:boolean `true` if the view parameters should be encoded in the url, `false` otherwise. Since 2.0

public boolean isIncludeViewParams()

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

Returns:boolean: true if the view parameters should be encoded in the url, false otherwise.
Since: 2.0

setDisableClientWindow	back to summary
public void setDisableClientWindow(boolean disableClientWindow) Set whether or not the client window should be encoded into the target url. Parameters disableClientWindow:boolean if @{code true}, the client window will not be included in this outcome target. Since 2.2

setDisableClientWindow

back to summary

public void setDisableClientWindow(boolean disableClientWindow)

Set whether or not the client window should be encoded into the target url.

Parameters

disableClientWindow:boolean: if @{code true}, the client window will not be included in this outcome target.

Since

2.2

setIncludeViewParams	back to summary
public void setIncludeViewParams(boolean includeViewParams) Set whether or not the page parameters should be encoded into the target url. Parameters includeViewParams:boolean The state of the switch for encoding page parameters Since 2.0

setIncludeViewParams

back to summary

public void setIncludeViewParams(boolean includeViewParams)

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

Parameters

includeViewParams:boolean: The state of the switch for encoding page parameters

Since

2.0

setOutcome back to summary

setOutcome	back to summary
public void setOutcome(String outcome) Sets the `outcome` property of the `UIOutcomeTarget`. This value is passed to the NavigationHandler when resolving the target url of this component. Parameters outcome:String the navigation outcome Since 2.0

public void setOutcome(String outcome)

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

Parameters

outcome:String: the navigation outcome

Since

2.0

jakarta.faces.component back to summary

pack-priv final Enum UIOutcomeTarget.PropertyKeys

Class Inheritance

extends Enum<UIOutcomeTarget.PropertyKeys>

java.lang.Object
java.lang.Enum
jakarta.faces.component.UIOutcomeTarget.PropertyKeys

Field Summary

Modifier and Type	Field and Description
public static final UIOutcomeTarget.PropertyKeys	disableClientWindow
public static final UIOutcomeTarget.PropertyKeys	includeViewParams
public static final UIOutcomeTarget.PropertyKeys	outcome

Constructor Summary

Access	Constructor and Description
private	PropertyKeys()

Method Summary

Modifier and Type	Method and Description
public static UIOutcomeTarget.PropertyKeys	valueOf(String name)
public static UIOutcomeTarget.PropertyKeys[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

disableClientWindow	back to summary
public static final UIOutcomeTarget.PropertyKeys disableClientWindow

includeViewParams	back to summary
public static final UIOutcomeTarget.PropertyKeys includeViewParams

outcome	back to summary
public static final UIOutcomeTarget.PropertyKeys outcome

Constructor Detail

PropertyKeys	back to summary
private PropertyKeys()

Method Detail

valueOf	back to summary
public static UIOutcomeTarget.PropertyKeys valueOf(String name)

values	back to summary
public static UIOutcomeTarget.PropertyKeys[] values()

public Class UIOutcomeTarget

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum UIOutcomeTarget.PropertyKeys

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail