JavaScript API Reference for Oracle ADF Faces

oracle.adf.view.js.component.rich
Class AdfRichPopup

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.component.AdfUIPopup
         |
         +--oracle.adf.view.js.component.rich.AdfRichPopup

public class AdfRichPopup
extends AdfUIPopup

ALIGN_AFTER_CENTER

public static Object ALIGN_AFTER_CENTER

ALIGN_AFTER_END

public static Object ALIGN_AFTER_END

ALIGN_AFTER_START

public static Object ALIGN_AFTER_START

ALIGN_BEFORE_AFTER

public static Object ALIGN_BEFORE_AFTER

ALIGN_BEFORE_CENTER

public static Object ALIGN_BEFORE_CENTER

ALIGN_BEFORE_END

public static Object ALIGN_BEFORE_END

ALIGN_BEFORE_START

public static Object ALIGN_BEFORE_START

ALIGN_END_AFTER

public static Object ALIGN_END_AFTER

ALIGN_END_BEFORE

public static Object ALIGN_END_BEFORE

ALIGN_END_CENTER

public static Object ALIGN_END_CENTER

ALIGN_OVERLAP

public static Object ALIGN_OVERLAP

ALIGN_OVERLAP_END_BEFORE

public static Object ALIGN_OVERLAP_END_BEFORE

ALIGN_OVERLAP_START_BEFORE

public static Object ALIGN_OVERLAP_START_BEFORE

ALIGN_START_AFTER

public static Object ALIGN_START_AFTER

ALIGN_START_BEFORE

public static Object ALIGN_START_BEFORE

ALIGN_START_CENTER

public static Object ALIGN_START_CENTER

ANIMATE_DEFAULT

public static Object ANIMATE_DEFAULT

Constant that represents is the default enumeration of the animate property. This is the default.

ANIMATE_FALSE

public static Object ANIMATE_FALSE

Constant that represents is the false enumeration of the animate property.

ANIMATE_TRUE

public static Object ANIMATE_TRUE

Constant that represents is the true enumeration of the animate property.

AUTO_CANCEL_DISABLED

public static Object AUTO_CANCEL_DISABLED

Constant that represents is the disabled enumeration of the autoCanceled property. With this option, the popup will restore visiblity when its DOM is replaced.

AUTO_CANCEL_ENABLED

public static Object AUTO_CANCEL_ENABLED

Constant that represents is the enabled enumeration of the autoCanceled property. This is the default. When this option is selected, the popup will auto-dismiss when its DOM is replaced.

CONTENT_DELIVERY_IMMEDIATE

public static Object CONTENT_DELIVERY_IMMEDIATE

Constant that represents is the immediate enumeration of the contentDelivery property. This value will cause the markup to be delivered to to client on initial rendering.

CONTENT_DELIVERY_LAZY

public static Object CONTENT_DELIVERY_LAZY

Constant that represents is the lazy enumeration of the contentDelivery property. With this value, the content will be delivered on the first request.

CONTENT_DELIVERY_LAZY_UNCACHED

public static Object CONTENT_DELIVERY_LAZY_UNCACHED

Constant that represents is the lazyUncached enumeration of the contentDelivery property. With this option, the content will be delivered each time the poppup is shown.

HINT_ALIGN

public static Object HINT_ALIGN

Constant that is used as the key to a map of popup hints. This gives the alignment preference. The possible values are as follows:

• AdfRichPopup.ALIGN_AFTER_START
• AdfRichPopup.ALIGN_AFTER_END
• AdfRichPopup.ALIGN_AFTER_CENTER
• AdfRichPopup.ALIGN_BEFORE_START
• AdfRichPopup.ALIGN_BEFORE_END
• AdfRichPopup.ALIGN_BEFORE_CENTER
• AdfRichPopup.ALIGN_END_AFTER
• AdfRichPopup.ALIGN_END_BEFORE
• AdfRichPopup.ALIGN_END_CENTER
• AdfRichPopup.ALIGN_START_AFTER
• AdfRichPopup.ALIGN_START_BEFORE
• AdfRichPopup.ALIGN_START_CENTER
• AdfRichPopup.ALIGN_OVERLAP
• AdfRichPopup.ALIGN_BEFORE_AFTER

See also:

show(Object)

HINT_ALIGN_ID

public static Object HINT_ALIGN_ID

Constant that is used as the key to a map of popup hints. The key's value should hold the client id of the component the popup should be alligned to.

HINT_LAUNCH_ID

public static Object HINT_LAUNCH_ID

The client id of the component that launched the popup. This hint is needed when using the popup fetch listener in order to make sure that the popup events are invoked in the correct context. This hint is required when the eventContext popup property is "launcher".

HINT_TAIL

public static Object HINT_TAIL

Constant that is used as the key to a map of popup hints. Indicates if a popup tail is shown. The tail value is associated with its visual presentation defined in the active skin. The out of the box values are as follows:

• AdfRichPopup.TAIL_NONE
• AdfRichPopup.TAIL_SIMPLE

See also:

show(Object)

RESET_EDITABLE_VALUES_WHEN_CANCELED

public static Object RESET_EDITABLE_VALUES_WHEN_CANCELED

Constant for the resetEditableValues property that that indicates that the popup should reset input components within its content when canceled.

TAIL_NONE

public static Object TAIL_NONE

TAIL_SIMPLE

public static Object TAIL_SIMPLE

AdfRichPopup

public AdfRichPopup()

The popup component is an invisible control whose contents will be used in popup windows, such as context menus.

cancel

public Object cancel()

Hides the popup component and queues the AdfPopupCanceledEvent. This event will propagate to the server if there are registered server-side listeners.

Return:

Object

getAnimate

public string getAnimate()

Get function for attribute for 'animate'.

Return:

string - Animate

getAutoCancel

public string getAutoCancel()

Get function for attribute for 'autoCancel'.

Return:

string - AutoCancel

getAutoDismissalTimeout

public number getAutoDismissalTimeout()

Get function for attribute for 'autoDismissalTimeout'.

Return:

number - AutoDismissalTimeout

getChildCreation

public string getChildCreation()

Get function for attribute for 'childCreation'.

Return:

string - ChildCreation

getContentDelivery

public string getContentDelivery()

Get function for attribute for 'contentDelivery'.

Return:

string - ContentDelivery

getEventContext

public string getEventContext()

Get function for attribute for 'eventContext'. This attribute is secured. You may get it, but you may not set it. Any changes to this attribute will not be transmitted to the server.

Return:

string - EventContext

_getFirstMenuPeer

private Object _getFirstMenuPeer(Object component)

Visits the first child looking to see if it's a Menu.

Parameters:

component

Return:

Object - the child menu peer if exists as the first child

getLauncherVar

public string getLauncherVar()

Get function for attribute for 'launcherVar'. This attribute is secured. You may get it, but you may not set it. Any changes to this attribute will not be transmitted to the server.

Return:

string - LauncherVar

getPopupCanceledListener

public Object getPopupCanceledListener()

Get function for attribute for 'popupCanceledListener'.

Return:

Object - PopupCanceledListener

getPopupFetchListener

public Object getPopupFetchListener()

Get function for attribute for 'popupFetchListener'.

Return:

Object - PopupFetchListener

getResetEditableValues

public string getResetEditableValues()

Get function for attribute for 'resetEditableValues'.

Return:

string - ResetEditableValues

getVisible

public boolean getVisible()

Get function for attribute for 'visible'. This attribute is secured. You may get it, but you may not set it. Any changes to this attribute will not be transmitted to the server.

Return:

boolean - Visible

hide

public Object hide()

Hides the popup component

Return:

Object

isPopupVisible

public Object isPopupVisible()

Returns true or false indicating if the popup is visible.

Return:

Object - null - true if the popup is visible else false.

setAnimate

public void setAnimate(string newAnimate)

Set function for attribute 'Animate'.

Parameters:

newAnimate

Return:

void - No Value returned

setAutoCancel

public void setAutoCancel(string newAutoCancel)

Set function for attribute 'AutoCancel'.

Parameters:

newAutoCancel

Return:

void - No Value returned

setAutoDismissalTimeout

public void setAutoDismissalTimeout(number newAutoDismissalTimeout)

Set function for attribute 'AutoDismissalTimeout'.

Parameters:

newAutoDismissalTimeout

Return:

void - No Value returned

setChildCreation

public void setChildCreation(string newChildCreation)

Set function for attribute 'ChildCreation'.

Parameters:

newChildCreation

Return:

void - No Value returned

setContentDelivery

public void setContentDelivery(string newContentDelivery)

Set function for attribute 'ContentDelivery'.

Parameters:

newContentDelivery

Return:

void - No Value returned

setPopupCanceledListener

public void setPopupCanceledListener(Object newPopupCanceledListener)

Set function for attribute 'PopupCanceledListener'.

Parameters:

newPopupCanceledListener

Return:

void - No Value returned

setPopupFetchListener

public void setPopupFetchListener(Object newPopupFetchListener)

Set function for attribute 'PopupFetchListener'.

Parameters:

newPopupFetchListener

Return:

void - No Value returned

setResetEditableValues

public void setResetEditableValues(string newResetEditableValues)

Set function for attribute 'ResetEditableValues'.

Parameters:

newResetEditableValues

Return:

void - No Value returned

show

public Object show(Object hints)

Shows the popup component and its contents.

Parameters:

hints

-

A map containing hints for the display The following are the predefined hints AdfRichPopup.HINT_ALIGN alignment hint. See diagram below: before_start     before_end start_before overlap Launching DOM Element end_before     start_after end_after after_start     after_end The following are the possible values: AdfRichPopup.ALIGN_AFTER_START: The popup appears underneath the element with the popup's upper-left corner aligned with the lower-left corner of the element. The left edges of the element and the popup are aligned. AdfRichPopup.ALIGN_AFTER_END: The popup appears underneath the element with the popup's upper-right corner aligned with the lower-right corner of the element. The right edges of the element and the popup are aligned. AdfRichPopup.ALIGN_BEFORE_START: The popup appears above the element with the popup's lower-left corner aligned with the upper-left corner of the element. The left edges of the element and the popup are aligned. AdfRichPopup.ALIGN_BEFORE_END: The popup appears above the element with the popup's lower-right corner aligned with the upper-right corner of the element. The right edges of the element and the popup are aligned. AdfRichPopup.ALIGN_END_AFTER: The popup appears to the right of the element with the popup's lower-left corner aligned with the lower-right corner of the element. The bottom edges of the element and the popup are aligned. AdfRichPopup.ALIGN_END_BEFORE: The popup appears to the right of the element with the popup's upper-left corner aligned with the upper-right corner of the element. The top edges of the element and the popup are aligned. AdfRichPopup.ALIGN_START_AFTER: The popup appears to the left of the element with the popup's lower-right corner aligned with the lower-left corner of the element. The bottom edges of the element and the popup are aligned. AdfRichPopup.ALIGN_START_BEFORE: The popup appears to the left of the element with the popup's upper-right corner aligned with the upper-left corner of the element. The top edges of the element and the popup are aligned. AdfRichPopup.ALIGN_OVERLAP: The popup appears over top of the element with the upper-left corners aligned. Currently only AdfRichPopup.ALIGN_START_AFTER, AdfRichPopup.ALIGN_BEFORE_START and AdfRichPopup.ALIGN_END_BEFORE are supported AdfRichPopup.HINT_ALIGN_ID id of the component the popup should align to. Example: construction of the hints parameter var hints = new Object(); hints[AdfRichPopup.HINT_ALIGN] = AdfRichPopup.ALIGN_AFTER_START; hints[AdfRichPopup.HINT_ALIGN_ID] = myInputTextId; Default value = null

Return:

Object

_visitChildrenForMenu

private Object _visitChildrenForMenu(Object component)

Callback invoked for _getFirstMenuPeer that test to see if the component is a AdfRichMenu.

Parameters:

component

Return:

Object - 2 to stop the chain