JavaScript API Reference for Oracle ADF Faces

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

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

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
                           |
                           +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlPanelDrawerPeer

public class AdfDhtmlPanelDrawerPeer
extends AdfDhtmlPanelTabbedPeer

Field Summary

private static Object	_FLOAT_CLASS
private static Object	_OPEN_CLASS
private static Object	_TABS_PARENT
private static Object	_TEMP_FLOAT_SUBID
private static Object	_TRACKER_SUBID

Fields inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlPanelTabbedPeer

TAB_SUB_ID_ABOVE, TAB_SUB_ID_BELOW, TAB_SUB_ID_ICON, TAB_SUB_ID_ICON_BELOW

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

Fields inherited from oracle.adf.view.js.base.AdfObject

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Constructor Summary

public

AdfDhtmlPanelDrawerPeer()

Method Summary

private Object	_alignLeft(Object component)
protected Object	BindToComponent(Object component, Object domElement) Update any state necessary to bind to the current DOM component
private Object	_checkInvalid(Object component)
public Object	componentRemoved(Object component) Clean up the peer because it's component is being removed.
protected Object	DescendantMessageChanged() this method can be overridden to call AdfPage.PAGE.getClientIdsWithMessages(rootId) to find out the client ids with messages for this subtree.
private Object	_drawerClosed() This is used as a callback when the drawer closes
private Object	_drawerOpened() This is used as a callback when the drawer opened
private Object	_getAlignNodeId(Object component, Object domElement)
private Object	_getAutoDismiss(Object component) whether or not to auto dismiss the drawer
private Object	_getCacheablePopupHints(Object component, Object alignNodeId)
private Object	_getPopupHints(Object component, Object alignNodeId) get the hints to use on the popup
private Object	_getSize(Object val, Object alignSize)
protected Object	HandleComponentClick(Object componentEvent) tab header onclick handler
private Object	_handleResize() Callback invoked when the size of the align element changes.
private Object	_initializeDrawer(Object clientId) initialize the drawer.
protected static Object	InitSubclass()
protected Object	IsDisclosedTabRequired(Object element)
private Object	_isPercent(Object val) whether or not the value is a percent
protected Object	NewTabSelected(Object component)
private Object	_percentSize(Object val, Object size) only call this if you already called isPercent
private Object	_placeHandles(Object component, Object domElement) place the handles at their initial location
private Object	_remove(Object component) called when the drawer is removed
private Object	_removeHandlePositioning(Object component, Object domElement) when the drawer is opened we save off the handle positioning and then remove it from the handle
private Object	_renderClosed(Object component, Object domElement) close the drawer
private Object	_renderOpen(Object component, Object domElement)
private Object	_restoreHandlePositioning(Object component, Object domElement) when the drawer is closed we restore the handle positioning that was saved in _removeHandlePositioning
private Object	_setDimensionValue(Object component, Object contentElement, Object alignNodeId) calculate the dimensions of the drawer based on height, width, maximumHeight, maximumWidth attributes
private Object	_setInitialMargins(Object component, Object domElement, Object alignNode, Object alignTop, Object alignLeft, Object isAlignedLeft, Object shadowElement, Object shadowElementHeight, Object shadowElementWidth) In some cases you're aligning to something that has padding, so offset that with negative margins if necessary.
protected Object	TabReselected(Object component, Object child) This method is called when the currently disclosed tab is reselected
private Object	_trackerRemoved() callback when the tracker component left at the initial dom position is removed.
protected Object	UseInvertedRenderingPosition() This is needed because when the panelDrawer has position set to "right", it means align the entire drawer on the right, but the tabs are rendered such that the tabs are to the left of the showDetailItem content.

Methods inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlPanelTabbedPeer

ComponentRemoved, GetBodyInnerElement, GetBodyOuterElement, getContainerId, GetOldDisclosedChild, GetRecentTabClientId, GetSubIdDomElement, GetVertTabsElement, HandleComponentBlur, HandleComponentFocus, HandleComponentKeyUp, HandleComponentMouseDown, HandleComponentMouseOut, HandleComponentMouseOver, HandleComponentMouseUp, InitDomElement, IsRecentTabOnTheBelowBar, needsResizeNotify, QueueClientDisclosureChanges, ResizeNotify, SetRecentTabInfo

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

addComponentEventHandlers, addComponentPropertyChanges, addComponentPropertyGetters, addDomEventHandlers, addEventHandlerToDomInstance, addSuppressedPPRAttributes, applyDragReadyState, ApplyDragReadyState, applyDragSourceState, ApplyDragSourceState, bind, cancelAllPopups, cancelPopup, ChildVisibilityChanged, clearDragReadyState, ClearDragReadyState, clearDragSourceState, ClearDragSourceState, ComponentInlineStyleChanged, ComponentPropertyChanged, ComponentStyleClassChanged, ComponentVisibleChanged, ConvertClientIdToLocator, convertLocatorToClientId, createComponentEvent, CreateComponentEvent, CreateDraggableNode, createInnerPeerClassWithSubId, createPeerClass, createSubId, DefaultInitClass, descendantMessageChanged, DispatchComponentEvent, DispatchUncanceledComponentEvent, 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, getReadyState, GetReadyState, GetRichResourceURL, getSubIdDomElement, hideAllPopups, hidePopup, InitClass, initialize, isActive, isInActiveHeirarchy, isPopupVisible, messageNotify, MessageNotify, messageShow, MessageShow, needsChildVisibilityChanges, needsFocusTargetStyleClass, 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, Init, initiateDrag, isVisible

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

_FLOAT_CLASS

private static Object _FLOAT_CLASS

_OPEN_CLASS

private static Object _OPEN_CLASS

_TABS_PARENT

private static Object _TABS_PARENT

_TEMP_FLOAT_SUBID

private static Object _TEMP_FLOAT_SUBID

_TRACKER_SUBID

private static Object _TRACKER_SUBID

Constructor Detail

AdfDhtmlPanelDrawerPeer

public AdfDhtmlPanelDrawerPeer()

Method Detail

_alignLeft

private Object _alignLeft(Object component)

Parameters:

component

Return:

Object

BindToComponent

protected Object BindToComponent(Object component,
Object domElement)

Update any state necessary to bind to the current DOM component

Parameters:

component
domElement

Return:

Object

Overrides:

AdfRichUIPeer.BindToComponent(Object, Object)

_checkInvalid

private Object _checkInvalid(Object component)

Parameters:

component

Return:

Object

componentRemoved

public Object componentRemoved(Object component)

Clean up the peer because it's component is being removed.

Parameters:

component

Return:

Object

Overrides:

AdfUIPeer.componentRemoved(AdfUIComponent)

DescendantMessageChanged

protected Object DescendantMessageChanged()

this method can be overridden to call AdfPage.PAGE.getClientIdsWithMessages(rootId) to find out the client ids with messages for this subtree. For each client id returned you can call AdfPage.PAGE.getClientIdsWithMessages(clientId) for the specific messages.

Return:

Object

Overrides:

AdfRichUIPeer.descendantMessageChanged(AdfUIComponent)

_drawerClosed

private Object _drawerClosed()

This is used as a callback when the drawer closes

Return:

Object

_drawerOpened

private Object _drawerOpened()

This is used as a callback when the drawer opened

Return:

Object

_getAlignNodeId

private Object _getAlignNodeId(Object component,
Object domElement)

Parameters:

component
domElement

Return:

Object

_getAutoDismiss

private Object _getAutoDismiss(Object component)

whether or not to auto dismiss the drawer

Parameters:

component

Return:

Object

_getCacheablePopupHints

private Object _getCacheablePopupHints(Object component,
Object alignNodeId)

Parameters:

component
alignNodeId

Return:

Object

_getPopupHints

private Object _getPopupHints(Object component,
Object alignNodeId)

get the hints to use on the popup

Parameters:

component
alignNodeId

Return:

Object

_getSize

private Object _getSize(Object val,
Object alignSize)

Parameters:

val	-	percentage value, like "75%", or fixed value like px or em
alignSize	-	the value of the dimension of the alignNode, if val is a percent the alignSize will be used to determine the size returned.

Return:

Object - integer value of the dimension

HandleComponentClick

protected Object HandleComponentClick(Object componentEvent)

tab header onclick handler

Parameters:

componentEvent

Return:

Object

Overrides:

AdfDhtmlPanelTabbedPeer.HandleComponentClick(Object)

_handleResize

private Object _handleResize()

Callback invoked when the size of the align element changes.

Return:

Object

See also:

AdfAgent.addResizeListener(String, Function)

_initializeDrawer

private Object _initializeDrawer(Object clientId)

initialize the drawer.

Parameters:

clientId

Return:

Object

InitSubclass

protected static Object InitSubclass()

Return:

Object

Overrides:

AdfDhtmlPanelTabbedPeer.InitSubclass()

IsDisclosedTabRequired

protected Object IsDisclosedTabRequired(Object element)

Parameters:

element

Return:

Object

Overrides:

AdfDhtmlPanelTabbedPeer.IsDisclosedTabRequired(Object)

_isPercent

private Object _isPercent(Object val)

whether or not the value is a percent

Parameters:

val

Return:

Object

NewTabSelected

protected Object NewTabSelected(Object component)

Parameters:

component

Return:

Object

Overrides:

AdfDhtmlPanelTabbedPeer.NewTabSelected(Object)

_percentSize

private Object _percentSize(Object val,
Object size)

only call this if you already called isPercent

Parameters:

val	-	percentage value, like "75%"
size	-	the original size

Return:

Object - the new size which is a percentage of the original size.

_placeHandles

private Object _placeHandles(Object component,
Object domElement)

place the handles at their initial location

Parameters:

component
domElement

Return:

Object

_remove

private Object _remove(Object component)

called when the drawer is removed

Parameters:

component

Return:

Object

_removeHandlePositioning

private Object _removeHandlePositioning(Object component,
Object domElement)

when the drawer is opened we save off the handle positioning and then remove it from the handle

Parameters:

component
domElement

Return:

Object

_renderClosed

private Object _renderClosed(Object component,
Object domElement)

close the drawer

Parameters:

component
domElement

Return:

Object

_renderOpen

private Object _renderOpen(Object component,
Object domElement)

Parameters:

component
domElement

Return:

Object

_restoreHandlePositioning

private Object _restoreHandlePositioning(Object component,
Object domElement)

when the drawer is closed we restore the handle positioning that was saved in _removeHandlePositioning

Parameters:

component
domElement

Return:

Object

_setDimensionValue

private Object _setDimensionValue(Object component,
Object contentElement,
Object alignNodeId)

calculate the dimensions of the drawer based on height, width, maximumHeight, maximumWidth attributes

Parameters:

component
contentElement
alignNodeId

Return:

Object

_setInitialMargins

private Object _setInitialMargins(Object component,
Object domElement,
Object alignNode,
Object alignTop,
Object alignLeft,
Object isAlignedLeft,
Object shadowElement,
Object shadowElementHeight,
Object shadowElementWidth)

In some cases you're aligning to something that has padding, so offset that with negative margins if necessary. A shadow floating element may have been left as a child of the original dom parent so that other content will still flow around the area where the handles will be rendered. We will adjust the size of the shadowElement in this method.

Parameters:

component
domElement
alignNode
alignTop
alignLeft
isAlignedLeft
shadowElement
shadowElementHeight
shadowElementWidth

Return:

Object

TabReselected

protected Object TabReselected(Object component,
Object child)

This method is called when the currently disclosed tab is reselected

Parameters:

component
child

Return:

Object

Overrides:

AdfDhtmlPanelTabbedPeer.TabReselected(Object, Object)

_trackerRemoved

private Object _trackerRemoved()

callback when the tracker component left at the initial dom position is removed.

Return:

Object

UseInvertedRenderingPosition

protected Object UseInvertedRenderingPosition()

This is needed because when the panelDrawer has position set to "right", it means align the entire drawer on the right, but the tabs are rendered such that the tabs are to the left of the showDetailItem content. So the position attribute is "right", but for rendering the tabs relative to the showDetailItem content we want it to behave as if it's "left".

Return:

Object

Overrides:

AdfDhtmlPanelTabbedPeer.UseInvertedRenderingPosition()

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