Echo.Sync.SplitPane

Echo.Sync
SplitPane

Class Hierarchy:

Component rendering peer: SplitPane

Descendant Class Summary
`Echo.Sync.SplitPane.ChildPane`

Constructor Summary
Public	`Echo.Sync.SplitPane()` Constructor.

Instance Method Summary
Internal	`_getBoundedSeparatorPosition()` Converts a desired separator position into a render-able separator position that complies with the SplitPane's separator bounds (miniumSize and maximumSize of child component layout data).
Internal	`_getInsetsSizeAdjustment()` Determines the number of pixels of inset margin specified in a layout data object.
Public	`getPreferredSize()` Calculates the preferred rendered size of the SplitPane by measuring the sizes of its content and/or invoking getPreferredSize() on its content (if supported).
Internal	`_getSize()` Retrieves the (potentially cached) dimensions of the SplitPane outer DIV.
Internal	`_hasRelocatedChildren()` Determines if the specified update has caused either child of the SplitPane to be relocated (i.
Internal	`_loadRenderData()` Retrieves properties from Echo.
Internal	`_overlayAdd()` Adds an overlay DIV at maximum z-index to cover any objects that will not provide move mouseup freedback.
Internal	`_overlayRemove()` Removes the overlay DIV.
Internal	`_processKeyPress()` Processes a key press event.
Internal	`_processSeparatorMouseDown()` Processes a mouse down event on a SplitPane separator that is about to be dragged.
Internal	`_processSeparatorMouseMove()` Processes a mouse move event on a SplitPane separator that is being dragged.
Internal	`_processSeparatorMouseUp()` Processes a mouse up event on a SplitPane separator that was being dragged.
Internal	`_processSeparatorRolloverEnter()` Processes a mouse rollover enter event on the SplitPane separator.
Internal	`_processSeparatorRolloverExit()` Processes a mouse rollover exit event on the SplitPane separator.
Internal	`_redraw()` Updates the variable CSS attributes of the SplitPane.
Internal	`_removeSeparatorListeners()` Removes listeners from the separator used to monitor its state while it is being dragging.
Public	`renderAdd()` Adds basic structure of SplitPane to DOM, but much work is delayed for initial invocation of renderDisplay().
Internal	`_renderAddChild()` Renders the addition of a child.
Public	`renderDisplay()`
Public	`renderDispose()`
Internal	`_renderRemoveChild()` Renders the removal a single child component.
Public	`renderUpdate()`

Methods inherited from class Echo.Render.ComponentSync

renderAdd, renderDispose, renderUpdate

Echo.Render.ComponentSync()

Constructor.

_getBoundedSeparatorPosition

Converts a desired separator position into a render-able separator position that complies with the SplitPane's separator bounds (miniumSize and maximumSize of child component layout data).

Parameters:: position (Number) - requested separator position

Returns:: (Number) the bounded separator position

_getInsetsSizeAdjustment

Determines the number of pixels of inset margin specified in a layout data object. Horizontal or vertical pixels will be analyzed based on the SplitPane's orientation. The result of this method can be subtracted from the desired height or width of a pane to determine the appropriate value to set for a CSS width/height attribute.

Parameters:: layoutData (Object) - a component layout data object

Returns:: (Number) the number of inset pixels

getPreferredSize

Calculates the preferred rendered size of the SplitPane by measuring the sizes of its content and/or invoking getPreferredSize() on its content (if supported).

_getSize

Retrieves the (potentially cached) dimensions of the SplitPane outer DIV.

Returns:: (Core.Web.Measure.Bounds) the dimensions

_hasRelocatedChildren

Determines if the specified update has caused either child of the SplitPane to be relocated (i.e., a child which existed before continues to exist, but at a different index).

Parameters:: update (Echo.Update.ComponentUpdate) - the component update

Returns:: (Boolean) true if a child has been relocated

_loadRenderData

Retrieves properties from Echo.SplitPane component instances and stores them in local variables in a format more convenient for processing by this synchronization peer.

_overlayAdd

Adds an overlay DIV at maximum z-index to cover any objects that will not provide move mouseup freedback.

_overlayRemove

Removes the overlay DIV.

_processKeyPress

Processes a key press event.

_processSeparatorMouseDown

Processes a mouse down event on a SplitPane separator that is about to be dragged.

_processSeparatorMouseMove

Processes a mouse move event on a SplitPane separator that is being dragged.

_processSeparatorMouseUp

Processes a mouse up event on a SplitPane separator that was being dragged.

_processSeparatorRolloverEnter

Processes a mouse rollover enter event on the SplitPane separator.

_processSeparatorRolloverExit

Processes a mouse rollover exit event on the SplitPane separator.

_redraw

Updates the variable CSS attributes of the SplitPane.

Parameters:: position (Number) - the pixel position of the separator

_removeSeparatorListeners

Removes listeners from the separator used to monitor its state while it is being dragging.

renderAdd

Adds basic structure of SplitPane to DOM, but much work is delayed for initial invocation of renderDisplay().

_renderAddChild

Renders the addition of a child.

Parameters:: update (Echo.Update.ComponentUpdate) - the update; child (Echo.Component) - the added child; index (Number) - the index of the child within the SplitPane

renderDisplay

renderDispose

_renderRemoveChild

Renders the removal a single child component.

Parameters:: update (Echo.Update.ComponentUpdate) - the update; child (Echo.Component) - the removed child

renderUpdate