commit extjs-2.2.1
[extjs.git] / docs / output / Ext.layout.BorderLayout.html
1         <div class="body-wrap">
2         <div class="top-tools">
3             <a class="inner-link" href="#Ext.layout.BorderLayout-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4             <a class="inner-link" href="#Ext.layout.BorderLayout-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5             <a class="inner-link" href="#Ext.layout.BorderLayout-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                             <a class="inner-link" href="#Ext.layout.BorderLayout-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7                         <a class="bookmark" href="../docs/?class=Ext.layout.BorderLayout"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
8         </div>
9                 <div class="inheritance res-block">
10 <pre class="res-block-inner"><a ext:cls="Ext.layout.ContainerLayout" ext:member="" href="output/Ext.layout.ContainerLayout.html">ContainerLayout</a>
11   <img src="resources/elbow-end.gif"/>BorderLayout</pre></div>
12                 <h1>Class Ext.layout.BorderLayout</h1>
13         <table cellspacing="0">
14             <tr><td class="label">Package:</td><td class="hd-info">Ext.layout</td></tr>
15             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/BorderLayout.js" target="_blank">BorderLayout.js</a></td></tr>
16             <tr><td class="label">Class:</td><td class="hd-info">BorderLayout</td></tr>
17                                     <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.layout.ContainerLayout" ext:member="" href="output/Ext.layout.ContainerLayout.html">ContainerLayout</a></td></tr>
18                     </table>
19         <div class="description">
20             *
21 <p>This is a multi-pane, application-oriented UI layout style that supports multiple nested panels, automatic
22 split bars between regions and built-in expanding and collapsing of regions.
23 This class is intended to be extended or created via the layout:'border' <a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">Ext.Container.layout</a> config,
24 and should generally not need to be created directly via the new keyword.</p>
25 <p>BorderLayout does not have any direct config options (other than inherited ones).  All configs available
26 for customizing the BorderLayout are at the <a ext:cls="Ext.layout.BorderLayout.Region" href="output/Ext.layout.BorderLayout.Region.html">Ext.layout.BorderLayout.Region</a> and
27 <a ext:cls="Ext.layout.BorderLayout.SplitRegion" href="output/Ext.layout.BorderLayout.SplitRegion.html">Ext.layout.BorderLayout.SplitRegion</a> levels.</p>
28 <p><b>The regions of a BorderLayout are fixed at render time and thereafter, no regions may be removed or
29 added. The BorderLayout must have a center region, which will always fill the remaining space not used by
30 the other regions in the layout.</b></p>
31 <p>Example usage:</p>
32 <pre><code>var border = <b>new</b> Ext.Panel({
33     title: <em>'Border Layout'</em>,
34     layout:<em>'border'</em>,
35     items: [{
36         title: <em>'South Panel'</em>,
37         region: <em>'south'</em>,
38         height: 100,
39         minSize: 75,
40         maxSize: 250,
41         margins: <em>'0 5 5 5'</em>
42     },{
43         title: <em>'West Panel'</em>,
44         region:<em>'west'</em>,
45         margins: <em>'5 0 0 5'</em>,
46         cmargins: <em>'5 5 0 5'</em>,
47         width: 200,
48         minSize: 100,
49         maxSize: 300
50     },{
51         title: <em>'Main Content'</em>,
52         region:<em>'center'</em>,
53         margins: <em>'5 5 0 0'</em>
54     }]
55 });</code></pre>        </div>
56         
57         <div class="hr"></div>
58                 <a id="Ext.layout.BorderLayout-configs"></a>
59         <h2>Config Options</h2>
60         <table cellspacing="0" class="member-table">
61             <tr>
62                 <th class="sig-header" colspan="2">Config Options</th>
63                 <th class="msource-header">Defined By</th>
64             </tr>
65                 <tr class="config-row inherited expandable">\r
66         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
67         <td class="sig">\r
68         <a id="Ext.layout.BorderLayout-extraCls"></a>\r
69             <b>extraCls</b> : String            <div class="mdesc">\r
70                         <div class="short">An optional extra CSS class that will be added to the container (defaults to ''). This can be useful for adding custo...</div>\r
71             <div class="long">\r
72                 An optional extra CSS class that will be added to the container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.            </div>\r
73                         </div>\r
74         </td>\r
75         <td class="msource"><a ext:cls="Ext.layout.ContainerLayout" ext:member="#extraCls" href="output/Ext.layout.ContainerLayout.html#extraCls">ContainerLayout</a></td>\r
76     </tr>\r
77         <tr class="config-row inherited alt">\r
78         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
79         <td class="sig">\r
80         <a id="Ext.layout.BorderLayout-renderHidden"></a>\r
81             <b>renderHidden</b> : Boolean            <div class="mdesc">\r
82                             True to hide each contained item on render (defaults to false).                        </div>\r
83         </td>\r
84         <td class="msource"><a ext:cls="Ext.layout.ContainerLayout" ext:member="#renderHidden" href="output/Ext.layout.ContainerLayout.html#renderHidden">ContainerLayout</a></td>\r
85     </tr>\r
86             </table>
87                 <a id="Ext.layout.BorderLayout-props"></a>
88         <h2>Public Properties</h2>
89         <div class="no-members">This class has no public properties.</div>        <a id="Ext.layout.BorderLayout-methods"></a>
90         <h2>Public Methods</h2>
91         <div class="no-members">This class has no public methods.</div>        <a id="Ext.layout.BorderLayout-events"></a>
92         <h2>Public Events</h2>
93         <div class="no-members">This class has no public events.</div>
94         </div>