JavaScript API Reference for Oracle ADF Faces

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

oracle.adfinternal.view.js.laf.dhtml.rich
Class AdfDhtmlDocumentPeer

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.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.base.AdfUIPeer
               |
               +--oracle.adf.view.js.laf.rich.AdfRichUIPeer
                     |
                     +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlDocumentPeer

public class AdfDhtmlDocumentPeer
extends AdfRichUIPeer

Renders html, head and body for DHTML

Field Summary

private static Object	_ALERT_CONFIRM_DIALOG_CONTAINER_ID
private static Object	_ALERT_CONFIRM_DIALOG_ID_EXPANDO
private static Object	_ALERT_CONFIRM_DIALOG_MAX_WIDTH_EXPANDO
private static Object	_ALERT_CONFIRM_POPUP_ID_EXPANDO
private static Object	_DIALOG_CANCEL_ID_SUBID
private static Object	_DIALOG_CONTENT_SUBID
private Object	_globalMessageCount
private static Object	_ICON_CONTAINER_ID
private static Object	_INACTIVE_STYLECLASS
private Object	_initSkipLink
private static Object	_MESSAGE_DIALOG_CONTAINER_ID
private static Object	_MESSAGE_DIALOG_ID
private Object	_setDocumentTitle
private Object	_setUncommittedDataWarning
private static Object	_SKIP_LINK_ID

Fields inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer

addComponentPropertyChanges, addComponentPropertyGetters, BUSY_STYLECLASS, DISABLED_STYLECLASS, DRAG_SOURCE_STYLECLASS, DROP_TARGET_STYLECLASS, FOCUS_TARGET_STYLECLASS, HOVER_TARGET_STYLECLASS, READONLY_STYLECLASS

Fields inherited from oracle.adf.view.js.base.AdfObject

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Constructor Summary

public

AdfDhtmlDocumentPeer() Renders html, head and body for DHTML

Method Summary

private Object	_activateFocus()
private static void	_alertConfirmCallback(Object event) The dialog confirm/alert dialog event callback.
private static void	_alertConfirmTimeoutCallback(String dialogId) The dialog confirm/alert timeout callback.
protected Object	ComponentShortDescChanged(Object component, Object domElement, Object newValue, Object oldValue) property change handler
protected Object	ComponentTitleChanged(Object component, Object domElement, Object newValue, Object oldValue) property change handler
private Object	_delayedSetDocumentTitle()
public Object	getMessageDialogId() Returns the id of the message dialog
private Object	_getSkipLinkElement(Object component)
private static Object	_getSkipLinkTargetId(Object component)
private Object	_getSlaveComponent()
protected Object	HandleComponentBlur(Object componentEvent)
protected Object	HandleComponentClick(Object componentEvent)
protected Object	HandleComponentContextMenu(Object componentEvent)
protected Object	HandleComponentDialog(Object componentEvent)
protected Object	HandleComponentFocus(Object componentEvent)
protected Object	HandleComponentKeyUp(Object componentEvent)
protected Object	HandleComponentRedirect(Object componentEvent)
private Object	_hideMessagePopup() Hides the message popup.
protected Object	Init(Object component) Initializes the instance.
protected Object	InitDomElement(Object component, Object domElement) Initialize the associated domElement when the peer is created.
private Object	_initSkipLink(Object component)
protected static Object	InitSubclass()
public Boolean	isMessagesDialogShowable() MessageHandler API used by the messaging framework pieces.
private static Object	_isPotentiallyFocusable(Object element)
protected Object	MessageNotify(Object maxType, Object messages) Called to notify the peer that its messages have changed.
protected Object	MessageShow(Object maxType, Object messages) Called to notify the peer that its messages should be shown.
private Object	_messageUpdate(Object maxType, Object messages, Object alwaysShow) when alwaysShow is false - the dialog only opens if a global message added - if component message added, dialog does not open, but if already open is updated when alwaysShow is true - dialog (or component note window) opened.
protected Object	PopupClosed(Object component, Object contentDom) Hook for notifying a peer that a popup of its was just closed.
protected Object	ReplaceDomElement(Object newElement, Object oldElement) Override to handle the client icon DOM replacement - instead of replacing the whole thing, add in any new icons
private static void	_setAlertConfirmMessage(String dialogId, String message) Sets the message of the alert/confirm dialog.
private Object	_setDocumentTitle(Object component)
public Object	setMessagesDialogShown(Boolean visible) MessageHandler API used by the messaging framework pieces.
private Object	_setUncommittedDataWarning(Object component)
boolean	__showAlertConfirm(boolean isAlert, String title, String message, Function callback, int timeout)
private Object	_skipToContent()

Methods inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer

addComponentEventHandlers, addComponentPropertyChanges, addComponentPropertyGetters, addDomEventHandlers, addEventHandlerToDomInstance, addSuppressedPPRAttributes, bind, BindToComponent, cancelAllPopups, cancelPopup, ChildVisibilityChanged, ComponentInlineStyleChanged, ComponentPropertyChanged, componentRemoved, ComponentRemoved, ComponentStyleClassChanged, ComponentVisibleChanged, ConvertClientIdToLocator, convertLocatorToClientId, CreateDraggableNode, createPeerClass, createSubId, CreateSubId, DefaultInitClass, DispatchComponentEvent, domReplaceNotify, DomReplaceNotify, focus, Focus, getAbsoluteId, getAbsoluteLocator, getAccessibleName, GetAccessibleName, getAllPopups, getComponent, GetComponent, GetComponentId, getComponentParent, getComponentProperty, GetComponentVisible, getDescendantComponents, getDomContentElement, getDomContentElementForComponent, GetDomContentElementForNode, getDomDocument, getDomElement, getDomElementForComponent, getDomNode, GetDomNodeForCommentComponent, getDomNodeForComponent, getDragOverFeedback, GetDragOverFeedback, getDragTransferable, GetDragTransferable, getFirstAncestorComponent, getInlineEditor, GetInlineEditor, getInlineStyleProperty, getLocatorByDomElement, getPagePosition, getPopupWindow, getReadyState, GetReadyState, GetRichResourceURL, getSubIdDomElement, GetSubIdDomElement, hideAllPopups, hidePopup, InitClass, initialize, isActive, isInActiveHeirarchy, isPopupVisible, messageNotify, messageShow, needsChildVisibilityChanges, processPushData, ProcessPushData, registerKeyStroke, replaceDomElement, resizeNotify, ResizeNotify, scrollIntoView, ScrollIntoView, setBusy, SetBusy, setInlineStyleProperty, showContextMenu, showPopup, TruncateClientId, TruncateClientIdOnceImpl, UnbindFromComponent, unregisterKeyStroke, visitChildren

Methods inherited from oracle.adf.view.js.base.AdfUIPeer

getDefaultDragRecognizer, getParentPeer, initiateDrag, isVisible, needsResizeNotify

Methods inherited from oracle.adf.view.js.base.AdfObject

adopt, clone, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, getClass, GetLazyArrayProperty, GetLazyMapProperty, getTypeName, toDebugString, toString

Field Detail

_ALERT_CONFIRM_DIALOG_CONTAINER_ID

private static Object _ALERT_CONFIRM_DIALOG_CONTAINER_ID

_ALERT_CONFIRM_DIALOG_ID_EXPANDO

private static Object _ALERT_CONFIRM_DIALOG_ID_EXPANDO

_ALERT_CONFIRM_DIALOG_MAX_WIDTH_EXPANDO

private static Object _ALERT_CONFIRM_DIALOG_MAX_WIDTH_EXPANDO

_ALERT_CONFIRM_POPUP_ID_EXPANDO

private static Object _ALERT_CONFIRM_POPUP_ID_EXPANDO

_DIALOG_CANCEL_ID_SUBID

private static Object _DIALOG_CANCEL_ID_SUBID

_DIALOG_CONTENT_SUBID

private static Object _DIALOG_CONTENT_SUBID

_globalMessageCount

private Object _globalMessageCount

_ICON_CONTAINER_ID

private static Object _ICON_CONTAINER_ID

_INACTIVE_STYLECLASS

private static Object _INACTIVE_STYLECLASS

_initSkipLink

private Object _initSkipLink

_MESSAGE_DIALOG_CONTAINER_ID

private static Object _MESSAGE_DIALOG_CONTAINER_ID

_MESSAGE_DIALOG_ID

private static Object _MESSAGE_DIALOG_ID

_setDocumentTitle

private Object _setDocumentTitle

_setUncommittedDataWarning

private Object _setUncommittedDataWarning

_SKIP_LINK_ID

private static Object _SKIP_LINK_ID

Constructor Detail

AdfDhtmlDocumentPeer

public AdfDhtmlDocumentPeer()

Renders html, head and body for DHTML

Method Detail

_activateFocus

private Object _activateFocus()

Return:

Object

_alertConfirmCallback

private static void _alertConfirmCallback(Object event)

The dialog confirm/alert dialog event callback.

Parameters:

event

Return:

void - null

_alertConfirmTimeoutCallback

private static void _alertConfirmTimeoutCallback(String dialogId)

The dialog confirm/alert timeout callback. Forces the dialog to cancel after the timeout period.

Parameters:

dialogId

-

client id of the confirm or alert dialog

Return:

void - null

ComponentShortDescChanged

protected Object ComponentShortDescChanged(Object component,
Object domElement,
Object newValue,
Object oldValue)

property change handler

Parameters:

component
domElement
newValue
oldValue

Return:

Object

ComponentTitleChanged

protected Object ComponentTitleChanged(Object component,
Object domElement,
Object newValue,
Object oldValue)

property change handler

Parameters:

component
domElement
newValue
oldValue

Return:

Object

_delayedSetDocumentTitle

private Object _delayedSetDocumentTitle()

Return:

Object

getMessageDialogId

public Object getMessageDialogId()

Returns the id of the message dialog

Return:

Object

_getSkipLinkElement

private Object _getSkipLinkElement(Object component)

Parameters:

component

Return:

Object

_getSkipLinkTargetId

private static Object _getSkipLinkTargetId(Object component)

Parameters:

component

Return:

Object

_getSlaveComponent

private Object _getSlaveComponent()

Return:

Object

HandleComponentBlur

protected Object HandleComponentBlur(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentClick

protected Object HandleComponentClick(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentContextMenu

protected Object HandleComponentContextMenu(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentDialog

protected Object HandleComponentDialog(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentFocus

protected Object HandleComponentFocus(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentKeyUp

protected Object HandleComponentKeyUp(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentRedirect

protected Object HandleComponentRedirect(Object componentEvent)

Parameters:

componentEvent

Return:

Object

_hideMessagePopup

private Object _hideMessagePopup()

Hides the message popup.

Return:

Object

Init

protected Object Init(Object component)

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

Parameters:

component

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)

_initSkipLink

private Object _initSkipLink(Object component)

Parameters:

component

Return:

Object

InitSubclass

protected static Object InitSubclass()

Return:

Object

isMessagesDialogShowable

public Boolean isMessagesDialogShowable()

MessageHandler API used by the messaging framework pieces. Determines whether the setMessagesDialogShown() API is able to show a dialog. If no dialog is showable, then links that would invoke it should be hidden.

Return:

Boolean - true if setMessageDialogShown(true) will do anything, false otherwise

_isPotentiallyFocusable

private static Object _isPotentiallyFocusable(Object element)

Parameters:

element

Return:

Object

MessageNotify

protected Object MessageNotify(Object maxType,
Object messages)

Called to notify the peer that its messages have changed. The messages provided will be an array of FacesMessage or AdfFacesMessage objects. If this array is null then all the messages have been cleared from this component.

Parameters:

maxType
messages

Return:

Object

Overrides:

AdfUIPeer.messageNotify(Object, Number, Array)

MessageShow

protected Object MessageShow(Object maxType,
Object messages)

Called to notify the peer that its messages should be shown. The messages provided will be an array of FacesMessage or AdfFacesMessage objects. If this array is null then all the messages have been cleared from this component.

Parameters:

maxType
messages

Return:

Object

Overrides:

AdfUIPeer.messageShow(Object, Number, Array)

_messageUpdate

private Object _messageUpdate(Object maxType,
Object messages,
Object alwaysShow)

when alwaysShow is false - the dialog only opens if a global message added - if component message added, dialog does not open, but if already open is updated when alwaysShow is true - dialog (or component note window) opened.

Parameters:

maxType
messages
alwaysShow

Return:

Object

PopupClosed

protected Object PopupClosed(Object component,
Object contentDom)

Hook for notifying a peer that a popup of its was just closed.

Parameters:

component
contentDom

Return:

Object

Overrides:

AdfRichUIPeer.PopupClosed(AdfUIComponent, HTMLElement, String)

ReplaceDomElement

protected Object ReplaceDomElement(Object newElement,
Object oldElement)

Override to handle the client icon DOM replacement - instead of replacing the whole thing, add in any new icons

Parameters:

newElement
oldElement

Return:

Object

Overrides:

AdfRichUIPeer.replaceDomElement(AdfUIComponent, HTMLElement, HTMLElement)

_setAlertConfirmMessage

private static void _setAlertConfirmMessage(String dialogId,
String message)

Sets the message of the alert/confirm dialog.

Parameters:

dialogId	-	alert/confirm dialog client id
message	-	displayed by the alert/confirm dialog

Return:

void - null

_setDocumentTitle

private Object _setDocumentTitle(Object component)

Parameters:

component

Return:

Object

setMessagesDialogShown

public Object setMessagesDialogShown(Boolean visible)

MessageHandler API used by the messaging framework pieces. Specifies the visibility of the document's "all messages" dialog. If setting it to be visible, this will also move focus into the dialog.

Parameters:

visible

-

true if to make it visible, false to hide it

Return:

Object

_setUncommittedDataWarning

private Object _setUncommittedDataWarning(Object component)

Parameters:

component

Return:

Object

__showAlertConfirm

boolean __showAlertConfirm(boolean isAlert,
String title,
String message,
Function callback,
int timeout)

Parameters:

isAlert	-	true if the message dialog should be an alert (ok button); otherwise, the dialog will be a confirm dialog (ok and cancel buttons)
title	-	of the dialog
message	-	displayed in the body of the dialog
callback	-	function that has a single actual parameter that is an AdfDialogEvent.
timeout	-	period in milliseconds that the dialog will be displayed before auto-dismissing with a cancel dialog outcome. Default value = null

Return:

boolean - true if the popup dialog is show; otherwise, false if the alert/confirm dialog is already visible.

_skipToContent

private Object _skipToContent()

Return:

Object

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