# JavaScript API Reference for Oracle ADF Faces

Overview | Package | Class | Tree | Deprecated | Index | Help
| Oracle® Fusion Middleware Javascript API Reference for Oracle ADF Faces 12c (12.2.1.4.0) E81451-01
PREV NEXT | FRAMES NO FRAMES Warning: private items are visible |

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

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

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

    public class AdfDhtmlMessagesPeer
    extends AdfRichUIPeer

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.

## Field Summary

### Fields inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer
`addComponentPropertyChanges, addComponentPropertyGetters, BUSY_STYLECLASS, CreateSubId, DISABLED_STYLECLASS, DRAG_READY_STYLECLASS, DRAG_SOURCE_STYLECLASS, DROP_TARGET_STYLECLASS, FOCUS_TARGET_STYLECLASS, HOVER_TARGET_STYLECLASS, READONLY_STYLECLASS, SELECTED_STYLECLASS`

### Fields inherited from oracle.adf.view.js.base.AdfObject
`constructor, superclass`

### Fields inherited from org.ecmascript.object.Object
`prototype`

## Constructor Summary
`public` | `AdfDhtmlMessagesPeer()` Peer for the messages component.

## Method Summary
`public Object` | `componentRemoved(Object component)` Clean up the peer because it's component is being removed.
`protected String` | `GetComponentGlobalOnly(AdfUIComponent component, HTMLElement root)` Optimized getter for the attribute named globalOnly.
`protected String` | `GetComponentMessage(AdfUIComponent component, HTMLElement root)` Optimized getter for the attribute named message.
`protected String` | `GetComponentShortDesc(AdfUIComponent component, HTMLElement root)` Optimized getter for the attribute named shortDesc.
`protected String` | `GetComponentText(AdfUIComponent component, HTMLElement root)` Optimized getter for the attribute named text.
`protected static Object` | `InitSubclass()` Class initializer.
`public Boolean` | `isMessagesDialogShowable()` The AdfDhtmlMessagesPeer is only used when the messages component is inline, when using a dialog the document peer is used.
`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)`
`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.

### Methods inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer
`addComponentEventHandlers, addComponentPropertyChanges, addComponentPropertyGetters, addDomEventHandlers, addEventHandlerToDomInstance, addSuppressedPPRAttributes, applyDragReadyState, ApplyDragReadyState, applyDragSourceState, ApplyDragSourceState, bind, BindToComponent, cancelAllPopups, cancelPopup, ChildVisibilityChanged, clearDragReadyState, ClearDragReadyState, clearDragSourceState, ClearDragSourceState, ComponentInlineStyleChanged, ComponentPropertyChanged, ComponentRemoved, ComponentStyleClassChanged, ComponentVisibleChanged, ConvertClientIdToLocator, convertLocatorToClientId, createComponentEvent, CreateComponentEvent, CreateDraggableNode, createInnerPeerClassWithSubId, createPeerClass, createSubId, DefaultInitClass, descendantMessageChanged, DescendantMessageChanged, DispatchComponentEvent, DispatchUncanceledComponentEvent, domReplaceNotify, DomReplaceNotify, focus, Focus, getAbsoluteId, getAbsoluteLocator, getAccessibleName, GetAccessibleName, getAllPopups, GetBestMatchSubId, getComponent, GetComponent, GetComponentId, getComponentParent, getComponentProperty, GetComponentVisible, getDescendantComponents, getDomContentElement, getDomContentElementForComponent, GetDomContentElementForNode, getDomDocument, getDomElement, getDomElementForComponent, getDomNode, GetDomNodeForCommentComponent, getDomNodeForComponent, getDomRootNodes, GetDomRootNodes, getDragOverFeedback, GetDragOverFeedback, getDragTransferable, GetDragTransferable, GetElementToReplaceWithSVG, getFallbackDomElement, GetFallbackDomElement, getFirstAncestorComponent, getInlineEditor, GetInlineEditor, getInlineStyleProperty, getLocatorByDomElement, getPagePosition, getPopupWindow, getReadyState, GetReadyState, GetRichResourceURL, getSubIdDomElement, GetSubIdDomElement, hideAllPopups, hidePopup, InitClass, InitDomElement, initialize, isAbsoluteLocatorCacheable, isActive, isBusy, isComponentContainedByElement, isInActiveHeirarchy, isInlineSVGIcon, isPopupVisible, messageNotify, messageShow, needsChildVisibilityChanges, needsFocusTargetStyleClass, PopupClosed, processPushData, ProcessPushData, registerADSAccessibility, RegisterADSAccessibility, registerKeyStroke, replaceDomElement, ReplaceDomElement, resizeNotify, ResizeNotify, scrollIntoView, ScrollIntoView, setBusy, SetBusy, setInlineStyleProperty, showContextMenu, showPopup, simulateMouse, SimulateMouseOnDescendant, TruncateClientId, TruncateClientIdOnceImpl, UnbindFromComponent, unregisterKeyStroke, UpdateMessageType, visitChildren`

### Methods inherited from oracle.adf.view.js.base.AdfUIPeer
`getDefaultDragRecognizer, getParentPeer, Init, initiateDrag, isVisible, needsResizeNotify`

### Methods inherited from oracle.adf.view.js.base.AdfObject
`adopt, clone, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, exportPrototypeSymbol, getClass, GetLazyArrayProperty, GetLazyMapProperty, getTypeName, toDebugString, toString`

## Field Detail

## Constructor Detail

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

## Method Detail

### 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

### 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`

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

Overview | Package | Class | Tree | Deprecated | Index | Help
| Oracle® Fusion Middleware Javascript API Reference for Oracle ADF Faces 12c (12.2.1.4.0) E81451-01
PREV NEXT | FRAMES NO FRAMES Warning: private items are visible |

Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.