Module: wcSplitter

Source:

Members


var $pane

An array of two elements representing each side of the splitter.Index 0 is always either top or left depending on orientation.

Type:
Source:

Methods


<static> function constructor(container, parent, orientation)

Parameters:
Name Type Description
container external:jQuery~selector | external:jQuery~Object | external:domNode A container element for this splitter.
parent wcLayout | wcSplitter | wcDocker The splitter's parent object.
orientation module:wcDocker.ORIENTATION The orientation of the splitter bar.
Source:

function animPos(value)

Animates to a given splitter position.

Parameters:
Name Type Description
value Number Assigns the target splitter position. Value must be a percentage between 0 and 1.
module:wcSplitter~onFinished A finished event handler.
Source:

function bottom( [item]) -> module:wcLayout | module:wcPanel | module:wcFrame | wcSplitter | Boolean

Gets, or Sets the element associated with the bottom pane (for vertical layouts).

Parameters:
Name Type Argument Description
item module:wcLayout | module:wcPanel | module:wcFrame | wcSplitter <optional>
If supplied, the pane will be replaced with this item.
Source:
Returns:
- The current object assigned to the pane, or false.
Type
module:wcLayout | module:wcPanel | module:wcFrame | wcSplitter | Boolean

function destroy( [destroyPanes])

Destroys the splitter.

Parameters:
Name Type Argument Default Description
destroyPanes Boolean <optional>
true If true, both panes attached will be destroyed as well. Use false if you plan to continue using the objects assigned to each pane, or make sure to remove them first before destruction.
Source:

function initLayouts( [topLeftLayout] [, bottomRightLayout])

Initializes the two panes of the splitter with its own layouts.
This should be used to initialize the splitter when creating one for use inside your panel.

Parameters:
Name Type Argument Default Description
topLeftLayout module:wcDocker.LAYOUT <optional>
wcDocker.LAYOUT.TABLE The type of layout to use for the top or left pane.
bottomRightLayout module:wcDocker.LAYOUT <optional>
wcDocker.LAYOUT.TABLE The type of layout to use for the bottom or right pane.
Source:

function left( [item]) -> module:wcLayout | module:wcPanel | module:wcFrame | wcSplitter | Boolean

Gets, or Sets the element associated with the left side pane (for horizontal layouts).

Parameters:
Name Type Argument Description
item module:wcLayout | module:wcPanel | module:wcFrame | wcSplitter <optional>
If supplied, the pane will be replaced with this item.
Source:
Returns:
- The current object assigned to the pane, or false.
Type
module:wcLayout | module:wcPanel | module:wcFrame | wcSplitter | Boolean

function maxSize() -> module:wcDocker~Size

Gets the maximum size constraint of the outer splitter area.

Source:
Returns:
- The maximum size.
Type
module:wcDocker~Size

function minSize() -> module:wcDocker~Size

Gets the minimum size constraint of the outer splitter area.

Source:
Returns:
The minimum size.
Type
module:wcDocker~Size

function orientation(orientation)

Gets, or Sets the orientation of the splitter.

Parameters:
Name Type Description
orientation module:wcDocker.ORIENTATION The new orientation of the splitter.
Source:

function pane(index [, item]) -> module:wcLayout | module:wcPanel | module:wcFrame | wcSplitter | Boolean

Gets, or Sets the element associated with a pane.

Parameters:
Name Type Argument Description
index Number The index of the pane, only 0 and 1 are valid.
item module:wcLayout | module:wcPanel | module:wcFrame | wcSplitter <optional>
If supplied, the pane will be replaced with this item.
Source:
Returns:
- The current object assigned to the pane, or false.
Type
module:wcLayout | module:wcPanel | module:wcFrame | wcSplitter | Boolean

function pos( [value]) -> Number

Get, or Set the current splitter position.

Parameters:
Name Type Argument Description
value Number <optional>
If supplied, assigns a new splitter position. Value must be a percentage value between 0 and 1.
Source:
Returns:
- The current position.
Type
Number

Gets, or Sets the element associated with the right side pane (for horizontal layouts).

Parameters:
Name Type Argument Description
item module:wcLayout | module:wcPanel | module:wcFrame | wcSplitter <optional>
If supplied, the pane will be replaced with this item.
Source:
Returns:
- The current object assigned to the pane, or false.
Type
module:wcLayout | module:wcPanel | module:wcFrame | wcSplitter | Boolean

function scrollable(index [, x] [, y]) -> module:wcDocker~Scrollable

Gets, or Sets whether a pane can be scrolled via scroll bars.By default, scrolling is enabled in both directions.

Parameters:
Name Type Argument Description
index Number The index of the pane, only 0 and 1 are valid.
x Boolean <optional>
Whether to allow scrolling in the horizontal direction.
y Boolean <optional>
Whether to allow scrolling in the vertical direction.
Source:
Returns:
- The current scroll state for each direction.
Type
module:wcDocker~Scrollable

function top( [item]) -> module:wcLayout | module:wcPanel | module:wcFrame | wcSplitter | Boolean

Gets, or Sets the element associated with the top pane (for vertical layouts).

Parameters:
Name Type Argument Description
item module:wcLayout | module:wcPanel | module:wcFrame | wcSplitter <optional>
If supplied, the pane will be replaced with this item.
Source:
Returns:
- The current object assigned to the pane, or false.
Type
module:wcLayout | module:wcPanel | module:wcFrame | wcSplitter | Boolean