JavaScript API Reference for Oracle ADF Faces

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

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

Direct Known Subclasses:

AdfDhtmlCommandTrainStopPeer

public class AdfDhtmlCommandNavigationItemPeer
extends AdfRichUIPeer

_HIGHLIGHTED_STYLE_CLASS

private static Object _HIGHLIGHTED_STYLE_CLASS

_REMOVE_ICON_ID

private static Object _REMOVE_ICON_ID

_SUB_ID_MAP

private static Object _SUB_ID_MAP

commandNavigationItem component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [remove_icon --> rmAbv] - the remove button that may be displayed on a commandNavigationItem in a navigationPane hint=tabs 2. [tab_text --> disAcr] - the clickable text displayed on a commandNavigationItem in a navigationPane hint=tabs

_TAB_ANCHOR_ID

private static Object _TAB_ANCHOR_ID

AdfDhtmlCommandNavigationItemPeer

public AdfDhtmlCommandNavigationItemPeer()

canRemove

public Object canRemove()

Returns true if this item can be removed

Return:

Object

ComponentTextChanged

protected Object ComponentTextChanged(Object component,
                                      Object domElement,
                                      Object newValue,
                                      Object oldValue)

Parameters:

component
domElement
newValue
oldValue

Return:

Object

GetAccessibleName

protected Object GetAccessibleName()

Returns a human readable name for the component.

Return:

Object

Overrides:

AdfRichUIPeer.getAccessibleName(Object)

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:

AdfRichUIPeer.GetBestMatchSubId(Object)

GetComponentText

protected Object GetComponentText(Object component,
                                  Object domElement)

Optimized getter for text property

Parameters:

component
domElement

Return:

Object

getInlineEditableTextElement

public static Object getInlineEditableTextElement(Object component,
                                                  Object domElement)

Parameters:

component
domElement

Return:

Object

GetInlineEditor

protected Object GetInlineEditor(Object event)

Given the component this peer is bound to and the optional DOM event to start editing, return the AdfRichInlineEditor for this component at the event location, if any. Subclasses should override GetInlineEditor.

Parameters:

event

Return:

Object

Overrides:

AdfRichUIPeer.getInlineEditor(AdfUIComponent, Object)

GetSubIdDomElement

protected HTMLElement GetSubIdDomElement(String subElementId)

Returns the dom element for a given subElementId for commandNavigationItem.

Parameters:

subElementId

-

the id of the child dom element or component

Return:

HTMLElement - the DOM within the component related to scopedId

Overrides:

AdfRichUIPeer.getSubIdDomElement(Object, Object)

HandleComponentBlur

protected Object HandleComponentBlur(Object componentEvent)

Handle component blur.

Parameters:

componentEvent

-

the component event invoked by blur

Return:

Object

HandleComponentClick

protected Object HandleComponentClick(Object componentEvent)

Ignore clicks when either the component is marked disabled or if they are made with a right-click. If the commandNaviagtionItem is a having valid href, then the click on commandNavigationItem should result in opening the href in the specified target frame. Otherwise the click will get converted into an action event.

Parameters:

componentEvent

Return:

Object

HandleComponentFocus

protected Object HandleComponentFocus(Object componentEvent)

Handle component focus. If the commandNavigationItem is disabled or is located on a disabled MenuBar, don't move focus and don't highlight.

Parameters:

componentEvent

Return:

Object

HandleComponentKeyUp

protected Object HandleComponentKeyUp(Object componentEvent)

Component keyboard key up event handler.

Parameters:

componentEvent

-

the component event invoked by key up

Return:

Object

HandleComponentMouseOver

protected Object HandleComponentMouseOver(Object componentEvent)

If the commandNavigationItem is disabled or is located on a disabled MenuBar, dont open the popup on mouse over.

Parameters:

componentEvent

Return:

Object

_handleTabFocusOrBlur

private Object _handleTabFocusOrBlur(Object componentEvent,
                                     Object isFocus)

Handle component focus or blur.

Parameters:

componentEvent	-	the component event invoked by focus
isFocus

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

Static function to perform their subclass-specific initialization.

Return:

Object

_isDisabled

private Object _isDisabled()

To check if the commandNavigationItem is displayed disabled.

Return:

Object

_isOnRemoveButton

private Object _isOnRemoveButton(Object componentEvent)

See if the event is on the remove button.

Parameters:

componentEvent

Return:

Object - boolean if the event is on the remove button.

_saveAndRemoveCompressedLayout

private Object _saveAndRemoveCompressedLayout()

If conveyor belt is used by parent navPane, saves off the conveyor belt first item. Then removes compressed layout support so it can be reinitialized.

Return:

Object