oracle.apps.fnd.applcore.globalSearch.ui
Class PopupHint

java.lang.Object
  oracle.apps.fnd.applcore.globalSearch.ui.PopupHint

public class PopupHint
extends java.lang.Object

Hints for showing popups.

Nested Class Summary

static class

PopupHint.HintAlignment The alignment of the hints.

Field Summary

static java.lang.String	HINT_ALIGN The ID of the hint to describe how to align the popup.
static java.lang.String	HINT_ALIGN_ID The ID of the UI Component to align the popup with.
static java.lang.String	HINT_LAUNCH_SOURCE_ID The ID of the UI component that launched the popup.

Constructor Summary

PopupHint(java.lang.String name)
Constructor.

PopupHint(java.lang.String name, java.lang.String sourceId)
Constructor.

Method Summary

void	addAlignHint(java.lang.String alignTo, PopupHint.HintAlignment alignment) Add hints to align the popup with another UI component.
void	addQuotedHint(java.lang.String name, java.lang.String value) Add a hint to the collection of hints and putting the value in quotes.
void	addUnquotedHint(java.lang.String name, java.lang.String value) Add a hint to the collection of hints.
java.lang.String	getHintName() Gets the hint variable name.
java.lang.String	getHintScript() Generates the hint javascript based upon the hints supplied.
void	setHintName(java.lang.String name) Sets the hint variable name.

Methods inherited from class java.lang.Object

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

Field Detail

HINT_LAUNCH_SOURCE_ID

public static final java.lang.String HINT_LAUNCH_SOURCE_ID

The ID of the UI component that launched the popup.

See Also:

Constant Field Values

HINT_ALIGN_ID

public static final java.lang.String HINT_ALIGN_ID

The ID of the UI Component to align the popup with.

See Also:

Constant Field Values

HINT_ALIGN

public static final java.lang.String HINT_ALIGN

The ID of the hint to describe how to align the popup.

See Also:

Constant Field Values

Constructor Detail

PopupHint

public PopupHint(java.lang.String name)

Constructor.

Parameters:

name - the name of the hint variable when generated.

PopupHint

public PopupHint(java.lang.String name,
                 java.lang.String sourceId)

Constructor.

Parameters:

name - the name of the hint variable when generated.

sourceId - the ID of the component that launched the popup.

Method Detail

setHintName

public void setHintName(java.lang.String name)

Sets the hint variable name.

Parameters:

name - the name of the hint variable when generated.

getHintName

public java.lang.String getHintName()

Gets the hint variable name.

Returns:

the name of the hint variable when generated.

addAlignHint

public void addAlignHint(java.lang.String alignTo,
                         PopupHint.HintAlignment alignment)

Add hints to align the popup with another UI component.

Parameters:

alignTo - the ID of the UI component to align the popup to.

alignment - the alignment of the popup to the UI component.

addQuotedHint

public void addQuotedHint(java.lang.String name,
                          java.lang.String value)

Add a hint to the collection of hints and putting the value in quotes.

Parameters:

name - the name of the hint

value - the value of the hint

addUnquotedHint

public void addUnquotedHint(java.lang.String name,
                            java.lang.String value)

Add a hint to the collection of hints.

Parameters:

name - the name of the hint

value - the value of the hint

getHintScript

public java.lang.String getHintScript()

Generates the hint javascript based upon the hints supplied.

Returns:

the hint javascript