Class idx.layout.BorderContainer
Extends
dijit.layout.BorderContainer.
BorderContainer with toggling behavior to easily collapse and restore panes.
The toggling behavior can be "locked" programmatically.
Defined in: <idx\layout\BorderContainer.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Field Summary
Field Attributes | Field Name and Description |
---|---|
If true, successive resize calls will be ignored and only the last resize will take effect.
|
|
Derived CSS class.
|
|
Overrides super-class's default to false for performance improvement.
|
|
Specifies toggling behavior.
|
|
Tooltip texts for "expand", "collapse" and "restore".
|
Method Summary
Method Attributes | Method Name and Description |
---|---|
collapse(region)
Collapse a child widget.
|
|
expand(region)
Expand a child widget.
|
|
getSplitter(region)
Overrides base function to allow for "left" and "right" or "leading" and "trailing"
regardless of how the regions on the ContentPane's are defined.
|
|
lock()
Locks toggling behavior.
|
|
onDragEnd(region)
Callback to be called when dragging has ended on a splitter.
|
|
onDragStart(region)
Callback to be called when dragging has started on a splitter.
|
|
onPanelClose(region, logicalRegion, layoutPriority)
Callback to be called when a child widget gets collapsed.
|
|
onPanelOpen(region, logicalRegion, layoutPriority)
Callback to be called when a child widget gets restored or expanded from collapsed state.
|
|
resize(newSize, currentSize)
Handles optimization of resizing with "delayResize" property set.
|
|
restore(region)
Restore a child widget.
|
|
unlock()
Unlocks toggling behavior.
|
Field Detail
{Boolean} delayResize
If true, successive resize calls will be ignored and only the last resize will take effect.
Will not work with IE8 and prior versions.
- Default Value:
- true
{String} idxBaseClass
Derived CSS class.
- Default Value:
- "idxBorderContainer"
{Boolean} liveSplitters
Overrides super-class's default to false for performance improvement.
- Default Value:
- false
{Boolean} toggleable
Specifies toggling behavior.
- Default Value:
- true
{Object} toggleTitles
Tooltip texts for "expand", "collapse" and "restore".
Default texts are used when not specified.
- Default Value:
- null
Method Detail
collapse(region)
Collapse a child widget.
- Parameters:
- {String} region
expand(region)
Expand a child widget.
- Parameters:
- {String} region
getSplitter(region)
Overrides base function to allow for "left" and "right" or "leading" and "trailing"
regardless of how the regions on the ContentPane's are defined.
- Parameters:
- region
- The name of the region which may be "left", "right", "top", "bottom", "center", "leading" or or "trailing".
lock()
Locks toggling behavior.
onDragEnd(region)
Callback to be called when dragging has ended on a splitter.
- Parameters:
- {String} region
onDragStart(region)
Callback to be called when dragging has started on a splitter.
- Parameters:
- {String} region
onPanelClose(region, logicalRegion, layoutPriority)
Callback to be called when a child widget gets collapsed.
onPanelOpen(region, logicalRegion, layoutPriority)
Callback to be called when a child widget gets restored or expanded from collapsed state.
resize(newSize, currentSize)
Handles optimization of resizing with "delayResize" property set.
- Parameters:
- {Object} newSize
- {Object} currentSize
restore(region)
Restore a child widget.
- Parameters:
- {String} region
unlock()
Unlocks toggling behavior.