OracleJavaScript API Reference for Oracle ADF Faces

 

SUMMARY: FIELD | CONSTR | METHOD    DETAIL: FIELD | CONSTR | METHOD

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
The popup component is an invisible control whose contents will be used in popup windows, such as context menus.



Field Summary

public static Object
ALIGN_AFTER_END
public static Object
ALIGN_AFTER_START
public static Object
ALIGN_BEFORE_AFTER
public static Object
ALIGN_BEFORE_END
public static Object
ALIGN_BEFORE_START
public static Object
ALIGN_END_AFTER
public static Object
ALIGN_END_BEFORE
public static Object
ALIGN_OVERLAP
public static Object
ALIGN_START_AFTER
public static Object
ALIGN_START_BEFORE
public static Object
ANIMATE_DEFAULT
Constant that represents is the default enumeration of the animate property.
public static Object
AUTO_CANCEL_DISABLED
Constant that represents is the disabled enumeration of the autoCanceled property.
public static Object
AUTO_CANCEL_ENABLED
Constant that represents is the enabled enumeration of the autoCanceled property.
public static Object
CONTENT_DELIVERY_IMMEDIATE
Constant that represents is the immediate enumeration of the contentDelivery property.
public static Object
CONTENT_DELIVERY_LAZY
Constant that represents is the lazy enumeration of the contentDelivery property.
public static Object
CONTENT_DELIVERY_LAZY_UNCACHED
Constant that represents is the lazyUncached enumeration of the contentDelivery property.
public static Object
HINT_ALIGN
Constant that is used as the key to a map of popup hints.
public static Object
HINT_ALIGN_ID
Constant that is used as the key to a map of popup hints.
public static Object
HINT_LAUNCH_ID
The client id of the component that launched the popup.
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.


Fields inherited from org.ecmascript.object.Object

constructor, prototype


Constructor Summary

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


Method Summary

public Object
cancel()
Hides the popup component and queues the AdfPopupCanceledEvent.
public String
getAnimate()
Get function for attribute for 'animate'.
public String
getAutoCancel()
Get function for attribute for 'autoCancel'.
public String
getChildCreation()
Get function for attribute for 'childCreation'.
public String
getContentDelivery()
Get function for attribute for 'contentDelivery'.
public String
getEventContext()
Get function for attribute for 'eventContext'.
private Object
_getFirstMenuPeer(Object component)
Visits the first child looking to see if it's a Menu.
public String
getLauncherVar()
Get function for attribute for 'launcherVar'.
public Object
getPopupCanceledListener()
Get function for attribute for 'popupCanceledListener'.
public Object
getPopupFetchListener()
Get function for attribute for 'popupFetchListener'.
public String
getResetEditableValues()
Get function for attribute for 'resetEditableValues'.
public Boolean
getVisible()
Get function for attribute for 'visible'.
public Object
hide()
Hides the popup component
public Object
isPopupVisible()
Returns true or false indicating if the popup is visible.
public void
setAnimate(String newAnimate)
Set function for attribute 'Animate'.
public void
setAutoCancel(String newAutoCancel)
Set function for attribute 'AutoCancel'.
public void
setChildCreation(String newChildCreation)
Set function for attribute 'ChildCreation'.
public void
setContentDelivery(String newContentDelivery)
Set function for attribute 'ContentDelivery'.
public void
setPopupCanceledListener(Object newPopupCanceledListener)
Set function for attribute 'PopupCanceledListener'.
public void
setPopupFetchListener(Object newPopupFetchListener)
Set function for attribute 'PopupFetchListener'.
public void
setResetEditableValues(String newResetEditableValues)
Set function for attribute 'ResetEditableValues'.
public Object
show(Object hints)
Shows the popup component and its contents.
private Object
_visitChildrenForMenu(Object component)
Callback invoked for _getFirstMenuPeer that test to see if the component is a AdfRichMenu.


Methods inherited from oracle.adf.view.js.component.AdfUIPopup

dontPropagateDescendantMessageChanges, isEventRoot


Field Detail


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

ANIMATE_DEFAULT

public static Object ANIMATE_DEFAULT

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

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_BEFORE_START
  • AdfRichPopup.ALIGN_BEFORE_END
  • AdfRichPopup.ALIGN_END_AFTER
  • AdfRichPopup.ALIGN_END_BEFORE
  • AdfRichPopup.ALIGN_START_AFTER
  • AdfRichPopup.ALIGN_START_BEFORE
  • 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".

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.

Constructor Detail


AdfRichPopup

public AdfRichPopup()

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

Method Detail


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

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

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:

  1. 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.
  2. 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.
  3. 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.
  4. 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.
  5. 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.
  6. 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.
  7. 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.
  8. 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.
  9. 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

SUMMARY: FIELD | CONSTR | METHOD    DETAIL: FIELD | CONSTR | METHOD

 

Generated on 2011.08.31 02:41 UTC
Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.