JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.laf.dhtml.rich
Class AdfDhtmlTrainPeer

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.AdfDhtmlTrainPeer

public class AdfDhtmlTrainPeer
extends AdfRichUIPeer

_isVertical

private Object _isVertical

_OVERFLOW_ELEMENT_STYLE_CLASS

private static Object _OVERFLOW_ELEMENT_STYLE_CLASS

_PARENT_END

private static Object _PARENT_END

_PARENT_START

private static Object _PARENT_START

_SELECTED_STOP_STATE

private static Object _SELECTED_STOP_STATE

AdfDhtmlTrainPeer

public AdfDhtmlTrainPeer()

Peer Implementation for the train - AdfDhtmlTrainPeer derives from AdfRichUIPeer

_addJoin

private Object _addJoin(Object element,
                        Object clientId,
                        Object isStart)

adds a join (previous or next join) to an element.

Parameters:

element
clientId	-	of the component
isStart	-	a boolean indicating that it's a start join (iow, the join before the end element)

Return:

Object

_addJoins

private Object _addJoins(Object index,
                         Object clientId)

Add start and end joins for a stop.

Parameters:

index	-	of the current stop.
clientId	-	of the component

Return:

Object

ComponentRemoved

protected Object ComponentRemoved(Object component)

Handles the removal of a component.

Parameters:

component

-

component that this peer will be associated with.

Return:

Object

Overrides:

AdfUIPeer.componentRemoved(AdfUIComponent)

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 [<index>, <item>] 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)

_createOverflowElement

private HTMLElement _createOverflowElement(HTMLElement element)

Creates the overflow element.

Parameters:

element

-

the DOM element representing the stop for which the overflow element is being created.

Return:

HTMLElement - the overflowElement.

_fixTextLinkDivWidth

private Object _fixTextLinkDivWidth()

In Firefox when text link of train stop is clicked, it forces the text/link has focus and a focus ring is drawn around the text which would mean it needs more space. The width of the container div doesn't change accordingly and forces the link text to go into the next row. This function increases the width of the container div as original width + 2*border width (4px).

Return:

Object

_getTextElement

private HTMLElement _getTextElement(Object element)

Gets the text element of the stop.

Parameters:

element

Return:

HTMLElement - the text element.

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

_isElementAParentStop

private static Object _isElementAParentStop(Object element,
                                            Object clientId)

Function to find if the element is a parent stop.

Parameters:

element	-	element to be be checked
clientId	-	client id of the component

Return:

Object

needsResizeNotify

public Object needsResizeNotify()

Override to indicate interest in resize notifications.

Return:

Object

Overrides:

AdfUIPeer.needsResizeNotify(Object)

resizeNotify

public Object resizeNotify(Object component,
                           Object oldWidth,
                           Object oldHeight,
                           Object newWidth,
                           Object newHeight)

Resize notification callback - we perform geometry management here.

Parameters:

component	-	component that this peer will be associated with.
oldWidth	-	old value for the width of the train.
oldHeight	-	old value of the height of the train.
newWidth	-	new Width
newHeight	-	new height

Return:

Object

Overrides:

AdfUIPeer.resizeNotify(Object, Object, Object, Object, Object)

_trainClick

private Object _trainClick(Object event)

Callback for when a stop inside an overflow is clicked.

Parameters:

event

Return:

Object