commit extjs-2.2.1
[extjs.git] / docs / output / Ext.layout.ContainerLayout.html
1         <div class="body-wrap">
2         <div class="top-tools">
3             <a class="inner-link" href="#Ext.layout.ContainerLayout-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4             <a class="inner-link" href="#Ext.layout.ContainerLayout-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5             <a class="inner-link" href="#Ext.layout.ContainerLayout-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                             <a class="inner-link" href="#Ext.layout.ContainerLayout-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.ContainerLayout"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
8         </div>
9                 <h1>Class Ext.layout.ContainerLayout</h1>
10         <table cellspacing="0">
11             <tr><td class="label">Package:</td><td class="hd-info">Ext.layout</td></tr>
12             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/ContainerLayout.js" target="_blank">ContainerLayout.js</a></td></tr>
13             <tr><td class="label">Class:</td><td class="hd-info">ContainerLayout</td></tr>
14                         <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.layout.AnchorLayout" href="output/Ext.layout.AnchorLayout.html">AnchorLayout</a>, <a ext:cls="Ext.layout.BorderLayout" href="output/Ext.layout.BorderLayout.html">BorderLayout</a>, <a ext:cls="Ext.layout.ColumnLayout" href="output/Ext.layout.ColumnLayout.html">ColumnLayout</a>, <a ext:cls="Ext.layout.FitLayout" href="output/Ext.layout.FitLayout.html">FitLayout</a>, <a ext:cls="Ext.layout.TableLayout" href="output/Ext.layout.TableLayout.html">TableLayout</a></td></tr>
15                                     <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
16                     </table>
17         <div class="description">
18             *
19 <p>Every <a ext:cls="Ext.Container" href="output/Ext.Container.html">Container</a> delegates the rendering of its child <a ext:cls="Ext.Component" href="output/Ext.Component.html">Component</a>s
20 to a layout manager class which must be <a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">configured</a> into the Container.</p> Some
21 layouts also provide sizing and positioning of child Components/
22 <p>The ContainerLayout class is the default layout manager used when no layout is configured into a Container.
23 It provides the basic foundation for all other layout classes in Ext. It simply renders all child Components
24 into the Container, performing no sizing os positioning services. This class is intended to be extended and should
25 generally not need to be created directly via the new keyword.        </div>
26         
27         <div class="hr"></div>
28                 <a id="Ext.layout.ContainerLayout-configs"></a>
29         <h2>Config Options</h2>
30         <table cellspacing="0" class="member-table">
31             <tr>
32                 <th class="sig-header" colspan="2">Config Options</th>
33                 <th class="msource-header">Defined By</th>
34             </tr>
35                 <tr class="config-row expandable">\r
36         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
37         <td class="sig">\r
38         <a id="Ext.layout.ContainerLayout-extraCls"></a>\r
39             <b>extraCls</b> : String            <div class="mdesc">\r
40                         <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
41             <div class="long">\r
42                 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
43                         </div>\r
44         </td>\r
45         <td class="msource">ContainerLayout</td>\r
46     </tr>\r
47         <tr class="config-row alt">\r
48         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
49         <td class="sig">\r
50         <a id="Ext.layout.ContainerLayout-renderHidden"></a>\r
51             <b>renderHidden</b> : Boolean            <div class="mdesc">\r
52                             True to hide each contained item on render (defaults to false).                        </div>\r
53         </td>\r
54         <td class="msource">ContainerLayout</td>\r
55     </tr>\r
56             </table>
57                 <a id="Ext.layout.ContainerLayout-props"></a>
58         <h2>Public Properties</h2>
59                 <table cellspacing="0" class="member-table">
60             <tr>
61                 <th class="sig-header" colspan="2">Property</th>
62                 <th class="msource-header">Defined By</th>
63             </tr>
64                 <tr class="property-row expandable">\r
65         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
66         <td class="sig">\r
67         <a id="Ext.layout.ContainerLayout-activeItem"></a>\r
68             <b>activeItem</b> : Ext.Component            <div class="mdesc">\r
69                         <div class="short">
70 A reference to the Ext.Component that is active.  For example,
71 if(myPanel.layout.activeItem.id == 'item-1') { ... }....</div>\r
72             <div class="long">\r
73                 
74 A reference to the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> that is active.  For example,
75 if(myPanel.layout.activeItem.id == 'item-1') { ... }.  activeItem only applies to layout styles that can
76 display items one at a time (like <a ext:cls="Ext.layout.Accordion" href="output/Ext.layout.Accordion.html">Ext.layout.Accordion</a>, <a ext:cls="Ext.layout.CardLayout" href="output/Ext.layout.CardLayout.html">Ext.layout.CardLayout</a>
77 and <a ext:cls="Ext.layout.FitLayout" href="output/Ext.layout.FitLayout.html">Ext.layout.FitLayout</a>).  Read-only.  Related to <a ext:cls="Ext.Container" ext:member="activeItem" href="output/Ext.Container.html#activeItem">Ext.Container.activeItem</a>.            </div>\r
78                         </div>\r
79         </td>\r
80         <td class="msource">ContainerLayout</td>\r
81     </tr>\r
82             </table>
83                 <a id="Ext.layout.ContainerLayout-methods"></a>
84         <h2>Public Methods</h2>
85         <div class="no-members">This class has no public methods.</div>        <a id="Ext.layout.ContainerLayout-events"></a>
86         <h2>Public Events</h2>
87         <div class="no-members">This class has no public events.</div>
88         </div>