Module: wcFrame

Source:

Members


var $container

The container that holds the frame.

Type:
Source:

var $frame

The outer frame element.

Type:
Source:

Methods


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

PRIVATE - Handled internally by docker and should never be constructed by the user.

Parameters:
Name Type Description
container external:jQuery~selector | external:jQuery~Object | external:domNode A container element for this frame.
parent module:wcSplitter | wcDocker The frames parent object.
isFloating Boolean If true, the frame will be a floating window.
Source:

function addPanel(panel [, index])

Adds a given panel as a new tab item to the frame.

Parameters:
Name Type Argument Description
panel module:wcPanel The panel to add.
index Number <optional>
Insert index.
Source:

function collapse( [instant])

Collapses the frame, if it is a collapser.

Parameters:
Name Type Argument Description
instant Boolean <optional>
If true, collapses without animating.
Source:

function expand()

Expands the frame, if it is a collapser.

Source:

function initSize() -> module:wcDocker~Size

Gets the initially desired size of the panel.

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

function isCollapser() -> Boolean

Gets whether this frame is inside a collapser.

Source:
Returns:
- Whether this frame is inside a collapser.
Type
Boolean

function isExpanded() -> Boolean | undefined

Gets whether the frame is expanded, if it is a collapser.

Source:
Returns:
- The current expanded state, or undefined if it is not a collapser.
Type
Boolean | undefined

function maxSize() -> module:wcDocker~Size

Gets the maximum size of the frame.

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

function minSize() -> module:wcDocker~Size

Gets the minimum size of the frame.

Source:
Returns:
- The minimum size of the frame.
Type
module:wcDocker~Size

function panel( [tabIndex] [, autoFocus]) -> module:wcPanel

Gets, or Sets the currently visible panel.

Parameters:
Name Type Argument Description
tabIndex Number <optional>
If supplied, sets the current panel index.
autoFocus Boolean <optional>
If true, this tab will be focused (brought to front).
Source:
Returns:
- The currently visible panel.
Type
module:wcPanel

function pos( [x] [, y] [, pixels]) -> module:wcDocker~Coordinate

Gets, or Sets the position of the frame.

Parameters:
Name Type Argument Description
x Number <optional>
If supplied, assigns a new horizontal position.
y Number <optional>
If supplied, assigns a new vertical position.
pixels Boolean <optional>
If true, the coordinates passed in will be treated as a pixel position rather than a percentage.
Source:
Returns:
- The current position of the frame. If the pixel parameter was true, the position will be in pixels.
Type
module:wcDocker~Coordinate

function removePanel(panel) -> Boolean

Removes a given panel from the frame.

Parameters:
Name Type Description
panel module:wcPanel The panel to remove.
Source:
Returns:
- True if any panels still remain after the removal.
Type
Boolean

function tabOrientation( [orientation]) -> module:wcDocker.TAB

Gets, or Sets the tab orientation for the frame. This puts the tabbed widgets visually on any side of the frame.

Parameters:
Name Type Argument Description
orientation module:wcDocker.TAB <optional>
Assigns the orientation of the tab items displayed.
Version:
  • 3.0.0
Source:
Returns:
- The current orientation.
Type
module:wcDocker.TAB