Upgrade to ExtJS 3.0.0 - Released 07/06/2009
[extjs.git] / docs / output / Ext.layout.BorderLayout.SplitRegion.html
1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.layout.BorderLayout.SplitRegion-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.layout.BorderLayout.SplitRegion-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.layout.BorderLayout.SplitRegion-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.layout.BorderLayout.SplitRegion-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.layout.BorderLayout.SplitRegion"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.layout.BorderLayout.Region.html" ext:member="" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif">BorderLayout.SplitRegion</pre></div><h1>Class <a href="source/BorderLayout.html#cls-Ext.layout.BorderLayout.SplitRegion">Ext.layout.BorderLayout.SplitRegion</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.layout</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">BorderLayout.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/BorderLayout.html#cls-Ext.layout.BorderLayout.SplitRegion">BorderLayout.SplitRegion</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.layout.BorderLayout.Region.html" ext:cls="Ext.layout.BorderLayout.Region" ext:member="">BorderLayout.Region</a></td></tr></table><div class="description"><p>This is a specialized type of <a href="output/Ext.layout.BorderLayout.Region.html" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout region</a> that
2 has a built-in <a href="output/Ext.SplitBar.html" ext:cls="Ext.SplitBar">Ext.SplitBar</a> for user resizing of regions.  The movement of the split bar
3 is configurable to move either <a href="output/Ext.layout.BorderLayout.SplitRegion.html#Ext.layout.BorderLayout.SplitRegion-tickSize" ext:member="tickSize" ext:cls="Ext.layout.BorderLayout.SplitRegion">smooth or incrementally</a>.</p></div><div class="hr"></div><a id="Ext.layout.BorderLayout.SplitRegion-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-animFloat"></a><b><a href="source/BorderLayout.html#cfg-Ext.layout.BorderLayout.Region-animFloat">animFloat</a></b> : Boolean<div class="mdesc"><div class="short">When a collapsed region's bar is clicked, the region's panel will be displayed as a floated
4 panel that will close aga...</div><div class="long">When a collapsed region's bar is clicked, the region's panel will be displayed as a floated
5 panel that will close again once the user mouses out of that panel (or clicks out if
6 <tt><a href="output/Ext.layout.BorderLayout.Region.html#Ext.layout.BorderLayout.Region-autoHide" ext:member="autoHide" ext:cls="Ext.layout.BorderLayout.Region">autoHide</a> = false</tt>).  Setting <tt><a href="output/Ext.layout.BorderLayout.Region.html#Ext.layout.BorderLayout.Region-animFloat" ext:member="animFloat" ext:cls="Ext.layout.BorderLayout.Region">animFloat</a> = false</tt> will
7 prevent the open and close of these floated panels from being animated (defaults to <tt>true</tt>).</div></div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#animFloat" ext:member="#animFloat" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-autoHide"></a><b><a href="source/BorderLayout.html#cfg-Ext.layout.BorderLayout.Region-autoHide">autoHide</a></b> : Boolean<div class="mdesc"><div class="short">When a collapsed region's bar is clicked, the region's panel will be displayed as a floated
8 panel.  If autoHide = tru...</div><div class="long">When a collapsed region's bar is clicked, the region's panel will be displayed as a floated
9 panel.  If <tt>autoHide = true</tt>, the panel will automatically hide after the user mouses
10 out of the panel.  If <tt>autoHide = false</tt>, the panel will continue to display until the
11 user clicks outside of the panel (defaults to <tt>true</tt>).</div></div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#autoHide" ext:member="#autoHide" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-cmargins"></a><b><a href="source/BorderLayout.html#cfg-Ext.layout.BorderLayout.Region-cmargins">cmargins</a></b> : Object<div class="mdesc"><div class="short">An object containing margins to apply to the region when in the collapsed state in the
12 format:{
13     top: (top margin)...</div><div class="long">An object containing margins to apply to the region when in the collapsed state in the
14 format:<pre><code>{
15     top: (top margin),
16     right: (right margin),
17     bottom: (bottom margin),
18     left: (left margin)
19 }</code></pre>
20 <p>May also be a string containing space-separated, numeric margin values. The order of the
21 sides associated with each value matches the way CSS processes margin values.</p>
22 <p><ul>
23 <li>If there is only one value, it applies to all sides.</li>
24 <li>If there are two values, the top and bottom borders are set to the first value and the
25 right and left are set to the second.</li>
26 <li>If there are three values, the top is set to the first value, the left and right are set
27 to the second, and the bottom is set to the third.</li>
28 <li>If there are four values, they apply to the top, right, bottom, and left, respectively.</li>
29 </ul></p></div></div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#cmargins" ext:member="#cmargins" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-collapseMode"></a><b><a href="source/BorderLayout.html#cfg-Ext.layout.BorderLayout.Region-collapseMode">collapseMode</a></b> : String<div class="mdesc"><div class="short">collapseMode supports two configuration values:&lt;div class="mdetail-params"&gt;
30 undefined (default)&lt;div class="sub-desc"&gt;...</div><div class="long"><tt>collapseMode</tt> supports two configuration values:<div class="mdetail-params"><ul>
31 <li><b><tt>undefined</tt></b> (default)<div class="sub-desc">By default, <a href="output/Ext.layout.BorderLayout.Region.html#Ext.layout.BorderLayout.Region-collapsible" ext:member="collapsible" ext:cls="Ext.layout.BorderLayout.Region">collapsible</a>
32 regions are collapsed by clicking the expand/collapse tool button that renders into the region's
33 title bar.</div></li>
34 <li><b><tt>'mini'</tt></b><div class="sub-desc">Optionally, when <tt>collapseMode</tt> is set to
35 <tt>'mini'</tt> the region's split bar will also display a small collapse button in the center of
36 the bar. In <tt>'mini'</tt> mode the region will collapse to a thinner bar than in normal mode.
37 </div></li>
38 </ul></div></p>
39 <p><b>Note</b>: if a collapsible region does not have a title bar, then set <tt>collapseMode =
40 'mini'</tt> and <tt><a href="output/Ext.layout.BorderLayout.Region.html#Ext.layout.BorderLayout.Region-split" ext:member="split" ext:cls="Ext.layout.BorderLayout.Region">split</a> = true</tt> in order for the region to be <a href="output/Ext.layout.BorderLayout.Region.html#Ext.layout.BorderLayout.Region-collapsible" ext:member="collapsible" ext:cls="Ext.layout.BorderLayout.Region">collapsible</a>
41 by the user as the expand/collapse tool button (that would go in the title bar) will not be rendered.</p>
42 <p>See also <tt><a href="output/Ext.layout.BorderLayout.Region.html#Ext.layout.BorderLayout.Region-cmargins" ext:member="cmargins" ext:cls="Ext.layout.BorderLayout.Region">cmargins</a></tt>.</p></div></div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#collapseMode" ext:member="#collapseMode" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-collapsible"></a><b><a href="source/BorderLayout.html#cfg-Ext.layout.BorderLayout.Region-collapsible">collapsible</a></b> : Boolean<div class="mdesc"><div class="short">true to allow the user to collapse this region (defaults to false).  If
43 true, an expand/collapse tool button will aut...</div><div class="long"><p><tt>true</tt> to allow the user to collapse this region (defaults to <tt>false</tt>).  If
44 <tt>true</tt>, an expand/collapse tool button will automatically be rendered into the title
45 bar of the region, otherwise the button will not be shown.</p>
46 <p><b>Note</b>: that a title bar is required to display the collapse/expand toggle button -- if
47 no <tt>title</tt> is specified for the region's panel, the region will only be collapsible if
48 <tt><a href="output/Ext.layout.BorderLayout.Region.html#Ext.layout.BorderLayout.Region-collapseMode" ext:member="collapseMode" ext:cls="Ext.layout.BorderLayout.Region">collapseMode</a> = 'mini'</tt> and <tt><a href="output/Ext.layout.BorderLayout.Region.html#Ext.layout.BorderLayout.Region-split" ext:member="split" ext:cls="Ext.layout.BorderLayout.Region">split</a> = true</tt>.</div></div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#collapsible" ext:member="#collapsible" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.SplitRegion-collapsibleSplitTip"></a><b><a href="source/BorderLayout.html#cfg-Ext.layout.BorderLayout.SplitRegion-collapsibleSplitTip">collapsibleSplitTip</a></b> : String<div class="mdesc"><div class="short">The tooltip to display when the user hovers over a
49 collapsible region's split bar
50 (defaults to "Drag to resize. Doubl...</div><div class="long">The tooltip to display when the user hovers over a
51 <a href="output/Ext.layout.BorderLayout.Region.html#Ext.layout.BorderLayout.Region-collapsible" ext:member="collapsible" ext:cls="Ext.layout.BorderLayout.Region">collapsible</a> region's split bar
52 (defaults to "Drag to resize. Double click to hide."). Only applies if
53 <tt><a href="output/Ext.layout.BorderLayout.SplitRegion.html#Ext.layout.BorderLayout.SplitRegion-useSplitTips" ext:member="useSplitTips" ext:cls="Ext.layout.BorderLayout.SplitRegion">useSplitTips</a> = true</tt>.</div></div></td><td class="msource">BorderLayout.SplitRegion</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-floatable"></a><b><a href="source/BorderLayout.html#cfg-Ext.layout.BorderLayout.Region-floatable">floatable</a></b> : Boolean<div class="mdesc"><div class="short">true to allow clicking a collapsed region's bar to display the region's panel floated
54 above the layout, false to forc...</div><div class="long"><tt>true</tt> to allow clicking a collapsed region's bar to display the region's panel floated
55 above the layout, <tt>false</tt> to force the user to fully expand a collapsed region by
56 clicking the expand button to see it again (defaults to <tt>true</tt>).</div></div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#floatable" ext:member="#floatable" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-margins"></a><b><a href="source/BorderLayout.html#cfg-Ext.layout.BorderLayout.Region-margins">margins</a></b> : Object<div class="mdesc"><div class="short">An object containing margins to apply to the region when in the expanded state in the
57 format:{
58     top: (top margin),...</div><div class="long">An object containing margins to apply to the region when in the expanded state in the
59 format:<pre><code>{
60     top: (top margin),
61     right: (right margin),
62     bottom: (bottom margin),
63     left: (left margin)
64 }</code></pre>
65 <p>May also be a string containing space-separated, numeric margin values. The order of the
66 sides associated with each value matches the way CSS processes margin values:</p>
67 <p><div class="mdetail-params"><ul>
68 <li>If there is only one value, it applies to all sides.</li>
69 <li>If there are two values, the top and bottom borders are set to the first value and the
70 right and left are set to the second.</li>
71 <li>If there are three values, the top is set to the first value, the left and right are set
72 to the second, and the bottom is set to the third.</li>
73 <li>If there are four values, they apply to the top, right, bottom, and left, respectively.</li>
74 </ul></div></p>
75 <p>Defaults to:</p><pre><code>{top:0, right:0, bottom:0, left:0}</code></pre></div></div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#margins" ext:member="#margins" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-minHeight"></a><b><a href="source/BorderLayout.html#cfg-Ext.layout.BorderLayout.Region-minHeight">minHeight</a></b> : Number<div class="mdesc"><div class="short">The minimum allowable height in pixels for this region (defaults to 50)
76 maxHeight may also be specified.
77 Note: settin...</div><div class="long">The minimum allowable height in pixels for this region (defaults to <tt>50</tt>)
78 <tt>maxHeight</tt> may also be specified.</p><br>
79 <p><b>Note</b>: setting the <tt><a href="output/Ext.SplitBar.html#Ext.SplitBar-minSize" ext:member="minSize" ext:cls="Ext.SplitBar">minSize</a></tt> / 
80 <tt><a href="output/Ext.SplitBar.html#Ext.SplitBar-maxSize" ext:member="maxSize" ext:cls="Ext.SplitBar">maxSize</a></tt> supersedes any specified 
81 <tt>minHeight</tt> / <tt>maxHeight</tt>.</p></div></div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#minHeight" ext:member="#minHeight" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-minWidth"></a><b><a href="source/BorderLayout.html#cfg-Ext.layout.BorderLayout.Region-minWidth">minWidth</a></b> : Number<div class="mdesc"><div class="short">The minimum allowable width in pixels for this region (defaults to 50).
82 maxWidth may also be specified.
83 Note: setting...</div><div class="long"><p>The minimum allowable width in pixels for this region (defaults to <tt>50</tt>).
84 <tt>maxWidth</tt> may also be specified.</p><br>
85 <p><b>Note</b>: setting the <tt><a href="output/Ext.SplitBar.html#Ext.SplitBar-minSize" ext:member="minSize" ext:cls="Ext.SplitBar">minSize</a></tt> / 
86 <tt><a href="output/Ext.SplitBar.html#Ext.SplitBar-maxSize" ext:member="maxSize" ext:cls="Ext.SplitBar">maxSize</a></tt> supersedes any specified 
87 <tt>minWidth</tt> / <tt>maxWidth</tt>.</p></div></div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#minWidth" ext:member="#minWidth" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-split"></a><b><a href="source/BorderLayout.html#cfg-Ext.layout.BorderLayout.Region-split">split</a></b> : Boolean<div class="mdesc"><div class="short">true to create a SplitRegion and 
88 display a 5px wide Ext.SplitBar between this region and its neighbor, allowing the ...</div><div class="long"><p><tt>true</tt> to create a <a href="output/Ext.layout.BorderLayout.SplitRegion.html" ext:cls="Ext.layout.BorderLayout.SplitRegion">SplitRegion</a> and 
89 display a 5px wide <a href="output/Ext.SplitBar.html" ext:cls="Ext.SplitBar">Ext.SplitBar</a> between this region and its neighbor, allowing the user to
90 resize the regions dynamically.  Defaults to <tt>false</tt> creating a
91 <a href="output/Ext.layout.BorderLayout.Region.html" ext:cls="Ext.layout.BorderLayout.Region">Region</a>.</p><br>
92 <p><b>Notes</b>:</p><div class="mdetail-params"><ul>
93 <li>this configuration option is ignored if <tt>region='center'</tt></li> 
94 <li>when <tt>split == true</tt>, it is common to specify a
95 <tt><a href="output/Ext.SplitBar.html#Ext.SplitBar-minSize" ext:member="minSize" ext:cls="Ext.SplitBar">minSize</a></tt> and <tt><a href="output/Ext.SplitBar.html#Ext.SplitBar-maxSize" ext:member="maxSize" ext:cls="Ext.SplitBar">maxSize</a></tt>
96 for the <a href="output/Ext.BoxComponent.html" ext:cls="Ext.BoxComponent">BoxComponent</a> representing the region. These are not native
97 configs of <a href="output/Ext.BoxComponent.html" ext:cls="Ext.BoxComponent">BoxComponent</a>, and are used only by this class.</li>
98 <li>if <tt><a href="output/Ext.layout.BorderLayout.Region.html#Ext.layout.BorderLayout.Region-collapseMode" ext:member="collapseMode" ext:cls="Ext.layout.BorderLayout.Region">collapseMode</a> = 'mini'</tt> requires <tt>split = true</tt> to reserve space
99 for the collapse tool</tt></li> 
100 </ul></div></div></div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#split" ext:member="#split" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.SplitRegion-splitTip"></a><b><a href="source/BorderLayout.html#cfg-Ext.layout.BorderLayout.SplitRegion-splitTip">splitTip</a></b> : String<div class="mdesc"><div class="short">The tooltip to display when the user hovers over a
101 non-collapsible region's split bar
102 (defaults to "Drag to resize.")...</div><div class="long">The tooltip to display when the user hovers over a
103 <a href="output/Ext.layout.BorderLayout.Region.html#Ext.layout.BorderLayout.Region-collapsible" ext:member="collapsible" ext:cls="Ext.layout.BorderLayout.Region">non-collapsible</a> region's split bar
104 (defaults to <tt>"Drag to resize."</tt>).  Only applies if
105 <tt><a href="output/Ext.layout.BorderLayout.SplitRegion.html#Ext.layout.BorderLayout.SplitRegion-useSplitTips" ext:member="useSplitTips" ext:cls="Ext.layout.BorderLayout.SplitRegion">useSplitTips</a> = true</tt>.</div></div></td><td class="msource">BorderLayout.SplitRegion</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.SplitRegion-tickSize"></a><b><a href="source/BorderLayout.html#cfg-Ext.layout.BorderLayout.SplitRegion-tickSize">tickSize</a></b> : Number<div class="mdesc">The increment, in pixels by which to move this Region's <a href="output/Ext.SplitBar.html" ext:cls="Ext.SplitBar">SplitBar</a>.
106 By default, the <a href="output/Ext.SplitBar.html" ext:cls="Ext.SplitBar">SplitBar</a> moves smoothly.</div></td><td class="msource">BorderLayout.SplitRegion</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.SplitRegion-useSplitTips"></a><b><a href="source/BorderLayout.html#cfg-Ext.layout.BorderLayout.SplitRegion-useSplitTips">useSplitTips</a></b> : Boolean<div class="mdesc"><div class="short">true to display a tooltip when the user hovers over a region's split bar
107 (defaults to false).  The tooltip text will ...</div><div class="long"><tt>true</tt> to display a tooltip when the user hovers over a region's split bar
108 (defaults to <tt>false</tt>).  The tooltip text will be the value of either
109 <tt><a href="output/Ext.layout.BorderLayout.SplitRegion.html#Ext.layout.BorderLayout.SplitRegion-splitTip" ext:member="splitTip" ext:cls="Ext.layout.BorderLayout.SplitRegion">splitTip</a></tt> or <tt><a href="output/Ext.layout.BorderLayout.SplitRegion.html#Ext.layout.BorderLayout.SplitRegion-collapsibleSplitTip" ext:member="collapsibleSplitTip" ext:cls="Ext.layout.BorderLayout.SplitRegion">collapsibleSplitTip</a></tt> as appropriate.</div></div></td><td class="msource">BorderLayout.SplitRegion</td></tr></tbody></table><a id="Ext.layout.BorderLayout.SplitRegion-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-isCollapsed"></a><b><a href="source/BorderLayout.html#prop-Ext.layout.BorderLayout.Region-isCollapsed">isCollapsed</a></b> : Boolean<div class="mdesc">True if this region is collapsed. Read-only.</div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#isCollapsed" ext:member="#isCollapsed" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="property-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-layout"></a><b><a href="source/BorderLayout.html#prop-Ext.layout.BorderLayout.Region-layout">layout</a></b> : Layout<div class="mdesc">This region's layout.  Read-only.</div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#layout" ext:member="#layout" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="property-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-panel"></a><b><a href="source/BorderLayout.html#prop-Ext.layout.BorderLayout.Region-panel">panel</a></b> : Ext.Panel<div class="mdesc">This region's panel.  Read-only.</div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#panel" ext:member="#panel" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="property-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-position"></a><b><a href="source/BorderLayout.html#prop-Ext.layout.BorderLayout.Region-position">position</a></b> : String<div class="mdesc">This region's layout position (north, south, east, west or center).  Read-only.</div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#position" ext:member="#position" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr></tbody></table><a id="Ext.layout.BorderLayout.SplitRegion-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.SplitRegion-BorderLayout.SplitRegion"></a><b><a href="source/BorderLayout.html#cls-Ext.layout.BorderLayout.SplitRegion">BorderLayout.SplitRegion</a></b>(&nbsp;<code>Layout&nbsp;layout</code>,&nbsp;<code>Object&nbsp;config</code>,&nbsp;<code>String&nbsp;position</code>&nbsp;)
110     <div class="mdesc"><div class="short">Create a new SplitRegion.</div><div class="long">Create a new SplitRegion.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>layout</code> : Layout<div class="sub-desc">The <a href="output/Ext.layout.BorderLayout.html" ext:cls="Ext.layout.BorderLayout">BorderLayout</a> instance that is managing this Region.</div></li><li><code>config</code> : Object<div class="sub-desc">The configuration options</div></li><li><code>position</code> : String<div class="sub-desc">The region position.  Valid values are: north, south, east, west and center.  Every
111 BorderLayout must have a center region for the primary content -- all other regions are optional.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">BorderLayout.SplitRegion</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-getMargins"></a><b><a href="source/BorderLayout.html#method-Ext.layout.BorderLayout.Region-getMargins">getMargins</a></b>()
112     :
113                                         Object<div class="mdesc"><div class="short">Returns the current margins for this region.  If the region is collapsed, the
114 cmargins (collapsed margins) value will...</div><div class="long">Returns the current margins for this region.  If the region is collapsed, the
115 <a href="output/Ext.layout.BorderLayout.Region.html#Ext.layout.BorderLayout.Region-cmargins" ext:member="cmargins" ext:cls="Ext.layout.BorderLayout.Region">cmargins</a> (collapsed margins) value will be returned, otherwise the
116 <a href="output/Ext.layout.BorderLayout.Region.html#Ext.layout.BorderLayout.Region-margins" ext:member="margins" ext:cls="Ext.layout.BorderLayout.Region">margins</a> value will be returned.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">An object containing the element's margins: &lt;tt&gt;{left: (left
117 margin), top: (top margin), right: (right margin), bottom: (bottom margin)}&lt;/tt&gt;</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#getMargins" ext:member="#getMargins" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-getMinHeight"></a><b><a href="source/BorderLayout.html#method-Ext.layout.BorderLayout.Region-getMinHeight">getMinHeight</a></b>()
118     :
119                                         Number<div class="mdesc"><div class="short">Returns the minimum allowable height for this region.</div><div class="long">Returns the minimum allowable height for this region.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The minimum height</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#getMinHeight" ext:member="#getMinHeight" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-getMinWidth"></a><b><a href="source/BorderLayout.html#method-Ext.layout.BorderLayout.Region-getMinWidth">getMinWidth</a></b>()
120     :
121                                         Number<div class="mdesc"><div class="short">Returns the minimum allowable width for this region.</div><div class="long">Returns the minimum allowable width for this region.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">The minimum width</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#getMinWidth" ext:member="#getMinWidth" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-getSize"></a><b><a href="source/BorderLayout.html#method-Ext.layout.BorderLayout.Region-getSize">getSize</a></b>()
122     :
123                                         Object<div class="mdesc"><div class="short">Returns the current size of this region.  If the region is collapsed, the size of the
124 collapsedEl will be returned, o...</div><div class="long">Returns the current size of this region.  If the region is collapsed, the size of the
125 collapsedEl will be returned, otherwise the size of the region's panel will be returned.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">An object containing the element's size: &lt;tt&gt;{width: (element width),
126 height: (element height)}&lt;/tt&gt;</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#getSize" ext:member="#getSize" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.SplitRegion-getSplitBar"></a><b><a href="source/BorderLayout.html#method-Ext.layout.BorderLayout.SplitRegion-getSplitBar">getSplitBar</a></b>()
127     :
128                                         Ext.SplitBar<div class="mdesc"><div class="short">Returns a reference to the split bar in use by this region.</div><div class="long">Returns a reference to the split bar in use by this region.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.SplitBar</code><div class="sub-desc">The split bar</div></li></ul></div></div></div></td><td class="msource">BorderLayout.SplitRegion</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-isVisible"></a><b><a href="source/BorderLayout.html#method-Ext.layout.BorderLayout.Region-isVisible">isVisible</a></b>()
129     :
130                                         Boolean<div class="mdesc"><div class="short">True if this region is currently visible, else false.</div><div class="long">True if this region is currently visible, else false.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#isVisible" ext:member="#isVisible" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-setPanel"></a><b><a href="source/BorderLayout.html#method-Ext.layout.BorderLayout.Region-setPanel">setPanel</a></b>(&nbsp;<code>Ext.Panel&nbsp;panel</code>&nbsp;)
131     :
132                                         void<div class="mdesc"><div class="short">Sets the specified panel as the container element for this region.</div><div class="long">Sets the specified panel as the container element for this region.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>panel</code> : Ext.Panel<div class="sub-desc">The new panel</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#setPanel" ext:member="#setPanel" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-slideIn"></a><b><a href="source/BorderLayout.html#method-Ext.layout.BorderLayout.Region-slideIn">slideIn</a></b>()
133     :
134                                         void<div class="mdesc"><div class="short">If this Region is floatable, and this Region has been slid into floating visibility, then this method slides
135 this reg...</div><div class="long">If this Region is <a href="output/Ext.layout.BorderLayout.Region.html#Ext.layout.BorderLayout.Region-floatable" ext:member="floatable" ext:cls="Ext.layout.BorderLayout.Region">floatable</a>, and this Region has been slid into floating visibility, then this method slides
136 this region back into its collapsed state.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#slideIn" ext:member="#slideIn" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.BorderLayout.Region-slideOut"></a><b><a href="source/BorderLayout.html#method-Ext.layout.BorderLayout.Region-slideOut">slideOut</a></b>()
137     :
138                                         void<div class="mdesc"><div class="short">If this Region is floatable, this method slides this Region into full visibility over the top
139 of the center Region wh...</div><div class="long">If this Region is <a href="output/Ext.layout.BorderLayout.Region.html#Ext.layout.BorderLayout.Region-floatable" ext:member="floatable" ext:cls="Ext.layout.BorderLayout.Region">floatable</a>, this method slides this Region into full visibility <i>over the top
140 of the center Region</i> where it floats until either <a href="output/Ext.layout.BorderLayout.Region.html#Ext.layout.BorderLayout.Region-slideIn" ext:member="slideIn" ext:cls="Ext.layout.BorderLayout.Region">slideIn</a> is called, or other regions of the layout
141 are clicked, or the mouse exits the Region.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.layout.BorderLayout.Region.html#slideOut" ext:member="#slideOut" ext:cls="Ext.layout.BorderLayout.Region">BorderLayout.Region</a></td></tr></tbody></table><a id="Ext.layout.BorderLayout.SplitRegion-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>