JavaScript API Reference for Oracle ADF Faces

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

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

Warning:

• This is an unsupported, internal implementation class.
• Use an API class that might provide equivalent functionality instead.
• This class will change without notice.
• It is not recommended that you use anything in this class.

org.ecmascript.object.Object
   |
   +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlPanelWindowPeer
         |
         +--oracle.adfinternal.view.js.laf.dhtml.internalWindow.AdfDhtmlDialogPeer

public class AdfDhtmlDialogPeer
extends AdfDhtmlPanelWindowPeer

Client peer for the dialog component.

Field Summary

private static Object	_ANIMATION_DURATION_SKIN_PROPERTY
private static Object	_BUTTON_IDS
private static Object	_BUTTON_OUTCOMES
private static Object	_CANCEL_ID
private static Object	_DIALOG_RESIZE_GHOST_CLASS
private static Object	_NO_ID
private static Object	_OK_ID
private static Object	_OUTCOME_ATTR_NAME
private static Object	_YES_ID

Fields inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlPanelWindowPeer

GetSubIdDomElement

Fields inherited from org.ecmascript.object.Object

constructor, prototype

Constructor Summary

public

AdfDhtmlDialogPeer() Client peer for the dialog component.

Method Summary

public Object	fireCancel() Queues a dialog cancel event.
public string	getAnimationDurationSkinProperty()
private static HTMLElement	_getButtonDom(String clientId, String buttonId) Get button DOM Element
public HTMLElement	getDefaultButtonDom(String clientId) Looks for the default button in order of precedence.
protected string	GetResizeGhostSelector()
protected Object	HandleComponentClick(AdfUIInputEvent componentEvent) Raises the correct AdfDialogEvent based on the id of the dom element associated with the native event target.
protected Object	HandleComponentKeyDown(AdfUIInputEvent componentEvent) The AdfUIInputEvent.KEY_DOWN_EVENT_TYPE is registered in the super class AdfDhtmlPanelWindowPeer.
protected Object	HandleComponentKeyPress(AdfUIInputEvent componentEvent) There is a one condition that is handled here:
protected Object	HandleComponentKeyUp(AdfUIInputEvent componentEvent) The AdfUIInputEvent.KEY_UP_EVENT_TYPE is registered in the super class AdfDhtmlPanelWindowPeer.
public Object	handleEscapeKey(Object event) Fires the AdfDialogEvent.OUTCOME_CANCEL event in response to an Esc key.
public static Object	hideDialogIfNoMessages(Object id)
protected Object	Init(Object component, Object usage)
protected Object	InitDomElement(Object component, Object domElement)
protected static Object	InitSubclass()
protected boolean	IsBusy(String clientId)
private static Boolean	_isOKPresent(String clientId) Returns the OK button's DOM element, if any
private static Boolean	_isYesPresent(String clientId)
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:
protected Object	SetBusy(Object isBusy) Override to disable the provided buttons when the dialog is busy
private static Object	_setButtonDisableState(String clientId, Boolean disabled) Stores the outcome mapped to a button in an expando.
private static Object	_setOutcomeExpandos(String clientId) Stores the outcome mapped to a button in an expando.

Field Detail

_ANIMATION_DURATION_SKIN_PROPERTY

private static Object _ANIMATION_DURATION_SKIN_PROPERTY

_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

private static Object _OUTCOME_ATTR_NAME

_YES_ID

private static Object _YES_ID

Constructor Detail

AdfDhtmlDialogPeer

public AdfDhtmlDialogPeer()

Client peer for the dialog component.

Method Detail

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

getAnimationDurationSkinProperty

public string getAnimationDurationSkinProperty()

Return:

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

_getButtonDom

private static HTMLElement _getButtonDom(String clientId,
String buttonId)

Get button DOM Element

Parameters:

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

Return:

HTMLElement - The HTML Dom Element for the button

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

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

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

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

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

handleEscapeKey

public Object handleEscapeKey(Object event)

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

Parameters:

event

Return:

Object

hideDialogIfNoMessages

public static Object hideDialogIfNoMessages(Object id)

Parameters:

id

Return:

Object

Init

protected Object Init(Object component,
Object usage)

Parameters:

component
usage

Return:

Object

InitDomElement

protected Object InitDomElement(Object component,
Object domElement)

Parameters:

component
domElement

Return:

Object

InitSubclass

protected static Object InitSubclass()

Return:

Object

IsBusy

protected boolean IsBusy(String clientId)

Parameters:

clientId

-

the client id of the dialog

Return:

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

_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

SetBusy

protected Object SetBusy(Object isBusy)

Override to disable the provided buttons when the dialog is busy

Parameters:

isBusy

Return:

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

_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

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