oracle.adf.view.rich.component.rich

Class RichPopup.PopupHints

java.lang.Object

oracle.adf.view.rich.component.rich.RichPopup.PopupHints

Enclosing class:

RichPopup

public static class RichPopup.PopupHints
extends Object

Server-side representation of popup hints passed to the RichPopup's show method. These hints define behaviors when a popup becomes visible.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RichPopup.PopupHints.AlignTypes Represents the primary hint of how the client-side position manager will will attempt to align a popup to an element.
static class	RichPopup.PopupHints.HintTypes Key identifier that defines a characteristic about how a popup should be shown.

Constructor Summary

Constructors

Constructor and Description
RichPopup.PopupHints()

Method Summary

Methods

Modifier and Type	Method and Description
RichPopup.PopupHints	add(RichPopup.PopupHints.HintTypes hint, RichPopup.PopupHints.AlignTypes alignType) Adds the RichPopup.PopupHints.HintTypes.HINT_ALIGN hint.
RichPopup.PopupHints	add(RichPopup.PopupHints.HintTypes hint, String clientId) Adds a RichPopup.PopupHints.HintTypes.HINT_ALIGN_ID or a RichPopup.PopupHints.HintTypes.HINT_LAUNCH_ID hint for a component's clientId.
RichPopup.PopupHints	add(RichPopup.PopupHints.HintTypes hint, javax.faces.component.UIComponent component) Adds a RichPopup.PopupHints.HintTypes.HINT_ALIGN_ID or a RichPopup.PopupHints.HintTypes.HINT_LAUNCH_ID hint using a component reference.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RichPopup.PopupHints

public RichPopup.PopupHints()

Method Detail

add

public RichPopup.PopupHints add(RichPopup.PopupHints.HintTypes hint,
                       javax.faces.component.UIComponent component)

Adds a RichPopup.PopupHints.HintTypes.HINT_ALIGN_ID or a RichPopup.PopupHints.HintTypes.HINT_LAUNCH_ID hint using a component reference. The component must be in the right context in order to ask for the fully qualified component's client id. For example, if the component is in a table, the correct row must be selected.

Parameters:

hint - RichPopup.PopupHints.HintTypes.HINT_ALIGN_ID or RichPopup.PopupHints.HintTypes.HINT_LAUNCH_ID

component - target align or launch source component

Returns:

this instance to be used for chaining add operations

Throws:

IllegalArgumentException - component cannot be null

add

public RichPopup.PopupHints add(RichPopup.PopupHints.HintTypes hint,
                       String clientId)

Adds a RichPopup.PopupHints.HintTypes.HINT_ALIGN_ID or a RichPopup.PopupHints.HintTypes.HINT_LAUNCH_ID hint for a component's clientId. The client Id must be fully qualified including the correct naming containers and stamping to represent its correct context.

Parameters:

hint - RichPopup.PopupHints.HintTypes.HINT_ALIGN_ID or RichPopup.PopupHints.HintTypes.HINT_LAUNCH_ID

clientId - of the align or launcher component

Returns:

this instance to be used for chaining add operations

Throws:

IllegalArgumentException - hint cannot be null; invalid hint type. Must be HintTypes#HINT_ALIGN_ID or HintTypes#HINT_LAUNCH_ID; clientId cannot be null

add

public RichPopup.PopupHints add(RichPopup.PopupHints.HintTypes hint,
                       RichPopup.PopupHints.AlignTypes alignType)

Adds the RichPopup.PopupHints.HintTypes.HINT_ALIGN hint.

Parameters:

hint - RichPopup.PopupHints.HintTypes.HINT_ALIGN

alignType - location the popup should be placed aligned to a DOM element.

Returns:

this instance to be used for chaining add operations

Throws:

IllegalArgumentException - hint cannot be null; alignType cannot be null