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

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

    public class AdfDhtmlTrainV2Peer
    extends AdfRichUIPeer

Stateless peer Implementation for the new Alta v1.1 version of Train.

## Field Summary
`private static Object` | `_JOIN_ANIMATION_STYLE_CLASS`
`private static Object` | `_JOIN_FILL_CLASS`
`private static Object` | `_JOIN_WRAPPER_CLASS`
`private static Object` | `_NODE_STAMP_ID`
`private static Object` | `_STOP_CONTAINER_ID`
`private static Object` | `_STOP_MIN_WIDTH`
`private static Object` | `_V_JOIN_ANIMATION_STYLE_CLASS`
`private static Object` | `_V_JOIN_FILL_CLASS`
`private static Object` | `_V_JOIN_WRAPPER_CLASS`
`private static Object` | `_V_STOPS_CLASS`

### 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` | `AdfDhtmlTrainV2Peer()` Stateless peer Implementation for the new Alta v1.1 version of Train.

## Method Summary
`protected Object` | `ConvertClientIdToLocator(AdfUIComponent component, Object childComponent, String descComponentClientId, Array<Array<Object>> replaceArray)` Function to replace client id fragments when converting a clientId to an absolute locator.
`public String` | `convertLocatorToClientId(AdfUIComponent component, Number index)` Function to replace client id fragments when converting an absolute locator to clientId.
`static Object` | `__fillJoins(Object fillLength, Object joinPadding, Object isVertical)`
`private static Object` | `_fillJoinsHorizontal(Object fillWidth, Object joinPadding)`
`private static Object` | `_fillJoinsVertical(Object fillHeight, Object joinPadding)`
`protected Object` | `GetBestMatchSubId(Object domElement)` Returns the best match subId for the given domElement.
`protected HTMLElement` | `GetSubIdDomElement(Object locator)` Train peer handles the stop subids only in case of implicit nodeStamp facet.
`protected Object` | `InitDomElement(Object component, Object domElement)` Initialize the associated domElement when the peer is created.
`protected static Object` | `InitSubclass()` Initialize constants used by the peer.
`static Object` | `__saveJoinHeight(Object component)` Sync current joinHeight on client with server.
`static Object` | `__saveJoinWidth(Object component)` Sync current joinWidth on client with server.
`private static Object` | `_setMinWidth(Object component, Object domElement, Object stopsContainerId)`

### 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, ComponentRemoved, ComponentStyleClassChanged, ComponentVisibleChanged, createComponentEvent, CreateComponentEvent, CreateDraggableNode, createInnerPeerClassWithSubId, createPeerClass, createSubId, DefaultInitClass, descendantMessageChanged, DescendantMessageChanged, DispatchComponentEvent, DispatchUncanceledComponentEvent, domReplaceNotify, 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, ReplaceDomElement, resizeNotify, ResizeNotify, scrollIntoView, ScrollIntoView, setBusy, SetBusy, setInlineStyleProperty, showContextMenu, showPopup, simulateMouse, SimulateMouseOnDescendant, TruncateClientId, TruncateClientIdOnceImpl, UnbindFromComponent, unregisterKeyStroke, UpdateMessageType, visitChildren`

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

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

## Field Detail

### _JOIN_ANIMATION_STYLE_CLASS

`private static Object _JOIN_ANIMATION_STYLE_CLASS`

### _JOIN_FILL_CLASS

`private static Object _JOIN_FILL_CLASS`

### _JOIN_WRAPPER_CLASS

`private static Object _JOIN_WRAPPER_CLASS`

### _NODE_STAMP_ID

`private static Object _NODE_STAMP_ID`

### _STOP_CONTAINER_ID

`private static Object _STOP_CONTAINER_ID`

### _STOP_MIN_WIDTH

`private static Object _STOP_MIN_WIDTH`

### _V_JOIN_ANIMATION_STYLE_CLASS

`private static Object _V_JOIN_ANIMATION_STYLE_CLASS`

### _V_JOIN_FILL_CLASS

`private static Object _V_JOIN_FILL_CLASS`

### _V_JOIN_WRAPPER_CLASS

`private static Object _V_JOIN_WRAPPER_CLASS`

### _V_STOPS_CLASS

`private static Object _V_STOPS_CLASS`

## Constructor Detail

### AdfDhtmlTrainV2Peer

`public AdfDhtmlTrainV2Peer()`
  Stateless peer Implementation for the new Alta v1.1 version of Train.

## Method Detail

### ConvertClientIdToLocator

`protected Object ConvertClientIdToLocator(AdfUIComponent component,
Object childComponent,
String descComponentClientId,
Array<Array<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 the index exists, skip the first id fragment after the train id and append the index in the format trainId[index] else skip the first id fragment after the train id.

  The peer is not bound when this method is called

  Parameters:

    `component` | - | The train 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(AdfUIComponent component,
Number index)`
  Function to replace client id fragments when converting an absolute locator to clientId.
  Parameters:

    `component` | - | The train component for this peer
    `index` | - | the index of the train stop

  Return:
    `String` - the client id fragment in the format: clientId + ":" + stamped index
  Overrides:
    `AdfUIPeer.convertLocatorToClientId(Object, Object)`

### __fillJoins

`static Object __fillJoins(Object fillLength,
Object joinPadding,
Object isVertical)`
  Parameters:

    `fillLength` |  |
    `joinPadding` |  |
    `isVertical` |  |

  Return:
    `Object`

### _fillJoinsHorizontal

`private static Object _fillJoinsHorizontal(Object fillWidth,
Object joinPadding)`
  Parameters:

    `fillWidth` |  |
    `joinPadding` |  |

  Return:
    `Object`

### _fillJoinsVertical

`private static Object _fillJoinsVertical(Object fillHeight,
Object joinPadding)`
  Parameters:

    `fillHeight` |  |
    `joinPadding` |  |

  Return:
    `Object`

### GetBestMatchSubId

`protected Object GetBestMatchSubId(Object domElement)`
  Returns the best match subId for the given domElement. This impl of GetBestMatchSubId gets called only in case of implicit nodeStamp facet. WARNING - You must make sure to bind the component to the peer before calling this function.
  Parameters:

    `domElement` |  |

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

### GetSubIdDomElement

`protected HTMLElement GetSubIdDomElement(Object locator)`
  Train peer handles the stop subids only in case of implicit nodeStamp facet. Get the DOM element of a train stop for the given sub-id
  Parameters:

    `locator` |  |

  Return:
    `HTMLElement` - the element or null if not found
  Overrides:
    `AdfRichUIPeer.getSubIdDomElement(Object, 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` | - | Component that this peer will be associated with.
    `domElement` | - | Root DOM element of this peer.

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

### InitSubclass

`protected static Object InitSubclass()`
  Initialize constants used by the peer.
  Return:
    `Object`

### __saveJoinHeight

`static Object __saveJoinHeight(Object component)`
  Sync current joinHeight on client with server. This is required to ensure animation draws starting from previous height and not from the start.
  Parameters:

    `component` |  |

  Return:
    `Object`

### __saveJoinWidth

`static Object __saveJoinWidth(Object component)`
  Sync current joinWidth on client with server. This is required to ensure animation draws starting from previous width and not from the start.
  Parameters:

    `component` |  |

  Return:
    `Object`

### _setMinWidth

`private static Object _setMinWidth(Object component,
Object domElement,
Object stopsContainerId)`
  Parameters:

    `component` |  |
    `domElement` |  |
    `stopsContainerId` |  |

  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.