# JavaScript API Reference for Oracle ADF Faces

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

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

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

## Warning:

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

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

    public class AdfDhtmlIteratorPeer
    extends AdfDhtmlImplicitPeer

Implicitly present peer for iterators. Iterator Peers/components are currently only present when the test automation feature is present.

## Field Summary

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

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

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

## Constructor Summary
`public` | `AdfDhtmlIteratorPeer()` Implicitly present peer for iterators.

## Method Summary
`private Object` | `_buildTokenToIndexMap(Object component)` Returns the map of tokens to relative indices
`private Object` | `_ensureAbsoluteLocatorInitialization(Object component)` Ensures that the parent is initialized and we have initialized our child token map
`public static String` | `fixupIteratorAbsoluteLocator(Object locator, Object stopComponent)` Given an absolute locator determine if the ancestors are iterators and if so, fix up the iterator absolute locators
`public Object` | `getAbsoluteLocator(Object component, Object 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.
`private static Object` | `_getAncestorContentDomElement(Object component)` returns a non-null, ancestor dom content Node.
`private Object` | `_getFirstAncestorIterator(Object component)`
`private static Object` | `_getIteratorToken(Object node, Object iteratorPrefix)`

### Methods inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlImplicitPeer
`componentRemoved, getComponentParent, initialize, visitChildren`

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

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

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

## Field Detail

## Constructor Detail

### AdfDhtmlIteratorPeer

`public AdfDhtmlIteratorPeer()`
  Implicitly present peer for iterators. Iterator Peers/components are currently only present when the test automation feature is present.

## Method Detail

### _buildTokenToIndexMap

`private Object _buildTokenToIndexMap(Object component)`
  Returns the map of tokens to relative indices
  Parameters:

    `component` |  |

  Return:
    `Object`

### _ensureAbsoluteLocatorInitialization

`private Object _ensureAbsoluteLocatorInitialization(Object component)`
  Ensures that the parent is initialized and we have initialized our child token map
  Parameters:

    `component` |  |

  Return:
    `Object`

### fixupIteratorAbsoluteLocator

`public static String fixupIteratorAbsoluteLocator(Object locator,
Object stopComponent)`
  Given an absolute locator determine if the ancestors are iterators and if so, fix up the iterator absolute locators
  Parameters:

    `locator` |  |
    `stopComponent` | - | Optional component to to stop at when computing absolute locators. If null we compute absolute locators until we get to the component we are looking for, or then end of the iterator's parent component's descendants

  Return:
    `String` - The potentially transformed absolute locator for the component

### getAbsoluteLocator

`public Object getAbsoluteLocator(Object component,
Object 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. Provided primarily for test automation users. For most components, absoluteLocator will be same as absoluteId, except in the case of stamping components like table.
  Parameters:

    `component` |  |
    `clientId` |  |

  Return:
    `Object`
  Overrides:
    `AdfUIPeer.getAbsoluteLocator(AdfUIComponent, String)`

### _getAncestorContentDomElement

`private static Object _getAncestorContentDomElement(Object component)`
  returns a non-null, ancestor dom content Node. The parentComponent could have a null contentDomNode if it is an iterator as well
  Parameters:

    `component` |  |

  Return:
    `Object`

### _getFirstAncestorIterator

`private Object _getFirstAncestorIterator(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### _getIteratorToken

`private static Object _getIteratorToken(Object node,
Object iteratorPrefix)`
  Parameters:

    `node` |  |
    `iteratorPrefix` |  |

  Return:
    `Object`

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

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

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