docs/output/Ext.layout.ColumnLayout.html

   1         <div class="body-wrap">
   2         <div class="top-tools">
   3             <a class="inner-link" href="#Ext.layout.ColumnLayout-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
   4             <a class="inner-link" href="#Ext.layout.ColumnLayout-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
   5             <a class="inner-link" href="#Ext.layout.ColumnLayout-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
   6                             <a class="inner-link" href="#Ext.layout.ColumnLayout-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.ColumnLayout"><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"/>ColumnLayout</pre></div>
  12                 <h1>Class Ext.layout.ColumnLayout</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/ColumnLayout.js" target="_blank">ColumnLayout.js</a></td></tr>
  16             <tr><td class="label">Class:</td><td class="hd-info">ColumnLayout</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 the layout style of choice for creating structural layouts in a multi-column format where the width of
  22 each column can be specified as a percentage or fixed width, but the height is allowed to vary based on the content.
  23 This class is intended to be extended or created via the layout:'column' <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>ColumnLayout does not have any direct config options (other than inherited ones), but it does support a
  26 specific config property of <b><tt>columnWidth</tt></b> that can be included in the config of any panel added to it.  The
  27 layout will use the columnWidth (if present) or width of each panel during layout to determine how to size each panel.
  28 If width or columnWidth is not specified for a given panel, its width will default to the panel's width (or auto).</p>
  29 <p>The width property is always evaluated as pixels, and must be a number greater than or equal to 1.
  30 The columnWidth property is always evaluated as a percentage, and must be a decimal value greater than 0 and
  31 less than 1 (e.g., .25).</p>
  32 <p>The basic rules for specifying column widths are pretty simple.  The logic makes two passes through the
  33 set of contained panels.  During the first layout pass, all panels that either have a fixed width or none
  34 specified (auto) are skipped, but their widths are subtracted from the overall container width.  During the second
  35 pass, all panels with columnWidths are assigned pixel widths in proportion to their percentages based on
  36 the total <b>remaining</b> container width.  In other words, percentage width panels are designed to fill the space
  37 left over by all the fixed-width and/or auto-width panels.  Because of this, while you can specify any number of columns
  38 with different percentages, the columnWidths must always add up to 1 (or 100%) when added together, otherwise your
  39 layout may not render as expected.  Example usage:</p>
  40 <pre><code><i>// All columns are percentages -- they must add up to 1</i>
  41 <b>var</b> p = <b>new</b> Ext.Panel({
  42     title: <em>'Column Layout - Percentage Only'</em>,
  43     layout:<em>'column'</em>,
  44     items: [{
  45         title: <em>'Column 1'</em>,
  46         columnWidth: .25
  47     },{
  48         title: <em>'Column 2'</em>,
  49         columnWidth: .6
  50     },{
  51         title: <em>'Column 3'</em>,
  52         columnWidth: .15
  53     }]
  54 });
  55
  56 <i>// Mix of width and columnWidth -- all columnWidth values must add up</i>
  57 <i>// to 1. The first column will take up exactly 120px, and the last two</i>
  58 <i>// columns will fill the remaining container width.</i>
  59 <b>var</b> p = <b>new</b> Ext.Panel({
  60     title: <em>'Column Layout - Mixed'</em>,
  61     layout:<em>'column'</em>,
  62     items: [{
  63         title: <em>'Column 1'</em>,
  64         width: 120
  65     },{
  66         title: <em>'Column 2'</em>,
  67         columnWidth: .8
  68     },{
  69         title: <em>'Column 3'</em>,
  70         columnWidth: .2
  71     }]
  72 });</code></pre>        </div>
  73
  74         <div class="hr"></div>
  75                 <a id="Ext.layout.ColumnLayout-configs"></a>
  76         <h2>Config Options</h2>
  77         <table cellspacing="0" class="member-table">
  78             <tr>
  79                 <th class="sig-header" colspan="2">Config Options</th>
  80                 <th class="msource-header">Defined By</th>
  81             </tr>
  82                 <tr class="config-row expandable">\r
  83         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  84         <td class="sig">\r
  85         <a id="Ext.layout.ColumnLayout-extraCls"></a>\r
  86             <b>extraCls</b> : String            <div class="mdesc">\r
  87                         <div class="short">An optional extra CSS class that will be added to the container (defaults to 'x-column'). This can be useful for addi...</div>\r
  88             <div class="long">\r
  89                 An optional extra CSS class that will be added to the container (defaults to 'x-column'). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.            </div>\r
  90                         </div>\r
  91         </td>\r
  92         <td class="msource">ColumnLayout</td>\r
  93     </tr>\r
  94         <tr class="config-row inherited alt">\r
  95         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  96         <td class="sig">\r
  97         <a id="Ext.layout.ColumnLayout-renderHidden"></a>\r
  98             <b>renderHidden</b> : Boolean            <div class="mdesc">\r
  99                             True to hide each contained item on render (defaults to false).                        </div>\r
 100         </td>\r
 101         <td class="msource"><a ext:cls="Ext.layout.ContainerLayout" ext:member="#renderHidden" href="output/Ext.layout.ContainerLayout.html#renderHidden">ContainerLayout</a></td>\r
 102     </tr>\r
 103             </table>
 104                 <a id="Ext.layout.ColumnLayout-props"></a>
 105         <h2>Public Properties</h2>
 106         <div class="no-members">This class has no public properties.</div>        <a id="Ext.layout.ColumnLayout-methods"></a>
 107         <h2>Public Methods</h2>
 108         <div class="no-members">This class has no public methods.</div>        <a id="Ext.layout.ColumnLayout-events"></a>
 109         <h2>Public Events</h2>
 110         <div class="no-members">This class has no public events.</div>
 111         </div>