Upgrade to ExtJS 3.0.0 - Released 07/06/2009

[extjs.git] / docs / output / Ext.ux.grid.CheckColumn.html

diff --git a/docs/output/Ext.ux.grid.CheckColumn.html b/docs/output/Ext.ux.grid.CheckColumn.html
new file mode 100644 (file)
index 0000000..79ff2d3
--- /dev/null
+++ b/docs/output/Ext.ux.grid.CheckColumn.html
@@ -0,0 +1,29 @@
+<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></table><div class="description">GridPanel plugin to add a column with check boxes to a grid.\r
+<p>Example usage:</p>\r
+<pre><code><i>// create the column\r</i>
+<b>var</b> checkColumn = <b>new</b> Ext.grid.CheckColumn({\r
+   header: <em>'Indoor?'</em>,\r
+   dataIndex: <em>'indoor'</em>,\r
+   id: <em>'check'</em>,\r
+   width: 55\r
+});\r
+\r
+<i>// add the column to the column model\r</i>
+<b>var</b> cm = <b>new</b> Ext.grid.ColumnModel([{\r
+       header: <em>'Foo'</em>,\r
+       ...\r
+    },\r
+    checkColumn\r
+]);\r
+\r
+<i>// create the grid\r</i>
+<b>var</b> grid = <b>new</b> Ext.grid.EditorGridPanel({\r
+    ...\r
+    cm: cm,\r
+    plugins: [checkColumn], <i>// include plugin\r</i>
+    ...\r
+});</code></pre>\r
+In addition to storing a Boolean value within the record data, this\r
+class toggles a css class between <tt>'x-grid3-check-col'</tt> and\r
+<tt>'x-grid3-check-col-on'</tt> to alter the background image used for\r
+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>
\ No newline at end of file