JavaScript API Reference for Oracle ADF Faces

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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

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

public class AdfDhtmlTrainPeer
extends AdfRichUIPeer

Peer Implementation for the train - AdfDhtmlTrainPeer derives from AdfRichUIPeer

Field Summary

private Object	_isScreenReaderMode
private Object	_isVertical
private static Object	_OVERFLOW_ELEMENT_STYLE_CLASS
private static Object	_SELECTED_STOP_STATE

Fields inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer

addComponentPropertyChanges, addComponentPropertyGetters, BUSY_STYLECLASS, DISABLED_STYLECLASS, DRAG_SOURCE_STYLECLASS, DROP_TARGET_STYLECLASS, FOCUS_TARGET_STYLECLASS, HOVER_TARGET_STYLECLASS, READONLY_STYLECLASS

Fields inherited from oracle.adf.view.js.base.AdfObject

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Constructor Summary

public

AdfDhtmlTrainPeer() Peer Implementation for the train - AdfDhtmlTrainPeer derives from AdfRichUIPeer

Method Summary

private Object	_addJoin(Object element, Object isStart)
private Object	_addJoins(Object index)
protected Object	ComponentRemoved(Object component) Handles the removal of a component.
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 index) Function to replace client id fragments when converting an absolute locator to clientId.
private Object	_createOverflowElement(Object element)
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.
private Object	_getTextElement(Object element)
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.
public Object	needsResizeNotify() Tests whether the peer requires resize notification.
public Object	resizeNotify(Object component, Object oldWidth, Object oldHeight, Object newWidth, Object newHeight) Called to notify the peer of resize activity.
private Object	_trainClick(Object event)

Methods inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer

addComponentEventHandlers, addComponentPropertyChanges, addComponentPropertyGetters, addDomEventHandlers, addEventHandlerToDomInstance, addSuppressedPPRAttributes, bind, BindToComponent, cancelAllPopups, cancelPopup, ChildVisibilityChanged, ComponentInlineStyleChanged, ComponentPropertyChanged, componentRemoved, ComponentStyleClassChanged, ComponentVisibleChanged, CreateDraggableNode, createPeerClass, createSubId, CreateSubId, DefaultInitClass, DispatchComponentEvent, 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, getDragOverFeedback, GetDragOverFeedback, getDragTransferable, GetDragTransferable, getFirstAncestorComponent, getInlineEditor, GetInlineEditor, getInlineStyleProperty, getLocatorByDomElement, getPagePosition, getPopupWindow, getReadyState, GetReadyState, GetRichResourceURL, getSubIdDomElement, GetSubIdDomElement, hideAllPopups, hidePopup, Init, InitClass, initialize, isActive, isInActiveHeirarchy, isPopupVisible, messageNotify, MessageNotify, messageShow, MessageShow, needsChildVisibilityChanges, PopupClosed, processPushData, ProcessPushData, registerKeyStroke, replaceDomElement, ReplaceDomElement, ResizeNotify, scrollIntoView, ScrollIntoView, setBusy, SetBusy, setInlineStyleProperty, showContextMenu, showPopup, TruncateClientId, TruncateClientIdOnceImpl, UnbindFromComponent, unregisterKeyStroke, visitChildren

Methods inherited from oracle.adf.view.js.base.AdfUIPeer

getDefaultDragRecognizer, getParentPeer, initiateDrag, isVisible

Methods inherited from oracle.adf.view.js.base.AdfObject

adopt, clone, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, getClass, GetLazyArrayProperty, GetLazyMapProperty, getTypeName, toDebugString, toString

Field Detail

_isScreenReaderMode

private Object _isScreenReaderMode

_isVertical

private Object _isVertical

_OVERFLOW_ELEMENT_STYLE_CLASS

private static Object _OVERFLOW_ELEMENT_STYLE_CLASS

_SELECTED_STOP_STATE

private static Object _SELECTED_STOP_STATE

Constructor Detail

AdfDhtmlTrainPeer

public AdfDhtmlTrainPeer()

Peer Implementation for the train - AdfDhtmlTrainPeer derives from AdfRichUIPeer

Method Detail

_addJoin

private Object _addJoin(Object element,
Object isStart)

Parameters:

element
isStart

Return:

Object

_addJoins

private Object _addJoins(Object index)

Parameters:

index

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(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 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	-	{AdfUIComponent} The train component for this peer
childComponent
descComponentClientId	-	{String} The clientId of the component that the absolute scoped id is being generated for
replaceArray	-	{Array<Array

Return:

Object

Overrides:

AdfRichUIPeer.ConvertClientIdToLocator(Object, Object, Object, Object)

convertLocatorToClientId

public String convertLocatorToClientId(Object component,
Object index)

Function to replace client id fragments when converting an absolute locator to clientId.

Parameters:

component	-	{AdfUIComponent} The train component for this peer
index	-	{Number} 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 Object _createOverflowElement(Object element)

Parameters:

element

Return:

Object

_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 Object _getTextElement(Object element)

Parameters:

element

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

needsResizeNotify

public Object needsResizeNotify()

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.

Return:

Object

Overrides:

AdfUIPeer.needsResizeNotify(Object)

resizeNotify

public Object resizeNotify(Object component,
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:

component
oldWidth
oldHeight
newWidth
newHeight

Return:

Object

Overrides:

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

_trainClick

private Object _trainClick(Object event)

Parameters:

event

Return:

Object

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD