make sure the README will appear on github
[extjs.git] / docs / output / Ext.layout.FitLayout.html
1         <div class="body-wrap">
2         <div class="top-tools">
3             <a class="inner-link" href="#Ext.layout.FitLayout-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4             <a class="inner-link" href="#Ext.layout.FitLayout-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5             <a class="inner-link" href="#Ext.layout.FitLayout-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                             <a class="inner-link" href="#Ext.layout.FitLayout-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.FitLayout"><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"/>FitLayout</pre></div>
12                 <h1>Class Ext.layout.FitLayout</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/FitLayout.js" target="_blank">FitLayout.js</a></td></tr>
16             <tr><td class="label">Class:</td><td class="hd-info">FitLayout</td></tr>
17                         <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.layout.Accordion" href="output/Ext.layout.Accordion.html">Accordion</a>, <a ext:cls="Ext.layout.CardLayout" href="output/Ext.layout.CardLayout.html">CardLayout</a></td></tr>
18                                     <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>
19                     </table>
20         <div class="description">
21             *
22 <p>This is a base class for layouts that contain a single item that automatically expands to fill the layout's
23 container.  This class is intended to be extended or created via the layout:'fit' <a ext:cls="Ext.Container" ext:member="layout" href="output/Ext.Container.html#layout">Ext.Container.layout</a>
24 config, and should generally not need to be created directly via the new keyword.</p>
25 <p>FitLayout does not have any direct config options (other than inherited ones).  To fit a panel to a container
26 using FitLayout, simply set layout:'fit' on the container and add a single panel to it.  If the container has
27 multiple panels, only the first one will be displayed.  Example usage:</p>
28 <pre><code>var p = <b>new</b> Ext.Panel({
29     title: <em>'Fit Layout'</em>,
30     layout:<em>'fit'</em>,
31     items: {
32         title: <em>'Inner Panel'</em>,
33         html: <em>'&lt;p&gt;This is the inner panel content&lt;/p&gt;'</em>,
34         border: false
35     }
36 });</code></pre>        </div>
37         
38         <div class="hr"></div>
39                 <a id="Ext.layout.FitLayout-configs"></a>
40         <h2>Config Options</h2>
41         <table cellspacing="0" class="member-table">
42             <tr>
43                 <th class="sig-header" colspan="2">Config Options</th>
44                 <th class="msource-header">Defined By</th>
45             </tr>
46                 <tr class="config-row inherited expandable">\r
47         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
48         <td class="sig">\r
49         <a id="Ext.layout.FitLayout-extraCls"></a>\r
50             <b>extraCls</b> : String            <div class="mdesc">\r
51                         <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
52             <div class="long">\r
53                 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
54                         </div>\r
55         </td>\r
56         <td class="msource"><a ext:cls="Ext.layout.ContainerLayout" ext:member="#extraCls" href="output/Ext.layout.ContainerLayout.html#extraCls">ContainerLayout</a></td>\r
57     </tr>\r
58         <tr class="config-row inherited alt">\r
59         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
60         <td class="sig">\r
61         <a id="Ext.layout.FitLayout-renderHidden"></a>\r
62             <b>renderHidden</b> : Boolean            <div class="mdesc">\r
63                             True to hide each contained item on render (defaults to false).                        </div>\r
64         </td>\r
65         <td class="msource"><a ext:cls="Ext.layout.ContainerLayout" ext:member="#renderHidden" href="output/Ext.layout.ContainerLayout.html#renderHidden">ContainerLayout</a></td>\r
66     </tr>\r
67             </table>
68                 <a id="Ext.layout.FitLayout-props"></a>
69         <h2>Public Properties</h2>
70                 <table cellspacing="0" class="member-table">
71             <tr>
72                 <th class="sig-header" colspan="2">Property</th>
73                 <th class="msource-header">Defined By</th>
74             </tr>
75                 <tr class="property-row inherited expandable">\r
76         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
77         <td class="sig">\r
78         <a id="Ext.layout.FitLayout-activeItem"></a>\r
79             <b>activeItem</b> : Ext.Component            <div class="mdesc">\r
80                         <div class="short">
81 A reference to the Ext.Component that is active.  For example,
82 if(myPanel.layout.activeItem.id == 'item-1') { ... }....</div>\r
83             <div class="long">\r
84                 
85 A reference to the <a ext:cls="Ext.Component" href="output/Ext.Component.html">Ext.Component</a> that is active.  For example,
86 if(myPanel.layout.activeItem.id == 'item-1') { ... }.  activeItem only applies to layout styles that can
87 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>
88 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
89                         </div>\r
90         </td>\r
91         <td class="msource"><a ext:cls="Ext.layout.ContainerLayout" ext:member="#activeItem" href="output/Ext.layout.ContainerLayout.html#activeItem">ContainerLayout</a></td>\r
92     </tr>\r
93             </table>
94                 <a id="Ext.layout.FitLayout-methods"></a>
95         <h2>Public Methods</h2>
96         <div class="no-members">This class has no public methods.</div>        <a id="Ext.layout.FitLayout-events"></a>
97         <h2>Public Events</h2>
98         <div class="no-members">This class has no public events.</div>
99         </div>