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

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

Direct Known Subclasses:
  AdfDhtmlCommandTrainStopPeer, AdfDhtmlCommandTrainV2StopPeer

    public class AdfDhtmlCommandNavigationItemPeer
    extends AdfRichUIPeer

## Field Summary
`private static Object` | `_HIGHLIGHTED_STYLE_CLASS`
`private static Object` | `_REMOVE_ICON_ID`
`private static Object` | `_TAB_ANCHOR_ID`

### 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` | `AdfDhtmlCommandNavigationItemPeer()`

## Method Summary
`public Object` | `canRemove()` Returns true if this item can be removed
`protected Object` | `ComponentTextChanged(Object component, Object domElement, Object newValue, Object oldValue)`
`protected Object` | `GetAccessibleName()` Returns a human readable name for the component.
`protected Object` | `GetComponentText(Object component, Object domElement)` Optimized getter for text property
`public static Object` | `getInlineEditableTextElement(Object component, Object domElement)`
`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.
`protected Object` | `HandleComponentBlur(Object componentEvent)` Handle component blur.
`protected Object` | `HandleComponentClick(Object componentEvent)` Ignore clicks when either the component is marked disabled or if they are made with a right-click.
`protected Object` | `HandleComponentFocus(Object componentEvent)` Handle component focus.
`protected Object` | `HandleComponentKeyUp(Object componentEvent)` Component keyboard key up event handler.
`protected Object` | `HandleComponentMouseOver(Object componentEvent)` If the commandNavigationItem is disabled or is located on a disabled MenuBar, dont open the popup on mouse over.
`private Object` | `_handleTabFocusOrBlur(Object componentEvent, Object isFocus)` Handle component focus or blur.
`protected Object` | `InitDomElement(Object component, Object domElement)` Initialize the associated domElement when the peer is created.
`protected static Object` | `InitSubclass()` Static function to perform their subclass-specific initialization.
`private Object` | `_isDisabled()` To check if the commandNavigationItem is displayed disabled.
`private Object` | `_isOnRemoveButton(Object componentEvent)` See if the event is on the remove button.
`private Object` | `_saveAndRemoveCompressedLayout()` If conveyor belt is used by parent navPane, saves off the conveyor belt first item.

### 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, ConvertClientIdToLocator, convertLocatorToClientId, createComponentEvent, CreateComponentEvent, CreateDraggableNode, createInnerPeerClassWithSubId, createPeerClass, createSubId, DefaultInitClass, descendantMessageChanged, DescendantMessageChanged, DispatchComponentEvent, DispatchUncanceledComponentEvent, domReplaceNotify, DomReplaceNotify, focus, Focus, getAbsoluteId, getAbsoluteLocator, getAccessibleName, getAllPopups, GetBestMatchSubId, 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, getInlineStyleProperty, getLocatorByDomElement, getPagePosition, getPopupWindow, getReadyState, GetReadyState, GetRichResourceURL, getSubIdDomElement, 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

### _HIGHLIGHTED_STYLE_CLASS

`private static Object _HIGHLIGHTED_STYLE_CLASS`

### _REMOVE_ICON_ID

`private static Object _REMOVE_ICON_ID`

### _TAB_ANCHOR_ID

`private static Object _TAB_ANCHOR_ID`

## Constructor Detail

### AdfDhtmlCommandNavigationItemPeer

`public AdfDhtmlCommandNavigationItemPeer()`

## Method Detail

### 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)`

### 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)`

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

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.