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_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_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_OVERLAP

public static Object ALIGN_OVERLAP

ALIGN_START_AFTER

public static Object ALIGN_START_AFTER

ALIGN_START_BEFORE

public static Object ALIGN_START_BEFORE

CONTENT_DELIVERY_IMMEDIATE

public static Object CONTENT_DELIVERY_IMMEDIATE

Copyright (c) 2008, 2009, Oracle and/or its affiliates. All rights reserved. The AdfRichPopup class to show/hide a popup. Note: This is a "partial" class, the majority of this class is generated.

CONTENT_DELIVERY_LAZY

public static Object CONTENT_DELIVERY_LAZY

CONTENT_DELIVERY_LAZY_UNCACHED

public static Object CONTENT_DELIVERY_LAZY_UNCACHED

HINT_ALIGN

public static Object HINT_ALIGN

HINT_ALIGN_ID

public static Object HINT_ALIGN_ID

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

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

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

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

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