Upgrade to ExtJS 3.1.0 - Released 12/16/2009
[extjs.git] / docs / source / TableLayout.html
1 <html>\r
2 <head>\r
3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \r
4   <title>The source code</title>\r
5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
7 </head>\r
8 <body  onload="prettyPrint();">\r
9     <pre class="prettyprint lang-js"><div id="cls-Ext.layout.TableLayout"></div>/**\r
10  * @class Ext.layout.TableLayout\r
11  * @extends Ext.layout.ContainerLayout\r
12  * <p>This layout allows you to easily render content into an HTML table.  The total number of columns can be\r
13  * specified, and rowspan and colspan can be used to create complex layouts within the table.\r
14  * This class is intended to be extended or created via the layout:'table' {@link Ext.Container#layout} config,\r
15  * and should generally not need to be created directly via the new keyword.</p>\r
16  * <p>Note that when creating a layout via config, the layout-specific config properties must be passed in via\r
17  * the {@link Ext.Container#layoutConfig} object which will then be applied internally to the layout.  In the\r
18  * case of TableLayout, the only valid layout config property is {@link #columns}.  However, the items added to a\r
19  * TableLayout can supply the following table-specific config properties:</p>\r
20  * <ul>\r
21  * <li><b>rowspan</b> Applied to the table cell containing the item.</li>\r
22  * <li><b>colspan</b> Applied to the table cell containing the item.</li>\r
23  * <li><b>cellId</b> An id applied to the table cell containing the item.</li>\r
24  * <li><b>cellCls</b> A CSS class name added to the table cell containing the item.</li>\r
25  * </ul>\r
26  * <p>The basic concept of building up a TableLayout is conceptually very similar to building up a standard\r
27  * HTML table.  You simply add each panel (or "cell") that you want to include along with any span attributes\r
28  * specified as the special config properties of rowspan and colspan which work exactly like their HTML counterparts.\r
29  * Rather than explicitly creating and nesting rows and columns as you would in HTML, you simply specify the\r
30  * total column count in the layoutConfig and start adding panels in their natural order from left to right,\r
31  * top to bottom.  The layout will automatically figure out, based on the column count, rowspans and colspans,\r
32  * how to position each panel within the table.  Just like with HTML tables, your rowspans and colspans must add\r
33  * up correctly in your overall layout or you'll end up with missing and/or extra cells!  Example usage:</p>\r
34  * <pre><code>\r
35 // This code will generate a layout table that is 3 columns by 2 rows\r
36 // with some spanning included.  The basic layout will be:\r
37 // +--------+-----------------+\r
38 // |   A    |   B             |\r
39 // |        |--------+--------|\r
40 // |        |   C    |   D    |\r
41 // +--------+--------+--------+\r
42 var table = new Ext.Panel({\r
43     title: 'Table Layout',\r
44     layout:'table',\r
45     defaults: {\r
46         // applied to each contained panel\r
47         bodyStyle:'padding:20px'\r
48     },\r
49     layoutConfig: {\r
50         // The total column count must be specified here\r
51         columns: 3\r
52     },\r
53     items: [{\r
54         html: '&lt;p&gt;Cell A content&lt;/p&gt;',\r
55         rowspan: 2\r
56     },{\r
57         html: '&lt;p&gt;Cell B content&lt;/p&gt;',\r
58         colspan: 2\r
59     },{\r
60         html: '&lt;p&gt;Cell C content&lt;/p&gt;',\r
61         cellCls: 'highlight'\r
62     },{\r
63         html: '&lt;p&gt;Cell D content&lt;/p&gt;'\r
64     }]\r
65 });\r
66 </code></pre>\r
67  */\r
68 Ext.layout.TableLayout = Ext.extend(Ext.layout.ContainerLayout, {\r
69     <div id="cfg-Ext.layout.TableLayout-columns"></div>/**\r
70      * @cfg {Number} columns\r
71      * The total number of columns to create in the table for this layout.  If not specified, all Components added to\r
72      * this layout will be rendered into a single row using one column per Component.\r
73      */\r
74 \r
75     // private\r
76     monitorResize:false,\r
77     \r
78     targetCls: 'x-table-layout-ct',\r
79 \r
80     <div id="cfg-Ext.layout.TableLayout-tableAttrs"></div>/**\r
81      * @cfg {Object} tableAttrs\r
82      * <p>An object containing properties which are added to the {@link Ext.DomHelper DomHelper} specification\r
83      * used to create the layout's <tt>&lt;table&gt;</tt> element. Example:</p><pre><code>\r
84 {\r
85     xtype: 'panel',\r
86     layout: 'table',\r
87     layoutConfig: {\r
88         tableAttrs: {\r
89                 style: {\r
90                         width: '100%'\r
91                 }\r
92         },\r
93         columns: 3\r
94     }\r
95 }</code></pre>\r
96      */\r
97     tableAttrs:null,\r
98     \r
99     // private\r
100     setContainer : function(ct){\r
101         Ext.layout.TableLayout.superclass.setContainer.call(this, ct);\r
102 \r
103         this.currentRow = 0;\r
104         this.currentColumn = 0;\r
105         this.cells = [];\r
106     },\r
107 \r
108     // private\r
109     onLayout : function(ct, target){\r
110         var cs = ct.items.items, len = cs.length, c, i;\r
111 \r
112         if(!this.table){\r
113             this.table = target.createChild(\r
114                 Ext.apply({tag:'table', cls:'x-table-layout', cellspacing: 0, cn: {tag: 'tbody'}}, this.tableAttrs), null, true);\r
115         }\r
116         this.renderAll(ct, target);\r
117     },\r
118 \r
119     // private\r
120     getRow : function(index){\r
121         var row = this.table.tBodies[0].childNodes[index];\r
122         if(!row){\r
123             row = document.createElement('tr');\r
124             this.table.tBodies[0].appendChild(row);\r
125         }\r
126         return row;\r
127     },\r
128 \r
129     // private\r
130     getNextCell : function(c){\r
131         var cell = this.getNextNonSpan(this.currentColumn, this.currentRow);\r
132         var curCol = this.currentColumn = cell[0], curRow = this.currentRow = cell[1];\r
133         for(var rowIndex = curRow; rowIndex < curRow + (c.rowspan || 1); rowIndex++){\r
134             if(!this.cells[rowIndex]){\r
135                 this.cells[rowIndex] = [];\r
136             }\r
137             for(var colIndex = curCol; colIndex < curCol + (c.colspan || 1); colIndex++){\r
138                 this.cells[rowIndex][colIndex] = true;\r
139             }\r
140         }\r
141         var td = document.createElement('td');\r
142         if(c.cellId){\r
143             td.id = c.cellId;\r
144         }\r
145         var cls = 'x-table-layout-cell';\r
146         if(c.cellCls){\r
147             cls += ' ' + c.cellCls;\r
148         }\r
149         td.className = cls;\r
150         if(c.colspan){\r
151             td.colSpan = c.colspan;\r
152         }\r
153         if(c.rowspan){\r
154             td.rowSpan = c.rowspan;\r
155         }\r
156         this.getRow(curRow).appendChild(td);\r
157         return td;\r
158     },\r
159     \r
160     // private\r
161     getNextNonSpan: function(colIndex, rowIndex){\r
162         var cols = this.columns;\r
163         while((cols && colIndex >= cols) || (this.cells[rowIndex] && this.cells[rowIndex][colIndex])) {\r
164             if(cols && colIndex >= cols){\r
165                 rowIndex++;\r
166                 colIndex = 0;\r
167             }else{\r
168                 colIndex++;\r
169             }\r
170         }\r
171         return [colIndex, rowIndex];\r
172     },\r
173 \r
174     // private\r
175     renderItem : function(c, position, target){\r
176         if(c && !c.rendered){\r
177             c.render(this.getNextCell(c));\r
178             this.configureItem(c, position);\r
179         }else if(c && !this.isValidParent(c, target)){\r
180             var container = this.getNextCell(c);\r
181             container.insertBefore(c.getPositionEl().dom, null);\r
182             c.container = Ext.get(container);\r
183             this.configureItem(c, position);\r
184         }\r
185     },\r
186 \r
187     // private\r
188     isValidParent : function(c, target){\r
189         return c.getPositionEl().up('table', 5).dom.parentNode === (target.dom || target);\r
190     }\r
191 \r
192     <div id="prop-Ext.layout.TableLayout-activeItem"></div>/**\r
193      * @property activeItem\r
194      * @hide\r
195      */\r
196 });\r
197 \r
198 Ext.Container.LAYOUTS['table'] = Ext.layout.TableLayout;</pre>    \r
199 </body>\r
200 </html>