| | animFloat : BooleanConfig Options|
| | animFloat : BooleanWhen 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 : BooleanWhen a collapsed region's bar is clicked, the region's panel will be displayed as a floated
+prevent the open and close of these floated panels from being animated (defaults to true). | BorderLayout.Region | | | autoHide : BooleanWhen a collapsed region's bar is clicked, the region's panel will be displayed as a floated
panel. If autoHide = tru... 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 : ObjectAn object containing margins to apply to the region when in the collapsed state in the
-format:{
+user clicks outside of the panel (defaults to true). | BorderLayout.Region | | | cmargins : ObjectAn 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: {
top: (top margin),
@@ -29,7 +29,7 @@ right and left are set to the second.
If there are three values, the top is set to the first value, the left and right are set
to the second, and the bottom is set to the third.
If there are four values, they apply to the top, right, bottom, and left, respectively.
-
| BorderLayout.Region | | | collapseMode : StringcollapseMode supports two configuration values:<div class="mdetail-params">
+ | BorderLayout.Region | | | collapseMode : StringcollapseMode supports two configuration values:<div class="mdetail-params">
undefined (default)<div class="sub-desc">... collapseMode supports two configuration values:
- undefined (default)
By default, collapsible
regions are collapsed by clicking the expand/collapse tool button that renders into the region's
@@ -42,17 +42,17 @@ the bar. In 'mini' mode the region will collapse to a thinner bar than
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 : Booleantrue to allow the user to collapse this region (defaults to false). If
+ See also cmargins. | BorderLayout.Region | | | collapsible : Booleantrue to allow the user to collapse this region (defaults to false). If
true, an expand/collapse tool button will aut... 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 : Booleantrue to allow clicking a collapsed region's bar to display the region's panel floated
+ collapseMode = 'mini' and split = true. | BorderLayout.Region | | | floatable : Booleantrue 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 : ObjectAn object containing margins to apply to the region when in the expanded state in the
-format:{
+clicking the expand button to see it again (defaults to true). | BorderLayout.Region | | | margins : ObjectAn 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: {
top: (top margin),
@@ -70,19 +70,19 @@ right and left are set to the second.
to the second, and the bottom is set to the third.
If there are four values, they apply to the top, right, bottom, and left, respectively.
- Defaults to: {top:0, right:0, bottom:0, left:0}
| BorderLayout.Region | | | minHeight : NumberThe minimum allowable height in pixels for this region (defaults to 50)
-maxHeight may also be specified.
+ Defaults to: {top:0, right:0, bottom:0, left:0}
| BorderLayout.Region | | | minHeight : NumberThe minimum allowable height in pixels for this region (defaults to 50)
+maxHeight may also be specified.
Note: settin... The minimum allowable height in pixels for this region (defaults to 50)
maxHeight may also be specified.
Note: setting the minSize /
maxSize supersedes any specified
-minHeight / maxHeight. | BorderLayout.Region | | | minWidth : NumberThe minimum allowable width in pixels for this region (defaults to 50).
-maxWidth may also be specified.
+minHeight / maxHeight. | BorderLayout.Region | | | minWidth : NumberThe minimum allowable width in pixels for this region (defaults to 50).
+maxWidth may also be specified.
Note: setting... The minimum allowable width in pixels for this region (defaults to 50).
maxWidth may also be specified.
Note: setting the minSize /
maxSize supersedes any specified
-minWidth / maxWidth. | BorderLayout.Region | | | split : Booleantrue to create a SplitRegion and
+minWidth / maxWidth. | BorderLayout.Region | | | split : Booleantrue to create a SplitRegion and
display a 5px wide Ext.SplitBar between this region and its neighbor, allowing the u... true to create a SplitRegion and
display a 5px wide Ext.SplitBar between this region and its neighbor, allowing the user to
resize the regions dynamically. Defaults to false creating a
@@ -95,35 +95,35 @@ for the BoxCom
configs of BoxComponent, and are used only by this class.
if collapseMode = 'mini' requires split = true to reserve space
for the collapse tool
- | BorderLayout.Region |
Public Properties|
| | isCollapsed : Boolean True if this region is collapsed. Read-only. | BorderLayout.Region | | | layout : Layout This region's layout. Read-only. | BorderLayout.Region | | | panel : Ext.Panel This region's panel. Read-only. | BorderLayout.Region | | | position : String This region's layout position (north, south, east, west or center). Read-only. | BorderLayout.Region |
Public MethodsPublic Properties|
| | isCollapsed : Boolean True if this region is collapsed. Read-only. | BorderLayout.Region | | | layout : Layout This region's layout. Read-only. | BorderLayout.Region | | | panel : Ext.Panel This region's panel. Read-only. | BorderLayout.Region | | | position : String This region's layout position (north, south, east, west or center). Read-only. | BorderLayout.Region |
Public Methods|
| | BorderLayout.Region( Layout layout, Object config, String position )
| BorderLayout.Region | | | getMargins()
- :
- ObjectReturns the current margins for this region. If the region is collapsed, the
+must have a center region for the primary content -- all other regions are optional. Returns: | BorderLayout.Region | | | getMargins()
+ :
+ ObjectReturns 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:Returns:ObjectAn object containing the element's margins: <tt>{left: (left
-margin), top: (top margin), right: (right margin), bottom: (bottom margin)}</tt>
| BorderLayout.Region | | | getMinHeight()
- :
- NumberReturns the minimum allowable height for this region. Returns the minimum allowable height for this region. | BorderLayout.Region | | | getMinWidth()
- :
- NumberReturns the minimum allowable width for this region. Returns the minimum allowable width for this region. | BorderLayout.Region | | | getSize()
- :
- ObjectReturns the current size of this region. If the region is collapsed, the size of the
+ margins value will be returned. Parameters:Returns:ObjectAn object containing the element's margins: <tt>{left: (left
+margin), top: (top margin), right: (right margin), bottom: (bottom margin)}</tt>
| BorderLayout.Region | | | getMinHeight()
+ :
+ NumberReturns the minimum allowable height for this region. Returns the minimum allowable height for this region. | BorderLayout.Region | | | getMinWidth()
+ :
+ NumberReturns the minimum allowable width for this region. Returns the minimum allowable width for this region. | BorderLayout.Region | | | getSize()
+ :
+ ObjectReturns 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. | BorderLayout.Region | | | isVisible()
- :
- BooleanTrue if this region is currently visible, else false. True if this region is currently visible, else false. | BorderLayout.Region | | | setPanel( Ext.Panel panel )
- :
- voidSets the specified panel as the container element for this region. Sets the specified panel as the container element for this region. Parameters:panel : Ext.PanelThe new panel
Returns: | BorderLayout.Region | | | slideIn()
- :
- voidIf this Region is floatable, and this Region has been slid into floating visibility, then this method slides
+collapsedEl will be returned, otherwise the size of the region's panel will be returned. | BorderLayout.Region | | | isVisible()
+ :
+ BooleanTrue if this region is currently visible, else false. True if this region is currently visible, else false. | BorderLayout.Region | | | setPanel( Ext.Panel panel )
+ :
+ voidSets the specified panel as the container element for this region. Sets the specified panel as the container element for this region. Parameters:panel : Ext.PanelThe new panel
Returns: | BorderLayout.Region | | | slideIn()
+ :
+ voidIf 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. | BorderLayout.Region | | | slideOut()
- :
- voidIf this Region is floatable, this method slides this Region into full visibility over the top
+this region back into its collapsed state. | BorderLayout.Region | | | slideOut()
+ :
+ voidIf this Region is floatable, this method slides this Region into full visibility over the top
of the center Region wh... If this Region is floatable, this method slides this Region into full visibility over the top
of the center Region where it floats until either slideIn is called, or other regions of the layout
are clicked, or the mouse exits the Region. | BorderLayout.Region |
Public EventsThis class has no public events. |