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

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

    public class AdfDhtmlListViewPeer
    extends AdfRichUIPeer

## Field Summary
`private static Object` | `_ACTION_MODE_ROW_KEY`
`private static Object` | `_COLLAPSED_GROUP_KEY`
`private static Object` | `_DROP_TARGET_CLASS`
`public static Object` | `DW_SUB_ID`
`private static Object` | `_EXPANDED_GROUP_KEY`
`private static Object` | `_FETCH_DELAY_TIMEOUT`
`private static Object` | `_FETCH_INDEX_ATTR`
`private static Object` | `_FETCH_MORE_DIV`
`private static Object` | `_FETCH_MORE_LINK`
`private Object` | `_fetchId`
`private static Object` | `_GROUP_HEADER_ATTR`
`private static Object` | `_HIGHLIGHTED_CLASS`
`private static Object` | `_ICON_COLLAPSED`
`private static Object` | `_ICON_EXPANDED`
`private static Object` | `_ICON_STYLE_COLLAPSED`
`private static Object` | `_ICON_STYLE_EXPANDED`
`private static Object` | `_INPUT_REGEXP`
`private static Object` | `_NEEDS_REFRESH_ATTRIBUTE`
`private static Object` | `_ROW_KEY`
`private static Object` | `_SCROLLBAR_BEHAVIOR`
`private static Object` | `_SCROLLBAR_BEHAVIOR_AUTO_HIDE`
`private static Object` | `_SEL_UPDATE_ALL_SELECT`
`private static Object` | `_SEL_UPDATE_ALL_UNSELECT`
`private static Object` | `_SEL_UPDATE_ALL_UPDATE`
`private static Object` | `_SELECTED_CLASS`
`private static Object` | `_SUB_ID_MAP` listView component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1.
`private static Object` | `_UNDO_FETCH_ATTRIBUTE`

### 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` | `AdfDhtmlListViewPeer()`

## Method Summary
`private Object` | `_addMore(Object clientKey, Object index)` Scrolling and virtualization
`public Object` | `applyDragReadyStateForRowKeys(AdfUIComponent component, AdfUIInputEvent inputEvent, Array rowKeys)` Given an array of rowKeys, apply the drag ready state.
`public Object` | `applyDragSourceStateForRowKeys(AdfUIComponent component, AdfUIInputEvent inputEvent, Array rowKeys)` Given an array of rowKeys, apply the drag source state.
`private Object` | `_calculateScrollBarWidth(Object rootElement)`
`private Object` | `_cancelPendingFetch()`
`public Object` | `canDeliverSelectionEvent()`
`protected Object` | `ClearDragReadyState(Object dragReadyObj)` Called by the framework to clear the drag ready state.
`protected Object` | `ClearDragSourceState(Object dragSourceObj)` Called by the framework to clear the drag source state
`private Object` | `_cloneItemForDrag(Object dragItem)`
`protected Object` | `ComponentGroupDisclosedRowKeysChanged(Object component, Object domElement, Object newValue, Object oldValue)`
`protected Object` | `ComponentSelectedRowKeysChanged(Object component, Object domElement, Object newValue, Object oldValue)`
`protected Object` | `ConvertClientIdToLocator(Object component, Object childComponent, Object descComponentClientId, Object replaceArray)` Function to replace client id fragments when converting a clientId to an absolute locator.
`public String` | `convertLocatorToClientId(Object component, Object itemIndex)` Function to replace client id fragments when converting an absolute locator to clientId.
`Object` | `__deleteItemSwiped()`
`private Object` | `_disableActionMode(DomElement target)` disables actionable mode if the target element is outside the actionable listitem
`private Object` | `_displayStatus(String text)` Displays the status icon during data fetch
`Object` | `__doItemSelection(Object event, Object rowKey, Object item)` Internal method to do item selection based on the event key modifiers like shift/ctrl etc
`protected Object` | `DomReplaceNotify(Object domNode)` Notifies the peer that some DOM corresponding to a child (or descendent) has been replaced.
`private Object` | `_doResizeNotifyOnFetchedChildren(Object insertAfterNode)` Children fetched after initial load do not get resizeNotify and we need to call resize Notify explicitly on them.
`private Object` | `_enableActionMode()` enables actionable mode.
`private static Object` | `_findFirstChildByTagName(Object parent, Object name)`
`private Object` | `_findItemByKey(String rowKey)` Returns the row and the index associated with the rowKey in the dom structure
`protected Object` | `GetBestMatchSubId(HTMLElement childElement)` Returns the best match subId for the given domElement.
`private static Object` | `_getChildBySubId(Object parent, Object sub)`
`private Object` | `_getDataBody(Object rootDomElement)`
`private Object` | `_getDomNodesForDrag(Object rowKeys)` Get all the table columns that should be used for the drag ready state or the drag ghost.
`public HTMLElement` | `getDragNodeForRowKeys(Array rowKeys)` Given an array of rowkeys stamped by this peer, returns the Node to use for dragging
`public Object` | `getDragOffsetForRowKeys(AdfUIInputEvent inputEvent, Array rowKeys)` Given an array of rowkeys stamped by this peer, and the inputEvent for drag returns the offset within the drag object
`private Object` | `_getElemBySubId(Object sub, Object rootDomElement)` Gets an element belonging to this peer based on the root DOM element.
`private Object` | `_getExpandAction(HTMLElement target)` Returns the collapse/expand action if the user clicks on the group header
`private Object` | `_getFirstRowKeyAndItem()` Returns the rowkey and the item before the selected item.
`Object` | `__getItemSwiped()`
`private Object` | `_getLastRowKey()`
`private Object` | `_getNextRowKeyAndItem(String selectedRowKey, Boolean includeGroupHeader)` Returns the rowkey and the item after the selected item.
`private Object` | `_getPreviousRowKeyAndItem(String selectedRowKey, Boolean includeGroupHeader)` Returns the rowkey and the item before the selected item.
`public Number` | `getRowIndex(String rowKey)` Returns the index of a row identified by rowKey.
`public String` | `getRowKey(Number index)` Returns the rowKey to identify a row based on its index.
`Object` | `__getRowKeyAndItem(Object domElement, Object rootDomElement)` Returns the row key attribute and the row from a dom element.
`private Object` | `_getRowKeyAndOrientationForPosition(Object pageX, Object pageY, Object hints)` Given a location in page coordinates inside this Peer, return the rowKey, if any, that is stamped within those bounds.
`public Object` | `getRowKeyAndOrientationFromHints(Number pageX, Number pageY, Object hints)` Given a location in page coordinates inside this Peer, return the rowKey, if any, that is stamped within those bounds.
`public Object` | `getRowKeyBounds(String rowKey)` Given a rowKey in this Peer, return the bounds of the rowKey's visualization
`public String` | `getRowKeyForEvent(AdfUIInputEvent inputEvent)` Given a IUInputEvent, return the rowKey.
`private Object` | `_getStatusMessage()`
`protected Object` | `GetSubIdDomElement(Object subElementId)` Returns the DOM element identified by the passed in subId.
`Object` | `__getSwipeSelected()`
`private Object` | `_getTargetGroupHeader(DomElement node)` Returns the row header node by starting at the target node, walking up the parent hierarchy until it reaches the first row header or the root dom element for the peer.
`private Object` | `_handleArrowLeftRight(Object arrowLeft, Object domEvent)`
`private Object` | `_handleArrowUpDown(Object arrowUp, Object domEvent)`
`protected Object` | `HandleComponentClick(Object componentEvent)`
`protected Object` | `HandleComponentFocus(Object componentEvent)` Handle component focus.
`protected Object` | `HandleComponentKeyDown(Object componentEvent)` keyboard handling
`protected Object` | `HandleComponentMouseOut(Object componentEvent)`
`protected Object` | `HandleComponentMouseOver(Object componentEvent)` Event Handlers
`private Object` | `_handleDataBodySelectStart(Object evt)`
`private Object` | `_handleDataCallback(Object node, Object pendingFetch, Object afterNode, Object component)`
`private Object` | `_handleSpaceBar(Object domEvent)`
`private Object` | `_handleTabKey(Object domEvent)`
`private Object` | `_hideListViewScrollbar(Object rootElement)`
`private Object` | `_hideStatus()`
`protected Object` | `InitDomElement(ADfUIComponent component, HTMLElement domElement)` Initialize the associated domElement when the peer is created.
`public Object` | `initializeAutoHideScrolling(Object rootElement)`
`protected static Object` | `InitSubclass()` Registers component handlers.
`private Object` | `_isActionsFacetDisplayed(Object item)`
`public Object` | `isDisclosureFetchPending()`
`public Boolean` | `isDragAvailable(Object target)` Determines if a drag can be initiated on the target node.
`private Boolean` | `_isInActionMode()` Checks whether actionable mode is enabled or not
`private Object` | `_isMultipleSelect()` Returns if multiple selection is enabled on the listView component
`private Object` | `_isOwnComponentEvent(AdfComponentEvent componentEvent)` Determines whether the component event belongs to this listView (as opposed to a child listView displayed in a popup or otherwise)
`private static Object` | `_isRTL()`
`Object` | `__isSelectionEnabled(AdfUIComponent component)` Returns if the selection is enabled on the ListView component
`private Object` | `_isTargetCellEditable(Object node)` Returns if the current node is an editable cell for e.g.
`private Object` | `_needsHorizontalScrollbar(Object element)`
`public Object` | `needsResizeNotify(Object component)` Tests whether the peer requires resize notification.
`private Object` | `_needsVerticalScrollbar(Object element)`
`private Object` | `_queueFetchEvent(Object subtype, Object key, Object index)`
`protected Object` | `ReplaceDomElement(HTMLElement newElement, HTMLElement oldElement)` Replaces the a dom element contained in this peer.
`protected Object` | `ResizeNotify(Object oldWidth, Object oldHeight, Object newWidth, Object newHeight)` Called to notify the peer of resize activity.
`private Object` | `_selectItemRange(Object rowKeyStart, Object rowKeyEnd)` Select a range of rows from rowKeyStart to rowKeyEnd.
`private Object` | `_selHighlightItem(DomElement item, Object select)` Changes the CSS to highlight or un-higlight for selection in the listView
`private Object` | `_selIsOnlySelection(Object rowKey)`
`private Object` | `_selIsSelected(String rowKey)` Returns if a certain rowKey is selected
`private Object` | `_selSelectItem(String rowKey, DomElement item, Boolean skipUpdate)` Selects an item in the listView
`private Object` | `_selUnselectAll()` Unselects all items
`private Object` | `_selUnselectItem(String rowKey, DomElement item)` Un-Selects an item in the listView
`private Object` | `_selUpdateAll(Integer selType)` Updates the entire selection in the ListView component
`private static Object` | `_setCursor(Object elem, Object cur)`
`private Object` | `_setFocusRowKey()`
`Object` | `__setItemSwiped(Object component, Object rootDom)`
`private Object` | `_setListItemTabStop(String rowKey)` Makes the list item corresponding to rowKey tabstoppable and other list item non tabstoppable
`Object` | `__setSwipeSelected(Object selected)`
`public Object` | `showDragFeedback(AdfDnDContext dndContext, String rowKey, Object userAction, String lastValidRowKey, Number pageX, Number pageY, Boolean dragExit)` Shows feedback for the given drop target rowkey
`private Object` | `_showItemHoverState(Object componentEvent, Object show)`
`private Object` | `_startFetch(Object subtype, Object key, Object index)`
`public Object` | `suppressSelectionEventDelivery(Object freeze)` Selection Logic (items)
`private Object` | `_unclipItem(Object item)` scroll the view port to make sure that the an item is visible into the viewport
`private Object` | `_unhideListViewScrollbar(Object rootElement)`
`private Object` | `_updateLVSelectionState(Object state)`

### 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, clearDragSourceState, ComponentInlineStyleChanged, ComponentPropertyChanged, componentRemoved, ComponentRemoved, ComponentStyleClassChanged, ComponentVisibleChanged, createComponentEvent, CreateComponentEvent, CreateDraggableNode, createInnerPeerClassWithSubId, createPeerClass, createSubId, DefaultInitClass, descendantMessageChanged, DescendantMessageChanged, DispatchComponentEvent, DispatchUncanceledComponentEvent, domReplaceNotify, focus, Focus, getAbsoluteId, getAbsoluteLocator, getAccessibleName, GetAccessibleName, getAllPopups, getComponent, GetComponent, GetComponentId, getComponentParent, getComponentProperty, GetComponentVisible, getDescendantComponents, getDomContentElement, getDomContentElementForComponent, GetDomContentElementForNode, getDomDocument, getDomElement, getDomElementForComponent, getDomNode, GetDomNodeForCommentComponent, getDomNodeForComponent, getDomRootNodes, GetDomRootNodes, getDragOverFeedback, GetDragOverFeedback, getDragTransferable, GetDragTransferable, GetElementToReplaceWithSVG, getFallbackDomElement, GetFallbackDomElement, getFirstAncestorComponent, getInlineEditor, GetInlineEditor, getInlineStyleProperty, getLocatorByDomElement, getPagePosition, getPopupWindow, getReadyState, GetReadyState, GetRichResourceURL, getSubIdDomElement, hideAllPopups, hidePopup, InitClass, initialize, isAbsoluteLocatorCacheable, isActive, isBusy, isComponentContainedByElement, isInActiveHeirarchy, isInlineSVGIcon, isPopupVisible, messageNotify, MessageNotify, messageShow, MessageShow, needsChildVisibilityChanges, needsFocusTargetStyleClass, PopupClosed, processPushData, ProcessPushData, registerADSAccessibility, RegisterADSAccessibility, registerKeyStroke, replaceDomElement, resizeNotify, scrollIntoView, ScrollIntoView, setBusy, SetBusy, setInlineStyleProperty, showContextMenu, showPopup, simulateMouse, SimulateMouseOnDescendant, TruncateClientId, TruncateClientIdOnceImpl, UnbindFromComponent, unregisterKeyStroke, UpdateMessageType, visitChildren`

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

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

### _ACTION_MODE_ROW_KEY

`private static Object _ACTION_MODE_ROW_KEY`

### _COLLAPSED_GROUP_KEY

`private static Object _COLLAPSED_GROUP_KEY`

### _DROP_TARGET_CLASS

`private static Object _DROP_TARGET_CLASS`

### DW_SUB_ID

`public static Object DW_SUB_ID`

### _EXPANDED_GROUP_KEY

`private static Object _EXPANDED_GROUP_KEY`

### _FETCH_DELAY_TIMEOUT

`private static Object _FETCH_DELAY_TIMEOUT`

### _FETCH_INDEX_ATTR

`private static Object _FETCH_INDEX_ATTR`

### _FETCH_MORE_DIV

`private static Object _FETCH_MORE_DIV`

### _FETCH_MORE_LINK

`private static Object _FETCH_MORE_LINK`

### _fetchId

`private Object _fetchId`

### _GROUP_HEADER_ATTR

`private static Object _GROUP_HEADER_ATTR`

### _HIGHLIGHTED_CLASS

`private static Object _HIGHLIGHTED_CLASS`

### _ICON_COLLAPSED

`private static Object _ICON_COLLAPSED`

### _ICON_EXPANDED

`private static Object _ICON_EXPANDED`

### _ICON_STYLE_COLLAPSED

`private static Object _ICON_STYLE_COLLAPSED`

### _ICON_STYLE_EXPANDED

`private static Object _ICON_STYLE_EXPANDED`

### _INPUT_REGEXP

`private static Object _INPUT_REGEXP`

### _NEEDS_REFRESH_ATTRIBUTE

`private static Object _NEEDS_REFRESH_ATTRIBUTE`

### _ROW_KEY

`private static Object _ROW_KEY`

### _SCROLLBAR_BEHAVIOR

`private static Object _SCROLLBAR_BEHAVIOR`

### _SCROLLBAR_BEHAVIOR_AUTO_HIDE

`private static Object _SCROLLBAR_BEHAVIOR_AUTO_HIDE`

### _SEL_UPDATE_ALL_SELECT

`private static Object _SEL_UPDATE_ALL_SELECT`

### _SEL_UPDATE_ALL_UNSELECT

`private static Object _SEL_UPDATE_ALL_UNSELECT`

### _SEL_UPDATE_ALL_UPDATE

`private static Object _SEL_UPDATE_ALL_UPDATE`

### _SELECTED_CLASS

`private static Object _SELECTED_CLASS`

### _SUB_ID_MAP

`private static Object _SUB_ID_MAP`
  listView component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [fetchMoreItems --> fchmrlnk] - fetch more link. for e.g click("rich=dmotpl:listView#fetchMoreItems). {External indexing example --> Internal indexing example} getElementText("rich=dmoTpl:listView[2]:ot4"); Please note that in case of listView with groups, the index is a flattened index and includes groups-->

### _UNDO_FETCH_ATTRIBUTE

`private static Object _UNDO_FETCH_ATTRIBUTE`

## Constructor Detail

### AdfDhtmlListViewPeer

`public AdfDhtmlListViewPeer()`

## Method Detail

### _addMore

`private Object _addMore(Object clientKey,
Object index)`
  Scrolling and virtualization
  Parameters:

    `clientKey` |  |
    `index` |  |

  Return:
    `Object`

### applyDragReadyStateForRowKeys

`public Object applyDragReadyStateForRowKeys(AdfUIComponent component,
AdfUIInputEvent inputEvent,
Array rowKeys)`
  Given an array of rowKeys, apply the drag ready state.
  Parameters:

    `component` | - | the component for this peer
    `inputEvent` | - | the event that started the dragging.
    `rowKeys` | - | array of row keys

  Return:
    `Object` - an object to be passed to the clear method
  See also:
    "#clearDragReadyState"

### applyDragSourceStateForRowKeys

`public Object applyDragSourceStateForRowKeys(AdfUIComponent component,
AdfUIInputEvent inputEvent,
Array rowKeys)`
  Given an array of rowKeys, apply the drag source state.
  Parameters:

    `component` | - | the component for this peer
    `inputEvent` | - | the event that started the dragging.
    `rowKeys` | - | array of row keys

  Return:
    `Object` - an object to be passed to the clear method
  See also:
    "#clearDragSourceState"

### _calculateScrollBarWidth

`private Object _calculateScrollBarWidth(Object rootElement)`
  Parameters:

    `rootElement` |  |

  Return:
    `Object`

### _cancelPendingFetch

`private Object _cancelPendingFetch()`
  Return:
    `Object`

### canDeliverSelectionEvent

`public Object canDeliverSelectionEvent()`
  Return:
    `Object`

### ClearDragReadyState

`protected Object ClearDragReadyState(Object dragReadyObj)`
  Called by the framework to clear the drag ready state.
  Parameters:

    `dragReadyObj` |  |

  Return:
    `Object`
  Overrides:
    `AdfUIPeer.clearDragReadyState(AdfUIComponent, Object)`

### ClearDragSourceState

`protected Object ClearDragSourceState(Object dragSourceObj)`
  Called by the framework to clear the drag source state
  Parameters:

    `dragSourceObj` |  |

  Return:
    `Object`
  Overrides:
    `AdfUIPeer.clearDragSourceState(AdfUIComponent, Object)`

### _cloneItemForDrag

`private Object _cloneItemForDrag(Object dragItem)`
  Parameters:

    `dragItem` |  |

  Return:
    `Object`

### ComponentGroupDisclosedRowKeysChanged

`protected Object ComponentGroupDisclosedRowKeysChanged(Object component,
Object domElement,
Object newValue,
Object oldValue)`
  Parameters:

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

  Return:
    `Object`

### ComponentSelectedRowKeysChanged

`protected Object ComponentSelectedRowKeysChanged(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)`
  Function to replace client id fragments when converting a clientId to an absolute locator. It tries to find the rowkey information for the childComponent. If rowKey exists, skip the first id fragment after the table id and append the rowIndex in the format listViewId[rowIndex] else skip the first id fragment after the listview id.

  The peer is not bound when this method is called

  Parameters:

    `component` | - | The listView component for this peer
    `childComponent` |  |
    `descComponentClientId` | - | The clientId of the component that the absolute scoped id 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`
  Overrides:
    `AdfRichUIPeer.ConvertClientIdToLocator(Object, Object, Object, Object)`

### convertLocatorToClientId

`public String convertLocatorToClientId(Object component,
Object itemIndex)`
  Function to replace client id fragments when converting an absolute locator to clientId.
  Parameters:

    `component` | - | The table component for this peer
    `itemIndex` | - | the index of the item for the component

  Return:
    `String` - the client id fragment in the below format clientId + ":" + stamped rowKey client Id fragment related to rowIndex
  Overrides:
    `AdfUIPeer.convertLocatorToClientId(Object, Object)`

### __deleteItemSwiped

`Object __deleteItemSwiped()`
  Return:
    `Object`

### _disableActionMode

`private Object _disableActionMode(DomElement target)`
  disables actionable mode if the target element is outside the actionable listitem
  Parameters:

    `target` | - | - dom element where the focus is moved

  Return:
    `Object`

### _displayStatus

`private Object _displayStatus(String text)`
  Displays the status icon during data fetch
  Parameters:

    `text` | - | the icon title

  Return:
    `Object`

### __doItemSelection

`Object __doItemSelection(Object event,
Object rowKey,
Object item)`
  Internal method to do item selection based on the event key modifiers like shift/ctrl etc
  Parameters:

    `event` |  |
    `rowKey` |  |
    `item` |  |

  Return:
    `Object`

### DomReplaceNotify

`protected Object DomReplaceNotify(Object domNode)`
  Notifies the peer that some DOM corresponding to a child (or descendent) has been replaced.
  Parameters:

    `domNode` |  |

  Return:
    `Object`
  Overrides:
    `AdfRichUIPeer.domReplaceNotify(AdfUIComponent, Object)`

### _doResizeNotifyOnFetchedChildren

`private Object _doResizeNotifyOnFetchedChildren(Object insertAfterNode)`
  Children fetched after initial load do not get resizeNotify and we need to call resize Notify explicitly on them.
  Parameters:

    `insertAfterNode` |  |

  Return:
    `Object`

### _enableActionMode

`private Object _enableActionMode()`
  enables actionable mode. We are using a component property so that the state is maintained even after the component is PPRed.
  Return:
    `Object`

### _findFirstChildByTagName

`private static Object _findFirstChildByTagName(Object parent,
Object name)`
  Parameters:

    `parent` |  |
    `name` |  |

  Return:
    `Object`

### _findItemByKey

`private Object _findItemByKey(String rowKey)`
  Returns the row and the index associated with the rowKey in the dom structure
  Parameters:

    `rowKey` | - | the rowKey to look for in dom structure

  Return:
    `Object` - an object literal with row and index attributes if the rowkey is found else null

### GetBestMatchSubId

`protected Object GetBestMatchSubId(HTMLElement childElement)`
  Returns the best match subId for the given domElement. This can be enhanced further to return programmatically determined subIds. WARNING - You must make sure to bind the component to the peer before calling this function.
  Parameters:

    `childElement` | - | the DOM element

  Return:
    `Object`
  See also:
    `AdfRichUIPeer.GetSubIdDomElement(Object)`
  Overrides:
    `AdfRichUIPeer.GetBestMatchSubId(Object)`

### _getChildBySubId

`private static Object _getChildBySubId(Object parent,
Object sub)`
  Parameters:

    `parent` |  |
    `sub` |  |

  Return:
    `Object`

### _getDataBody

`private Object _getDataBody(Object rootDomElement)`
  Parameters:

    `rootDomElement` |  |

  Return:
    `Object`

### _getDomNodesForDrag

`private Object _getDomNodesForDrag(Object rowKeys)`
  Get all the table columns that should be used for the drag ready state or the drag ghost.
  Parameters:

    `rowKeys` |  |

  Return:
    `Object`

### getDragNodeForRowKeys

`public HTMLElement getDragNodeForRowKeys(Array rowKeys)`
  Given an array of rowkeys stamped by this peer, returns the Node to use for dragging
  Parameters:

    `rowKeys` | - | the array of rowKeys

  Return:
    `HTMLElement` - the dom element representing the dragged nodes

### getDragOffsetForRowKeys

`public Object getDragOffsetForRowKeys(AdfUIInputEvent inputEvent,
Array rowKeys)`
  Given an array of rowkeys stamped by this peer, and the inputEvent for drag returns the offset within the drag object
  Parameters:

    `inputEvent` |  |
    `rowKeys` | - | the array of rowKeys

  Return:
    `Object` - point with x and y coordinates

### _getElemBySubId

`private Object _getElemBySubId(Object sub,
Object rootDomElement)`
  Gets an element belonging to this peer based on the root DOM element.
  Parameters:

    `sub` | - | the sub ID to identify the sub element
    `rootDomElement` |  |

  Return:
    `Object` - the found sub element or null if not found

### _getExpandAction

`private Object _getExpandAction(HTMLElement target)`
  Returns the collapse/expand action if the user clicks on the group header
  Parameters:

    `target` | - | the target of the event

  Return:
    `Object` - String "collapse" or "expand" if the event is on group disclosure icon else null

### _getFirstRowKeyAndItem

`private Object _getFirstRowKeyAndItem()`
  Returns the rowkey and the item before the selected item.
  Return:
    `Object` - object literal with rowKey and the listView items root dom node

### __getItemSwiped

`Object __getItemSwiped()`
  Return:
    `Object`

### _getLastRowKey

`private Object _getLastRowKey()`
  Return:
    `Object`

### _getNextRowKeyAndItem

`private Object _getNextRowKeyAndItem(String selectedRowKey,
Boolean includeGroupHeader)`
  Returns the rowkey and the item after the selected item.
  Parameters:

    `selectedRowKey` | - | the rowKey that is currently selected
    `includeGroupHeader` | - | is set to true if group header needs to be included

  Return:
    `Object` - object literal with rowKey and the listView items root dom node

### _getPreviousRowKeyAndItem

`private Object _getPreviousRowKeyAndItem(String selectedRowKey,
Boolean includeGroupHeader)`
  Returns the rowkey and the item before the selected item.
  Parameters:

    `selectedRowKey` | - | the rowKey that is currently selected
    `includeGroupHeader` | - | is set to true if group header needs to be included

  Return:
    `Object` - object literal with rowKey and the listView items root dom node

### getRowIndex

`public Number getRowIndex(String rowKey)`
  Returns the index of a row identified by rowKey.
  There is no guarantee that a row identified by a rowKey can be found on the client since all the rows are not rendered on the client. Also keep in mind that the rowKey on the client is not the same as the one on the server, since the server provides a mechanism for converting client row keys into server row keys. Please note that indexes do not represent any parent/child relationship in a heirarchicaly listView, which means that the heirarchical listView is flattened when the rowIndex is considered.
  Parameters:

    `rowKey` | - | the client side rowKey that identifies a row

  Return:
    `Number` - the index of a row for a row key if is found otherwise -1.
  See also:
    `getRowKey(Number)`

### getRowKey

`public String getRowKey(Number index)`
  Returns the rowKey to identify a row based on its index.
  There is no guarantee that a row identified by a rowKey can be found on the client since all the rows are not rendered on the client. Also keep in mind that the rowKey on the client is not the same as the one on the server, since the server provides a mechanism for converting client row keys into server row keys. Please note that indexes do not represent any parent/child relationship in a heirarchicaly listView, which means that the heirarchical listView is flattened when the rowIndex is considered.
  Parameters:

    `index` | - | the rowIndex of the row

  Return:
    `String` - the rowKey to identify a row if is found otherwise null.
  See also:
    `getRowIndex(String)`

### __getRowKeyAndItem

`Object __getRowKeyAndItem(Object domElement,
Object rootDomElement)`
  Returns the row key attribute and the row from a dom element. If necessary, walks up the dom hierarchy to find the element with the rowKey attribute
  Parameters:

    `domElement` |  |
    `rootDomElement` |  |

  Return:
    `Object`

### _getRowKeyAndOrientationForPosition

`private Object _getRowKeyAndOrientationForPosition(Object pageX,
Object pageY,
Object hints)`
  Given a location in page coordinates inside this Peer, return the rowKey, if any, that is stamped within those bounds. As a performance aid, a rowKey and its bounds may optionally be passed to aid in determining the current rowKey.
  Parameters:

    `pageX` |  |
    `pageY` |  |
    `hints` |  |

  Return:
    `Object`

### getRowKeyAndOrientationFromHints

`public Object getRowKeyAndOrientationFromHints(Number pageX,
Number pageY,
Object hints)`
  Given a location in page coordinates inside this Peer, return the rowKey, if any, that is stamped within those bounds. As a performance aid, a rowKey, its bounds and orientation may optionally be passed to aid in determining the current rowKey.
  Parameters:

    `pageX` | - | the x position of the pointer
    `pageY` | - | the y position of the pointer
    `hints` | - | An object containings hints for lastRowKey, lastRowKeyBounds, lastDropOrientation etc. See AdfStampedDropTarget.HINT* for possible hints. The rowKey and dropOrientation are set on this hint object as a return values

  Return:
    `Object`

### getRowKeyBounds

`public Object getRowKeyBounds(String rowKey)`
  Given a rowKey in this Peer, return the bounds of the rowKey's visualization
  Parameters:

    `rowKey` | - | to look for

  Return:
    `Object` - object literal with the bounds of the rowKey if found else null
  See also:
    `AdfAgent.getElementPageBounds(HTMLElement)`

### getRowKeyForEvent

`public String getRowKeyForEvent(AdfUIInputEvent inputEvent)`
  Given a IUInputEvent, return the rowKey.
  Parameters:

    `inputEvent` |  |

  Return:
    `String` - rowKey

### _getStatusMessage

`private Object _getStatusMessage()`
  Return:
    `Object`

### GetSubIdDomElement

`protected Object GetSubIdDomElement(Object subElementId)`
  Returns the DOM element identified by the passed in subId.
  Parameters:

    `subElementId` |  |

  Return:
    `Object` - the DOM element
  Overrides:
    `AdfRichUIPeer.getSubIdDomElement(Object, Object)`

### __getSwipeSelected

`Object __getSwipeSelected()`
  Return:
    `Object`

### _getTargetGroupHeader

`private Object _getTargetGroupHeader(DomElement node)`
  Returns the row header node by starting at the target node, walking up the parent hierarchy until it reaches the first row header or the root dom element for the peer. If a row header is found it's returned else null.
  Parameters:

    `node` | - | the dom node from which the closest row header node is determined.

  Return:
    `Object` - row header node or null.

### _handleArrowLeftRight

`private Object _handleArrowLeftRight(Object arrowLeft,
Object domEvent)`
  Parameters:

    `arrowLeft` |  |
    `domEvent` |  |

  Return:
    `Object`

### _handleArrowUpDown

`private Object _handleArrowUpDown(Object arrowUp,
Object domEvent)`
  Parameters:

    `arrowUp` |  |
    `domEvent` |  |

  Return:
    `Object`

### HandleComponentClick

`protected Object HandleComponentClick(Object componentEvent)`
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### HandleComponentFocus

`protected Object HandleComponentFocus(Object componentEvent)`
  Handle component focus.
  Parameters:

    `componentEvent` | - | the component event invoked by focus

  Return:
    `Object`

### HandleComponentKeyDown

`protected Object HandleComponentKeyDown(Object componentEvent)`
  keyboard handling
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### HandleComponentMouseOut

`protected Object HandleComponentMouseOut(Object componentEvent)`
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### HandleComponentMouseOver

`protected Object HandleComponentMouseOver(Object componentEvent)`
  Event Handlers
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### _handleDataBodySelectStart

`private Object _handleDataBodySelectStart(Object evt)`
  Parameters:

    `evt` |  |

  Return:
    `Object`

### _handleDataCallback

`private Object _handleDataCallback(Object node,
Object pendingFetch,
Object afterNode,
Object component)`
  Parameters:

    `node` |  |
    `pendingFetch` |  |
    `afterNode` |  |
    `component` |  |

  Return:
    `Object`

### _handleSpaceBar

`private Object _handleSpaceBar(Object domEvent)`
  Parameters:

    `domEvent` |  |

  Return:
    `Object`

### _handleTabKey

`private Object _handleTabKey(Object domEvent)`
  Parameters:

    `domEvent` |  |

  Return:
    `Object`

### _hideListViewScrollbar

`private Object _hideListViewScrollbar(Object rootElement)`
  Parameters:

    `rootElement` |  |

  Return:
    `Object`

### _hideStatus

`private Object _hideStatus()`
  Return:
    `Object`

### InitDomElement

`protected Object InitDomElement(ADfUIComponent component,
HTMLElement 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`
  Overrides:
    `AdfRichUIPeer.InitDomElement(AdfUIComponent, Object)`

### initializeAutoHideScrolling

`public Object initializeAutoHideScrolling(Object rootElement)`
  Parameters:

    `rootElement` |  |

  Return:
    `Object`

### InitSubclass

`protected static Object InitSubclass()`
  Registers component handlers.
  Return:
    `Object`

### _isActionsFacetDisplayed

`private Object _isActionsFacetDisplayed(Object item)`
  Parameters:

    `item` |  |

  Return:
    `Object`

### isDisclosureFetchPending

`public Object isDisclosureFetchPending()`
  Return:
    `Object`

### isDragAvailable

`public Boolean isDragAvailable(Object target)`
  Determines if a drag can be initiated on the target node. Typically if a mousedown occurred on an editable value holder in a row, then a drag is not available.
  Parameters:

    `target` |  |

  Return:
    `Boolean` - false if a drag is not available, true otherwise.

### _isInActionMode

`private Boolean _isInActionMode()`
  Checks whether actionable mode is enabled or not
  Return:
    `Boolean` - true if the action mode property is not null

### _isMultipleSelect

`private Object _isMultipleSelect()`
  Returns if multiple selection is enabled on the listView component
  Return:
    `Object`

### _isOwnComponentEvent

`private Object _isOwnComponentEvent(AdfComponentEvent componentEvent)`
  Determines whether the component event belongs to this listView (as opposed to a child listView displayed in a popup or otherwise)
  Parameters:

    `componentEvent` | - | the component event to test

  Return:
    `Object`

### _isRTL

`private static Object _isRTL()`
  Return:
    `Object`

### __isSelectionEnabled

`Object __isSelectionEnabled(AdfUIComponent component)`
  Returns if the selection is enabled on the ListView component
  Parameters:

    `component` | - | the listView component

  Return:
    `Object`

### _isTargetCellEditable

`private Object _isTargetCellEditable(Object node)`
  Returns if the current node is an editable cell for e.g. input, select, anchor etc
  Parameters:

    `node` |  |

  Return:
    `Object`

### _needsHorizontalScrollbar

`private Object _needsHorizontalScrollbar(Object element)`
  Parameters:

    `element` |  |

  Return:
    `Object`

### needsResizeNotify

`public Object needsResizeNotify(Object component)`
  Tests whether the peer requires resize notification. Peers which perform geometry management should override this to return true. When true, resizeNotify() will be called when browser window is resized.
  Parameters:

    `component` |  |

  Return:
    `Object`
  Overrides:
    `AdfUIPeer.needsResizeNotify(Object)`

### _needsVerticalScrollbar

`private Object _needsVerticalScrollbar(Object element)`
  Parameters:

    `element` |  |

  Return:
    `Object`

### _queueFetchEvent

`private Object _queueFetchEvent(Object subtype,
Object key,
Object index)`
  Parameters:

    `subtype` |  |
    `key` |  |
    `index` |  |

  Return:
    `Object`

### ReplaceDomElement

`protected Object ReplaceDomElement(HTMLElement newElement,
HTMLElement oldElement)`
  Replaces the a dom element contained in this peer. The dom element might be a child (or descendent).
  Parameters:

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

  Return:
    `Object`
  Overrides:
    `AdfRichUIPeer.replaceDomElement(AdfUIComponent, HTMLElement, HTMLElement)`

### ResizeNotify

`protected Object ResizeNotify(Object oldWidth,
Object oldHeight,
Object newWidth,
Object newHeight)`
  Called to notify the peer of resize activity. Only called if peer overrides needsResizeNotify() to return true.
  Parameters:

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

  Return:
    `Object`
  Overrides:
    `AdfUIPeer.resizeNotify(Object, Object, Object, Object, Object)`

### _selectItemRange

`private Object _selectItemRange(Object rowKeyStart,
Object rowKeyEnd)`
  Select a range of rows from rowKeyStart to rowKeyEnd.
  Parameters:

    `rowKeyStart` |  |
    `rowKeyEnd` |  |

  Return:
    `Object`

### _selHighlightItem

`private Object _selHighlightItem(DomElement item,
Object select)`
  Changes the CSS to highlight or un-higlight for selection in the listView
  Parameters:

    `item` | - | the root dom element for the listview item
    `select` |  |

  Return:
    `Object`

### _selIsOnlySelection

`private Object _selIsOnlySelection(Object rowKey)`
  Parameters:

    `rowKey` |  |

  Return:
    `Object` - Returns true if rowKey is the only current selection

### _selIsSelected

`private Object _selIsSelected(String rowKey)`
  Returns if a certain rowKey is selected
  Parameters:

    `rowKey` | - | for a listItem

  Return:
    `Object`

### _selSelectItem

`private Object _selSelectItem(String rowKey,
DomElement item,
Boolean skipUpdate)`
  Selects an item in the listView
  Parameters:

    `rowKey` | - | the rowKey to select
    `item` | - | the root dom element for the listview item
    `skipUpdate` | - | whether component property update should be skipped

  Return:
    `Object`

### _selUnselectAll

`private Object _selUnselectAll()`
  Unselects all items
  Return:
    `Object`

### _selUnselectItem

`private Object _selUnselectItem(String rowKey,
DomElement item)`
  Un-Selects an item in the listView
  Parameters:

    `rowKey` | - | the rowKey to select
    `item` | - | the root dom element for the listview item

  Return:
    `Object`

### _selUpdateAll

`private Object _selUpdateAll(Integer selType)`
  Updates the entire selection in the ListView component
  Parameters:

    `selType` | - | enum for the selection update. possible values are selType : _SEL_UPDATE_ALL_SELECT - select all itms _SEL_UPDATE_ALL_UNSELECT - unselect all items _SEL_UPDATE_ALL_UPDATE - only update the items

  Return:
    `Object`

### _setCursor

`private static Object _setCursor(Object elem,
Object cur)`
  Parameters:

    `elem` |  |
    `cur` |  |

  Return:
    `Object`

### _setFocusRowKey

`private Object _setFocusRowKey()`
  Return:
    `Object`

### __setItemSwiped

`Object __setItemSwiped(Object component,
Object rootDom)`
  Parameters:

    `component` |  |
    `rootDom` |  |

  Return:
    `Object`

### _setListItemTabStop

`private Object _setListItemTabStop(String rowKey)`
  Makes the list item corresponding to rowKey tabstoppable and other list item non tabstoppable
  Parameters:

    `rowKey` | - | which needs tabstop

  Return:
    `Object`

### __setSwipeSelected

`Object __setSwipeSelected(Object selected)`
  Parameters:

    `selected` |  |

  Return:
    `Object`

### showDragFeedback

`public Object showDragFeedback(AdfDnDContext dndContext,
String rowKey,
Object userAction,
String lastValidRowKey,
Number pageX,
Number pageY,
Boolean dragExit)`
  Shows feedback for the given drop target rowkey
  Parameters:

    `dndContext` | - | the drag and drop context
    `rowKey` | - | of the drop target
    `userAction` |  |
    `lastValidRowKey` | - | the rowKey from previous feedback
    `pageX` | - | null or the x position of the mouse in page coordinates
    `pageY` | - | null or the y position of the mouse in page coordinates
    `dragExit` | - | true if the feedback is due to the drag exiting this component

  Return:
    `Object`

### _showItemHoverState

`private Object _showItemHoverState(Object componentEvent,
Object show)`
  Parameters:

    `componentEvent` |  |
    `show` |  |

  Return:
    `Object`

### _startFetch

`private Object _startFetch(Object subtype,
Object key,
Object index)`
  Parameters:

    `subtype` |  |
    `key` |  |
    `index` |  |

  Return:
    `Object`

### suppressSelectionEventDelivery

`public Object suppressSelectionEventDelivery(Object freeze)`
  Selection Logic (items)
  Parameters:

    `freeze` |  |

  Return:
    `Object`

### _unclipItem

`private Object _unclipItem(Object item)`
  scroll the view port to make sure that the an item is visible into the viewport
  Parameters:

    `item` |  |

  Return:
    `Object`

### _unhideListViewScrollbar

`private Object _unhideListViewScrollbar(Object rootElement)`
  Parameters:

    `rootElement` |  |

  Return:
    `Object`

### _updateLVSelectionState

`private Object _updateLVSelectionState(Object state)`
  Parameters:

    `state` |  |

  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.