| Package: | CQ.Ext.layout |
| Class: | BorderLayout.Region |
| Subclasses: | BorderLayout.SplitRegion |
| Extends: | Object |
| Clientlib: | cq.widgets |
This is a region of a BorderLayout that acts as a subcontainer within the layout. Each region has its own layout that is independent of other regions and the containing BorderLayout, and can be any of the valid Ext layout types.
Region size is managed automatically and cannot be changed by the user -- for resizable regions, see CQ.Ext.layout.BorderLayout.SplitRegion.
| Config Options | Defined By | |
|---|---|---|
|
animFloat : Boolean When a collapsed region's bar is clicked, the region's panel will be displayed as a floated panel that will close aga...
When a collapsed region's bar is clicked, the region's panel will be displayed as a floated panel that will close again once the user mouses out of that panel (or clicks out if autoHide = false). Setting animFloat = false will prevent the open and close of these floated panels from being animated (defaults to true).
|
BorderLayout.Region | |
|
autoHide : Boolean When a collapsed region's bar is clicked, the region's panel will be displayed as a floated panel. If autoHide = true...
When a collapsed region's bar is clicked, the region's panel will be displayed as a floated panel. If autoHide = true, the panel will automatically hide after the user mouses out of the panel. If autoHide = false, the panel will continue to display until the user clicks outside of the panel (defaults to true).
|
BorderLayout.Region | |
|
cmargins : Object An object containing margins to apply to the region when in the collapsed state in the format:{
top: (top margin)...
An object containing margins to apply to the region when in the collapsed state in the format:
May also be a string containing space-separated, numeric margin values. The order of the sides associated with each value matches the way CSS processes margin values.
|
BorderLayout.Region | |
|
collapseMode : String collapseMode supports two configuration values: undefined (default)By default, collapsible regions are collapsed by c...
collapseMode supports two configuration values:
Note: if a collapsible region does not have a title bar, then set collapseMode = 'mini' and split = true in order for the region to be collapsible by the user as the expand/collapse tool button (that would go in the title bar) will not be rendered. See also cmargins. |
BorderLayout.Region | |
|
collapsible : Boolean true to allow the user to collapse this region (defaults to false). If true, an expand/collapse tool button will auto...
true to allow the user to collapse this region (defaults to false). If true, an expand/collapse tool button will automatically be rendered into the title bar of the region, otherwise the button will not be shown. Note: that a title bar is required to display the collapse/expand toggle button -- if no title is specified for the region's panel, the region will only be collapsible if collapseMode = 'mini' and split = true. |
BorderLayout.Region | |
|
floatable : Boolean true to allow clicking a collapsed region's bar to display the region's panel floated above the layout, false to forc...
true to allow clicking a collapsed region's bar to display the region's panel floated above the layout, false to force the user to fully expand a collapsed region by clicking the expand button to see it again (defaults to true).
|
BorderLayout.Region | |
|
margins : Object An object containing margins to apply to the region when in the expanded state in the format:{
top: (top margin),...
An object containing margins to apply to the region when in the expanded state in the format:
May also be a string containing space-separated, numeric margin values. The order of the sides associated with each value matches the way CSS processes margin values:
Defaults to: |
BorderLayout.Region | |
|
minHeight : Number The minimum allowable height in pixels for this region (defaults to 50) maxHeight may also be specified. Note: settin...
|
BorderLayout.Region | |
|
minWidth : Number The minimum allowable width in pixels for this region (defaults to 50). maxWidth may also be specified. Note: setting...
|
BorderLayout.Region | |
|
split : Boolean true to create a SplitRegion and display a 5px wide CQ.Ext.SplitBar between this region and its neighbor, allowing th...
true to create a SplitRegion and display a 5px wide CQ.Ext.SplitBar between this region and its neighbor, allowing the user to resize the regions dynamically. Defaults to false creating a Region. Notes:
|
BorderLayout.Region | |
| Method | Defined By | |
|---|---|---|
BorderLayout.Region( Layout layout, Object config, String position ) Create a new Region.
Create a new Region.
Parameters:
|
BorderLayout.Region | |
|
getMargins() : Object Returns the current margins for this region. If the region is collapsed, the
cmargins (collapsed margins) value will...
Returns the current margins for this region. If the region is collapsed, the
cmargins (collapsed margins) value will be returned, otherwise the
margins value will be returned.
Parameters:
|
BorderLayout.Region | |
|
getMinHeight() : Number Returns the minimum allowable height for this region.
Returns the minimum allowable height for this region.
Parameters:
|
BorderLayout.Region | |
|
getMinWidth() : Number Returns the minimum allowable width for this region.
Returns the minimum allowable width for this region.
Parameters:
|
BorderLayout.Region | |
|
getSize() : Object Returns the current size of this region. If the region is collapsed, the size of the
collapsedEl will be returned, o...
Returns the current size of this region. If the region is collapsed, the size of the
collapsedEl will be returned, otherwise the size of the region's panel will be returned.
Parameters:
|
BorderLayout.Region | |
|
isVisible() : Boolean True if this region is currently visible, else false.
True if this region is currently visible, else false.
Parameters:
|
BorderLayout.Region | |
setPanel( CQ.Ext.Panel panel ) : void Sets the specified panel as the container element for this region.
Sets the specified panel as the container element for this region.
Parameters:
|
BorderLayout.Region | |
|
slideIn() : void If this Region is floatable, and this Region has been slid into floating visibility, then this method slides
this reg...
If this Region is floatable, and this Region has been slid into floating visibility, then this method slides
this region back into its collapsed state.
Parameters:
|
BorderLayout.Region | |
|
slideOut() : void If this Region is floatable, this method slides this Region into full visibility over the top
of the center Region wh...
|
BorderLayout.Region | |