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

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

    public class AdfDhtmlDeckPeer
    extends AdfRichUIPeer

## Field Summary
`private Object` | `_swipeMgr`

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

## Method Summary
`protected Object` | `ComponentRemoved(AdfUIComponent component)` Hook called when peers are disassociated from their components.
`private static Object` | `_deleteElement(Object root, Object elementToDelete, Object deleteDom, Object deleteObjects)`
`protected Object` | `DescendantMessageChanged(Object component)` Navigation failed because of a validation failure in descendant component.
`protected HTMLElement` | `DomReplaceNotify(HTMLElement domNode)` Overidden to track replacement of DOM children such as with optimized rendering.
`static Object` | `__getBackNavigate(Object component, Object domElement)` Getter for "backNavigate."
`static Object` | `__getChildCount(Object component, Object domElement)` Getter for total child count property
`static Object` | `__getChildIndex(Object domElement)` Getter for index of the displayedChild.
`protected Object` | `GetComponentDisplayedChild(Object component, Object domElement)` Optimized getter for "displayedChild."
`static Object` | `__getForwardNavigate(Object component, Object domElement)` Getter for "forwardNavigate."
`private static Object` | `_getOptimizedDomAttribute(Object attributeName, Object component, Object domElement)`
`private static Object` | `_getReplaceNavigate(Object component, Object domElement)` Getter for "replace" Navigate.
`private static Object` | `_getTransitionType(Object component, Object domElement, Object oldIndex, Object newIndex)`
`protected Object` | `InitDomElement(Object component, Object domElement)` Initialize the associated domElement when the peer is created.
`protected static Object` | `InitSubclass()` Hook to identify which attributes have optimized getters.
`public Object` | `needsResizeNotify(AdfUIComponent component)` Indicates whether this peer has interest in resize notifications.
`private static Object` | `_removeIds(Object element)` removes IDs from an element and its subtree.
`private static Object` | `_replaceChild(Object oldChild, Object newChild)`
`protected Object` | `ReplaceDomElement(HTMLElement newElement, HTMLElement oldElement)` Overridden to perform an optimized replacement of the DOM.
`public Object` | `restoreSwipePanel()` Restore the UI to the original state (pre swipe) a) if the event is canceled by the clientListener registered on the component.
`private Object` | `_statefulOptimizeReplaceFinished(Object oldChild)`
`private static Object` | `_statelessOptimizeReplaceFinished(Object callbackParams)`

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

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

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

### _swipeMgr

`private Object _swipeMgr`

## Constructor Detail

### AdfDhtmlDeckPeer

`public AdfDhtmlDeckPeer()`

## Method Detail

### 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:
    `AdfRichUIPeer.bind(AdfUIComponent)`
    `AdfRichUIPeer.componentRemoved(AdfUIComponent)`
  Overrides:
    `AdfUIPeer.componentRemoved(AdfUIComponent)`

### _deleteElement

`private static Object _deleteElement(Object root,
Object elementToDelete,
Object deleteDom,
Object deleteObjects)`
  Parameters:

    `root` |  |
    `elementToDelete` |  |
    `deleteDom` |  |
    `deleteObjects` |  |

  Return:
    `Object`

### DescendantMessageChanged

`protected Object DescendantMessageChanged(Object component)`
  Navigation failed because of a validation failure in descendant component. Restore the swipe panel state
  Parameters:

    `component` |  |

  Return:
    `Object`
  Overrides:
    `AdfRichUIPeer.descendantMessageChanged(AdfUIComponent)`

### DomReplaceNotify

`protected HTMLElement DomReplaceNotify(HTMLElement domNode)`
  Overidden to track replacement of DOM children such as with optimized rendering.
  Parameters:

    `domNode` | - | the DOM element involved in the replacement

  Return:
    `HTMLElement` - the DOM node which should be the target of a subsequent resize traversal
  Overrides:
    `AdfRichUIPeer.domReplaceNotify(AdfUIComponent, Object)`

### __getBackNavigate

`static Object __getBackNavigate(Object component,
Object domElement)`
  Getter for "backNavigate."
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### __getChildCount

`static Object __getChildCount(Object component,
Object domElement)`
  Getter for total child count property
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### __getChildIndex

`static Object __getChildIndex(Object domElement)`
  Getter for index of the displayedChild. Index is zero based. Returns -1 if there is no child to be displayed.
  Parameters:

    `domElement` |  |

  Return:
    `Object`

### GetComponentDisplayedChild

`protected Object GetComponentDisplayedChild(Object component,
Object domElement)`
  Optimized getter for "displayedChild."
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### __getForwardNavigate

`static Object __getForwardNavigate(Object component,
Object domElement)`
  Getter for "forwardNavigate."
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### _getOptimizedDomAttribute

`private static Object _getOptimizedDomAttribute(Object attributeName,
Object component,
Object domElement)`
  Parameters:

    `attributeName` |  |
    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### _getReplaceNavigate

`private static Object _getReplaceNavigate(Object component,
Object domElement)`
  Getter for "replace" Navigate.
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### _getTransitionType

`private static Object _getTransitionType(Object component,
Object domElement,
Object oldIndex,
Object newIndex)`
  Parameters:

    `component` |  |
    `domElement` |  |
    `oldIndex` |  |
    `newIndex` |  |

  Return:
    `Object`

### InitDomElement

`protected Object InitDomElement(Object 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` |  |
    `domElement` |  |

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

### InitSubclass

`protected static Object InitSubclass()`
  Hook to identify which attributes have optimized getters.
  Return:
    `Object`

### needsResizeNotify

`public Object needsResizeNotify(AdfUIComponent component)`
  Indicates whether this peer has interest in resize notifications.
  Parameters:

    `component` | - | the component bound to this peer

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

### _removeIds

`private static Object _removeIds(Object element)`
  removes IDs from an element and its subtree.
  Parameters:

    `element` |  |

  Return:
    `Object`

### _replaceChild

`private static Object _replaceChild(Object oldChild,
Object newChild)`
  Parameters:

    `oldChild` |  |
    `newChild` |  |

  Return:
    `Object`

### ReplaceDomElement

`protected Object ReplaceDomElement(HTMLElement newElement,
HTMLElement oldElement)`
  Overridden to perform an optimized replacement of the DOM. The dom element may be a child (or descendent).
  Parameters:

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

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

### restoreSwipePanel

`public Object restoreSwipePanel()`
  Restore the UI to the original state (pre swipe) a) if the event is canceled by the clientListener registered on the component. This is invoked from the AdfRichDeck.js file b) Validation failed on the server. See #DescendantMessageChanged method.
  Return:
    `Object`

### _statefulOptimizeReplaceFinished

`private Object _statefulOptimizeReplaceFinished(Object oldChild)`
  Parameters:

    `oldChild` |  |

  Return:
    `Object`

### _statelessOptimizeReplaceFinished

`private static Object _statelessOptimizeReplaceFinished(Object callbackParams)`
  Parameters:

    `callbackParams` |  |

  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.