JavaScript API Reference for Oracle ADF Faces

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

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

public class AdfDhtmlToolboxPeer
extends AdfRichUIPeer

AdfDhtmlToolboxPeer

public AdfDhtmlToolboxPeer()

Peer Implementation for the toolbox

_areRowsValid

private Object _areRowsValid()

Returns true if we already have valid cached row values.

Return:

Object

_getPadding

private Object _getPadding(Object element)

Helper method to get the left/right outer padding and margin for an element

Parameters:

element

Return:

Object

_getRowInfo

private Object _getRowInfo(Object rowElement)

Returns information for all toolbars in a row for later use.

Parameters:

rowElement

Return:

Object - JavaScript object that contains the following: 1) Array of Child Peers for this row 2) Total Width of the row (not including border sizes) 3) Fixed Width of the row 4) Total Flex for this row

_initRows

private Object _initRows()

Collects information on each row in the toolbox and saves this off in a private variable.

Return:

Object

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)

_overflowChildren

private Object _overflowChildren(Object row,
                                 Number newRowWidth,
                                 Number spaceToRemove)

Set the toolbar sizes for the toolbars in the toolbox row. The algorithm for overflow is to go from right to left. Meaning take the right most toolbar and try to have it overflow first. If there is still space that needs to be removed it moves to the next toolbar to its left and repeats until the space to be removed has been accounteded for. This is done by taking the preferred width of the toolbar and subtracting all the space to be removed (spaceRemoved). IF the resulting space is less then the minimum width for this toolbar (which is the size of the overflow icon) then the toolbar width is set to the minimum. The toolbar logic is then responsible for filling the overflow popup component based on the width value provided by the toolbox. Next the spaceRemoved is decreased by the amount the toolbar use to consume minus the minimum width. The same process is started again with the next toolbar to the left. ELSE In the case where the preferred width minus the spaceRemoved is greater then the minimum width of the toolbar then we use the new dimension and set the toolbar width to this value. The toolbar is responsable for determining what elements need to go into the overflow.

Parameters:

row
newRowWidth	-	the new row width of the toolbox row
spaceToRemove	-	is a positive integer value used to remove space from each toolbar in this toolbox row.

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)

_stretchChildren

private Object _stretchChildren(Object row,
                                Number newRowWidth,
                                Number bonusSpace)

Increases toolbar sizes to fill up bonus space. This method will do two potential updates for the toolbar element. 1) it will try to provide the toolbar peer with all the space it requires to prevent it from overflowing. 2) Distribute space to each toolbar in this row that has a flex value that is not zero. For peers that are not toolbars the only action is to set the parent width (a TD) to the width of the peer to prevent the browser from allocating extra space for the TD. Example of none toolbars is things like menu's which can be directly added to the toolbox without surrounding it in a toolbar.

Parameters:

row
newRowWidth	-	the new row width of the toolbox row
bonusSpace	-	is a positive integer value used to distribute extra space.

Return:

Object