JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.laf.dhtml.internalWindow
Class AdfDhtmlDialogPeer

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.base.AdfUIPeer
               |
               +--oracle.adf.view.js.laf.rich.AdfRichUIPeer
                     |
                     +--oracle.adfinternal.view.js.laf.dhtml.internalWindow.AdfDhtmlPanelWindowBasePeer
                           |
                           +--oracle.adfinternal.view.js.laf.dhtml.rich.desktop.AdfDhtmlPanelWindowPeer
                                 |
                                 +--oracle.adfinternal.view.js.laf.dhtml.internalWindow.AdfDhtmlDialogPeer

public class AdfDhtmlDialogPeer
extends AdfDhtmlPanelWindowPeer

_ANIMATE_SKIN_PROPERTY

private static Object _ANIMATE_SKIN_PROPERTY

Overrides:

AdfDhtmlPanelWindowBasePeer._ANIMATE_SKIN_PROPERTY

_ANIMATION_DURATION_SKIN_PROPERTY

private static Object _ANIMATION_DURATION_SKIN_PROPERTY

Overrides:

AdfDhtmlPanelWindowBasePeer._ANIMATION_DURATION_SKIN_PROPERTY

_BUTTON_ID_MAP

private static Object _BUTTON_ID_MAP

Map of button ids, which are used differently for new vs. old button impl.

_BUTTON_IDS

private static Object _BUTTON_IDS

_BUTTON_OUTCOMES

private static Object _BUTTON_OUTCOMES

_CANCEL_ID

private static Object _CANCEL_ID

_DIALOG_RESIZE_GHOST_CLASS

private static Object _DIALOG_RESIZE_GHOST_CLASS

_NO_ID

private static Object _NO_ID

_OK_ID

private static Object _OK_ID

_OUTCOME_ATTR_NAME_EXPANDO

private static Object _OUTCOME_ATTR_NAME_EXPANDO

_YES_ID

private static Object _YES_ID

AdfDhtmlDialogPeer

public AdfDhtmlDialogPeer()

Client peer for the dialog component.

fireCancel

public Object fireCancel()

Queues a dialog cancel event. This is invoked when the dialog is force close by the AdfDhtmlDialogManager when a modal dialog has modeless children.

Return:

Object

getAnimateSkinProperty

public String getAnimateSkinProperty()

Return:

String - null "-tr-animate" skinning property for the dialog component.

Overrides:

AdfDhtmlPanelWindowBasePeer.getAnimateSkinProperty()

getAnimationDurationSkinProperty

public String getAnimationDurationSkinProperty()

Return:

String - skinning property name for the animation duration of the dialog.

Overrides:

AdfDhtmlPanelWindowBasePeer.getAnimationDurationSkinProperty()

GetBestMatchSubId

protected Object GetBestMatchSubId(Object domElement)

Returns the best match subId for the given domElement. This can be enhanced further to return programmatically determined subIds. WARNING - You must make sure to bind the component to the peer before calling this function.

Parameters:

domElement

Return:

Object

See also:

AdfRichUIPeer.GetSubIdDomElement(Object)

Overrides:

AdfRichUIPeer.GetBestMatchSubId(Object)

_getButtonDom

private static HTMLElement _getButtonDom(String clientId,
                                         String buttonId)

Get the af:commandButton or af:button DOM Element, if found.

Parameters:

clientId	-	the client id of the dialog
buttonId	-	used to for the subclientId

Return:

HTMLElement - The HTML Dom Element for the button

_getButtonRootElement

private HTMLElement _getButtonRootElement(Object domElement,
                                          String clientId)

Returns an af:button or af:commandButton root element for the provided interior domElement, or null if no potential button root element was found.

Parameters:

domElement
clientId	-	dialog client id

Return:

HTMLElement - the root HTML dom element for the button, or null if not found.

getDefaultButtonDom

public HTMLElement getDefaultButtonDom(String clientId)

Looks for the default button in order of precedence. Returns null if "Yes", "OK", "No", or "Cancel" buttons do not exist.

Parameters:

clientId

-

the client id of the dialog

Return:

HTMLElement - The HTML Dom Element for the button

GetResizeGhostSelector

protected String GetResizeGhostSelector()

Return:

String - the selector name that is used to locate the client style that's applied the to drag ghost during drag-and-drop resizing

Overrides:

AdfDhtmlPanelWindowBasePeer.GetResizeGhostSelector()

GetSubIdDomElement

protected HTMLElement GetSubIdDomElement(String subElementId)

Returns the dom element for a given subElementId for dialog.

Parameters:

subElementId

-

the id of the child dom element or component

Return:

HTMLElement - the DOM within the component related to scopedId

Overrides:

AdfRichUIPeer.getSubIdDomElement(Object, Object)

HandleComponentClick

protected Object HandleComponentClick(AdfUIInputEvent componentEvent)

Raises the correct AdfDialogEvent based on the id of the dom element associated with the native event target. Expandos attributes set in the InitDomElement are use to map the target's id to the AdfDialogEvent's outcome.

Parameters:

componentEvent

-

click event

Return:

Object

Overrides:

AdfDhtmlPanelWindowBasePeer.HandleComponentClick(AdfUIInputEvent)

HandleComponentKeyDown

protected Object HandleComponentKeyDown(AdfUIInputEvent componentEvent)

The AdfUIInputEvent.KEY_DOWN_EVENT_TYPE is registered in the super class AdfDhtmlPanelWindowPeer. There are a few conditions that are handled here; otherwise, the super implementation is invoked. 1.) If the enter key was used and the OK button is present, AdfDialogEvent.OUTCOME_OK is fired. 2.) If the enter key was used and the YES button is present, AdfDialogEvent.OUTCOME_YES is fired. Note that if the enter key was used and the close or cancel buttons were in focus, we do not want to do anything because those will be handled by keypress instead.

Parameters:

componentEvent

-

wrapped key down event

Return:

Object

Overrides:

AdfDhtmlPanelWindowBasePeer.HandleComponentKeyDown(AdfUIInputEvent)

HandleComponentKeyPress

protected Object HandleComponentKeyPress(AdfUIInputEvent componentEvent)

There is a one condition that is handled here: 1.) If enter key on the close or cancel buttons, hide the dialog.

Parameters:

componentEvent

-

wrapped key press event

Return:

Object

Overrides:

AdfDhtmlPanelWindowBasePeer.HandleComponentKeyPress(AdfUIInputEvent)

HandleComponentKeyUp

protected Object HandleComponentKeyUp(AdfUIInputEvent componentEvent)

The AdfUIInputEvent.KEY_UP_EVENT_TYPE is registered in the super class AdfDhtmlPanelWindowPeer. There is one condition that is handled here; otherwise, the super implementation is invoked. 1.) If the space key was used on the close button, the AdfDialogEvent.OUTCOME_CANCEL is fired.

Parameters:

componentEvent

-

wrappered dom event

Return:

Object

Overrides:

AdfDhtmlPanelWindowBasePeer.HandleComponentKeyUp(AdfUIInputEvent)

handleEscapeKey

public Object handleEscapeKey(Object event)

Fires the AdfDialogEvent.OUTCOME_CANCEL event in response to an Esc key.

Parameters:

event

Return:

Object

Overrides:

AdfDhtmlPanelWindowBasePeer.handleEscapeKey(Object)

hideDialogIfNoMessages

public static Object hideDialogIfNoMessages(Object id)

Bug #13560292 - this method needs explicit export since it is being called from java code

Parameters:

id

Return:

Object

Init

protected Object Init(Object component,
                      Object usage)

Initializes the instance. Subclasses of AdfObject must call their superclass' Init

Parameters:

component
usage

Return:

Object

Overrides:

AdfObject.Init()

InitDomElement

protected Object InitDomElement(Object component,
                                Object domElement)

Initialize the associated domElement when the peer is created. Stateless peers are not bound at the time that this method is called.

Parameters:

component
domElement

Return:

Object

Overrides:

AdfRichUIPeer.InitDomElement(AdfUIComponent, Object)

InitSubclass

protected static Object InitSubclass()

Return:

Object

Overrides:

AdfDhtmlPanelWindowBasePeer.InitSubclass()

IsBusy

protected Boolean IsBusy(String clientId)

This method need to be overridden by the peers to return the busy state of the component. The default implementation returns false.

Parameters:

clientId

-

the client id of the dialog

Return:

Boolean - null true if the dialog is in a busy state.

Overrides:

AdfRichUIPeer.isBusy()

_isOKPresent

private static Boolean _isOKPresent(String clientId)

Returns the OK button's DOM element, if any

Parameters:

clientId

-

the client id of the dialog

Return:

Boolean - true if the OK button is within the content of the dialog

_isYesPresent

private static Boolean _isYesPresent(String clientId)

Parameters:

clientId

-

the client id of the dialog

Return:

Boolean - true if the Yes button is within the content of the dialog

_queueDialogOutcome

private String _queueDialogOutcome(AdfRichDialog component,
                                   AdfUIInputEvent componentEvent,
                                   Boolean ignoreCancelAndClose)

Queues a dialog event with an appropriate outcome if the component event was for one of these source elements: - The yes button - The no button - The ok button - The cancel button - The close button

Parameters:

component	-	this dialog component
componentEvent	-	the mouse up or key up component event
ignoreCancelAndClose	-	true if cancel/close should not queue an outcome

Return:

String - undefined , the DialogEvent outcome, or true if handled otherwise

_returnButtonElement

private HTMLElement _returnButtonElement(String buttonId)

Convenience method to handle both new af:buttons and old af:commandButtons.

Parameters:

buttonId

-

the partial id used for the child button

Return:

HTMLElement - the DOM within the component related to scopedId

SetBusy

protected Object SetBusy(Object isBusy)

Override to disable the provided buttons when the dialog is busy

Parameters:

isBusy

Return:

Object

Overrides:

AdfRichUIPeer.setBusy(Object, Object)

_setButtonDisableState

private static Object _setButtonDisableState(String clientId,
                                             Boolean disabled)

Stores the outcome mapped to a button in an expando. This reference is used by the HandleComponentMouseUp to raise correct AdfDialogEvent.

Parameters:

clientId	-	the client id of the dialog
disabled

Return:

Object

__setButtonVisible

static Object __setButtonVisible(String clientId,
                                  String buttonId,
                                  Boolean makeVisible)

Allow button visibility to be toggled on and off.

Parameters:

clientId	-	the client id of the dialog
buttonId	-	the id for the button
makeVisible	-	new visible state

Return:

Object

__setDefaultButtonDisabled

Object __setDefaultButtonDisabled(String clientId,
                                   Boolean disabled)

Set the default button to the provided disabled value.

Parameters:

clientId	-	the client id of the dialog
disabled	-	new disabled value

Return:

Object

_setOutcomeExpandos

private static Object _setOutcomeExpandos(String clientId)

Stores the outcome mapped to a button in an expando. This reference is used by the HandleComponentMouseUp to raise correct AdfDialogEvent.

Parameters:

clientId

-

the client id of the dialog

Return:

Object

_usesUnifiedButtons

private static Object _usesUnifiedButtons(Object clientId)

Returns true if dialog with this clientId is using unified af:buttons.

Parameters:

clientId

Return:

Object