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.adf.view.js.laf.rich
Class AdfRichUIPeer

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.base.AdfUIPeer
               |
               +--oracle.adf.view.js.laf.rich.AdfRichUIPeer

Direct Known Subclasses:: AdfDhtmlBreadCrumbsPeer, AdfDhtmlButtonPeer, AdfDhtmlCalendarPeer, AdfDhtmlCarouselItemPeer, AdfDhtmlCarouselPeer, AdfDhtmlChooseColorBasePeer, AdfDhtmlChooseNumberSpinwheelPeer, AdfDhtmlClientDomTrackerPeer, AdfDhtmlColumnPeer, AdfDhtmlCommandButtonPeer, AdfDhtmlCommandLinkPeer, AdfDhtmlCommandMenuItemPeer, AdfDhtmlCommandNavigationItemPeer, AdfDhtmlCommandToolbarButtonPeer, AdfDhtmlContextInfoPeer, AdfDhtmlConveyorBeltPeer, AdfDhtmlDeckPeer, AdfDhtmlDeclarativeComponentPeer, AdfDhtmlDecorativeBoxPeer, AdfDhtmlDialogServicePopupContainerPeer, AdfDhtmlDocumentPeer, AdfDhtmlFormPeer, AdfDhtmlGoButtonPeer, AdfDhtmlGoImageLinkPeer, AdfDhtmlGoLinkPeer, AdfDhtmlGoMenuItemPeer, AdfDhtmlIconPeer, AdfDhtmlImagePeer, AdfDhtmlImplicitPeer, AdfDhtmlInlineFramePeer, AdfDhtmlLinkPeer, AdfDhtmlListItemPeer, AdfDhtmlListViewPeer, AdfDhtmlMasonryLayoutPeer, AdfDhtmlMediaPeer, AdfDhtmlMenuBarPeer, AdfDhtmlMenuPeer, AdfDhtmlMessagePeer, AdfDhtmlMessagesPeer, AdfDhtmlNavigationPanePeer, AdfDhtmlNoteWindowPeer, AdfDhtmlPagePeer, AdfDhtmlPanelAccordionPeer, AdfDhtmlPanelBorderLayoutPeer, AdfDhtmlPanelBoxPeer, AdfDhtmlPanelCollectionPeer, AdfDhtmlPanelDashboardPeer, AdfDhtmlPanelFormLayoutPeer, AdfDhtmlPanelGridLayoutPeer, AdfDhtmlPanelGroupLayoutPeer, AdfDhtmlPanelHeaderPeer, AdfDhtmlPanelLabelAndMessagePeer, AdfDhtmlPanelListPeer, AdfDhtmlPanelSplitterBasePeer, AdfDhtmlPanelSpringboardPeer, AdfDhtmlPanelStretchLayoutPeer, AdfDhtmlPanelTabbedPeer, AdfDhtmlPanelWindowBasePeer, AdfDhtmlPollPeer, AdfDhtmlPopupPeer, AdfDhtmlProgressIndicatorPeer, AdfDhtmlQuickQueryPeer, AdfDhtmlResetButtonPeer, AdfDhtmlSearchSectionPeer, AdfDhtmlSeparatorPeer, AdfDhtmlSpacerPeer, AdfDhtmlStatusIndicatorPeer, AdfDhtmlStreamingPeer, AdfDhtmlSuggestionsSectionPeer, AdfDhtmlTableBasePeer, AdfDhtmlTogglePeer, AdfDhtmlToolbarPeer, AdfDhtmlToolboxPeer, AdfDhtmlTrainButtonBarPeer, AdfDhtmlTrainPeer, AdfDhtmlTrainV2Peer, AdfDhtmlValuePeer

public class AdfRichUIPeer
extends AdfUIPeer

Base peer class for Peer using DHTML

Field Summary
`public static Object`	`addComponentPropertyChanges`
`public static Object`	`addComponentPropertyGetters`
`public static Object`	`BUSY_STYLECLASS`
`private static Object`	`_CREATE_SUB_ID_ARRAY`
`protected static Object`	`CreateSubId` Deprecated: Use the public AdfRichUIPeer.createSubId() instead.
`public static Object`	`DISABLED_STYLECLASS`
`public static Object`	`DRAG_READY_STYLECLASS`
`public static Object`	`DRAG_SOURCE_STYLECLASS`
`public static Object`	`DROP_TARGET_STYLECLASS`
`private static Object`	`_FILTER_PREFIX`
`public static Object`	`FOCUS_TARGET_STYLECLASS`
`private static Object`	`_GET_COMPONENT_FORMAT`
`private static Object`	`_HANDLE_COMPONENT_EVENT_FORMAT`
`private static Object`	`_HANDLE_DOM_EVENT_FORMAT`
`public static Object`	`HOVER_TARGET_STYLECLASS`
`private static Object`	`_NOSCRIPT_END_REGEX`
`private static Object`	`_POPUP_ID_DEFAULT`
`private static Object`	`_POPUP_LIST`
`private static Object`	`_PROPERTY_CHANGED_FORMAT`
`public static Object`	`READONLY_STYLECLASS`
`public static Object`	`SELECTED_STYLECLASS`
`private static Object`	`_SVG_EXPANDO`
`private static Object`	`_TWINKLE_ON_STYLECLASS`
`private static Object`	`_TWINKLE_TIMER_ID_ATTR`
`static Object`	`__TYPE_ATTR`

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

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Constructor Summary
`public`	`AdfRichUIPeer()` Base peer class for Peer using DHTML

Method Summary
`public static Object`	`addComponentEventHandlers(Class theClass, ...String componentEventTypes)` Called with list of peer component event handlers to call back based on component event type.
`private static Object`	`_addComponentEventHandlers(Class theClass, String[]\|undefined componentEventTypes)` Called with list of peer component event handlers to call back based on component event type.
`public static Object`	`addComponentPropertyChanges(Class theClass, ...String propertyNames)` Called with list of component properties that the peer wants to listen to changes for.
`private static Object`	`_addComponentPropertyChanges(Class theClass, String...:undefined propertyNames)` Called with list of component properties that the peer wants to listen to changes for.
`public static Object`	`addComponentPropertyGetters(Class theClass, ...String propertyNames)` Called with list of property names to callback to retrieve component properties from DOM
`private static Object`	`_addComponentPropertyGetters(Class theClass, String[] propertyNames)` Called with list of property names to callback to retrieve component properties from DOM
`public static Object`	`addDomEventHandlers(Class theClass, ...String domEventTypes)` Called with list of DOM event handlers to call back based on DOM event type.
`private static Object`	`_addDomEventHandlers(Class theClass, String[] domEventTypes)` Called with list of DOM event handlers to call back based on DOM event type.
`public static Object`	`addEventHandlerToDomInstance(Function theClass, Object domElement, Object domEventType)` Attach an event handler to the specified instance that will call back through the peer.
`public static Object`	`addSuppressedPPRAttributes(Function theClass, String...:undefined propertyNames)` Called with list of property names that won't result in a PPR request when this property changes on a component and the peer doesn't explicitly handle the change.
`private static Object`	`_addSuppressedPPRAttributes(Function theClass, String[]:undefined propertyNames)` Called with list of property names that won't result in a PPR request when this property changes on a component and the peer doesn't explicitly handle the change.
`public Object`	`applyDragReadyState(Object component, Object inputEvent)` Called by the framework when the drag is ready to be initiated.
`protected Object`	`ApplyDragReadyState(AdfUIInputEvent inputEvent)` Called by the framework when the drag is ready to be initiated after the component has been bound to this peer.
`public Object`	`applyDragSourceState(Object component, Object inputEvent)` Called by the framework when a drag has been initiated on the component for this peer.
`protected Object`	`ApplyDragSourceState(AdfDomUIInputEvent inputEvent)` Called by the framework when a drag has been initiated on the component for this peer.
`public Object`	`bind(AdfUIComponent component)` Binds the peer to the specified component, if necessary.
`protected Object`	`BindToComponent(Object component, Object domNode)` Update any state necessary to bind to the current DOM component
`public Object`	`cancelAllPopups(AdfUIComponent component, Object replaceDom)` Cancel dismissal of all popups.
`public Object`	`cancelPopup(AdfUIComponent component, String popupId)` Cancel dismissal of a popup.
`protected Object`	`ChildVisibilityChanged(Object childComponent, Object childDomElement, Object childVisible)` Called when the visibility of a child component changes if the peer has overridden needsChildVisibilityChanges to return true.
`public Object`	`clearDragReadyState(Object component, Object dragReadyObj)` Called by the framework to clear the drag ready state.
`protected Object`	`ClearDragReadyState(Object dragReadyObj)` Called by the framework to clear the drag ready state after the component has been bound to this peer.
`public Object`	`clearDragSourceState(Object component, Object dragSourceObj)` Called by the framework to clear the drag source state
`protected Object`	`ClearDragSourceState(Object dragSourceObj)` Called by the framework to clear the drag source state.
`protected Object`	`ComponentInlineStyleChanged(Object component, Object domElement, Object newValue, Object oldValue)` Deprecated.
`protected Object`	`ComponentPropertyChanged(Object propertyChangeEvent)` Called by the Component whenever a property changes
`public Object`	`componentRemoved(AdfUIComponent component)` Called by the framework to allow a peer to clean up its references to a component that it was previously initialized with because the component is being removed.
`protected Object`	`ComponentRemoved(AdfUIComponent component)` Hook called when peers are disassociated from their components.
`protected Object`	`ComponentStyleClassChanged(Object component, Object domElement, Object newValue, Object oldValue)`
`protected Object`	`ComponentVisibleChanged(Object component, Object domElement, Object newValue, Object oldValue)`
`protected Object`	`ConvertClientIdToLocator(Object component, Object childComponent, Object descComponentClientId, Object replaceArray)` Hook to record which indices in the clientId fragment should be skipped or skipped and replaced when converting a clientId to an absolute locator.
`public String`	`convertLocatorToClientId(Object component, Object stampKey)` Function to replace client id fragments when converting an absolute locator to clientId.
`public Object`	`createComponentEvent(Object component, Object domEvent, Object prevComponent)` Converts a Component AdfBaseEvent from a DOM event
`protected Object`	`CreateComponentEvent(Object domEvent, Object prevComponent)` Converts a Component AdfBaseEvent from a DOM event
`protected static Node`	`CreateDraggableNode(Node domNode)` Given a DOM Node in the document, returns a cloned draggable version of that DOM Node.
`public static Object`	`createInnerPeerClassWithSubId(Function theSuperclass, String peerName, String subId)` Creates an inner class for an existing peerclass.
`public static Object`	`createPeerClass(Function theSuperclass, String peerName, Boolean stateless, Object peerInitialization)` Required peer creation method for AdfRichUIPeers.
`public static String`	`createSubId(String clientId, String name)` Convenience function for creating a sub ID for finding marked children of a peer
`protected static Object`	`DefaultInitClass(Object peerInitialization)` Perform default subclass initialization
`private static Boolean`	`_defaultInstanceEventHandler(Object theEvent)` Default implementation that calls back the peer instance correctly with a DOM Event attached directly to a DOM Node.
`public Object`	`descendantMessageChanged(AdfUIComponent component)` Message notification callback.
`protected Object`	`DescendantMessageChanged()` this method can be overridden to call AdfPage.PAGE.getClientIdsWithMessages(rootId) to find out the client ids with messages for this subtree.
`protected Object`	`DispatchComponentEvent(Object componentEvent)` Dispatch a component event to the peer
`private Object`	`_dispatchDomEvent(Object agent, Object component, Object domEvent)` Dispatch a DOM event to this peer, binding the peer if the peer will handle the event
`protected Object`	`DispatchUncanceledComponentEvent(Object componentEvent)` Called when an event has bubbled all the way to the top without being canceled, but before the AdfComponent's HandleEvent is called The peer can return true to postpone calling HandleEvent rather than simply canceling the event.
`public Node`	`domReplaceNotify(AdfUIComponent component, Object domNode)` Notifies the peer that some DOM corresponding to a child (or descendent) has been replaced.
`protected Node`	`DomReplaceNotify(Object domNode)` Dom replace notify hook.
`private Object`	`_fetchSVGIcon(AdfUIComponent component)` Fetches the SVG icon using XHR from URL specified in component's icon property, if the component's iconDelivery property value is fetchAndInline.
`private static Node`	`_findCommentNodeWithContent(Node ancestorNode, String commentString)` Searches for a comment node whose comment matches the given String.
`private Object`	`_fixClientId(Object component, Object childComponent, Object descComponentClientId, Object replaceArray)` Recursive call to track indices of client id fragments that will be either skipped or replaced with a implementation-agnostic fragment, when converting a clientId to an absolute locator.
`public Object`	`focus(AdfUIComponent component)` Sets focus on the component.
`protected Object`	`Focus()` Overridable hook that sets the focus to the peer.
`public String`	`getAbsoluteId(Object component, Object clientId)` Implemented by the peer to eturns the absolute scoped id for this component without the leading ":".
`public String`	`getAbsoluteLocator(Object component, String clientId)` Implemented by peer to return the absolute locator, an implementation agnostic String identifier for a given clientId, that is a 'rendered instance-specific' version of the absolute scoped id and that does not contain the leading ':' character.
`public Object`	`getAccessibleName(Object component)` Subclasses should override GetAccessibleName().
`protected Object`	`GetAccessibleName()` Get AccessibleName hook.
`public Object`	`getAllPopups(AdfUIComponent component)` Returns all the currently open popups that belong to a component.
`protected Object`	`GetBestMatchSubId(Object domElement)` Returns the best match subId for the given domElement.
`private static Object`	`_getCommentNodeForComponent(Object firstSibling, Object commentString)`
`public Object`	`getComponent()` Returns the AdfUIComponent that this is the peer for.
`protected static Object`	`GetComponent(Object element)` Returns the component associated with this DOM Node
`private Object`	`_getComponentForVisitingElement(Object element, Object ignoreHidden)`
`protected Object`	`GetComponentId(Object component, Object domElement)` Implement AdfUiComponent.getId()
`public AdfUIComponent`	`getComponentParent(AdfUIComponent component)` Override to use the DOM hierarchy to determine our parent component.
`public Object`	`getComponentProperty(AdfUIComponent component, String propertyName)` Returns the value of the property for the component, or undefined if the peer does not know how to derive the property from the DOM.
`protected Object`	`GetComponentVisible(Object component, Object domElement)` Retrieves the "visible" property from the DOM
`public Array<AdfUIComponent>`	`getDescendantComponents(AdfUIComponent component, Array<AdfUIComponent> children)` Get components descended from this peer's component.
`public Object`	`getDomContentElement()` Returns the DOM Element representing the peer's content.
`public static Object`	`getDomContentElement()` Deprecated: use the instance method instead
`public static HTMLElement`	`getDomContentElementForComponent(Object component)` Returns the visible DOM Element that visibly represetns this component.
`protected static HTMLElement`	`GetDomContentElementForNode(Object domNode)` Returns the visible DOM Element that visibly represents this root Node.
`public Object`	`getDomDocument()` Returns the DOM document that this peer is in
`public Object`	`getDomElement()` Returns the DOM element for this peer, or null if this peer uses a comment to mark its location in the tree.
`public static Object`	`getDomElementForComponent(Object component)` Returns the DOM element for a component
`public Object`	`getDomNode()` Returns the DOM Node for this peer.
`protected static Object`	`GetDomNodeForCommentComponent(Object component)` Returns the Comment Node for a comment-based peer
`public static Object`	`getDomNodeForComponent(Object component)` Returns the DOM Node for a component
`public Object`	`getDomRootNodes(Object component, Node domNode)` Returns an array of all the DOM nodes of a component that are at the root of the component.
`protected Object`	`GetDomRootNodes(Node domNode)` Returns an array of all the DOM nodes of a component that are at the root of the component.
`public Node`	`getDragOverFeedback(AdfUIComponent component, AdfUIInputEvent inputEvent)` Returns the appropriate default drag over feedback for this peer.
`protected Node`	`GetDragOverFeedback(AdfUIInputEvent inputEvent)` Hook for peers to change the returned DOM Node used as the default drag over feedback when this Peer is a drag source.
`public AdfTransferable`	`getDragTransferable(AdfUIComponent component, AdfUIInputEvent inputEvent)` Returns the appropriate default transferable for this drag location, or null if this peer has no default Transferable.
`protected AdfTransferable`	`GetDragTransferable(AdfUIInputEvent inputEvent)` Subclass hook Returning the appropriate default transferable for this drag location, or null if this peer has no default Transferable.
`protected Object`	`GetElementToReplaceWithSVG(Object component)` Returns the span wrapper element of the component which will be replaced by the feteched SVG.
`public HTMLElement`	`getFallbackDomElement(Object component, String descendantLocator, String subId)` If this peer supports returning fallback DOM elements for descendants, potentially returns a DOM element for a given descendant absolute locator and optional subId.
`protected HTMLElement`	`GetFallbackDomElement(String descendantLocator, String subId)` Overriden by subclasses that want to support locators onto descendants that no longer work directly.
`public static AdfUIComponent`	`getFirstAncestorComponent(Object node)` Returns the first component that is associated with this node or one of this node's ancestors.
`private static Object`	`_getIconUrl(Object component)`
`public AdfRichInlineEditor`	`getInlineEditor(AdfUIComponent component, Object event)` Given the component this peer is bound to and the optional DOM event to start editing, return the AdfRichInlineEditor for this component at the event location, if any.
`protected AdfRichInlineEditor`	`GetInlineEditor(Object event)` Default bound, subclassable, implementation for getInlineEditor.
`public String`	`getInlineStyleProperty(AdfUIComponent component, String propName)` returns the style values corresponding to the CSS propertyName.
`public static String`	`getLocatorByDomElement(Object domElement, Object component)` Returns a String locator given a domElement and is usually a concatenation of 'absoluteLocator' and 'subId'.
`public Object`	`getPagePosition(Object component)` Returns the coordinates of the component's upper left corner in Page coordinates.
`public Object`	`getPopupWindow(AdfUIComponent component, String popupId)` Returns the AdfDhtmlPopupWindow object associated with a popup displayed by a component
`private static AdfUIComponent`	`_getPreviousNoScriptComponent(Node previousNode)` Checks if a previous sibling to the given node is a start for a NOSCRIPT element.
`public Object`	`getReadyState(Object component)` Returns whether the content of the peer is available are:
`protected Object`	`GetReadyState()` Returns whether the content of the bound peer is available.
`protected Object`	`GetRichResourceURL(Object path)`
`public HTMLElement`	`getSubIdDomElement(Object component, Object subId)` This function returns the dom element of the child element for the provided component; associated with the sub id.
`protected HTMLElement`	`GetSubIdDomElement(Object subId)` Returns a dom element for a given subid.
`public Object`	`hideAllPopups(AdfUIComponent component)` Deprecated: use #cancelAllPopups when hiding popups for unexpected reasons
`public Object`	`hidePopup(AdfUIComponent component, String popupId)` Hides the popup owned by a component(if any).
`protected static Object`	`InitClass(Object initializationState)` Class initialization for AdfRichUIPeer.
`protected Object`	`InitDomElement(AdfUIComponent component, Object domElement)` Initialize the associated domElement when the peer is created.
`public Object`	`initialize(AdfUIComponent component)` Initializes a peer instance about to be returned by AdfDhtmlLookAndFeel.getPeer() Non-framework code should never need to call this method
`private static Object`	`_initializeCallbacks(Object theClass, Object callbackMapPropertyName, Object callbackFormat, Object transformationMap, Object callbackBases)` Utility function for initializing class callbacks
`private static Object`	`_innerInit(Object clazz, Object component, Object outerThis)` Implementation of Init for inner classes that initializes the .outerThis.
`private static Object`	`_innerSubIdInitialize(Object component)` Implementation of initialize() for inner classes whose root DOM node can be identified by a subNode on the outer component's root DOM element
`public Object`	`isAbsoluteLocatorCacheable()` Checks if absolutelocator can be cached for this component.
`public Object`	`isActive()` Indicates whether the peer is currently active.
`public Boolean`	`isBusy()` This method need to be overridden by the peers to return the busy state of the component.
`public static Object`	`isComponentContainedByElement(AdfUIComponent component, HTMLElement element)` Returns true if the component is bound to this element or contained within this element
`public Object`	`isInActiveHeirarchy()` Indicates whether this peer or any of its descendents is active.
`public static Object`	`isInlineSVGIcon(AdfUIComponent component)`
`public Object`	`isPopupVisible(AdfUIComponent component, String popupId)` Checks if a popup is visible for the component.
`private static Object`	`_keystrokeCallback(Object keystroke)` Keystroke callback used as the implementation of the keystroke registration convenience.
`public Object`	`messageNotify(Object component, Object maxType, Object messages)` Message notification callback.
`protected Object`	`MessageNotify(Object maxType, Object messages)` This is the default implementation of the MessageNotification.
`public Object`	`messageShow(Object component, Object maxType, Object messages)` Message show callback.
`protected Object`	`MessageShow(Object maxType, Object messages)` This is the default implementation of MessageShow.
`public Boolean`	`needsChildVisibilityChanges(AdfUIComponent component)` Test whether the peer wants to be notified if the visibility of one of its children changes.
`public Object`	`needsFocusTargetStyleClass()` Test if the peer needs the :focus-target stype class injected for click-to-edit.
`protected Object`	`PopupClosed(AdfUIComponent component, HTMLElement contentDom, String popupId)` Hook for notifying a peer that a popup of its was just closed.
`private Object`	`_popupClosedHandler(Object param)`
`public Boolean`	`processPushData(AdfUIComponent component, Object payload, Number changeCount)` Called by the Active Data Service to deliver push data to the peer.
`protected Boolean`	`ProcessPushData(Object payload, Number changeCount)` Hook called by the Active Data Service to deliver push data to the peer.
`public Object`	`registerADSAccessibility(Object component)` Method called by Active Data Service when a component is registered for ADS This methods checks if the component already has an aria-live attribute.
`protected Object`	`RegisterADSAccessibility()`
`public static Object`	`registerKeyStroke(AdfUIComponent component, AdfKeyStroke keystroke, Function keyPressedCallback)` Registers a global keyboard shortcut/accelerator for a component.
`private static Object`	`_removeTwinkleCallback(Object domId)` Called back to remove twinkling adding by ProcessPushData
`public Object`	`replaceDomElement(AdfUIComponent component, HTMLElement newElement, HTMLElement oldElement)` Replaces the a dom element contained in this peer.
`protected Object`	`ReplaceDomElement(HTMLElement newElement, HTMLElement oldElement)` Hook for peers to perform an optimized replacement of the dom.
`public Object`	`resizeNotify(Object component, Object oldWidth, Object oldHeight, Object newWidth, Object newHeight)` Resize notification callback.
`protected Object`	`ResizeNotify(Object oldWidth, Object oldHeight, Object newWidth, Object newHeight)` Resize notification hook.
`public Object`	`scrollIntoView(Object component, Object focus, String subTargetId)` Scrolls this peer into view.
`protected Object`	`ScrollIntoView(Object component, Object focus, String subTargetId)` Default implementation of scrollIntoView.
`public Object`	`setBusy(Object component, Object isBusy)`
`protected Object`	`SetBusy(Object isBusy)`
`public Object`	`setInlineStyleProperty(AdfUIComponent component, String propName, String propValue)` Sets the propValue for the cssproperty named propName.
`public Object`	`showContextMenu(Event domEvent, String menuId, AdfUIComponent parentComponent, HTMLElement alignElement, String alignHint, String launchSourceId)` Show this peer's context menu (the popup will be placed close to the mouse's position and inside the bounds of the window)
`public Object`	`showPopup(AdfUIComponent component, HTMLElement contentDom, Object hints, String popupId)` Displays a popup for the component.
`public Object`	`simulateMouse(AdfUIComponent component, String subId, Object mouseEvent)` Simulate mouse type event on a component/subId.
`protected Object`	`SimulateMouseOnDescendant(AdfUIComponent targetComponent, HTMLElement domElement, Object mouseEvent)` Simulate mouse type event on a descendant component/subId.
`private static Object`	`_sliceArgumentsArray(Array theArguments, Number startIndex)` Create a new Array object containing the arguments array starting at the specified index
`protected Object`	`TruncateClientId(Object component, Object descendantComponent, Object childClientId, Object skipArray)` Hook to record which indices in the clientId fragment should be skipped when converting a clientId to an absolute scoped id.
`private Object`	`_truncateClientId(Object component, Object descendantComponent, Object childClientId, Object skipArray)` Recursive call to record which indices in the clientId fragment should be skipped when converting a clientId to an absolute scoped id.
`protected static Object`	`TruncateClientIdOnceImpl(Object component, Object descendantComponent, Object childClientId, Object skipArray)`
`protected Object`	`UnbindFromComponent()` Clean up any lazily instantiated state for the peer associated with the currently bound component and DOM element
`public static Object`	`unregisterKeyStroke(AdfUIComponent component, AdfKeyStroke keystroke)` Unregisters a global keyboard shortcut/accelerator for a component that was registered using AdfRichUIPeer.RegisterKeyStroke.
`protected Object`	`UpdateMessageType(Object element, Object maxType)` To sets the style based on the maxType.
`private Object`	`_visitChild(Object childComponent, Object callback, Object context, Object ignoreHidden)`
`public Number`	`visitChildren(AdfUIComponent component, Function callback, Object context, Boolean ignoreHidden)` Visits all of the children components of the component.
`private Object`	`_visitChildren(Object component, Object domElement, Object callback, Object context, Object ignoreHidden)` Helper for visitChildren that walks DOM nodes.

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

addComponentPropertyChanges

public static Object addComponentPropertyChanges

addComponentPropertyGetters

public static Object addComponentPropertyGetters

BUSY_STYLECLASS

public static Object BUSY_STYLECLASS

_CREATE_SUB_ID_ARRAY

private static Object _CREATE_SUB_ID_ARRAY

CreateSubId

protected static Object CreateSubId

Convenience function for creating a sub ID for finding marked children of a peer

Deprecated: Use the public AdfRichUIPeer.createSubId() instead.

DISABLED_STYLECLASS

public static Object DISABLED_STYLECLASS

DRAG_READY_STYLECLASS

public static Object DRAG_READY_STYLECLASS

DRAG_SOURCE_STYLECLASS

public static Object DRAG_SOURCE_STYLECLASS

DROP_TARGET_STYLECLASS

public static Object DROP_TARGET_STYLECLASS

_FILTER_PREFIX

private static Object _FILTER_PREFIX

FOCUS_TARGET_STYLECLASS

public static Object FOCUS_TARGET_STYLECLASS

_GET_COMPONENT_FORMAT

private static Object _GET_COMPONENT_FORMAT

_HANDLE_COMPONENT_EVENT_FORMAT

private static Object _HANDLE_COMPONENT_EVENT_FORMAT

_HANDLE_DOM_EVENT_FORMAT

private static Object _HANDLE_DOM_EVENT_FORMAT

HOVER_TARGET_STYLECLASS

public static Object HOVER_TARGET_STYLECLASS

_NOSCRIPT_END_REGEX

private static Object _NOSCRIPT_END_REGEX

_POPUP_ID_DEFAULT

private static Object _POPUP_ID_DEFAULT

_POPUP_LIST

private static Object _POPUP_LIST

_PROPERTY_CHANGED_FORMAT

private static Object _PROPERTY_CHANGED_FORMAT

READONLY_STYLECLASS

public static Object READONLY_STYLECLASS

SELECTED_STYLECLASS

public static Object SELECTED_STYLECLASS

_SVG_EXPANDO

private static Object _SVG_EXPANDO

_TWINKLE_ON_STYLECLASS

private static Object _TWINKLE_ON_STYLECLASS

_TWINKLE_TIMER_ID_ATTR

private static Object _TWINKLE_TIMER_ID_ATTR

__TYPE_ATTR

static Object __TYPE_ATTR

Constructor Detail

AdfRichUIPeer

public AdfRichUIPeer(): Base peer class for Peer using DHTML

Method Detail

addComponentEventHandlers

public static Object addComponentEventHandlers(Class theClass, ...String componentEventTypes)

Called with list of peer component event handlers to call back based on component event type.

Parameters:

`theClass`	-	Constructor of class to add event handlers to
`componentEventTypes`	-	varArgs list of component event types. These constants can be found on the component classes.

Return:

Object

See also:

_addComponentEventHandlers(Class, String[]|undefined)

_addComponentEventHandlers

private static Object _addComponentEventHandlers(Class theClass, String[]|undefined componentEventTypes)

Called with list of peer component event handlers to call back based on component event type.

Parameters:

`theClass`	-	Constructor of class to add event handlers to
`componentEventTypes`	-	Array of component event types. These constants can be found on the component classes.

Return:

Object

See also:

addComponentEventHandlers(Class, ...String)

addComponentPropertyChanges

public static Object addComponentPropertyChanges(Class theClass, ...String propertyNames)

Called with list of component properties that the peer wants to listen to changes for.

Parameters:

`theClass`	-	Constructor of class to add event handlers to
`propertyNames`	-	property names to listen to changes for.

Return:

Object

See also:

_addComponentPropertyChanges(Class, String...)

_addComponentPropertyChanges

private static Object _addComponentPropertyChanges(Class theClass, String...:undefined propertyNames)

Called with list of component properties that the peer wants to listen to changes for.

Parameters:

`theClass`	-	Constructor of class to add event handlers to
`propertyNames`	-	property names to listen to changes for. Default value = undefined

Return:

Object

See also:

addComponentPropertyChanges(Class, ...String)

addComponentPropertyGetters

public static Object addComponentPropertyGetters(Class theClass, ...String propertyNames)

Called with list of property names to callback to retrieve component properties from DOM

Parameters:

`theClass`	-	Class to add property getters to
`propertyNames`	-	varArgs list of propertyNames that peer as optimzied getters for

Return:

Object

See also:

_addComponentPropertyGetters(Class, String[])

_addComponentPropertyGetters

private static Object _addComponentPropertyGetters(Class theClass, String[] propertyNames)

Called with list of property names to callback to retrieve component properties from DOM

Parameters:

`theClass`	-	Class to add property getters to
`propertyNames`	-	Array of propertyNames that peer as optimzied getters for

Return:

Object

See also:

addComponentPropertyGetters(Class, ...String)

addDomEventHandlers

public static Object addDomEventHandlers(Class theClass, ...String domEventTypes)

Called with list of DOM event handlers to call back based on DOM event type. This will only work for events that bubble. For non-bubbling events, the event handlers need to be added in the peer's InitDomElement function, using the addEventHandlerToDomInstance instead of registering the event with this function.

Parameters:

`theClass`	-	Constructor of class to add event handlers to
`domEventTypes`	-	varArgs list of DOM event types. These constants can be found on the DhtmlLookAndFeel.

Return:

Object

See also:

addEventHandlerToDomInstance(Function, Object, Object)

_addDomEventHandlers(Class, String[])

_addDomEventHandlers

private static Object _addDomEventHandlers(Class theClass, String[] domEventTypes)

Parameters:

`theClass`	-	Constructor of class to add event handlers to
`domEventTypes`	-	Array of DOM event types. These constants can be found on the DhtmlLookAndFeel.

Return:

Object

See also:

addEventHandlerToDomInstance(Function, Object, Object)

addEventHandlerToDomInstance

public static Object addEventHandlerToDomInstance(Function theClass, Object domElement, Object domEventType)

Attach an event handler to the specified instance that will call back through the peer.

The main purpose of this method is to add non-bubbling DOM event listeners. If you want to add a DOM event listener for a bubbling event, you should add it using AdfRichUIPeer.addDomEventHandlers.

Note that while calling this function will implicitly result in a call to AdfRichUIPeer.addDomEventHandlers, you should not rely on this behavior if your peer is non-final. Non-final peers must explicitly call AdfRichUIPeer.addDomEventHandlers to ensure that the DOM events are delivered to their subclasses.

Parameters:

`theClass`	-	Class for which event should be registered
`domElement`	-	DOM Element to attach event listener to
`domEventType`

Return:

Object

See also:

addDomEventHandlers(Class, ...String)

addSuppressedPPRAttributes

public static Object addSuppressedPPRAttributes(Function theClass, String...:undefined propertyNames)

Called with list of property names that won't result in a PPR request when this property changes on a component and the peer doesn't explicitly handle the change. A peer will commonly register properties that don't appear in the DOM, in which case PPR updating the component accomplishes nothing.

Parameters:

`theClass`	-	AdfRichUIPeer subclass to specify the suppressed attributes for
`propertyNames`	-	var args list of component property names to suppress PPR for Default value = undefined

Return:

Object

See also:

_addSuppressedPPRAttributes(Function, String[])

_addSuppressedPPRAttributes

private static Object _addSuppressedPPRAttributes(Function theClass, String[]:undefined propertyNames)

Parameters:

`theClass`	-	AdfRichUIPeer subclass to specify the suppressed attributes for
`propertyNames`	-	Array of component property names to suppress PPR for Default value = undefined

Return:

Object

See also:

addSuppressedPPRAttributes(Function, String...)

applyDragReadyState

public Object applyDragReadyState(Object component, Object inputEvent)

Called by the framework when the drag is ready to be initiated. This method should display a change in the UI to indicate to the user that it is now possible to initiate a drag operation on the target of the event. This method is used in instances where a gesture must be executed before an item may be dragged.

Parameters:

`component`
`inputEvent`

Return:

Object

Overrides:

AdfUIPeer.applyDragReadyState(AdfUIComponent, AdfUIInputEvent)

ApplyDragReadyState

protected Object ApplyDragReadyState(AdfUIInputEvent inputEvent)

Called by the framework when the drag is ready to be initiated after the component has been bound to this peer. This method should display a change in the UI to indicate to the user that it is now possible to initiate a drag operation on the target of the event. This method is used in instances where a gesture must be executed before an item may be dragged.

Parameters:

inputEvent - the event that triggered the drag

Return:

Object - An object that will be passed back to the drag source in order to clear the drag ready state

See also:

applyDragReadyState(Object, Object)

Overrides:

AdfUIPeer.applyDragReadyState(AdfUIComponent, AdfUIInputEvent)

applyDragSourceState

public Object applyDragSourceState(Object component, Object inputEvent)

Called by the framework when a drag has been initiated on the component for this peer. This method should display a change in the UI to indicate to the user what node is being dragged.

Parameters:

`component`
`inputEvent`

Return:

Object

Overrides:

AdfUIPeer.applyDragSourceState(AdfUIComponent, AdfDomUIInputEvent)

ApplyDragSourceState

protected Object ApplyDragSourceState(AdfDomUIInputEvent inputEvent)

Called by the framework when a drag has been initiated on the component for this peer. This method should display a change in the UI to indicate to the user what node is being dragged. This method is called after the peer is bound to the component.

Parameters:

inputEvent - the event that triggered the drag

Return:

Object - An object that will be passed back to the clear method

See also:

applyDragSourceState(Object, Object)

Overrides:

AdfUIPeer.applyDragSourceState(AdfUIComponent, AdfDomUIInputEvent)

bind

public Object bind(AdfUIComponent component)

Binds the peer to the specified component, if necessary. Once bound a peer's isntance state points to whatever state it initialized for the component.

Parameters:

component - Component to bind peer to

Return:

Object

BindToComponent

protected Object BindToComponent(Object component, Object domNode)

Update any state necessary to bind to the current DOM component

Parameters:

`component`
`domNode`

Return:

Object

cancelAllPopups

public Object cancelAllPopups(AdfUIComponent component, Object replaceDom)

Cancel dismissal of all popups. The cancel dismissal is meant to be unexpected and will result in raising a popup canceled event.

Parameters:

`component`	-	the owner of one or more inline popups
`replaceDom`

Return:

Object

See also:

hideAllPopups(AdfUIComponent)

cancelPopup

public Object cancelPopup(AdfUIComponent component, String popupId)

Cancel dismissal of a popup. The cancel dismissal is meant to be unexpected and will result in raising a popup canceled event.

Parameters:

`component`	-	owner of a inline popup
`popupId`	-	an identifier for the popup Default value = null

Return:

Object

See also:

hidePopup(AdfUIComponent, String)

ChildVisibilityChanged

protected Object ChildVisibilityChanged(Object childComponent, Object childDomElement, Object childVisible)

Called when the visibility of a child component changes if the peer has overridden needsChildVisibilityChanges to return true. The peer can use the child's component, domElement, and new visibility parameters to determine whether it needs to handle the visibility change rather than letting the default implementation of hiding or showing the child. If the peer will handle the change (often by marking itself as needing to be redrawn, it should perform whatever work is necessary and return true from this method.

Overrides of this method should be aware that when this method is called, the child component's peer may no longer be bound to the child component (for example, if both the child and parent component peers are the same instance).

Overrides of this method should use the childDomElement parameter to determine whether the passed in childComponent is actually a direct descendant of the parent component.

Parameters:

`childComponent`
`childDomElement`
`childVisible`

Return:

Object

See also:

needsChildVisibilityChanges(AdfUIComponent)

clearDragReadyState

public Object clearDragReadyState(Object component, Object dragReadyObj)

Called by the framework to clear the drag ready state.

Parameters:

`component`
`dragReadyObj`

Return:

Object

Overrides:

AdfUIPeer.clearDragReadyState(AdfUIComponent, Object)

ClearDragReadyState

protected Object ClearDragReadyState(Object dragReadyObj)

Called by the framework to clear the drag ready state after the component has been bound to this peer.

Parameters:

dragReadyObj - the object returned from the apply method

Return:

Object

See also:

clearDragReadyState(Object, Object)

Overrides:

AdfUIPeer.clearDragReadyState(AdfUIComponent, Object)

clearDragSourceState

public Object clearDragSourceState(Object component, Object dragSourceObj)

Called by the framework to clear the drag source state

Parameters:

`component`
`dragSourceObj`

Return:

Object

Overrides:

AdfUIPeer.clearDragSourceState(AdfUIComponent, Object)

ClearDragSourceState

protected Object ClearDragSourceState(Object dragSourceObj)

Called by the framework to clear the drag source state. This method is called after the peer is bound to the component.

Parameters:

dragSourceObj - the object returned from the apply method

Return:

Object

See also:

clearDragSourceState(Object, Object)

Overrides:

AdfUIPeer.clearDragSourceState(AdfUIComponent, Object)

ComponentInlineStyleChanged

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

property setter for "inlineStyle" property componentInlineStyle has been deprecated because it may not perform correctly under certain circumstances. Please use setInlineProperty with propertyName as the first parameter and propertyValue as the second parameter, to replace the call to this deprecated method.

Deprecated.

Parameters:

`component`
`domElement`
`newValue`
`oldValue`

Return:

Object

See also:

AdfUIComponent.getInlineStyleProperty(String)

AdfUIComponent.setInlineStyleProperty(String, String)

ComponentPropertyChanged

protected Object ComponentPropertyChanged(Object propertyChangeEvent)

Called by the Component whenever a property changes

Parameters:

propertyChangeEvent

Return:

Object

Overrides:

AdfUIPeer.ComponentPropertyChanged(Object)

componentRemoved

public Object componentRemoved(AdfUIComponent component)

Called by the framework to allow a peer to clean up its references to a component that it was previously initialized with because the component is being removed.

Subclasses wishing to perform work when a peer's component is removed should override ComponentRemoved. When overriding, subclasses should call superclass.componentRemoved(component) as the last step in their override.

Parameters:

component - to disassociate from the peer instance.

Return:

Object

See also:

ComponentRemoved(AdfUIComponent)

Overrides:

AdfUIPeer.componentRemoved(AdfUIComponent)

ComponentRemoved

protected Object ComponentRemoved(AdfUIComponent component)

Hook called when peers are disassociated from their components. When this function is called, the peer is unbound and must call bind on itself if it needs to access its peer state.

Parameters:

component - Component being disassociated from the peer

Return:

Object

See also:

bind(AdfUIComponent)

componentRemoved(AdfUIComponent)

Overrides:

AdfUIPeer.componentRemoved(AdfUIComponent)

ComponentStyleClassChanged

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

Parameters:

`component`
`domElement`
`newValue`
`oldValue`

Return:

Object

ComponentVisibleChanged

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

Parameters:

`component`
`domElement`
`newValue`
`oldValue`

Return:

Object

ConvertClientIdToLocator

protected Object ConvertClientIdToLocator(Object component, Object childComponent, Object descComponentClientId, Object replaceArray)

Hook to record which indices in the clientId fragment should be skipped or skipped and replaced when converting a clientId to an absolute locator.

The peer is not bound when this method is called

Peers that need to replace and skip extra fragments when converting from clientIds to absolute locators such as Tables and Regions should override this method to add the index of the fragment to be replaced and skipped.

Parameters:

`component`	-	The component for this peer
`childComponent`	-	The immediate child component of this component
`descComponentClientId`	-	The clientId of the component that the absolute scoped id is being generated for
`replaceArray`	-	Array of maps of {index:, item:} to either skip or skip and fix the parent id fragment with the item value

Return:

Object

convertLocatorToClientId

public String convertLocatorToClientId(Object component, Object stampKey)

Function to replace client id fragments when converting an absolute locator to clientId.

The peer is not bound when this method is called

Parameters:

`component`	-	The component for this peer
`stampKey`	-	the stamp key which need to be replaced

Return:

String - the client id fragment in the below format clientId + ":" + stamped index of client Id fragment related to stampKey

Overrides:

AdfUIPeer.convertLocatorToClientId(Object, Object)

createComponentEvent

public Object createComponentEvent(Object component, Object domEvent, Object prevComponent)

Converts a Component AdfBaseEvent from a DOM event

Parameters:

`component`
`domEvent`
`prevComponent`

Return:

Object

CreateComponentEvent

protected Object CreateComponentEvent(Object domEvent, Object prevComponent)

Converts a Component AdfBaseEvent from a DOM event

Parameters:

`domEvent`
`prevComponent`

Return:

Object

CreateDraggableNode

protected static Node CreateDraggableNode(Node domNode)

Given a DOM Node in the document, returns a cloned draggable version of that DOM Node.

Parameters:

domNode - DOM Node to use as the basis for the draggable Node

Return:

Node - a Node containing the drag feedback

See also:

GetDragOverFeedback(AdfUIInputEvent)

createInnerPeerClassWithSubId

public static Object createInnerPeerClassWithSubId(Function theSuperclass, String peerName, String subId)

Creates an inner class for an existing peerclass. The DOM used by this innerclass is the subId off of the root DOM element of the outer peer.

Parameters:

`theSuperclass`	-	constructor of superclass
`peerName`	-	name of constructor to create for this peer
`subId`	-	the sub ID

Return:

Object

createPeerClass

public static Object createPeerClass(Function theSuperclass, String peerName, Boolean stateless, Object peerInitialization)

Required peer creation method for AdfRichUIPeers. After this function executes, the window object will contain a function named after the peerName parameter that may be used to create instances of the AdfRichUIPeer.

Parameters:

`theSuperclass`	-	constructor of superclass
`peerName`	-	name of constructor to create for this peer
`stateless`	-	`true` if all component instances can share the same peer instance. The default is to use the statelessness of the superclass. Default value = special
`peerInitialization`	-	Peer initialization state Default value = undefined

Return:

Object

Overrides:

AdfUIPeer.createPeerClass(Function, String, Object)

createSubId

public static String createSubId(String clientId, String name)

Convenience function for creating a sub ID for finding marked children of a peer

Parameters:

`clientId`	-	The clientId of the peer's component
`name`	-	The identifier to use for the subpiece

Return:

String - The generated sub ID

DefaultInitClass

protected static Object DefaultInitClass(Object peerInitialization)

Perform default subclass initialization

Parameters:

peerInitialization

Return:

Object

_defaultInstanceEventHandler

private static Boolean _defaultInstanceEventHandler(Object theEvent)

Default implementation that calls back the peer instance correctly with a DOM Event attached directly to a DOM Node.

Parameters:

theEvent - DOM Event object

Return:

Boolean - null

descendantMessageChanged

public Object descendantMessageChanged(AdfUIComponent component)

Message notification callback. A message was added or removed for a descendant of this component. Subclasses should override DescendantMessageChanged(). This implementation of descendantMessageChanged() simply ensures that the peer is bound before it calls the DescendantMessageChanged() hook.

Parameters:

component - Component this peer should be bound to

Return:

Object

DescendantMessageChanged

protected Object DescendantMessageChanged()

this method can be overridden to call AdfPage.PAGE.getClientIdsWithMessages(rootId) to find out the client ids with messages for this subtree. For each client id returned you can call AdfPage.PAGE.getClientIdsWithMessages(clientId) for the specific messages.

Return:: Object

DispatchComponentEvent

protected Object DispatchComponentEvent(Object componentEvent)

Dispatch a component event to the peer

Parameters:

componentEvent

Return:

Object

Overrides:

AdfUIPeer.DispatchComponentEvent(Object)

_dispatchDomEvent

private Object _dispatchDomEvent(Object agent, Object component, Object domEvent)

Dispatch a DOM event to this peer, binding the peer if the peer will handle the event

Parameters:

`agent`
`component`
`domEvent`

Return:

Object

DispatchUncanceledComponentEvent

protected Object DispatchUncanceledComponentEvent(Object componentEvent)

Called when an event has bubbled all the way to the top without being canceled, but before the AdfComponent's HandleEvent is called The peer can return true to postpone calling HandleEvent rather than simply canceling the event. In this case, it becomes the peer's responsibility to call HandleEvent, if desired, at some future point in time.

Parameters:

componentEvent - componentEvent that is about to be dispatched

Return:

Object - null true if the event should be postponed

Overrides:

AdfUIPeer.DispatchUncanceledComponentEvent(Object)

domReplaceNotify

public Node domReplaceNotify(AdfUIComponent component, Object domNode)

Notifies the peer that some DOM corresponding to a child (or descendent) has been replaced. Subclasses should override the DomReplaceNotify() hook.

Parameters:

`component`	-	Component that is being replaced
`domNode`	-	DOM Node for component that is being replaced

Return:

Node - the DOM node which should be the target of a subsequent resize notify traversal. Typically this is simply the domNode that is being replaced. In some cases the parent peer may detect that it needs to re-run its own resize notification logic, in which case the parent should return its own root dom element. Returning null prevents the resize notify traversal from occurring.

See also:

DomReplaceNotify(Object)

DomReplaceNotify

protected Node DomReplaceNotify(Object domNode)

Dom replace notify hook. Subclasses that need to track replacement of Dom children should do so here. The peer will be bound to its component when this hook is called

Parameters:

domNode - DOM Node for component that is being replaced

Return:

_fetchSVGIcon

private Object _fetchSVGIcon(AdfUIComponent component)

Fetches the SVG icon using XHR from URL specified in component's icon property, if the component's iconDelivery property value is fetchAndInline.

Parameters:

component - to get icon and iconDelivery properties

Return:

Object

_findCommentNodeWithContent

private static Node _findCommentNodeWithContent(Node ancestorNode, String commentString)

Searches for a comment node whose comment matches the given String.

Parameters:

`ancestorNode`	-	the node to start looking at, will continue looking at its descendants
`commentString`	-	the comment node must have this as its node value to be a match

Return:

Node - null or a comment node that matches the given String

_fixClientId

private Object _fixClientId(Object component, Object childComponent, Object descComponentClientId, Object replaceArray)

Recursive call to track indices of client id fragments that will be either skipped or replaced with a implementation-agnostic fragment, when converting a clientId to an absolute locator.

The peer is not bound when this method is called

Parameters:

`component`	-	The component for this peer
`childComponent`	-	The child component of this component
`descComponentClientId`	-	The clientId of the component that the absolute locator is being generated for.
`replaceArray`	-	Array of key-value array in format [, ] to either skip or skip and fix the parent id fragment with the item value

Return:

Object

focus

public Object focus(AdfUIComponent component)

Sets focus on the component. Subclasser should override the implementation of Focus.

Parameters:

component - The component the peer should focus on

Return:

Object

See also:

Focus()

Overrides:

AdfUIPeer.focus(Object)

Focus

protected Object Focus()

Overridable hook that sets the focus to the peer. The peer has already been bound to its component when this hook is called.

Return:: Object
See also:: focus(AdfUIComponent)
Overrides:: AdfUIPeer.focus(Object)

getAbsoluteId

public String getAbsoluteId(Object component, Object clientId)

Implemented by the peer to eturns the absolute scoped id for this component without the leading ":". The result of this call may be passed either directly to AdfPage.findComponentByAbsoluteId or by prepending a ":", to AdfUIComponent.findComponent on any AdfUIComponent instance. to find this component instance as long as the component instance isn't stamped.

Parameters:

`component`
`clientId`

Return:

String - The absolute scoped id for the component

See also:

AdfUIComponent.findComponent(String, Boolean)

AdfPage.findComponentByAbsoluteId(String)

Overrides:

AdfUIPeer.getAbsoluteId(AdfUIComponent, String)

getAbsoluteLocator

public String getAbsoluteLocator(Object component, String clientId)

Implemented by peer to return the absolute locator, an implementation agnostic String identifier for a given clientId, that is a 'rendered instance-specific' version of the absolute scoped id and that does not contain the leading ':' character. The result of this call can be passed directly to findComponentByAbsoluteLocator.

Parameters:

`component`	-	The component for this peer
`clientId`	-	the client Id of the component

Return:

String - The absolute locator for the component

See also:

AdfUIComponent.getAbsoluteLocator()

Overrides:

AdfUIPeer.getAbsoluteLocator(AdfUIComponent, String)

getAccessibleName

public Object getAccessibleName(Object component)

Subclasses should override GetAccessibleName(). This implementation of getAccessibleName() simply ensures that the peer is bound before it calls out to the ResizeNotify() hook.

Parameters:

component

Return:

Object

GetAccessibleName

protected Object GetAccessibleName()

Get AccessibleName hook. Subclasses could provide the accessible name (for the component) as they see fit. The default implementation returns null.

Return:: Object

getAllPopups

public Object getAllPopups(AdfUIComponent component)

Returns all the currently open popups that belong to a component.

Parameters:

component - The component that owns the popup

Return:

Object

See also:

showPopup(AdfUIComponent, HTMLElement, Object, String)

isPopupVisible(AdfUIComponent, String)

hidePopup(AdfUIComponent, String)

getPopupWindow(AdfUIComponent, String)

GetBestMatchSubId

protected Object GetBestMatchSubId(Object domElement)

Returns the best match subId for the given domElement. This is an abstract method and child peers should override this function to provide implementation to return mapped or programmatically mapped subids. WARNING - You must make sure to bind the component to the peer before calling this function.

Parameters:

domElement

Return:

Object

See also:

GetSubIdDomElement(Object)

_getCommentNodeForComponent

private static Object _getCommentNodeForComponent(Object firstSibling, Object commentString)

Parameters:

`firstSibling`
`commentString`

Return:

Object

getComponent

public Object getComponent()

Returns the AdfUIComponent that this is the peer for.

Return:: Object
Overrides:: AdfUIPeer.getComponent()

GetComponent

protected static Object GetComponent(Object element)

Returns the component associated with this DOM Node

Parameters:

element

Return:

Object

Overrides:

AdfUIPeer.getComponent()

_getComponentForVisitingElement

private Object _getComponentForVisitingElement(Object element, Object ignoreHidden)

Parameters:

`element`
`ignoreHidden`

Return:

Object

GetComponentId

protected Object GetComponentId(Object component, Object domElement)

Implement AdfUiComponent.getId()

Parameters:

`component`
`domElement`

Return:

Object

getComponentParent

public AdfUIComponent getComponentParent(AdfUIComponent component)

Override to use the DOM hierarchy to determine our parent component. Since the client component hierarchy is sparse, the component returned by this method may not be the same as the parent component on the server, but it will be one of the server component's ancestors or null.

Parameters:

component - to determine the parent of

Return:

AdfUIComponent - the parent of this component in the client component hierarchy.

Overrides:

AdfUIPeer.getComponentParent(AdfUIComponent)

getComponentProperty

public Object getComponentProperty(AdfUIComponent component, String propertyName)

Returns the value of the property for the component, or undefined if the peer does not know how to derive the property from the DOM.

Peers implement getters by implementing InitSubclass on their peer class and registering their properrty getters in this implementation by calling AdfRichUIPeer.addComponentPropertyGetters.

Parameters:

`component`	-	Component to retrieve the property for
`propertyName`	-	Name of property to retrieve

Return:

Object - value of the property if the peer can derive it

See also:

addComponentPropertyGetters(Class, ...String)

Overrides:

AdfUIPeer.getComponentProperty(AdfUIComponent, String)

GetComponentVisible

protected Object GetComponentVisible(Object component, Object domElement)

Retrieves the "visible" property from the DOM

Parameters:

`component`
`domElement`

Return:

Object

getDescendantComponents

public Array<AdfUIComponent> getDescendantComponents(AdfUIComponent component, Array<AdfUIComponent> children)

Get components descended from this peer's component. This method should only be called if this component returns a value from AdfRichUIPeer.getDomElementForComponent(rootComponent); This base implementation can be overwritten in child peers to handle special cases (popups and overflow).

There is no guarantee about the order of the children returned. If visiting the children in a known order is required please use AdfUIComponent.visitChildren.

All descendent children are returned, visible or not. If ignoring hidden children is required please use AdfUIComponent.visitChildren.

This method is faster than AdfUIComponent.visitChildren, if the limitations above are acceptable it is preferable to use this method.

Returns an array of descendant (child) components for this component.

Parameters:

`component`	-	this component
`children`	-	array to store child components in. Descendent components will be added to the end of the array. This param is optional, if not passed in an array will be created.

Return:

Array<AdfUIComponent> - array of child components, may be empty

Overrides:

AdfUIPeer.getDescendantComponents(AdfUIComponent, Array)

getDomContentElement

public Object getDomContentElement()

Returns the DOM Element representing the peer's content. For element-based peers. this will be the element itself. For comment-based peers, this will be the first child DIV

Return:: Object
See also:: getDomElement(); getDomContentElement()

getDomContentElement

public static Object getDomContentElement()

Deprecated: use the instance method instead
Return:: Object

getDomContentElementForComponent

public static HTMLElement getDomContentElementForComponent(Object component)

Returns the visible DOM Element that visibly represetns this component. For element-based peers, this is the same as the Peer's Dom Element

Parameters:

component

Return:

HTMLElement - the HTML element or null

GetDomContentElementForNode

protected static HTMLElement GetDomContentElementForNode(Object domNode)

Returns the visible DOM Element that visibly represents this root Node. For element-based peers, this is the same as the Peer's Dom Element

Parameters:

domNode

Return:

HTMLElement - a non-null HTML Element (not a comment node)

getDomDocument

public Object getDomDocument()

Returns the DOM document that this peer is in

Return:: Object

getDomElement

public Object getDomElement()

Returns the DOM element for this peer, or null if this peer uses a comment to mark its location in the tree.

Return:: Object
See also:: getDomNode(); getDomContentElement()

getDomElementForComponent

public static Object getDomElementForComponent(Object component)

Returns the DOM element for a component

Parameters:

component

Return:

Object

getDomNode

public Object getDomNode()

Returns the DOM Node for this peer. All components are represented by a DOM node.

Return:: Object
See also:: getDomElement(); getDomContentElement()

GetDomNodeForCommentComponent

protected static Object GetDomNodeForCommentComponent(Object component)

Returns the Comment Node for a comment-based peer

Parameters:

component

Return:

Object

getDomNodeForComponent

public static Object getDomNodeForComponent(Object component)

Returns the DOM Node for a component

Parameters:

component

Return:

Object

getDomRootNodes

public Object getDomRootNodes(Object component, Node domNode)

Returns an array of all the DOM nodes of a component that are at the root of the component. For element based components, this will return an array of the DOM element. For non-element components, the start and stop elements as well as all the root elements of the children will be returned. Used to indicate what nodes should be replaced during a PPR of this component.

Parameters:

`component`
`domNode`	-	the root DOM node of the component. May either be the node in the DOM or an XML node from the server response

Return:

Object - an array of the root nodes rendered for this component

GetDomRootNodes

protected Object GetDomRootNodes(Node domNode)

Parameters:

domNode - the root DOM node of the component. May either be the node in the DOM or an XML node from the server response

Return:

Object - an array of the root nodes rendered for this component

getDragOverFeedback

public Node getDragOverFeedback(AdfUIComponent component, AdfUIInputEvent inputEvent)

Returns the appropriate default drag over feedback for this peer.

Subclasses should override GetDragOverFeedback

Parameters:

`component`	-	the component for this peer
`inputEvent`	-	the inputEvent that triggered the drag

Return:

Node - HTML Node contianing the drag feedback

See also:

GetDragOverFeedback(AdfUIInputEvent)

Overrides:

AdfUIPeer.getDragOverFeedback(AdfUIComponent, AdfUIInputEvent)

GetDragOverFeedback

protected Node GetDragOverFeedback(AdfUIInputEvent inputEvent)

Hook for peers to change the returned DOM Node used as the default drag over feedback when this Peer is a drag source. The default implementation passes the peers root DOM Element to CreateDraggableNode to create the drag feedback.

Parameters:

inputEvent - the inputEvent that triggered the drag

Return:

Node - HTML Node contianing the drag feedback

See also:

getDragOverFeedback(AdfUIComponent, AdfUIInputEvent)

CreateDraggableNode(Node)

Overrides:

AdfUIPeer.getDragOverFeedback(AdfUIComponent, AdfUIInputEvent)

getDragTransferable

public AdfTransferable getDragTransferable(AdfUIComponent component, AdfUIInputEvent inputEvent)

Returns the appropriate default transferable for this drag location, or null if this peer has no default Transferable.

Subclasses should override GetDragTransferable

Parameters:

`component`	-	the component for this peer
`inputEvent`	-	the inputEvent that triggered the drag

Return:

AdfTransferable - Default transferable object, or null if no default transferable

See also:

GetDragTransferable(AdfUIInputEvent)

Overrides:

AdfUIPeer.getDragTransferable(AdfUIComponent, AdfUIInputEvent)

GetDragTransferable

protected AdfTransferable GetDragTransferable(AdfUIInputEvent inputEvent)

Subclass hook Returning the appropriate default transferable for this drag location, or null if this peer has no default Transferable.

The defaul implementation returns null

Parameters:

inputEvent - the inputEvent that triggered the drag

Return:

AdfTransferable - Default transferable object, or null if no default transferable

See also:

getDragTransferable(AdfUIComponent, AdfUIInputEvent)

Overrides:

AdfUIPeer.getDragTransferable(AdfUIComponent, AdfUIInputEvent)

GetElementToReplaceWithSVG

protected Object GetElementToReplaceWithSVG(Object component)

Returns the span wrapper element of the component which will be replaced by the feteched SVG. The default implementation returns the first span element in the component. Peers can override the default behavior to return a different element.

Parameters:

component

Return:

Object

getFallbackDomElement

public HTMLElement getFallbackDomElement(Object component, String descendantLocator, String subId)

If this peer supports returning fallback DOM elements for descendants, potentially returns a DOM element for a given descendant absolute locator and optional subId. This method is typically called by test automation frameworks when no component was found for the descendant locator.

Parameters:

`component`
`descendantLocator`	-	Absolute locator for descendant component originally searched for
`subId`	-	Optional subid for the child element for the descendant originally searched for

Return:

HTMLElement - the DOM within the component related to subId

See also:

AdfPage.findComponentOrAncestorByAbsoluteLocator(String)

GetFallbackDomElement(String, String)

getSubIdDomElement(Object, Object)

GetFallbackDomElement

protected HTMLElement GetFallbackDomElement(String descendantLocator, String subId)

Overriden by subclasses that want to support locators onto descendants that no longer work directly. This is often because a locator to a private child was originally recorded and the public component wants to maintain backwards compatibility. The default implmentation returns null.

Parameters:

`descendantLocator`	-	Absolute locator for descendant component originally searched for
`subId`	-	Optional subid for the child element for the descendant originally searched for

Return:

HTMLElement - the DOM within the component related to subId

See also:

getFallbackDomElement(Object, String, String)

getFirstAncestorComponent

public static AdfUIComponent getFirstAncestorComponent(Object node)

Returns the first component that is associated with this node or one of this node's ancestors.

Parameters:

node - DOM Node to determine ancestor component of

Return:

AdfUIComponent - null

_getIconUrl

private static Object _getIconUrl(Object component)

Parameters:

component

Return:

Object

getInlineEditor

public AdfRichInlineEditor getInlineEditor(AdfUIComponent component, Object event)

Given the component this peer is bound to and the optional DOM event to start editing, return the AdfRichInlineEditor for this component at the event location, if any. Subclasses should override GetInlineEditor.

Parameters:

`component`	-	Component this peer should be bound to
`event`

Return:

AdfRichInlineEditor - Inline editor for the component at the event location, if any

See also:

GetInlineEditor(Object)

GetInlineEditor

protected AdfRichInlineEditor GetInlineEditor(Object event)

Default bound, subclassable, implementation for getInlineEditor. The default implementation returns null for the inline editor.

Parameters:

event

Return:

AdfRichInlineEditor - Inline editor for the component at the event location, if any

See also:

getInlineEditor(AdfUIComponent, Object)

getInlineStyleProperty

public String getInlineStyleProperty(AdfUIComponent component, String propName)

returns the style values corresponding to the CSS propertyName.

The supplied parameter (propName) value should conform to CSS format and should be in lower case.

Parameters:

`component`	-	Component to associate with this peer
`propName`	-	The name of the css property to set

Return:

String - Returns the value corresponding to the CSS property

Overrides:

AdfUIPeer.getInlineStyleProperty(Object, String)

getLocatorByDomElement

public static String getLocatorByDomElement(Object domElement, Object component)

Returns a String locator given a domElement and is usually a concatenation of 'absoluteLocator' and 'subId'. This is typically called by test automation code that needs an identifier for a DOM element.

- if domElement is the root DOM for the component, then the absoluteLocator of the component is returned
- if domElement is a descendent of the root DOM for the component, then the DOM element among the list of supported subIds for the component, that is the best match is determined and the locator comprising of the 'absoluteLocator' and the best match 'subId' is returned.
- if domElement does not have a match among the list of supported subids, then it calles this function again with the parent component. - If a match among the list of supported subids for the parent component is found, the locator comprising of the 'absoluteLocator' and the best match 'subId' for the parent component is returned. - if the subid for the parent component is not found either, the absoluteLocator the component is returned. - if the domElement has no parent component then a null value is returned

Parameters:

`domElement`
`component`

Return:

String - locator , usually the concatenation of 'absoluteLocator' and 'subId'

getPagePosition

public Object getPagePosition(Object component)

Returns the coordinates of the component's upper left corner in Page coordinates.

Parameters:

component

Return:

Object - an object with two properties (x for the left coordinate and y for the top coordinate)

Overrides:

AdfUIPeer.getPagePosition(AdfUIComponent)

getPopupWindow

public Object getPopupWindow(AdfUIComponent component, String popupId)

Returns the AdfDhtmlPopupWindow object associated with a popup displayed by a component

Parameters:

`component`	-	the component that owns the popup
`popupId`	-	an identifier for the popup Default value = null

Return:

Object

See also:

showPopup(AdfUIComponent, HTMLElement, Object, String)

isPopupVisible(AdfUIComponent, String)

hidePopup(AdfUIComponent, String)

_getPreviousNoScriptComponent

private static AdfUIComponent _getPreviousNoScriptComponent(Node previousNode)

Checks if a previous sibling to the given node is a start for a NOSCRIPT element. This will skip over NOSCRIPT elements that have already ended before this node. This is used by getFirstAncestorComponent to check for a component that is a child of a NOSCRIPT component.

Parameters:

previousNode - the node from which to start the check

Return:

AdfUIComponent - the component if found or null

getReadyState

public Object getReadyState(Object component)

Returns whether the content of the peer is available are:

AdfUIComponent.STATE_LOADING The UIComponent is still loading state or content
AdfUIComponent.STATE_COMPLETE The UIComponent is fully loaded

Parameters:

component

Return:

Object

See also:

GetReadyState()

Overrides:

AdfUIPeer.getReadyState(Object)

GetReadyState

protected Object GetReadyState()

Returns whether the content of the bound peer is available. The default implementation returns AdfUIComponent.STATE_COMPLETE. Peers that need to perform additional initialization should override this method and register their component with AdfPage.registerLoadingComponent when the component is created and unregister the component with AdfPage.unregisterLoadingComponent when the component is completely loaded or removed.

Return:: Object
See also:: getReadyState(Object); AdfPage.registerLoadingComponent(AdfUIComponent); AdfPage.unregisterLoadingComponent(AdfUIComponent)
Overrides:: AdfUIPeer.getReadyState(Object)

GetRichResourceURL

protected Object GetRichResourceURL(Object path)

Parameters:

path

Return:

Object

getSubIdDomElement

public HTMLElement getSubIdDomElement(Object component, Object subId)

This function returns the dom element of the child element for the provided component; associated with the sub id.

Parameters:

`component`
`subId`

Return:

HTMLElement - the DOM within the component related to subId

GetSubIdDomElement

protected HTMLElement GetSubIdDomElement(Object subId)

Returns a dom element for a given subid. This is an abstract method and child peers should override this function to provide the support to retrieve dom element corresponding to the subid.

Parameters:

subId

Return:

HTMLElement - the DOM within the component related to subId

hideAllPopups

public Object hideAllPopups(AdfUIComponent component)

Hides all popups owned by a component(if any).

Deprecated: use #cancelAllPopups when hiding popups for unexpected reasons

Parameters:

component - the component that owns the popup

Return:

Object

See also:

showPopup(AdfUIComponent, HTMLElement, Object, String)

isPopupVisible(AdfUIComponent, String)

hidePopup(AdfUIComponent, String)

cancelAllPopups(AdfUIComponent, Object)

hidePopup

public Object hidePopup(AdfUIComponent component, String popupId)

Hides the popup owned by a component(if any).

Parameters:

`component`	-	the component that owns the popup
`popupId`	-	an identifier for the popup Default value = null

Return:

Object

See also:

cancelPopup(AdfUIComponent, String)

InitClass

protected static Object InitClass(Object initializationState)

Class initialization for AdfRichUIPeer. Subclasses should implement a static class.InitSublass(theClass) function to perform their subclass-specific initialization.

Parameters:

initializationState

Return:

Object

Overrides:

AdfUIPeer.InitClass()

InitDomElement

protected Object InitDomElement(AdfUIComponent 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`	-	Component that this peer will be associated with
`domElement`	-	Root DOM element of this peer

Return:

Object

initialize

public Object initialize(AdfUIComponent component)

Initializes a peer instance about to be returned by AdfDhtmlLookAndFeel.getPeer() Non-framework code should never need to call this method

Parameters:

component - to associate with this peer instance

Return:

Object

Overrides:

AdfUIPeer.initialize(AdfUIComponent)

_initializeCallbacks

private static Object _initializeCallbacks(Object theClass, Object callbackMapPropertyName, Object callbackFormat, Object transformationMap, Object callbackBases)

Utility function for initializing class callbacks

Parameters:

`theClass`	-	Constructor to attach callback map to
`callbackMapPropertyName`	-	Name of callback map property on constructor and its superclass
`callbackFormat`	-	Format array to use when determining callback functions to map base names to
`transformationMap`	-	Additional tranformation map to apply base callback names to before concatenation
`callbackBases`	-	Array of new callback types to apply for this subclass

Return:

Object

_innerInit

private static Object _innerInit(Object clazz, Object component, Object outerThis)

Implementation of Init for inner classes that initializes the .outerThis. We need to pass the extra superclass variable so that we call the correct superClass.Init

Parameters:

`clazz`
`component`
`outerThis`

Return:

Object

_innerSubIdInitialize

private static Object _innerSubIdInitialize(Object component)

Implementation of initialize() for inner classes whose root DOM node can be identified by a subNode on the outer component's root DOM element

Parameters:

component

Return:

Object

isAbsoluteLocatorCacheable

public Object isAbsoluteLocatorCacheable()

Checks if absolutelocator can be cached for this component.

Return:: Object - true .

isActive

public Object isActive()

Indicates whether the peer is currently active.

Return:: Object

isBusy

public Boolean isBusy()

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

Return:: Boolean - Returns true if the busy state on the component is set to true.

isComponentContainedByElement

public static Object isComponentContainedByElement(AdfUIComponent component, HTMLElement element)

Returns true if the component is bound to this element or contained within this element

Parameters:

`component`	-	to be checked
`element`	-	which may contain the component

Return:

Object

isInActiveHeirarchy

public Object isInActiveHeirarchy()

Indicates whether this peer or any of its descendents is active.

Return:: Object

isInlineSVGIcon

public static Object isInlineSVGIcon(AdfUIComponent component)

Parameters:

component - whose properties will be checked

Return:

Object - true if iconDelivery is inline or fetchAndInline for svg icon false otherwise

isPopupVisible

public Object isPopupVisible(AdfUIComponent component, String popupId)

Checks if a popup is visible for the component.

Parameters:

`component`	-	the component that owns the popup
`popupId`	-	an identifier for the popup Default value = null

Return:

Object

See also:

showPopup(AdfUIComponent, HTMLElement, Object, String)

hidePopup(AdfUIComponent, String)

_keystrokeCallback

private static Object _keystrokeCallback(Object keystroke)

Keystroke callback used as the implementation of the keystroke registration convenience.

Parameters:

keystroke

Return:

Object

See also:

registerKeyStroke(AdfUIComponent, AdfKeyStroke, Function)

messageNotify

public Object messageNotify(Object component, Object maxType, Object messages)

Message notification callback. Subclasses should override MessageNotify(). This implementation of messageNotify() simply ensures that the peer is bound before calls out to the MessageNotify() hook.

Parameters:

`component`
`maxType`
`messages`

Return:

Object

Overrides:

AdfUIPeer.messageNotify(Object, Number, Array)

MessageNotify

protected Object MessageNotify(Object maxType, Object messages)

This is the default implementation of the MessageNotification. It basically sets the style based on the maxType. If the maxType is null the all extra properties and expando's are removed from the root dom element.

Parameters:

`maxType`
`messages`

Return:

Object

Overrides:

AdfUIPeer.messageNotify(Object, Number, Array)

messageShow

public Object messageShow(Object component, Object maxType, Object messages)

Message show callback. Subclasses should override MessageShow(). This implementation of messageShow() simply ensures that the peer is bound before calls out to the MessageShow() hook.

Parameters:

`component`
`maxType`
`messages`

Return:

Object

Overrides:

AdfUIPeer.messageShow(Object, Number, Array)

MessageShow

protected Object MessageShow(Object maxType, Object messages)

This is the default implementation of MessageShow. It basically does nothing

Parameters:

`maxType`
`messages`

Return:

Object

Overrides:

AdfUIPeer.messageShow(Object, Number, Array)

needsChildVisibilityChanges

public Boolean needsChildVisibilityChanges(AdfUIComponent component)

Test whether the peer wants to be notified if the visibility of one of its children changes. If a peer overrides this method to return true, the peer's ChildVisibilityChanged method will be called.

The peer is not bound when this method is called. Peers with complicated logic to determine whether they need to be informed of child visibility changes should return true from this method and place their logic inside of their ChildVisibilityChanged override.

Parameters:

component

Return:

Boolean - null true if the peer cares about visiblity changes

See also:

ChildVisibilityChanged(Object, Object, Object)

needsFocusTargetStyleClass

public Object needsFocusTargetStyleClass()

Test if the peer needs the :focus-target stype class injected for click-to-edit. Rather then inject this for all UI components, we're only going to inject it for peers that need it due to an IE7/rtl bug when injecting style classes onto dom elements. Default is false (don't inject the style).

Return:: Object

PopupClosed

protected Object PopupClosed(AdfUIComponent component, HTMLElement contentDom, String popupId)

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

Parameters:

`component`	-	the component that owns the popup
`contentDom`	-	the DOM within the component that should be displayed
`popupId`	-	an identifier for the popup Default value = null

Return:

Object

_popupClosedHandler

private Object _popupClosedHandler(Object param)

Parameters:

param

Return:

Object

processPushData

public Boolean processPushData(AdfUIComponent component, Object payload, Number changeCount)

Called by the Active Data Service to deliver push data to the peer. Subclassers should override the implementation of ProcessPushData

Parameters:

`component`	-	Component to associate with this peer
`payload`	-	Peer-specific payload for the component
`changeCount`	-	Monotonically increasing Change count for this change

Return:

Boolean - Returns true if the component should continue to receive active data events.

See also:

ProcessPushData(Object, Number)

Overrides:

AdfUIPeer.processPushData(AdfUIComponent, Object, Boolean)

ProcessPushData

protected Boolean ProcessPushData(Object payload, Number changeCount)

Hook called by the Active Data Service to deliver push data to the peer. The peer has already been bound to its component when this hook is called.

Parameters:

`payload`	-	Peer-specific payload for the component
`changeCount`	-	Monotonically increasing Change count for this change

Return:

Boolean - Returns true if the component should continue to receive active data events.

See also:

processPushData(AdfUIComponent, Object, Number)

Overrides:

AdfUIPeer.processPushData(AdfUIComponent, Object, Boolean)

registerADSAccessibility

public Object registerADSAccessibility(Object component)

Method called by Active Data Service when a component is registered for ADS This methods checks if the component already has an aria-live attribute. If not, adds aria-live=polite to the root of the element.

Parameters:

component

Return:

Object

RegisterADSAccessibility

protected Object RegisterADSAccessibility()

Return:: Object

registerKeyStroke

public static Object registerKeyStroke(AdfUIComponent component, AdfKeyStroke keystroke, Function keyPressedCallback)

Registers a global keyboard shortcut/accelerator for a component. When the keystroke is pressed, the callback function will be called with the bound peer as "this". Peers should register their KeyStrokes in InitDomElement and unregister the KeyStrokes in componentRemoved

Parameters:

`component`	-	Component the keystroke should be registered for
`keystroke`	-	the key combination for the accelerator
`keyPressedCallback`	-	function called in response to the keystroke. The function takes a single argument--the KeyStroke pressed and returns false if the callback did not handle the event. The peer instance is passed as the implicit "this".

Return:

Object

See also:

unregisterKeyStroke(AdfUIComponent, AdfKeyStroke)

InitDomElement(AdfUIComponent, Object)

componentRemoved(AdfUIComponent)

_removeTwinkleCallback

private static Object _removeTwinkleCallback(Object domId)

Called back to remove twinkling adding by ProcessPushData

Parameters:

domId

Return:

Object

replaceDomElement

public Object replaceDomElement(AdfUIComponent component, HTMLElement newElement, HTMLElement oldElement)

Replaces the a dom element contained in this peer. The dom element maybe a child (or descendent)

Parameters:

`component`	-	Component for which to replace the dom node
`newElement`	-	the new dom element
`oldElement`	-	the old dom element

Return:

Object

ReplaceDomElement

protected Object ReplaceDomElement(HTMLElement newElement, HTMLElement oldElement)

Hook for peers to perform an optimized replacement of the dom. The dom element maybe a child (or descendent) The peer will be bound to its component when this hook is called

Parameters:

`newElement`	-	the new dom element
`oldElement`	-	the old dom element

Return:

Object

resizeNotify

public Object resizeNotify(Object component, Object oldWidth, Object oldHeight, Object newWidth, Object newHeight)

Resize notification callback. Subclasses should override ResizeNotify(). This implementation of resizeNotify() simply ensures that the peer is bound before calls out to the ResizeNotify() hook.

Parameters:

`component`
`oldWidth`
`oldHeight`
`newWidth`
`newHeight`

Return:

Object

Overrides:

AdfUIPeer.resizeNotify(Object, Object, Object, Object, Object)

ResizeNotify

protected Object ResizeNotify(Object oldWidth, Object oldHeight, Object newWidth, Object newHeight)

Resize notification hook. Subclasses should place geometry management logic here. Note that widths are clientWidths and heights are clientHeights.

Parameters:

`oldWidth`
`oldHeight`
`newWidth`
`newHeight`

Return:

Object

Overrides:

AdfUIPeer.resizeNotify(Object, Object, Object, Object, Object)

scrollIntoView

public Object scrollIntoView(Object component, Object focus, String subTargetId)

Scrolls this peer into view.

Parameters:

`component`
`focus`
`subTargetId`	-	optional component dependent DOM sub-id that needs to be scrolled/focused into view Default value = null

Return:

Object

ScrollIntoView

protected Object ScrollIntoView(Object component, Object focus, String subTargetId)

Default implementation of scrollIntoView.

Parameters:

`component`
`focus`
`subTargetId`	-	optional component dependent DOM sub-id that needs to be scrolled/focused into view Default value = null

Return:

Object

setBusy

public Object setBusy(Object component, Object isBusy)

Parameters:

`component`
`isBusy`

Return:

Object

SetBusy

protected Object SetBusy(Object isBusy)

Parameters:

isBusy

Return:

Object

setInlineStyleProperty

public Object setInlineStyleProperty(AdfUIComponent component, String propName, String propValue)

Sets the propValue for the cssproperty named propName.

The supplied parameter (propName) value should conform to CSS format and should be in lower case.

The property value set via setInlineStyleProperty will not be synchronized with the server-side property.

Parameters:

`component`	-	Component to associate with this peer
`propName`	-	The name of the css property to set
`propValue`	-	The value for this css property

Return:

Object

Overrides:

AdfUIPeer.setInlineStyleProperty(Object, String, String)

showContextMenu

public Object showContextMenu(Event domEvent, String menuId, AdfUIComponent parentComponent, HTMLElement alignElement, String alignHint, String launchSourceId)

Show this peer's context menu (the popup will be placed close to the mouse's position and inside the bounds of the window)

Parameters:

`domEvent`	-	the domEvent that triggered the context menu
`menuId`	-	the id of the popup containing the menu
`parentComponent`	-	[optional] the parent component for which the context menu is displayed. if the parentComponent is passed in, the context menu is resolved by taking into account if it is a naming container or not.
`alignElement`	-	[optional] the dom element to align the context menu with.
`alignHint`	-	[optional] alignment hint wrt alignElement (see AdfRichPopup). Defaults to AdfRichPopup.ALIGN_AFTER_START The context menu is shown at the mouse pointer by default. However it can be aligned with a dom element if this parameter is specified.
`launchSourceId`	-	[optional] client id of the launching source

Return:

Object

showPopup

public Object showPopup(AdfUIComponent component, HTMLElement contentDom, Object hints, String popupId)

Displays a popup for the component.

Parameters:

`component`	-	the component that owns the popup
`contentDom`	-	the DOM within the component that should be displayed
`hints`	-	a set of popup hints (see AdfDhtmlPopupWindow) Default value = null
`popupId`	-	an identifier for the popup Default value = null

Return:

Object

See also:

isPopupVisible(AdfUIComponent, String)

hidePopup(AdfUIComponent, String)

simulateMouse

public Object simulateMouse(AdfUIComponent component, String subId, Object mouseEvent)

Simulate mouse type event on a component/subId.

Parameters:

`component`	-	the component reeiving the mouseEvent.
`subId`	-	subId on component receiving the mouseEvent. May be null.
`mouseEvent`	-	javascript object containing a sparse set of mouse event name value pairs.

Return:

Object

SimulateMouseOnDescendant

protected Object SimulateMouseOnDescendant(AdfUIComponent targetComponent, HTMLElement domElement, Object mouseEvent)

Simulate mouse type event on a descendant component/subId. This will be propogated to caring parent components.

Parameters:

`targetComponent`	-	the component receiving the mouseEvent.
`domElement`	-	the particular dom element receiving the mouseEvent
`mouseEvent`	-	javascript object containing a sparse set of mouse event name value pairs.

Return:

Object

_sliceArgumentsArray

private static Object _sliceArgumentsArray(Array theArguments, Number startIndex)

Create a new Array object containing the arguments array starting at the specified index

Parameters:

`theArguments`	-	Arguments object to create array from
`startIndex`	-	argument index to start copying arguments from

Return:

Object

TruncateClientId

protected Object TruncateClientId(Object component, Object descendantComponent, Object childClientId, Object skipArray)

Hook to record which indices in the clientId fragment should be skipped when converting a clientId to an absolute scoped id.

The peer is not bound when this method is called

Peers that need to remove extra fragments when converting from clientIds to absolute scoped ids such as Tables and Regions should override this method to add the index of the fragment to be skipped to the end of the skipArray.

Parameters:

`component`	-	The component for this peer
`descendantComponent`	-	The component that the absolute scoped id is being generated for.
`childClientId`	-	The clientId of the component that the absolute scoped id is being generated for
`skipArray`	-	Array of indices to skip

Return:

Object

_truncateClientId

private Object _truncateClientId(Object component, Object descendantComponent, Object childClientId, Object skipArray)

Recursive call to record which indices in the clientId fragment should be skipped when converting a clientId to an absolute scoped id.

The peer is not bound when this method is called

Parameters:

`component`	-	The component for this peer
`descendantComponent`	-	The component that the absolute scoped id is being generated for.
`childClientId`	-	The clientId of the component that the absolute scoped id is being generated for
`skipArray`	-	Array of indices to skip

Return:

Object

TruncateClientIdOnceImpl

protected static Object TruncateClientIdOnceImpl(Object component, Object descendantComponent, Object childClientId, Object skipArray)

Parameters:

`component`
`descendantComponent`
`childClientId`
`skipArray`

Return:

Object

UnbindFromComponent

protected Object UnbindFromComponent()

Clean up any lazily instantiated state for the peer associated with the currently bound component and DOM element

Return:: Object

unregisterKeyStroke

public static Object unregisterKeyStroke(AdfUIComponent component, AdfKeyStroke keystroke)

Unregisters a global keyboard shortcut/accelerator for a component that was registered using AdfRichUIPeer.RegisterKeyStroke. Peers should unregister their KeyStrokesin componentRemoved.

Parameters:

`component`	-	Component the keystroke should be unregistered for
`keystroke`	-	the key combination for the accelerator

Return:

Object

See also:

registerKeyStroke(AdfUIComponent, AdfKeyStroke, Function)

componentRemoved(AdfUIComponent)

UpdateMessageType

protected Object UpdateMessageType(Object element, Object maxType)

To sets the style based on the maxType. If the maxType is null the all extra properties and expando's are removed from the element.

Parameters:

`element`
`maxType`

Return:

Object

_visitChild

private Object _visitChild(Object childComponent, Object callback, Object context, Object ignoreHidden)

Parameters:

`childComponent`
`callback`
`context`
`ignoreHidden`

Return:

Object

visitChildren

public Number visitChildren(AdfUIComponent component, Function callback, Object context, Boolean ignoreHidden)

Visits all of the children components of the component. A callback function will be invoked with one argument - a component - and must return one of three values. If it returns the number zero (or false), iteration will continue. If it returns the number one (or true), iteration will not continue into the children. If it returns the number two, iteration will entirely halt. Iteration proceeds depth first, but calling the parents before the children
Please note that you do take a performance hit for using ignoreHidden.

Parameters:

`component`	-	the component
`callback`	-	a function that will be called on each child
`context`	-	an object that will be set as "this" when the callback is invoked; can be null if no context is required.
`ignoreHidden`	-	if true, hidden DOM nodes will be skipped

Return:

Number - null

Overrides:

AdfUIPeer.visitChildren(AdfUIComponent, Function, Object, Boolean)

_visitChildren

private Object _visitChildren(Object component, Object domElement, Object callback, Object context, Object ignoreHidden)

Helper for visitChildren that walks DOM nodes. Note that this method will only return 0 or 2, which is intentional - 1 is only a legit return value from a callback to indicate "don't process the children of this component".

Parameters:

`component`
`domElement`
`callback`
`context`
`ignoreHidden`

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

JavaScript API Reference for Oracle ADF Faces

oracle.adf.view.js.laf.richClass AdfRichUIPeer

Field Summary

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

Fields inherited from org.ecmascript.object.Object

Constructor Summary

Method Summary

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

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

Field Detail

addComponentPropertyChanges

addComponentPropertyGetters

BUSY_STYLECLASS

_CREATE_SUB_ID_ARRAY

CreateSubId

DISABLED_STYLECLASS

DRAG_READY_STYLECLASS

DRAG_SOURCE_STYLECLASS

DROP_TARGET_STYLECLASS

_FILTER_PREFIX

FOCUS_TARGET_STYLECLASS

_GET_COMPONENT_FORMAT

_HANDLE_COMPONENT_EVENT_FORMAT

_HANDLE_DOM_EVENT_FORMAT

HOVER_TARGET_STYLECLASS

_NOSCRIPT_END_REGEX

_POPUP_ID_DEFAULT

_POPUP_LIST

_PROPERTY_CHANGED_FORMAT

READONLY_STYLECLASS

SELECTED_STYLECLASS

_SVG_EXPANDO

_TWINKLE_ON_STYLECLASS

_TWINKLE_TIMER_ID_ATTR

__TYPE_ATTR

Constructor Detail

AdfRichUIPeer

Method Detail

addComponentEventHandlers

_addComponentEventHandlers

addComponentPropertyChanges

_addComponentPropertyChanges

addComponentPropertyGetters

_addComponentPropertyGetters

addDomEventHandlers

_addDomEventHandlers

addEventHandlerToDomInstance

addSuppressedPPRAttributes

_addSuppressedPPRAttributes

applyDragReadyState

ApplyDragReadyState

applyDragSourceState

ApplyDragSourceState

bind

BindToComponent

cancelAllPopups

cancelPopup

ChildVisibilityChanged

clearDragReadyState

ClearDragReadyState

clearDragSourceState

ClearDragSourceState

ComponentInlineStyleChanged

ComponentPropertyChanged

componentRemoved

ComponentRemoved

ComponentStyleClassChanged

ComponentVisibleChanged

ConvertClientIdToLocator

convertLocatorToClientId

createComponentEvent

CreateComponentEvent

CreateDraggableNode

createInnerPeerClassWithSubId

createPeerClass

createSubId

DefaultInitClass

_defaultInstanceEventHandler

descendantMessageChanged

DescendantMessageChanged

oracle.adf.view.js.laf.rich
Class AdfRichUIPeer