docs/output/Ext.ux.layout.RowLayout.html

   1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.ux.layout.RowLayout-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.ux.layout.RowLayout-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.ux.layout.RowLayout-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.ux.layout.RowLayout-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.ux.layout.RowLayout"><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.ContainerLayout.html" ext:member="" ext:cls="Ext.layout.ContainerLayout">ContainerLayout</a>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif">RowLayout</pre></div><h1>Class <a href="source/RowLayout.html#cls-Ext.ux.layout.RowLayout">Ext.ux.layout.RowLayout</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.ux.layout</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">RowLayout.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/RowLayout.html#cls-Ext.ux.layout.RowLayout">RowLayout</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.layout.ContainerLayout.html" ext:cls="Ext.layout.ContainerLayout" ext:member="">ContainerLayout</a></td></tr></table><div class="description"><p>This is the layout style of choice for creating structural layouts in a multi-row format where the height of
   2 each row can be specified as a percentage or fixed height.  Row widths can also be fixed, percentage or auto.
   3 This class is intended to be extended or created via the layout:'ux.row' <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">Ext.Container.layout</a> config,
   4 and should generally not need to be created directly via the new keyword.</p>
   5 <p>RowLayout does not have any direct config options (other than inherited ones), but it does support a
   6 specific config property of <b><tt>rowHeight</tt></b> that can be included in the config of any panel added to it.  The
   7 layout will use the rowHeight (if present) or height of each panel during layout to determine how to size each panel.
   8 If height or rowHeight is not specified for a given panel, its height will default to the panel's height (or auto).</p>
   9 <p>The height property is always evaluated as pixels, and must be a number greater than or equal to 1.
  10 The rowHeight property is always evaluated as a percentage, and must be a decimal value greater than 0 and
  11 less than 1 (e.g., .25).</p>
  12 <p>The basic rules for specifying row heights are pretty simple.  The logic makes two passes through the
  13 set of contained panels.  During the first layout pass, all panels that either have a fixed height or none
  14 specified (auto) are skipped, but their heights are subtracted from the overall container height.  During the second
  15 pass, all panels with rowHeights are assigned pixel heights in proportion to their percentages based on
  16 the total <b>remaining</b> container height.  In other words, percentage height panels are designed to fill the space
  17 left over by all the fixed-height and/or auto-height panels.  Because of this, while you can specify any number of rows
  18 with different percentages, the rowHeights must always add up to 1 (or 100%) when added together, otherwise your
  19 layout may not render as expected.  Example usage:</p>
  20 <pre><code><i>// All rows are percentages -- they must add up to 1</i>
  21 <b>var</b> p = <b>new</b> Ext.Panel({
  22     title: <em>'Row Layout - Percentage Only'</em>,
  23     layout:<em>'ux.row'</em>,
  24     items: [{
  25         title: <em>'Row 1'</em>,
  26         rowHeight: .25
  27     },{
  28         title: <em>'Row 2'</em>,
  29         rowHeight: .6
  30     },{
  31         title: <em>'Row 3'</em>,
  32         rowHeight: .15
  33     }]
  34 });
  35
  36 <i>// Mix of height and rowHeight -- all rowHeight values must add</i>
  37 <i>// up to 1. The first row will take up exactly 120px, and the last two</i>
  38 <i>// rows will fill the remaining container height.</i>
  39 <b>var</b> p = <b>new</b> Ext.Panel({
  40     title: <em>'Row Layout - Mixed'</em>,
  41     layout:<em>'ux.row'</em>,
  42     items: [{
  43         title: <em>'Row 1'</em>,
  44         height: 120,
  45         <i>// standard panel widths are still supported too:</i>
  46         width: <em>'50%'</em> <i>// or 200</i>
  47     },{
  48         title: <em>'Row 2'</em>,
  49         rowHeight: .8,
  50         width: 300
  51     },{
  52         title: <em>'Row 3'</em>,
  53         rowHeight: .2
  54     }]
  55 });</code></pre></div><div class="hr"></div><a id="Ext.ux.layout.RowLayout-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  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.layout.RowLayout-enableTabbing"></a><b><a href="source/Focus.html#cfg-Ext.ux.layout.RowLayout-enableTabbing">enableTabbing</a></b> : Boolean<div class="mdesc"><tt>true</tt> to enable tabbing. Default is <tt>false</tt>.</div></td><td class="msource">RowLayout</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.ContainerLayout-extraCls"></a><b><a href="source/ContainerLayout.html#cfg-Ext.layout.ContainerLayout-extraCls">extraCls</a></b> : String<div class="mdesc"><div class="short">An optional extra CSS class that will be added to the container. This can be useful for adding
  56 customized styles to t...</div><div class="long"><p>An optional extra CSS class that will be added to the container. This can be useful for adding
  57 customized styles to the container or any of its children using standard CSS rules. See
  58 <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a>.<a href="output/Ext.Component.html#Ext.Component-ctCls" ext:member="ctCls" ext:cls="Ext.Component">ctCls</a> also.</p>
  59 <p><b>Note</b>: <tt>extraCls</tt> defaults to <tt>''</tt> except for the following classes
  60 which assign a value by default:
  61 <div class="mdetail-params"><ul>
  62 <li><a href="output/Ext.layout.AbsoluteLayout.html" ext:cls="Ext.layout.AbsoluteLayout">Absolute Layout</a> : <tt>'x-abs-layout-item'</tt></li>
  63 <li><a href="output/Ext.layout.Box.html" ext:cls="Ext.layout.Box">Box Layout</a> : <tt>'x-box-item'</tt></li>
  64 <li><a href="output/Ext.layout.ColumnLayout.html" ext:cls="Ext.layout.ColumnLayout">Column Layout</a> : <tt>'x-column'</tt></li>
  65 </ul></div>
  66 To configure the above Classes with an extra CSS class append to the default.  For example,
  67 for ColumnLayout:<pre><code>extraCls: <em>'x-column custom-class'</em></code></pre>
  68 </p></div></div></td><td class="msource"><a href="output/Ext.layout.ContainerLayout.html#extraCls" ext:member="#extraCls" ext:cls="Ext.layout.ContainerLayout">ContainerLayout</a></td></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.ContainerLayout-renderHidden"></a><b><a href="source/ContainerLayout.html#cfg-Ext.layout.ContainerLayout-renderHidden">renderHidden</a></b> : Boolean<div class="mdesc">True to hide each contained item on render (defaults to false).</div></td><td class="msource"><a href="output/Ext.layout.ContainerLayout.html#renderHidden" ext:member="#renderHidden" ext:cls="Ext.layout.ContainerLayout">ContainerLayout</a></td></tr></tbody></table><a id="Ext.ux.layout.RowLayout-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 expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.ContainerLayout-fieldTpl"></a><b><a href="source/ContainerLayout.html#prop-Ext.layout.ContainerLayout-fieldTpl">fieldTpl</a></b> : Ext.Template<div class="mdesc"><div class="short">The Ext.Template used by Field rendering layout classes (such as
  69 Ext.layout.FormLayout) to create the DOM structure o...</div><div class="long">The <a href="output/Template.html" ext:cls="Template">Ext.Template</a> used by Field rendering layout classes (such as
  70 <a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>) to create the DOM structure of a fully wrapped,
  71 labeled and styled form Field. A default Template is supplied, but this may be
  72 overriden to create custom field structures. The template processes values returned from
  73 <a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-getTemplateArgs" ext:member="getTemplateArgs" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout.getTemplateArgs</a>.</div></div></td><td class="msource"><a href="output/Ext.layout.ContainerLayout.html#fieldTpl" ext:member="#fieldTpl" ext:cls="Ext.layout.ContainerLayout">ContainerLayout</a></td></tr></tbody></table><a id="Ext.ux.layout.RowLayout-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.ux.layout.RowLayout-setActiveTab"></a><b><a href="source/GroupTab.html#method-Ext.ux.layout.RowLayout-setActiveTab">setActiveTab</a></b>(&nbsp;<code>String/Panel&nbsp;tab</code>&nbsp;)
  74     :
  75                                         void<div class="mdesc"><div class="short">Sets the specified tab as the active tab. This method fires the beforetabchange event which&#13;
  76 can return false to canc...</div><div class="long">Sets the specified tab as the active tab. This method fires the <a href="output/Ext.ux.layout.RowLayout.html#Ext.ux.layout.RowLayout-beforetabchange" ext:member="beforetabchange" ext:cls="Ext.ux.layout.RowLayout">beforetabchange</a> event which\r
  77 can return false to cancel the tab change.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>tab</code> : String/Panel<div class="sub-desc">The id or tab Panel to activate</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">RowLayout</td></tr></tbody></table><a id="Ext.ux.layout.RowLayout-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>