JavaScript API Reference for Oracle ADF Faces

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

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

public class AdfDhtmlMasonryLayoutPeer
extends AdfRichUIPeer

_compressedMasonryTileSizeClasses

private Object _compressedMasonryTileSizeClasses

_HAS_DELETE_LISTENER_KEY

private static Object _HAS_DELETE_LISTENER_KEY

_HAS_REORDER_LISTENER_KEY

private static Object _HAS_REORDER_LISTENER_KEY

_MASONRY_LAYOUT_CLASS

private static Object _MASONRY_LAYOUT_CLASS

_MASONRY_LAYOUT_DROP_TARGET_CLASS

private static Object _MASONRY_LAYOUT_DROP_TARGET_CLASS

_MASONRY_LAYOUT_TRANSITION_RESIZE_TO_CLASS

private static Object _MASONRY_LAYOUT_TRANSITION_RESIZE_TO_CLASS

_MASONRY_LAYOUT_TRANSITION_RESIZE_TO_FAST_CLASS

private static Object _MASONRY_LAYOUT_TRANSITION_RESIZE_TO_FAST_CLASS

_MASONRY_TILE_SIZE_CLASS_STEM

private static Object _MASONRY_TILE_SIZE_CLASS_STEM

_MASONRY_TRANSITION_HIDE_FROM_CLASS

private static Object _MASONRY_TRANSITION_HIDE_FROM_CLASS

_MASONRY_TRANSITION_HIDE_TO_CLASS

private static Object _MASONRY_TRANSITION_HIDE_TO_CLASS

_MASONRY_TRANSITION_MOVE_TO_CLASS

private static Object _MASONRY_TRANSITION_MOVE_TO_CLASS

_MASONRY_TRANSITION_MOVE_TO_FAST_CLASS

private static Object _MASONRY_TRANSITION_MOVE_TO_FAST_CLASS

_MASONRY_TRANSITION_RESIZE_TO_CLASS

private static Object _MASONRY_TRANSITION_RESIZE_TO_CLASS

_MASONRY_TRANSITION_SHOW_FROM_CLASS

private static Object _MASONRY_TRANSITION_SHOW_FROM_CLASS

_MASONRY_TRANSITION_SHOW_TO_CLASS

private static Object _MASONRY_TRANSITION_SHOW_TO_CLASS

_MAX_TILE_COL_SPAN

private static Object _MAX_TILE_COL_SPAN

_MAX_TILE_ROW_SPAN

private static Object _MAX_TILE_ROW_SPAN

_mlCommon

private Object _mlCommon

_rtl

private Object _rtl

_saveTilesOriginalOrder

private Object _saveTilesOriginalOrder

_UNCOMPRESSED_MASONRY_TILE_SIZE_CLASSES

private static Object _UNCOMPRESSED_MASONRY_TILE_SIZE_CLASSES

AdfDhtmlMasonryLayoutPeer

public AdfDhtmlMasonryLayoutPeer()

_compareTilesOriginalOrder

private static Number _compareTilesOriginalOrder(Object tile1,
                                                 Object tile2)

Compare tiles for sorting based on the original DOM order.

Parameters:

tile1	-	A tile.
tile2	-	Another tile.

Return:

Number - 1 if tile2 should be sorted before tile1, -1 if tile1 should be sorted before tile2, or 0 if the tile order doesn't need to change

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

Overrides:

AdfUIPeer.componentRemoved(AdfUIComponent)

_deferFunction

private Object _deferFunction(Function deferredFunc)

Defer a function call until the end of a layout cycle.

Parameters:

deferredFunc

-

function to defer

Return:

Object

deleteTile

public Object deleteTile(String tileClientId)

Delete a child of the masonryLayout.

Parameters:

tileClientId

-

clientId of the child to delete

Return:

Object

_deleteTileOriginalOrder

private Object _deleteTileOriginalOrder(Object deletedTile)

Delete a tile from the original DOM order.

Parameters:

deletedTile

-

Tile to delete.

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)

dropOnRowKey

public Object dropOnRowKey(Object dndContext,
                           Object proposedAction,
                           Object dropX,
                           Object dropY,
                           Object desiredDropIndexString,
                           Object dropOrientation)

Parameters:

dndContext
proposedAction
dropX
dropY
desiredDropIndexString
dropOrientation

Return:

Object

_encodeSelector

private static String _encodeSelector(String selector)

Encode the given selector to use with querySelector() or querySelectorAll().

Parameters:

selector

-

selector to encode

Return:

String - encoded selector

_finishInsertTile

private boolean _finishInsertTile(Object domNode)

Finish inserting a child tile.

Parameters:

domNode

-

div containing the inserted child tile

Return:

boolean - true if the insert is finished processing

_fireDeleteEvents

private Object _fireDeleteEvents()

Fire the saved masonryDelete events.

Return:

Object

_fireEvents

private Object _fireEvents(Array arEvents)

Fire the events in the array.

Parameters:

arEvents

-

array of events to fire

Return:

Object

_fireInsertEvents

private Object _fireInsertEvents()

Fire the saved masonryInsert events.

Return:

Object

_fireResizeEvents

private Object _fireResizeEvents()

Fire the saved masonryResize events.

Return:

Object

_getChildAtIndex

private Object _getChildAtIndex(Object parentElem,
                                Number index)

Get the child element at the index.

Parameters:

parentElem	-	parent element
index	-	index of child element

Return:

Object - child element at the index, or null if the index is invalid

_getChildElements

private Array _getChildElements(Object parentElem,
                                Boolean excludeDropSite)

Get the rendered child elements of the given parent element.

Parameters:

parentElem	-	parent element
excludeDropSite	-	true to exclude the dropsite, false to include it

Return:

Array - array of rendered child elements

_getChildIndex

private Number _getChildIndex(Object parentElem,
                              Object childElem)

Get the index of the child.

Parameters:

parentElem	-	parent element
childElem	-	child element

Return:

Number - index of the child, or -1 if not found

_getChildUnderPoint

private Object _getChildUnderPoint(Object parentElem,
                                   Number pageX,
                                   Number pageY)

Get the child element under the point.

Parameters:

parentElem	-	parent element
pageX	-	pageX coordinate
pageY	-	pageY coordinate

Return:

Object - child element under the point, or null if no child found under the point

_getDisplayDropIndexFromCoordinates

private String _getDisplayDropIndexFromCoordinates(AdfRichMasonryLayout masonryLayoutComponent,
                                                   HTMLElement domElem,
                                                   Number pageX,
                                                   Number pageY,
                                                   Boolean isExternalDragSource,
                                                   Object dragSourceComponent)

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

Parameters:

masonryLayoutComponent	-	the masonryLayout component to drop on
domElem	-	the DOM element of the masonryLayout
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
dragSourceComponent

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

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
dragSourceComponent

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(HTMLElement)

_getSizeStyleClassName

private String _getSizeStyleClassName(Object elem)

Get the size style class name on the given element.

Parameters:

elem

-

element on which the size style class is specified

Return:

String - size style class name

_getTileSpan

private Object _getTileSpan(Object elem)

Get the span of a given child tile of the masonryLayout.

Parameters:

elem

-

child tile to get the span for

Return:

Object - object specifying colSpan and rowSpan

_getUncompressedSizeStyleClassName

private String _getUncompressedSizeStyleClassName(Object elem)

Get the uncompressed name of the size style class on the given element.

Parameters:

elem

-

element on which the compressed size style class is specified

Return:

String - uncompressed size style class name

_hasDeleteListener

private boolean _hasDeleteListener()

Get whether a masonryDelete server listener is registered.

Return:

boolean - true if a server listener is registered

_hasReorderListener

private boolean _hasReorderListener()

Get whether a masonryReorder server listener is registered.

Return:

boolean - true if a server listener is registered

_hideTileOnEndFunc

private Object _hideTileOnEndFunc(Object elem)

Callback to run after a tile is hidden.

Parameters:

elem

-

child tile element that was hidden

Return:

Object

InitDomElement

protected Object InitDomElement(AdfUIComponent component,
                                Object domElement)

Initialize the associated domElement when the peer is created.

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

Hook to identify which attributes have optimized getters.

Return:

Object

insertTile

public Object insertTile(String sizeStyleClass,
                         Number index)

Insert a placeholder into the masonryLayout.

Parameters:

sizeStyleClass	-	style class specifying the size of the child to be inserted
index	-	index at which to insert

Return:

Object

_insertTileOriginalOrder

private Object _insertTileOriginalOrder(Object insertedTile,
                                        Number index)

Insert a tile into the original DOM order at the given index.

Parameters:

insertedTile	-	Tile to insert.
index	-	Index at which to insert.

Return:

Object

_isExternalDragSource

private Object _isExternalDragSource(Object dragSourceComponent)

Parameters:

dragSourceComponent

Return:

Object

_layoutCycleOnEndFunc

private Object _layoutCycleOnEndFunc()

Callback to run after whole layout cycle.

Return:

Object

_layoutCycleOnStartFunc

private Object _layoutCycleOnStartFunc()

Callback to run before whole layout cycle.

Return:

Object

_layoutOnEndFunc

private Object _layoutOnEndFunc()

Callback to run after layout.

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)

_preProcessOptimizedRender

private Object _preProcessOptimizedRender(Object domNode)

Preprocess an optimized render.

Parameters:

domNode

-

optimized render div

Return:

Object

_processInsertTile

private boolean _processInsertTile(Object domNode)

Process a child insert.

Parameters:

domNode

-

div containing inserted child tile

Return:

boolean - true if the insert is finished processing, false if not

_processOptimizedRender

private Number _processOptimizedRender(Object domNode)

Process an optimized render.

Parameters:

domNode

-

optimized render div

Return:

Number - if non-negative, the number of milliseconds in the future to reschedule this function call, or a negative number to not reschedule

_processResizeTile

private boolean _processResizeTile(Object domNode)

Process a child resize.

Parameters:

domNode

-

div containing resized child tile

Return:

boolean - true if the resize is finished processing, false if not

ReplaceDomElement

protected Object ReplaceDomElement(HTMLElement newElement,
                                   HTMLElement oldElement)

Hook for peers to perform an optimized replacement of the dom. The dom element may be a child (or descendent) The peer will be bound to its component when this hook is called

Parameters:

newElement	-	the new dom element
oldElement	-	the old dom element

Return:

Object

Overrides:

AdfRichUIPeer.replaceDomElement(AdfUIComponent, HTMLElement, HTMLElement)

_replaceResizedTile

private Object _replaceResizedTile(Object newNode)

Replace a resized tile with the newly rendered one.

Parameters:

newNode

-

newly rendered resized tile

Return:

Object

ResizeNotify

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

Notify the peer about a resize.

Parameters:

oldWidth	-	The old width of the component
oldHeight	-	The old height of the component
newWidth	-	The new width of the component
newHeight	-	The new height of the component

Return:

Object

Overrides:

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

resizeTile

public Object resizeTile(String tileClientId,
                         String styleClass)

Resize a child of the masonryLayout.

Parameters:

tileClientId	-	clientId of the child to resize
styleClass	-	style class for the new size

Return:

Object

_saveTilesOriginalOrder

private Object _saveTilesOriginalOrder(Array arTiles)

Save the original DOM order of the tiles.

Parameters:

arTiles

-

Array of tiles.

Return:

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

_sortTilesOriginalOrder

private static Array _sortTilesOriginalOrder(Array arTiles)

Sort tiles based on their original DOM order.

Parameters:

arTiles

-

Array of tiles.

Return:

Array - The given array of tiles, sorted.