JavaScript API Reference for Oracle ADF Faces

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

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

Direct Known Subclasses:

AdfDhtmlPanelDrawerPeer

public class AdfDhtmlPanelTabbedPeer
extends AdfRichUIPeer

_ANCHOR_SUB_ID_ABOVE

private static Object _ANCHOR_SUB_ID_ABOVE

_ANCHOR_SUB_ID_BELOW

private static Object _ANCHOR_SUB_ID_BELOW

_ANCHOR_SUB_ID_BELOW_LENGTH

private static Object _ANCHOR_SUB_ID_BELOW_LENGTH

_bodyInnerDiv

private Object _bodyInnerDiv

_bodyOuterDiv

private Object _bodyOuterDiv

_compressedLayoutMode

private static Object _compressedLayoutMode

_ELLIPSIS_SUBID

private static Object _ELLIPSIS_SUBID

_EXPANDO_COMPRESSED_LAYOUT_LINK

private static Object _EXPANDO_COMPRESSED_LAYOUT_LINK

_EXPANDO_DISCLOSED_TAB_ID

private static Object _EXPANDO_DISCLOSED_TAB_ID

_EXPANDO_ROWKEY_ATTRIBUTE

private static Object _EXPANDO_ROWKEY_ATTRIBUTE

_footerDiv

private Object _footerDiv

_footerTabsDiv

private Object _footerTabsDiv

_headerDiv

private Object _headerDiv

_headerTabsDiv

private Object _headerTabsDiv

_HIGHLIGHTED_STYLE_CLASS

private static Object _HIGHLIGHTED_STYLE_CLASS

_INVERTED_POSITION_MAP

private static Object _INVERTED_POSITION_MAP

_REMOVE_ICON_ABOVE_ID

private static Object _REMOVE_ICON_ABOVE_ID

_REMOVE_ICON_BELOW_ID

private static Object _REMOVE_ICON_BELOW_ID

_stretchedOnLastResize

private Object _stretchedOnLastResize

_TAB_BODY_INNER

private static Object _TAB_BODY_INNER

_TAB_BODY_OUTER

private static Object _TAB_BODY_OUTER

_TAB_CONTENT

private static Object _TAB_CONTENT

_TAB_FOOTER

private static Object _TAB_FOOTER

_TAB_HEADER

private static Object _TAB_HEADER

TAB_SUB_ID_ABOVE

public static Object TAB_SUB_ID_ABOVE

TAB_SUB_ID_BELOW

public static Object TAB_SUB_ID_BELOW

TAB_SUB_ID_ICON

public static Object TAB_SUB_ID_ICON

TAB_SUB_ID_ICON_BELOW

public static Object TAB_SUB_ID_ICON_BELOW

_TAB_VERTICAL

private static Object _TAB_VERTICAL

_vertDiv

private Object _vertDiv

AdfDhtmlPanelTabbedPeer

public AdfDhtmlPanelTabbedPeer()

BindToComponent

protected Object BindToComponent(AdfUIComponent component,
                                 HTMLElement rootElement)

Binds the component to this peer instance.

Parameters:

component	-	the component to bind
rootElement	-	the root DOM element of this peer

Return:

Object

Overrides:

AdfRichUIPeer.BindToComponent(Object, Object)

_canRemove

private Object _canRemove(Object childId)

Returns true if this item can be removed

Parameters:

childId

Return:

Object

_changeSelected

private Object _changeSelected(Object child,
                               String tabClientId,
                               String subId,
                               Object iconSubid,
                               Boolean isSelected)

Sets/Resets the selected state of the specified above/below tab inside this panelTabbed.

Parameters:

child
tabClientId	-	the client id of the showDetailItem component
subId	-	the subId part of the tab
iconSubid
isSelected	-	if the tab is now in a a selected state

Return:

Object

ComponentRemoved

protected Object ComponentRemoved(Object component)

Handles the removal of a component.

Parameters:

component

Return:

Object

Overrides:

AdfUIPeer.componentRemoved(AdfUIComponent)

_createCompressedLayoutPopupElement

private DOMElement _createCompressedLayoutPopupElement(DOMElement element)

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

Parameters:

element

-

the child element

Return:

DOMElement - compressed layout popup element

_displayIcon

private Object _displayIcon(Object target,
                            Object component,
                            Object icon)

Parameters:

target
component
icon

Return:

Object

_findChildFromSubId

private Object _findChildFromSubId(Object target,
                                   Object subId1,
                                   Object subId2)

Parameters:

target
subId1
subId2

Return:

Object

GetBodyInnerElement

protected Object GetBodyInnerElement()

This is the div the af|panelTabbed::body skin selector is on, this should have any visible borders on it.

Return:

Object

GetBodyOuterElement

protected Object GetBodyOuterElement()

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

_getChildren

private Object _getChildren()

Find child ShowDetailItem components by ID

Return:

Object

getContainerId

public Object getContainerId(Object aligningElement)

Parameters:

aligningElement

Return:

Object

_getConveyorBeltSupport

private Class _getConveyorBeltSupport(String containerId,
                                      Array children,
                                      Object availableWidth)

Create and return conveyor belt support.

Parameters:

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

Return:

Class - the conveyor belt support class

_getCurrencyFromDomElement

private Object _getCurrencyFromDomElement(Object domElement,
                                          Object rootDomElement)

Returns the row key attribute attached to the domElement. If necessary, walks up the dom hierarchy to find the element with the rowKey attribute

Parameters:

domElement
rootDomElement

Return:

Object

_getEllipsisElement

private HTMLElement _getEllipsisElement(Object child)

get the ellipsis DIV element

Parameters:

child

-

(HTMLElement) current tab instance

Return:

HTMLElement - the ellipsis element

GetOldDisclosedChild

protected Object GetOldDisclosedChild(Object component)

This saves a reference to the currently disclosed child item

Parameters:

component

Return:

Object

_getOverflowDroplistSupport

private Class _getOverflowDroplistSupport(String containerId,
                                          Array children,
                                          String position)

Create and return overflow droplist support.

Parameters:

containerId	-	the id for the overflow container
children	-	children to be managed by overflow
position	-	position for overflow popup to display in

Return:

Class - the overflow support class

_getOverflowSupport

private Class _getOverflowSupport(String subId,
                                  Array children,
                                  String position)

Create and return overflow support.

Parameters:

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

Return:

Class - the overflow support class

GetRecentTabClientId

protected static String GetRecentTabClientId()

Retrieves the client ID of the most recently disclosed tab pane.

Return:

String - the most recently disclosed tab pane or null

_getRenderingPosition

private Object _getRenderingPosition(Object component)

This is the position of the tabs relative to the showDetailItem content. This is needed to invert the rendered meaning in subclasses.

Parameters:

component

Return:

Object

GetSubIdDomElement

protected Object GetSubIdDomElement(Object subElementId)

Returns the DOM element identified by the passed in subId.

Parameters:

subElementId

Return:

Object - the DOM element

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

GetVertTabsElement

protected Object GetVertTabsElement()

Return:

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)

tab header onclick handler

Parameters:

componentEvent

Return:

Object

HandleComponentFocus

protected Object HandleComponentFocus(Object componentEvent)

Handle component focus.

Parameters:

componentEvent

-

the component event invoked by focus

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

HandleComponentMouseDown

protected Object HandleComponentMouseDown(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentMouseOut

protected Object HandleComponentMouseOut(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentMouseOver

protected Object HandleComponentMouseOver(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentMouseUp

protected Object HandleComponentMouseUp(Object componentEvent)

Parameters:

componentEvent

Return:

Object

_handleConveyorBeltNewSelection

private Object _handleConveyorBeltNewSelection(String newSelectionId)

Get tab index of tab component

Parameters:

newSelectionId

-

id of new selection

Return:

Object

_handleIcon

private Object _handleIcon(Object componentEvent,
                           Object isHover,
                           Object isDepressed)

Parameters:

componentEvent
isHover
isDepressed

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

_hasSubIdInId

private Object _hasSubIdInId(Object target,
                             Object subId1,
                             Object subId2)

Parameters:

target
subId1
subId2

Return:

Object

_hideOverflow

private Object _hideOverflow()

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
domElement

Return:

Object

Overrides:

AdfRichUIPeer.InitDomElement(AdfUIComponent, Object)

InitSubclass

protected static Object InitSubclass()

Return:

Object

IsDisclosedTabRequired

protected Object IsDisclosedTabRequired(Object element)

Parameters:

element

Return:

Object - whether one tab must be disclosed at all times

_isOnRemoveButton

private Object _isOnRemoveButton(Object childId,
                                 Object target)

Sees if the event is in the remove button target.

Parameters:

childId
target

Return:

Object

IsRecentTabOnTheBelowBar

protected static Boolean IsRecentTabOnTheBelowBar()

Retrieves whether the most recently disclosed tab pane was from the lower tab bar or the upper tab bar.

Return:

Boolean - true if lower, false if upper, null if unknown

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

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.

Parameters:

component

Return:

Object

Overrides:

AdfUIPeer.needsResizeNotify(Object)

NewTabSelected

protected Object NewTabSelected(Object component)

Parameters:

component

Return:

Object

QueueClientDisclosureChanges

protected Object QueueClientDisclosureChanges(AdfRichShowDetailItem oldDisclosed,
                                              AdfRichShowDetailItem newDisclosed)

Queues a disclosure event for the case where there is a disclosure counterpart component. (panelTabbed will always deal with disclosure counterpart components.) On client: 1.) Queue the setting of disclosed to false on the previously disclosed panel 2.) If #1 propogates through all listeners and doesn't get cancelled (e.g. from validation) then queue the setting of disclosed to true on the newly disclosed panel On server: 1.) Let the DisclosureEvent for the newly disclosed panel have fun 2.) Queue a DisclosureEvent for the previously disclosed panel(s) to set them to false

Parameters:

oldDisclosed	-	the panel that was disclosed
newDisclosed	-	the panel that the user wants to become disclosed

Return:

Object

_removeCompressedLayoutSupport

private Object _removeCompressedLayoutSupport()

Remove compressed layout support

Return:

Object

_resizeHeaderOrFooterTabs

private Object _resizeHeaderOrFooterTabs(Object headerOrFooterId,
                                         Object oldWidth,
                                         Object newWidth,
                                         Object above)

Parameters:

headerOrFooterId
oldWidth
newWidth
above

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,
                               Object above)

Parameters:

containerId
children
width
above

Return:

Object

_resizeTabs

private void _resizeTabs(Number oldWidth,
                         Number newWidth)

Resize the header

Parameters:

oldWidth	-	the last known width
newWidth	-	the new width

Return:

void - null

_resizeVertTabs

private Object _resizeVertTabs()

if the tabs are initially rendered hidden the offsetWidth of the tabs will be 0, so we need this method called in resizeNotify so that when the tabs are made visible the body left/right can be set based on the offsetWidth of the tabs.

Return:

Object

_saveAndRemoveCompressedLayout

private Object _saveAndRemoveCompressedLayout()

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

Return:

Object

_selectTab

private Object _selectTab(Object target)

Parameters:

target

Return:

Object

_setOldDisclosedChild

private Object _setOldDisclosedChild(Object component,
                                     Object newDisclosedId)

This saves a reference to the currently disclosed child item

Parameters:

component
newDisclosedId

Return:

Object

SetRecentTabInfo

protected static Object SetRecentTabInfo(String clientId,
                                         Boolean onTheBelowBar)

Specifies the client ID of the most recently disclosed tab pane, to gracefully restore state after a new tab selection.

Parameters:

clientId	-	the most recently disclosed tab pane or null
onTheBelowBar	-	true if the tab is on the lower tab bar, false if on the upper tab bar, null if unknown.

Return:

Object

_setTabSizes

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

Parameters:

children
desiredTabWidth
isOutterWidth

Return:

Object

_shouldCompressLayout

private Boolean _shouldCompressLayout(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

TabReselected

protected Object TabReselected(Object component,
                               Object child)

This method is called when the currently disclosed tab is reselected

Parameters:

component
child

Return:

Object

_updateOverflow

private Object _updateOverflow(Object newWidth)

Parameters:

newWidth

Return:

Object

UseInvertedRenderingPosition

protected Object UseInvertedRenderingPosition()

Return:

Object