Class UIOutcomeTarget

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 appropriate Renderer for this component instance.

  Overrides:

  getFamily in class UIOutput

• 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

  public String getOutcome()

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

  Since:

  2.0

• setOutcome

  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 - the navigation outcome

  Since:

  2.0