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

## 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.adfinternal.view.js.laf.dhtml.rich.subids.AdfDhtmlCommandNavigationItemPeer
             |
             +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlCommandTrainStopPeer

    public class AdfDhtmlCommandTrainStopPeer
    extends AdfDhtmlCommandNavigationItemPeer

## Field Summary

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

## Constructor Summary
`public` | `AdfDhtmlCommandTrainStopPeer()`

## Method Summary
`protected Object` | `GetBestMatchSubId(Object domElement)` Returns the best match subId for the given domElement.
`protected Object` | `GetComponentSelected(Object component, Object domElement)` Optimized getter for selected property
`protected Object` | `GetComponentText(Object component, Object domElement)` Optimized getter for text property
`protected HTMLElement` | `GetSubIdDomElement(String subElementId)` Get the DOM element of a train stop for the given sub-id
`protected Object` | `HandleComponentClick(Object componentEvent)`
`protected Object` | `InitDomElement(AdfUIComponent component, HTMLElement domElement)` Initialize the associated domElement when the peer is created.
`protected static Object` | `InitSubclass()`
`private Object` | `_isSelected()` To check if the commandNavigationItem is displayed selected.
`private static Object` | `_isTrain(Object component)` Returns true for Train, false for TrainButtonBar
`private static Object` | `_isVerticalTrain(Object component)` Returns true for vertical train layout, false for horizontal layout Note - Ensure the component passed is not TrainButtonBar
`protected Object` | `SetLinkAttributes(Object component, Object domElement)`

## Field Detail

## Constructor Detail

### AdfDhtmlCommandTrainStopPeer

`public AdfDhtmlCommandTrainStopPeer()`

## Method Detail

### GetBestMatchSubId

`protected Object GetBestMatchSubId(Object domElement)`
  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:

    `domElement` |  |

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

### GetComponentSelected

`protected Object GetComponentSelected(Object component,
Object domElement)`
  Optimized getter for selected property
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### GetComponentText

`protected Object GetComponentText(Object component,
Object domElement)`
  Optimized getter for text property
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`

### GetSubIdDomElement

`protected HTMLElement GetSubIdDomElement(String subElementId)`
  Get the DOM element of a train stop for the given sub-id
  Parameters:

    `subElementId` | - | the ID of the sub element

  Return:
    `HTMLElement` - the element or null if not found
  Overrides:
    `AdfDhtmlCommandNavigationItemPeer.GetSubIdDomElement(String)`

### HandleComponentClick

`protected Object HandleComponentClick(Object componentEvent)`
  Parameters:

    `componentEvent` |  |

  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`

### InitSubclass

`protected static Object InitSubclass()`
  Return:
    `Object`

### _isSelected

`private Object _isSelected()`
  To check if the commandNavigationItem is displayed selected.
  Return:
    `Object`

### _isTrain

`private static Object _isTrain(Object component)`
  Returns true for Train, false for TrainButtonBar
  Parameters:

    `component` |  |

  Return:
    `Object`

### _isVerticalTrain

`private static Object _isVerticalTrain(Object component)`
  Returns true for vertical train layout, false for horizontal layout Note - Ensure the component passed is not TrainButtonBar
  Parameters:

    `component` |  |

  Return:
    `Object`

### SetLinkAttributes

`protected Object SetLinkAttributes(Object component,
Object domElement)`
  Parameters:

    `component` |  |
    `domElement` |  |

  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.