docs/output/Ext.layout.TableLayout.html

   1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.layout.TableLayout-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.layout.TableLayout-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.layout.TableLayout-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.layout.TableLayout-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.layout.TableLayout"><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>
   2   <img src="resources/elbow-end.gif">TableLayout</pre></div><h1>Class <a href="source/TableLayout.html#cls-Ext.layout.TableLayout">Ext.layout.TableLayout</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.layout</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/TableLayout.html#cls-Ext.layout.TableLayout">TableLayout.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/TableLayout.html#cls-Ext.layout.TableLayout">TableLayout</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 layout allows you to easily render content into an HTML table.  The total number of columns can be
   3 specified, and rowspan and colspan can be used to create complex layouts within the table.
   4 This class is intended to be extended or created via the layout:'table' <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">Ext.Container.layout</a> config,
   5 and should generally not need to be created directly via the new keyword.</p>
   6 <p>Note that when creating a layout via config, the layout-specific config properties must be passed in via
   7 the <a href="output/Ext.Container.html#Ext.Container-layoutConfig" ext:member="layoutConfig" ext:cls="Ext.Container">Ext.Container.layoutConfig</a> object which will then be applied internally to the layout.  In the
   8 case of TableLayout, the only valid layout config property is <a href="output/Ext.layout.TableLayout.html#Ext.layout.TableLayout-columns" ext:member="columns" ext:cls="Ext.layout.TableLayout">columns</a>.  However, the items added to a
   9 TableLayout can supply the following table-specific config properties:</p>
  10 <ul>
  11 <li><b>rowspan</b> Applied to the table cell containing the item.</li>
  12 <li><b>colspan</b> Applied to the table cell containing the item.</li>
  13 <li><b>cellId</b> An id applied to the table cell containing the item.</li>
  14 <li><b>cellCls</b> A CSS class name added to the table cell containing the item.</li>
  15 </ul>
  16 <p>The basic concept of building up a TableLayout is conceptually very similar to building up a standard
  17 HTML table.  You simply add each panel (or "cell") that you want to include along with any span attributes
  18 specified as the special config properties of rowspan and colspan which work exactly like their HTML counterparts.
  19 Rather than explicitly creating and nesting rows and columns as you would in HTML, you simply specify the
  20 total column count in the layoutConfig and start adding panels in their natural order from left to right,
  21 top to bottom.  The layout will automatically figure out, based on the column count, rowspans and colspans,
  22 how to position each panel within the table.  Just like with HTML tables, your rowspans and colspans must add
  23 up correctly in your overall layout or you'll end up with missing and/or extra cells!  Example usage:</p>
  24 <pre><code><i>// This code will generate a layout table that is 3 columns by 2 rows</i>
  25 <i>// <b>with</b> some spanning included.  The basic layout will be:</i>
  26 <i>// +--------+-----------------+</i>
  27 <i>// |   A    |   B             |</i>
  28 <i>// |        |--------+--------|</i>
  29 <i>// |        |   C    |   D    |</i>
  30 <i>// +--------+--------+--------+</i>
  31 <b>var</b> table = <b>new</b> Ext.Panel({
  32     title: <em>'Table Layout'</em>,
  33     layout:<em>'table'</em>,
  34     defaults: {
  35         <i>// applied to each contained panel</i>
  36         bodyStyle:<em>'padding:20px'</em>
  37     },
  38     layoutConfig: {
  39         <i>// The total column count must be specified here</i>
  40         columns: 3
  41     },
  42     items: [{
  43         html: <em>'&lt;p&gt;Cell A content&lt;/p&gt;'</em>,
  44         rowspan: 2
  45     },{
  46         html: <em>'&lt;p&gt;Cell B content&lt;/p&gt;'</em>,
  47         colspan: 2
  48     },{
  49         html: <em>'&lt;p&gt;Cell C content&lt;/p&gt;'</em>,
  50         cellCls: <em>'highlight'</em>
  51     },{
  52         html: <em>'&lt;p&gt;Cell D content&lt;/p&gt;'</em>
  53     }]
  54 });</code></pre></div><div class="hr"></div><a id="Ext.layout.TableLayout-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 expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.TableLayout-columns"></a><b><a href="source/TableLayout.html#cfg-Ext.layout.TableLayout-columns">columns</a></b> : Number<div class="mdesc"><div class="short">The total number of columns to create in the table for this layout.  If not specified, all Components added to
  55 this l...</div><div class="long">The total number of columns to create in the table for this layout.  If not specified, all Components added to
  56 this layout will be rendered into a single row using one column per Component.</div></div></td><td class="msource">TableLayout</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
  57 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
  58 customized styles to the container or any of its children using standard CSS rules. See
  59 <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>
  60 <p><b>Note</b>: <tt>extraCls</tt> defaults to <tt>''</tt> except for the following classes
  61 which assign a value by default:
  62 <div class="mdetail-params"><ul>
  63 <li><a href="output/Ext.layout.AbsoluteLayout.html" ext:cls="Ext.layout.AbsoluteLayout">Absolute Layout</a> : <tt>'x-abs-layout-item'</tt></li>
  64 <li><a href="output/Ext.layout.Box.html" ext:cls="Ext.layout.Box">Box Layout</a> : <tt>'x-box-item'</tt></li>
  65 <li><a href="output/Ext.layout.ColumnLayout.html" ext:cls="Ext.layout.ColumnLayout">Column Layout</a> : <tt>'x-column'</tt></li>
  66 </ul></div>
  67 To configure the above Classes with an extra CSS class append to the default.  For example,
  68 for ColumnLayout:<pre><code>extraCls: <em>'x-column custom-class'</em></code></pre>
  69 </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><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.TableLayout-tableAttrs"></a><b><a href="source/TableLayout.html#cfg-Ext.layout.TableLayout-tableAttrs">tableAttrs</a></b> : Object<div class="mdesc"><div class="short">An object containing properties which are added to the DomHelper specification
  70 used to create the layout's &amp;lt;table&amp;...</div><div class="long"><p>An object containing properties which are added to the <a href="output/Ext.DomHelper.html" ext:cls="Ext.DomHelper">DomHelper</a> specification
  71 used to create the layout's <tt>&lt;table&gt;</tt> element. Example:</p><pre><code>{
  72     xtype: <em>'panel'</em>,
  73     layout: <em>'table'</em>,
  74     layoutConfig: {
  75         tableAttrs: {
  76             style: {
  77                 width: <em>'100%'</em>
  78             }
  79         },
  80         columns: 3
  81     }
  82 }</code></pre></div></div></td><td class="msource">TableLayout</td></tr></tbody></table><a id="Ext.layout.TableLayout-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
  83 Ext.layout.FormLayout) to create the DOM structure o...</div><div class="long">The <a href="output/Ext.Template.html" ext:cls="Ext.Template">Ext.Template</a> used by Field rendering layout classes (such as
  84 <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,
  85 labeled and styled form Field. A default Template is supplied, but this may be
  86 overriden to create custom field structures. The template processes values returned from
  87 <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><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-if"></a><b><a href="source/ContainerLayout.html#prop-Ext.layout.ContainerLayout-if">if</a></b> : Object<div class="mdesc"><div class="short">This monitorResize flag will be renamed soon as to avoid confusion
  88 with the Container version which hooks onWindowRes...</div><div class="long">This monitorResize flag will be renamed soon as to avoid confusion
  89 with the Container version which hooks onWindowResize to doLayout
  90 monitorResize flag in this context attaches the resize event between
  91 a container and it's layout</div></div></td><td class="msource"><a href="output/Ext.layout.ContainerLayout.html#if" ext:member="#if" ext:cls="Ext.layout.ContainerLayout">ContainerLayout</a></td></tr></tbody></table><a id="Ext.layout.TableLayout-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 inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.layout.ContainerLayout-parseMargins"></a><b><a href="source/ContainerLayout.html#method-Ext.layout.ContainerLayout-parseMargins">parseMargins</a></b>(&nbsp;<code>Number|String&nbsp;v</code>&nbsp;)
  92     :
  93                                         Object<div class="mdesc"><div class="short">Parses a number or string representing margin sizes into an object. Supports CSS-style margin declarations
  94 (e.g. 10, ...</div><div class="long">Parses a number or string representing margin sizes into an object. Supports CSS-style margin declarations
  95 (e.g. 10, "10", "10 10", "10 10 10" and "10 10 10 10" are all valid options and would return the same result)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>v</code> : Number|String<div class="sub-desc">The encoded margins</div></li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">An object with margin sizes for top, right, bottom and left</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.layout.ContainerLayout.html#parseMargins" ext:member="#parseMargins" ext:cls="Ext.layout.ContainerLayout">ContainerLayout</a></td></tr></tbody></table><a id="Ext.layout.TableLayout-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>