JavaScript API Reference for Oracle ADF Faces

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

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

public class AdfDhtmlNavigationPanePeer
extends AdfRichUIPeer

_BAR_HINT

private static Object _BAR_HINT

_CHOICE_BUTTON_ID

private static Object _CHOICE_BUTTON_ID

_CHOICE_DATA_CONTAINER_ID

private static Object _CHOICE_DATA_CONTAINER_ID

_compressedLayoutMode

private static Object _compressedLayoutMode

_ELLIPSIS_SUBID

private static Object _ELLIPSIS_SUBID

_isScreenReaderMode

private Object _isScreenReaderMode

_POPUP_CLOSED_TIME

private static Object _POPUP_CLOSED_TIME

_POPUP_ID

private static Object _POPUP_ID

_POPUP_PANEL_ID

private static Object _POPUP_PANEL_ID

_stretchedOnLastResize

private Object _stretchedOnLastResize

_SUB_ID_MAP

private static Object _SUB_ID_MAP

navigationPane component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [choice_dropdown --> _afrChoiceButton] - dropdown icon for navigationPane hint=choice 2. [end_overflow_indicator --> eoi] - end overflow indicator for hint=tabs and hint=bar 3. [start_overflow_indicator --> soi] - start overflow indicator for hint=tabs and hint=bar 4. [start_conveyor_belt_indicator --> scbi] - start conveyor belt indicator for hint=tabs 5. [end_conveyor_belt_indicator --> ecbi] - end conveyor belt indicator for hint=tabs 6. [conveyor_belt_droplist_indicator --> cbdli] - conveyor belt droplist indicator for hint=tabs

_TAB_CONTENT

private static Object _TAB_CONTENT

_TAB_CONTENT_DIV

private static Object _TAB_CONTENT_DIV

_TAB_HEADER

private static Object _TAB_HEADER

_TAB_HINT

private static Object _TAB_HINT

AdfDhtmlNavigationPanePeer

public AdfDhtmlNavigationPanePeer()

make AdfDhtmlNavigationPanePeer a subclass of AdfRichUIPeer

_addSeparators

private Object _addSeparators(Object children,
                              Object index,
                              Object afterselect)

This function will add the separator for the hint=bar

Parameters:

children
index
afterselect

Return:

Object

ComponentRemoved

protected Object ComponentRemoved(Object component)

Handles the removal of a component.

Parameters:

component

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 component id and append the index in the format componentId[index] else skip the first id fragment after the component 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
index

Return:

String - the client id fragment in the format: clientId + ":" + stamped index

Overrides:

AdfUIPeer.convertLocatorToClientId(Object, Object)

_createBarOverflowElement

private Object _createBarOverflowElement(Object element)

This function will create the overfow elements for hint=bar

Parameters:

element

Return:

Object

_createTabCompressedLayoutPopupElement

private DOMElement _createTabCompressedLayoutPopupElement(DOMElement element)

Create a compressed layout popup element to be used in either conveyor belt or overflow popup when hint=tabs.

Parameters:

element

-

the child element

Return:

DOMElement - compressed layout popup element

_getActiveChildIndex

private Object _getActiveChildIndex(Object children)

This function will return the active child index or 0 if no active child is there for hint=bar

Parameters:

children

Return:

Object

_getChildElements

private Array _getChildElements(String containerId,
                                ADFDomElement childContainer)

Retrieve valid child elements for the provided container.

Parameters:

containerId	-	the ID for the tab container
childContainer	-	the container of the children

Return:

Array - array of child elements

_getChoiceDropDownElement

private Object _getChoiceDropDownElement(Object component)

This method returns the dom element for the dropdown for hint=choice

Parameters:

component

Return:

Object - the DOM element of the drop down icon

_getEllipsisElement

private HTMLElement _getEllipsisElement(Object child)

get the ellipsis DIV element

Parameters:

child

-

(HTMLElement) current tab instance

Return:

HTMLElement - the ellipsis element

GetPopupAlignmentNode

protected Object GetPopupAlignmentNode(Object component,
                                       Object rootNode)

Returns the node for which to aling the note help window

Parameters:

component
rootNode

Return:

Object

_getPopupContentDom

private Object _getPopupContentDom(Object component)

Parameters:

component

Return:

Object

GetSubIdDomElement

protected HTMLElement GetSubIdDomElement(String subElementId)

Returns the dom element for a given subElementId for navigationPane.

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)

_getTabContentElement

private HTMLElement _getTabContentElement(Object child)

get the tab's middle DIV

Parameters:

child

-

(HTMLElement) current tab instance

Return:

HTMLElement - the tab center DIV element

_getTabConveyorBeltSupport

private Class _getTabConveyorBeltSupport(String containerId,
                                         Array children)

Create and return conveyor belt support.

Parameters:

containerId	-	the id for the conveyor belt container
children	-	children to be managed by the conveyor belt

Return:

Class - the conveyor belt support class

_getTabOverflowDroplistSupport

private Class _getTabOverflowDroplistSupport(String subId,
                                             Array children)

Create and return tab overflow droplist support.

Parameters:

subId	-	the id for the overflow container
children	-	children to be managed in overflow

Return:

Class - the overflow support class

_getTabOverflowSupport

private Class _getTabOverflowSupport(String subId,
                                     Array children)

Create and return tab overflow support.

Parameters:

subId	-	the id for the overflow container
children	-	children to be managed in overflow

Return:

Class - the overflow support class

_getTabTextElement

private HTMLElement _getTabTextElement(Object child)

get the icon-and-text DIV element

Parameters:

child

-

(HTMLElement) current tab instance

Return:

HTMLElement - the icon-and-text element

HandleComponentClick

protected Object HandleComponentClick(Object componentEvent)

Eat events to prevent button press causing form submit

Parameters:

componentEvent

Return:

Object

HandleComponentKeyDown

protected Object HandleComponentKeyDown(Object componentEvent)

component key down event handler.

Parameters:

componentEvent

-

the component event invoked by key down

Return:

Object

HandleComponentKeyUp

protected Object HandleComponentKeyUp(Object componentEvent)

Parameters:

componentEvent

-

Key Up event Implements keyboard handling for the peer, e.g. Esc cancels the dialog

Return:

Object

HandleComponentMouseDown

protected Object HandleComponentMouseDown(Object componentEvent)

component mouse over event handler.

Parameters:

componentEvent

-

the component event invoked by mouse over

Return:

Object

HandleComponentMouseOver

protected Object HandleComponentMouseOver(Object componentEvent)

This will be required to focus the choice item in the list when mouse will be over the item to move the focus to that item.

Parameters:

componentEvent

-

the component event invoked by mouse over

Return:

Object

_handleNavItemClick

private Object _handleNavItemClick(Object event)

This function will handle the Tab Click Event

Parameters:

event

Return:

Object

_handleRemoveButtonClick

private Object _handleRemoveButtonClick(Object event)

This function will handle remove button click event (from overflow)

Parameters:

event

-

the event

Return:

Object

_hideOverflow

private Object _hideOverflow()

Return:

Object

InitDomElement

protected Object InitDomElement(Object component,
                                Object domElement)

Initialize dom element

Parameters:

component
domElement

Return:

Object

Overrides:

AdfRichUIPeer.InitDomElement(AdfUIComponent, Object)

InitSubclass

protected static Object InitSubclass()

Initialize the peer class & event handlers

Return:

Object

_isLayoutCompressed

private Boolean _isLayoutCompressed(String layoutId)

Returns true if this is the layout is compressed

Parameters:

layoutId

-

the id of the potentially compressible layout element

Return:

Boolean - true if the layout is compressed

_layoutTabs

private Object _layoutTabs(Object oldWidth,
                           Object newWidth,
                           Object containerId,
                           Object children,
                           Object above)

truncate or stretch the tab text based on current tab size

Parameters:

oldWidth	-	previous width, ok if null
newWidth	-	current tab bar width
containerId
children	-	current tab collection
above

Return:

Object

needsResizeNotify

public Object needsResizeNotify(Object component)

Override to indicate interest in resize notifications

Parameters:

component

Return:

Object

Overrides:

AdfUIPeer.needsResizeNotify(Object)

PopupClosed

protected Object PopupClosed(Object component,
                             Object contentDom,
                             Object popupId)

Call back method called when the popup choice list is closed. This is used to do clean up after close

Parameters:

component
contentDom
popupId

Return:

Object

Overrides:

AdfRichUIPeer.PopupClosed(AdfUIComponent, HTMLElement, String)

_removeCompressedLayoutSupport

private Object _removeCompressedLayoutSupport()

Remove compreseed layout support

Return:

Object

ResizeNotify

protected void ResizeNotify(Number oldWidth,
                            Number oldHeight,
                            Number newWidth,
                            Number newHeight)

Resize notification callback - we perform geometry management here

Parameters:

oldWidth	-	the last known width
oldHeight	-	the last known height
newWidth	-	the new width
newHeight	-	the new height

Return:

void - null

Overrides:

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

_resizeOverflow

private Object _resizeOverflow(Object containerId,
                               Object children,
                               Object width)

Parameters:

containerId
children
width

Return:

Object

_resizeTabHeader

private void _resizeTabHeader(Number oldWidth,
                              Number newWidth)

Resize the tab header

Parameters:

oldWidth	-	the last known width
newWidth	-	the new width

Return:

void - null

_resizeTabsWithCompressedLayout

private void _resizeTabsWithCompressedLayout(Number oldWidth,
                                             Number newWidth,
                                             Object compressedLayoutSupport,
                                             Array children,
                                             Boolean tabsTruncate,
                                             DOMElement layoutContainer)

Resize tabs with compressed layout (either overflow or conveyor belt).

Parameters:

oldWidth	-	the last known width
newWidth	-	the new width
compressedLayoutSupport	-	A layout manager supporting compressed layout (overflow or conveyor belt)
children	-	array of child elements
tabsTruncate	-	if true, tab size truncates
layoutContainer	-	layout container

Return:

void - null

__saveAndRemoveCompressedLayout

Object __saveAndRemoveCompressedLayout()

If conveyor belt is used, saves off the conveyor belt first item. Then removes compressed layout support so it can be reinitialized. Method is called by child commandNavigationItem when there is a new selection.

Return:

Object

_setTabSizes

private Object _setTabSizes(Object children,
                            Object desiredTabWidth,
                            Object isOutterWidth)

Parameters:

children
desiredTabWidth
isOutterWidth

Return:

Object

_showChoicePopupPanel

private Object _showChoicePopupPanel(Object component)

This method displays the popup choice list for hint=choice

Parameters:

component

Return:

Object

_updateOverflow

private Object _updateOverflow(Object newWidth)

Parameters:

newWidth

Return:

Object