JavaScript API Reference for Oracle ADF Faces

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

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

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

public class AdfDhtmlPanelTabbedPeer
extends AdfRichUIPeer

Field Summary

private static Object	_ANCHOR_SUB_ID_ABOVE
private static Object	_ANCHOR_SUB_ID_BELOW
private static Object	_ANCHOR_SUB_ID_BELOW_LENGTH
private Object	_bodyDiv
private static Object	_EXPANDO_DISCLOSED_TAB_ID
private static Object	_EXPANDO_OVERFLOW_LINK
private static Object	_EXPANDO_ROWKEY_ATTRIBUTE
private Object	_footerDiv
private Object	_footerOverflowContent
private Object	_headerDiv
private Object	_headerOverflowContent
private static Object	_REMOVE_ICON_ABOVE_ID
private static Object	_REMOVE_ICON_BELOW_ID
private static Object	_TAB_BODY
private static Object	_TAB_FOOTER
private static Object	_TAB_HEADER
public static Object	TAB_SUB_ID_ABOVE
public static Object	TAB_SUB_ID_BELOW

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

addComponentPropertyChanges, addComponentPropertyGetters, BUSY_STYLECLASS, DISABLED_STYLECLASS, DRAG_SOURCE_STYLECLASS, DROP_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

AdfDhtmlPanelTabbedPeer()

Method Summary

protected Object	BindToComponent(AdfUIComponent component, HTMLElement rootElement) Binds the component to this peer instance.
private Object	_canRemove(Object childId) Returns true if this item can be removed
protected Object	ComponentRemoved(Object component) Handles the removal of a component.
private Object	_createOverflowElement(Object element)
private Object	_getChildren() Find child ShowDetailItem components by ID
private Object	_getCurrencyFromDomElement(Object domElement, Object rootDomElement) Returns the row key attribute attached to the domElement.
private Object	_getDisclosedChild() Return the disclosed ShowDetailItem component
private Object	_getOldDisclosedChild(Object component) This saves a reference to the currently disclosed child item
private Object	_getOverflowSupport(Object subId, Object rootElement, Object children, Object position)
protected static String	GetRecentTabClientId() Retrieves the client ID of the most recently disclosed tab pane.
protected Object	HandleComponentClick(Object componentEvent) tab header onclick handler
protected Object	HandleComponentKeyUp(Object componentEvent) Component keyboard key up event handler.
protected Object	InitDomElement(Object component, Object domElement) Initialize the associated domElement when the peer is created.
protected static Object	InitSubclass()
private Object	_isOnRemoveButton(Object childId, Object target) Sees if the event is in the remove button target.
protected static Boolean	IsRecentTabOnTheBelowBar() Retrieves whether the most recently disclosed tab pane was from the lower tab bar or the upper tab bar.
public Object	needsResizeNotify(Object component) Tests whether the peer requires resize notification.
private Object	_queueClientDisclosureChanges(AdfRichShowDetailItem oldDisclosed, AdfRichShowDetailItem newDisclosed) Queues a disclosure event for the case where there is a disclosure counterpart component.
protected Object	ResizeNotify(Object oldWidth, Object oldHeight, Object newWidth, Object newHeight) Called to notify the peer of resize activity.
private Object	_selectTab(Object target)
protected static Object	SetRecentTabInfo(String clientId, Boolean onTheBelowBar) Specifies the client ID of the most recently disclosed tab pane.

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

addComponentEventHandlers, addComponentPropertyChanges, addComponentPropertyGetters, addDomEventHandlers, addEventHandlerToDomInstance, addSuppressedPPRAttributes, bind, cancelAllPopups, cancelPopup, ChildVisibilityChanged, ComponentInlineStyleChanged, ComponentPropertyChanged, componentRemoved, ComponentStyleClassChanged, ComponentVisibleChanged, ConvertClientIdToLocator, convertLocatorToClientId, 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, 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

_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

_bodyDiv

private Object _bodyDiv

_EXPANDO_DISCLOSED_TAB_ID

private static Object _EXPANDO_DISCLOSED_TAB_ID

_EXPANDO_OVERFLOW_LINK

private static Object _EXPANDO_OVERFLOW_LINK

_EXPANDO_ROWKEY_ATTRIBUTE

private static Object _EXPANDO_ROWKEY_ATTRIBUTE

_footerDiv

private Object _footerDiv

_footerOverflowContent

private Object _footerOverflowContent

_headerDiv

private Object _headerDiv

_headerOverflowContent

private Object _headerOverflowContent

_REMOVE_ICON_ABOVE_ID

private static Object _REMOVE_ICON_ABOVE_ID

_REMOVE_ICON_BELOW_ID

private static Object _REMOVE_ICON_BELOW_ID

_TAB_BODY

private static Object _TAB_BODY

_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

Constructor Detail

AdfDhtmlPanelTabbedPeer

public AdfDhtmlPanelTabbedPeer()

Method Detail

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

ComponentRemoved

protected Object ComponentRemoved(Object component)

Handles the removal of a component.

Parameters:

component

Return:

Object

Overrides:

AdfUIPeer.componentRemoved(AdfUIComponent)

_createOverflowElement

private Object _createOverflowElement(Object element)

Parameters:

element

Return:

Object

_getChildren

private Object _getChildren()

Find child ShowDetailItem components by ID

Return:

Object

_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

_getDisclosedChild

private Object _getDisclosedChild()

Return the disclosed ShowDetailItem component

Return:

Object

_getOldDisclosedChild

private Object _getOldDisclosedChild(Object component)

This saves a reference to the currently disclosed child item

Parameters:

component

Return:

Object

_getOverflowSupport

private Object _getOverflowSupport(Object subId,
Object rootElement,
Object children,
Object position)

Parameters:

subId
rootElement
children
position

Return:

Object

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

HandleComponentClick

protected Object HandleComponentClick(Object componentEvent)

tab header onclick handler

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

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

_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

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)

_queueClientDisclosureChanges

private 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

ResizeNotify

protected Object ResizeNotify(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:

oldWidth
oldHeight
newWidth
newHeight

Return:

Object

Overrides:

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

_selectTab

private Object _selectTab(Object target)

Parameters:

target

Return:

Object

SetRecentTabInfo

protected static Object SetRecentTabInfo(String clientId,
Boolean onTheBelowBar)

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

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

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