Upgrade to ExtJS 3.0.3 - Released 10/11/2009
[extjs.git] / docs / output / Ext.ux.grid.CheckColumn.html
1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.ux.grid.CheckColumn-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.ux.grid.CheckColumn-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.ux.grid.CheckColumn-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="bookmark" href="../docs/?class=Ext.ux.grid.CheckColumn"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/CheckColumn.html#cls-Ext.ux.grid.CheckColumn">Ext.ux.grid.CheckColumn</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.ux.grid</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">CheckColumn.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/CheckColumn.html#cls-Ext.ux.grid.CheckColumn">CheckColumn</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr><tr><td class="hd-info"></td></tr></table><div class="description">GridPanel plugin to add a column with check boxes to a grid.\r
2 <p>Example usage:</p>\r
3 <pre><code><i>// create the column\r</i>
4 <b>var</b> checkColumn = <b>new</b> Ext.grid.CheckColumn({\r
5    header: <em>'Indoor?'</em>,\r
6    dataIndex: <em>'indoor'</em>,\r
7    id: <em>'check'</em>,\r
8    width: 55\r
9 });\r
10 \r
11 <i>// add the column to the column model\r</i>
12 <b>var</b> cm = <b>new</b> Ext.grid.ColumnModel([{\r
13        header: <em>'Foo'</em>,\r
14        ...\r
15     },\r
16     checkColumn\r
17 ]);\r
18 \r
19 <i>// create the grid\r</i>
20 <b>var</b> grid = <b>new</b> Ext.grid.EditorGridPanel({\r
21     ...\r
22     cm: cm,\r
23     plugins: [checkColumn], <i>// include plugin\r</i>
24     ...\r
25 });</code></pre>\r
26 In addition to storing a Boolean value within the record data, this\r
27 class toggles a css class between <tt>'x-grid3-check-col'</tt> and\r
28 <tt>'x-grid3-check-col-on'</tt> to alter the background image used for\r
29 a column.</div><div class="hr"></div><a id="Ext.ux.grid.CheckColumn-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.ux.grid.CheckColumn-methods"></a><h2>Public Methods</h2><div class="no-members">This class has no public methods.</div><a id="Ext.ux.grid.CheckColumn-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>