JavaScript API Reference for Oracle ADF Faces

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

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.AdfDhtmlMessagesPeer

public class AdfDhtmlMessagesPeer
extends AdfRichUIPeer

AdfDhtmlMessagesPeer

public AdfDhtmlMessagesPeer()

Peer for the messages component. The AdfDhtmlMessagesPeer is only used when the messages component is inline, when using a dialog the document peer is used.

componentRemoved

public Object componentRemoved(Object component)

Clean up the peer because it's component is being removed.

Parameters:

component

Return:

Object

Overrides:

AdfUIPeer.componentRemoved(AdfUIComponent)

GetComponentGlobalOnly

protected String GetComponentGlobalOnly(AdfUIComponent component,
                                        HTMLElement root)

Optimized getter for the attribute named globalOnly.

Parameters:

component	-	the component for this peer
root	-	the root DOM element for this peer

Return:

String - the globalOnly attribute value

GetComponentMessage

protected String GetComponentMessage(AdfUIComponent component,
                                     HTMLElement root)

Optimized getter for the attribute named message.

Parameters:

component	-	the component for this peer
root	-	the root DOM element for this peer

Return:

String - the message attribute value

GetComponentShortDesc

protected String GetComponentShortDesc(AdfUIComponent component,
                                       HTMLElement root)

Optimized getter for the attribute named shortDesc.

Parameters:

component	-	the component for this peer
root	-	the root DOM element for this peer

Return:

String - the shortDesc attribute value

GetComponentText

protected String GetComponentText(AdfUIComponent component,
                                  HTMLElement root)

Optimized getter for the attribute named text.

Parameters:

component	-	the component for this peer
root	-	the root DOM element for this peer

Return:

String - the text attribute value

GetSubIdDomElement

protected Object GetSubIdDomElement(Object subElementId)

Returns the DOM element identified by the passed in subId.

Parameters:

subElementId

Return:

Object - the DOM element

Overrides:

AdfRichUIPeer.getSubIdDomElement(Object, Object)

InitSubclass

protected static Object InitSubclass()

Class initializer.

Return:

Object

isMessagesDialogShowable

public Boolean isMessagesDialogShowable()

The AdfDhtmlMessagesPeer is only used when the messages component is inline, when using a dialog the document peer is used. See AdfDhtmlDocumentPeer.isMessagesDialogShowable for the method called when a popup 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

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)

Parameters:

maxType
messages
alwaysShow

Return:

Object

setMessagesDialogShown

public Object setMessagesDialogShown(Boolean visible)

The AdfDhtmlMessagesPeer is only used when the messages component is inline, when using a dialog the document peer is used. See AdfDhtmlDocumentPeer.setMessagesDialogShown for the method called when a popup 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