JavaScript API Reference for Oracle ADF Faces

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

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

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

public class AdfDhtmlPanelSplitterPeer
extends AdfRichUIPeer

Field Summary

private static Object	_DISCLOSED_STATE
private static Object	_DIVIDER_WIDTH
private static Object	_MINIMUM_PANE_SIZE
private static Object	_PANEL_SPLITTER_COLLAPSE_ANIMATION_DURATION
private static Object	_SPLITTER_PADDING_PIXELS

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

AdfDhtmlPanelSplitterPeer()

Method Summary

private Object	_afterCollapseAnimation(Object collapsed, Object horizontal, Object component, Object positionedFromEnd, Object fixedPane, Object fixedPaneChild, Object stretchedPane, Object stretchedPaneChild)
protected Object	BindToComponent(Object component, Object domElement) Update any state necessary to bind to the current DOM component
protected Object	ChildVisibilityChanged(Object childComponent, Object childDomElement, Object childVisible) Called when the visibility of a child component changes if the peer has overridden needsChildVisibilityChanges to return true.
protected Object	ComponentCollapsedChanged(Object component, Object domElement, Object newValue, Object oldValue)
protected Object	ComponentSplitterPositionChanged(Object component, Object domElement, Object newValue, Object oldValue)
protected Object	DomReplaceNotify(Object domNode) Notifies the peer that some DOM corresponding to a child (or descendent) has been replaced.
private Object	_findNextSplitter(Object domNode) Find the next splitter icon link.
private Object	_getCollapsedPane()
private Object	_getConstrainedSplitterPos(Object component, Object horizontal, Object newPosition) Gets the new splitter position, constraining the value to the min/max pane size as needed.
private Object	_getPanePadding(Object paneNode)
private static Object	_getPositionedFromEnd(Object component)
private Number	_getStyleHeight(DOMElement domElement) Get the style height of an element
private Number	_getStyleWidth(DOMElement domElement) Get the style width of an element
private Object	_handleCollapseAnimation(Object collapsed, Object component, Object positionedFromEnd)
protected Object	HandleComponentClick(Object componentEvent)
protected Object	HandleComponentKeyDown(AdfUIInputEvent componentEvent) Handles component-level key down.
protected Object	HandleComponentMouseDown(Object componentEvent)
protected Object	HandleComponentMouseOut(Object componentEvent)
protected Object	HandleComponentMouseOver(Object componentEvent)
private Object	_handleDrag(Object evt, Object deltaX, Object deltaY)
private Object	_handleDrop(Object evt, Object deltaX, Object deltaY)
private Object	_handleSplitterNavigationEvent(Object componentEvent) Navigate to the next splitter icon DOM element if found on the page.
protected static Object	InitSubclass()
private static Object	_isChildVisible(Object paneElement)
private static Object	_isHorizontal(Object component)
public Object	needsChildVisibilityChanges(Object component) Test whether the peer wants to be notified if the visibility of one of its children changes.
public Object	needsResizeNotify(Object component) Tests whether the peer requires resize notification.
private Object	_repositionPanes()
private Object	_resizeHorizontal(Object fixedPaneElement, Object stretchedPaneElement, Object dividerElement, Object newWidth, Object newHeight, Object splitterPosition, Object widthChanged, Object heightChanged, Object splitterPositionChanged, Object dividerWidth, Object positionedFromEnd)
protected Object	ResizeNotify(Object oldWidth, Object oldHeight, Object newWidth, Object newHeight) Called to notify the peer of resize activity.
private Object	_resizeOnly(Object onlyPane, Object newWidth, Object newHeight, Object widthChanged, Object heightChanged)
private Object	_resizeVertical(Object fixedPaneElement, Object stretchedPaneElement, Object dividerElement, Object newWidth, Object newHeight, Object splitterPosition, Object widthChanged, Object heightChanged, Object splitterPositionChanged, Object dividerWidth, Object positionedFromEnd)
private Object	_updateDivider(Object collapsed, Object positionedFromEnd)

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

addComponentEventHandlers, addComponentPropertyChanges, addComponentPropertyGetters, addDomEventHandlers, addEventHandlerToDomInstance, addSuppressedPPRAttributes, bind, cancelAllPopups, cancelPopup, ComponentInlineStyleChanged, ComponentPropertyChanged, componentRemoved, ComponentRemoved, ComponentStyleClassChanged, ComponentVisibleChanged, ConvertClientIdToLocator, convertLocatorToClientId, CreateDraggableNode, createPeerClass, createSubId, CreateSubId, DefaultInitClass, DispatchComponentEvent, 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, InitDomElement, initialize, isActive, isInActiveHeirarchy, isPopupVisible, messageNotify, MessageNotify, messageShow, MessageShow, 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

_DISCLOSED_STATE

private static Object _DISCLOSED_STATE

_DIVIDER_WIDTH

private static Object _DIVIDER_WIDTH

_MINIMUM_PANE_SIZE

private static Object _MINIMUM_PANE_SIZE

_PANEL_SPLITTER_COLLAPSE_ANIMATION_DURATION

private static Object _PANEL_SPLITTER_COLLAPSE_ANIMATION_DURATION

_SPLITTER_PADDING_PIXELS

private static Object _SPLITTER_PADDING_PIXELS

Constructor Detail

AdfDhtmlPanelSplitterPeer

public AdfDhtmlPanelSplitterPeer()

Method Detail

_afterCollapseAnimation

private Object _afterCollapseAnimation(Object collapsed,
Object horizontal,
Object component,
Object positionedFromEnd,
Object fixedPane,
Object fixedPaneChild,
Object stretchedPane,
Object stretchedPaneChild)

Parameters:

collapsed
horizontal
component
positionedFromEnd
fixedPane
fixedPaneChild
stretchedPane
stretchedPaneChild

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)

ChildVisibilityChanged

protected Object ChildVisibilityChanged(Object childComponent,
Object childDomElement,
Object childVisible)

Called when the visibility of a child component changes if the peer has overridden needsChildVisibilityChanges to return true. The peer can use the child's component, domElement, and new visibility parameters to determine whether it needs to handle the visibility change rather than letting the default implementation of hiding or showing the child. If the peer will handle the change (often by marking itself as needing to be redrawn, it should perform whatever work is necessary and return true from this method.

Overrides of this method should be aware that when this method is called, the child component's peer may no longer be bound to the child component (for example, if both the child and parent component peers are the same instance).

Overrides of this method should use the childDomElement parameter to determine whether the passed in childComponent is actually a direct descendant of the parent component.

Parameters:

childComponent
childDomElement
childVisible

Return:

Object

Overrides:

AdfRichUIPeer.ChildVisibilityChanged(Object, Object, Object)

ComponentCollapsedChanged

protected Object ComponentCollapsedChanged(Object component,
Object domElement,
Object newValue,
Object oldValue)

Parameters:

component
domElement
newValue
oldValue

Return:

Object

ComponentSplitterPositionChanged

protected Object ComponentSplitterPositionChanged(Object component,
Object domElement,
Object newValue,
Object oldValue)

Parameters:

component
domElement
newValue
oldValue

Return:

Object

DomReplaceNotify

protected Object DomReplaceNotify(Object domNode)

Notifies the peer that some DOM corresponding to a child (or descendent) has been replaced.

Parameters:

domNode

Return:

Object

Overrides:

AdfRichUIPeer.domReplaceNotify(AdfUIComponent, Object)

_findNextSplitter

private Object _findNextSplitter(Object domNode)

Find the next splitter icon link. This does not match the node passed in, but starts searching from the node. If none are found, it returns null.

Parameters:

domNode

Return:

Object

_getCollapsedPane

private Object _getCollapsedPane()

Return:

Object

_getConstrainedSplitterPos

private Object _getConstrainedSplitterPos(Object component,
Object horizontal,
Object newPosition)

Gets the new splitter position, constraining the value to the min/max pane size as needed.

Parameters:

component	-	Component that this peer is associated with
horizontal	-	True if horizontal splitter, false if vertical
newPosition	-	Requested new position for splitter

Return:

Object - the new splitter position taking min/max pane size values into account

_getPanePadding

private Object _getPanePadding(Object paneNode)

Parameters:

paneNode

Return:

Object

_getPositionedFromEnd

private static Object _getPositionedFromEnd(Object component)

Parameters:

component

Return:

Object

_getStyleHeight

private Number _getStyleHeight(DOMElement domElement)

Get the style height of an element

Parameters:

domElement

-

the element

Return:

Number - the height in pixels

_getStyleWidth

private Number _getStyleWidth(DOMElement domElement)

Get the style width of an element

Parameters:

domElement

-

the element

Return:

Number - the width in pixels

_handleCollapseAnimation

private Object _handleCollapseAnimation(Object collapsed,
Object component,
Object positionedFromEnd)

Parameters:

collapsed
component
positionedFromEnd

Return:

Object

HandleComponentClick

protected Object HandleComponentClick(Object componentEvent)

Parameters:

componentEvent

Return:

Object

HandleComponentKeyDown

protected Object HandleComponentKeyDown(AdfUIInputEvent componentEvent)

Handles component-level key down.

Parameters:

componentEvent

-

the key down component event

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

_handleDrag

private Object _handleDrag(Object evt,
Object deltaX,
Object deltaY)

Parameters:

evt
deltaX
deltaY

Return:

Object

_handleDrop

private Object _handleDrop(Object evt,
Object deltaX,
Object deltaY)

Parameters:

evt
deltaX
deltaY

Return:

Object

_handleSplitterNavigationEvent

private Object _handleSplitterNavigationEvent(Object componentEvent)

Navigate to the next splitter icon DOM element if found on the page. Will wrap around to find the first splitter if on the last.

Parameters:

componentEvent

Return:

Object

InitSubclass

protected static Object InitSubclass()

Return:

Object

_isChildVisible

private static Object _isChildVisible(Object paneElement)

Parameters:

paneElement

Return:

Object

_isHorizontal

private static Object _isHorizontal(Object component)

Parameters:

component

Return:

Object

needsChildVisibilityChanges

public Object needsChildVisibilityChanges(Object component)

Test whether the peer wants to be notified if the visibility of one of its children changes. If a peer overrides this method to return true, the peer's ChildVisibilityChanged method will be called.

The peer is not bound when this method is called. Peers with complicated logic to determine whether they need to be informed of child visibility changes should return true from this method and place their logic inside of their ChildVisibilityChanged override.

Parameters:

component

Return:

Object

Overrides:

AdfRichUIPeer.needsChildVisibilityChanges(AdfUIComponent)

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)

_repositionPanes

private Object _repositionPanes()

Return:

Object

_resizeHorizontal

private Object _resizeHorizontal(Object fixedPaneElement,
Object stretchedPaneElement,
Object dividerElement,
Object newWidth,
Object newHeight,
Object splitterPosition,
Object widthChanged,
Object heightChanged,
Object splitterPositionChanged,
Object dividerWidth,
Object positionedFromEnd)

Parameters:

fixedPaneElement
stretchedPaneElement
dividerElement
newWidth
newHeight
splitterPosition
widthChanged
heightChanged
splitterPositionChanged
dividerWidth
positionedFromEnd

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)

_resizeOnly

private Object _resizeOnly(Object onlyPane,
Object newWidth,
Object newHeight,
Object widthChanged,
Object heightChanged)

Parameters:

onlyPane
newWidth
newHeight
widthChanged
heightChanged

Return:

Object

_resizeVertical

private Object _resizeVertical(Object fixedPaneElement,
Object stretchedPaneElement,
Object dividerElement,
Object newWidth,
Object newHeight,
Object splitterPosition,
Object widthChanged,
Object heightChanged,
Object splitterPositionChanged,
Object dividerWidth,
Object positionedFromEnd)

Parameters:

fixedPaneElement
stretchedPaneElement
dividerElement
newWidth
newHeight
splitterPosition
widthChanged
heightChanged
splitterPositionChanged
dividerWidth
positionedFromEnd

Return:

Object

_updateDivider

private Object _updateDivider(Object collapsed,
Object positionedFromEnd)

Parameters:

collapsed
positionedFromEnd

Return:

Object

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