JavaScript API Reference for Oracle ADF Faces

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

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

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

public class AdfDhtmlPanelDashboardPeer
extends AdfRichUIPeer

Field Summary

private static Object	_INSERT_DELETE_PIXEL_HEIGHT
private static Object	_PHASE_1_DURATION_FACTOR
private static Object	_PHASE_2_DURATION_FACTOR

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

addComponentPropertyChanges, addComponentPropertyGetters, BUSY_STYLECLASS, DISABLED_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

AdfDhtmlPanelDashboardPeer()

Method Summary

private static Object	_adjustShim(Object animationObjects, Object dashboardClientId, Object columns, Object rowHeightPixels, Object desiredCellCount)
private Object	_animateReorderPositionTo(Object dashboardComponent, Object draggedChildIndex, Object desiredDropIndex)
private static Object	_arrayContains(Object theArray, Object theValue)
protected Object	ComponentRemoved(AdfUIComponent component) Hook called when peers are disassociated from their components.
private Object	_deleteElements(Object elementsToDelete, Object justDom)
protected HTMLElement	DomReplaceNotify(HTMLElement domNode) Overidden to track replacement of DOM children such as with optimized rendering.
private static Object	_domReplaceNotifyPhase2(Object callbackParameters)
private static Object	_formatPercent(Object value)
private Object	_getChildHeightInPixels(Object dashboardComponent)
private Object	_getChildWidthInPixels(Object dashboardComponent)
Object	__getDataBody()
private String	_getDispayDropIndexFromCoordinates(AdfRichPanelDashboard dashboardComponent, HTMLElement dataBody, Number pageX, Number pageY, Boolean isExternalDragSource) Returns the desired display index for the drop or null if the drop is outside of the data body.
public Object	getDraggedSourceChildIndex(Object dragSourceComponent, Object ignoreCachedValue)
private Object	_getRowKeyAndOrientationForPosition(Object pageX, Object pageY, Object hints, Object isExternalDragSource) Given a location in page coordinates inside this peer, return the desiredDropIndex, if any, that is stamped within those bounds.
public Object	getRowKeyAndOrientationFromHints(Number pageX, Number pageY, Object hints) Given a location in page coordinates inside this peer, return the desiredDropIndex, if any, that is stamped within those bounds.
public Object	getRowKeyBounds(String desiredDropIndexString) Given a desiredDropIndex in this peer, return the bounds of the desiredDropIndex's visualization.
protected Object	InitDomElement(AdfUIComponent component, Object domElement) Initialize the associated domElement when the peer is created.
protected static Object	InitSubclass() Initialize class members.
public Object	insertChildBehavior(AdfRichPanelDashboard dashboardComponent, Number insertIndex, AdfUIComponent alignComponent) Used by AdfPanelDashboardBehavior to scroll the dashboard to the end.
private static Object	_isDimensionsFromChildren(Object dashboardClientId)
public Object	needsResizeNotify(AdfUIComponent component) Indicates whether this peer has interest in resize notifications.
private Object	_preventDiagonalMovement(Object element, Object desiredColumnIndex, Object desiredRowIndex, Object columns, Object columnWidthPixels, Object rowHeightPixels, Object isRtl)
private static Object	_resetChildrenPositioningStyles(Object peerAndElementsToDelete, Object draggedChildIndex, Object desiredDropIndex)
protected Object	ResizeNotify(Number oldWidth, Number oldHeight, Number newWidth, Number newHeight) Resize notification callback to perform geometry management.
public Object	showDragFeedback(AdfDnDContext dndContext, String desiredDropIndexString, Object userAction, String lastDesiredDropIndexString, Number pageX, Number pageY, Boolean dragExit) Shows feedback for the given drop target desiredDropIndex.
private static Object	_sortAscending(Object a, Object b)
private Object	_workaroundForInternetExplorer(Object newWidth)

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

addComponentEventHandlers, addComponentPropertyChanges, addComponentPropertyGetters, addDomEventHandlers, addEventHandlerToDomInstance, addSuppressedPPRAttributes, bind, BindToComponent, cancelAllPopups, cancelPopup, ChildVisibilityChanged, ComponentInlineStyleChanged, ComponentPropertyChanged, 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, getReadyState, GetReadyState, 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

_INSERT_DELETE_PIXEL_HEIGHT

private static Object _INSERT_DELETE_PIXEL_HEIGHT

_PHASE_1_DURATION_FACTOR

private static Object _PHASE_1_DURATION_FACTOR

_PHASE_2_DURATION_FACTOR

private static Object _PHASE_2_DURATION_FACTOR

Constructor Detail

AdfDhtmlPanelDashboardPeer

public AdfDhtmlPanelDashboardPeer()

Method Detail

_adjustShim

private static Object _adjustShim(Object animationObjects,
Object dashboardClientId,
Object columns,
Object rowHeightPixels,
Object desiredCellCount)

Parameters:

animationObjects
dashboardClientId
columns
rowHeightPixels
desiredCellCount

Return:

Object

_animateReorderPositionTo

private Object _animateReorderPositionTo(Object dashboardComponent,
Object draggedChildIndex,
Object desiredDropIndex)

Parameters:

dashboardComponent
draggedChildIndex
desiredDropIndex

Return:

Object

_arrayContains

private static Object _arrayContains(Object theArray,
Object theValue)

Parameters:

theArray
theValue

Return:

Object

ComponentRemoved

protected Object ComponentRemoved(AdfUIComponent component)

Hook called when peers are disassociated from their components. When this function is called, the peer is unbound and must call bind on itself if it needs to access its peer state.

Parameters:

component

-

Component being disassociated from the peer

Return:

Object

See also:

AdfRichUIPeer.bind(AdfUIComponent)

AdfRichUIPeer.componentRemoved(AdfUIComponent)

Overrides:

AdfUIPeer.componentRemoved(AdfUIComponent)

_deleteElements

private Object _deleteElements(Object elementsToDelete,
Object justDom)

Parameters:

elementsToDelete
justDom

Return:

Object

DomReplaceNotify

protected HTMLElement DomReplaceNotify(HTMLElement domNode)

Overidden to track replacement of DOM children such as with optimized rendering.

Parameters:

domNode

-

the DOM element involved in the replacement

Return:

HTMLElement - the DOM node which should be the target of a subsequent resize traversal

Overrides:

AdfRichUIPeer.domReplaceNotify(AdfUIComponent, Object)

_domReplaceNotifyPhase2

private static Object _domReplaceNotifyPhase2(Object callbackParameters)

Parameters:

callbackParameters

Return:

Object

_formatPercent

private static Object _formatPercent(Object value)

Parameters:

value

Return:

Object

_getChildHeightInPixels

private Object _getChildHeightInPixels(Object dashboardComponent)

Parameters:

dashboardComponent

Return:

Object

_getChildWidthInPixels

private Object _getChildWidthInPixels(Object dashboardComponent)

Parameters:

dashboardComponent

Return:

Object

__getDataBody

Object __getDataBody()

Return:

Object

_getDispayDropIndexFromCoordinates

private String _getDispayDropIndexFromCoordinates(AdfRichPanelDashboard dashboardComponent,
HTMLElement dataBody,
Number pageX,
Number pageY,
Boolean isExternalDragSource)

Returns the desired display index for the drop or null if the drop is outside of the data body.

Parameters:

dashboardComponent	-	the panelDashboard component to drop on
dataBody	-	the data body element of the panelDashboard
pageX	-	the current x coordinate of the mouse in page coordinates
pageY	-	the current y coordinate of the mouse in page coordinates
isExternalDragSource	-	true if the drag source is not a child

Return:

String - null or the desired drop index for the current mouse position

getDraggedSourceChildIndex

public Object getDraggedSourceChildIndex(Object dragSourceComponent,
Object ignoreCachedValue)

Parameters:

dragSourceComponent
ignoreCachedValue

Return:

Object

_getRowKeyAndOrientationForPosition

private Object _getRowKeyAndOrientationForPosition(Object pageX,
Object pageY,
Object hints,
Object isExternalDragSource)

Given a location in page coordinates inside this peer, return the desiredDropIndex, if any, that is stamped within those bounds. As a performance aid, a desiredDropIndex and its bounds may optionally be passed to aid in determining the current desiredDropIndex.

Parameters:

pageX
pageY
hints
isExternalDragSource

Return:

Object

getRowKeyAndOrientationFromHints

public Object getRowKeyAndOrientationFromHints(Number pageX,
Number pageY,
Object hints)

Given a location in page coordinates inside this peer, return the desiredDropIndex, if any, that is stamped within those bounds. As a performance aid, a desiredDropIndex, its bounds and orientation may optionally be passed to aid in determining the current desiredDropIndex.

Parameters:

pageX	-	the x position of the pointer
pageY	-	the y position of the pointer
hints	-	An object containings hints for lastRowKey, lastRowKeyBounds, lastDropOrientation etc. See AdfStampedDropTarget.HINT* for possible hints. The rowKey and dropOrientation are set on this hint object as a return values.

Return:

Object

getRowKeyBounds

public Object getRowKeyBounds(String desiredDropIndexString)

Given a desiredDropIndex in this peer, return the bounds of the desiredDropIndex's visualization.

Parameters:

desiredDropIndexString

-

(aka rowKey) to look for

Return:

Object - object literal with the bounds of the desiredDropIndex if found else null

See also:

AdfAgent.getElementPageBounds(Object)

InitDomElement

protected Object InitDomElement(AdfUIComponent 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	-	Component that this peer will be associated with
domElement	-	Root DOM element of this peer

Return:

Object

Overrides:

AdfRichUIPeer.InitDomElement(AdfUIComponent, Object)

InitSubclass

protected static Object InitSubclass()

Initialize class members.

Return:

Object

insertChildBehavior

public Object insertChildBehavior(AdfRichPanelDashboard dashboardComponent,
Number insertIndex,
AdfUIComponent alignComponent)

Used by AdfPanelDashboardBehavior to scroll the dashboard to the end. Space will be opened up with a "loading" identifier, awaiting for the app developer's command to finish processing on the server while their action listener processes the necessary changes to the component structure and then invokes an optimized rendering on the panelDashboard. This optimized rendering will then swap out the "loading" placeholder with the new content in the browser.

Parameters:

dashboardComponent	-	the panelDashboard component for this peer
insertIndex	-	the index at which the placeholder shall be inserted
alignComponent	-	the component the insert animation should reveal from

Return:

Object

_isDimensionsFromChildren

private static Object _isDimensionsFromChildren(Object dashboardClientId)

Parameters:

dashboardClientId

Return:

Object

needsResizeNotify

public Object needsResizeNotify(AdfUIComponent component)

Indicates whether this peer has interest in resize notifications.

Parameters:

component

-

the component bound to this peer

Return:

Object

Overrides:

AdfUIPeer.needsResizeNotify(Object)

_preventDiagonalMovement

private Object _preventDiagonalMovement(Object element,
Object desiredColumnIndex,
Object desiredRowIndex,
Object columns,
Object columnWidthPixels,
Object rowHeightPixels,
Object isRtl)

Parameters:

element
desiredColumnIndex
desiredRowIndex
columns
columnWidthPixels
rowHeightPixels
isRtl

Return:

Object

_resetChildrenPositioningStyles

private static Object _resetChildrenPositioningStyles(Object peerAndElementsToDelete,
Object draggedChildIndex,
Object desiredDropIndex)

Parameters:

peerAndElementsToDelete
draggedChildIndex
desiredDropIndex

Return:

Object

ResizeNotify

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

Resize notification callback to perform geometry management.

Parameters:

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

Return:

Object

Overrides:

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

showDragFeedback

public Object showDragFeedback(AdfDnDContext dndContext,
String desiredDropIndexString,
Object userAction,
String lastDesiredDropIndexString,
Number pageX,
Number pageY,
Boolean dragExit)

Shows feedback for the given drop target desiredDropIndex.

Parameters:

dndContext	-	the drag and drop context
desiredDropIndexString	-	of the drop target
userAction
lastDesiredDropIndexString	-	the desired drop index from previous feedback
pageX	-	null or the x position of the mouse in page coordinates
pageY	-	null or the y position of the mouse in page coordinates
dragExit	-	true if the feedback is due to the drag exiting this component

Return:

Object

_sortAscending

private static Object _sortAscending(Object a,
Object b)

Parameters:

a
b

Return:

Object

_workaroundForInternetExplorer

private Object _workaroundForInternetExplorer(Object newWidth)

Parameters:

newWidth

Return:

Object

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