Upgrade to ExtJS 3.1.0 - Released 12/16/2009
[extjs.git] / docs / output / Ext.grid.CheckboxSelectionModel.html
index 917a458..1e4277b 100644 (file)
@@ -1,4 +1,4 @@
-<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.grid.CheckboxSelectionModel-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.grid.CheckboxSelectionModel-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.grid.CheckboxSelectionModel-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.grid.CheckboxSelectionModel-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.grid.CheckboxSelectionModel"><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.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif"><a href="output/Ext.grid.AbstractSelectionModel.html" ext:member="" ext:cls="Ext.grid.AbstractSelectionModel">AbstractSelectionModel</a>&#13;&nbsp;&nbsp;&nbsp;&nbsp;<img src="resources/elbow-end.gif"><a href="output/Ext.grid.RowSelectionModel.html" ext:member="" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a>&#13;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src="resources/elbow-end.gif">CheckboxSelectionModel</pre></div><h1>Class <a href="source/CheckboxSelectionModel.html#cls-Ext.grid.CheckboxSelectionModel">Ext.grid.CheckboxSelectionModel</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.grid</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">CheckboxSelectionModel.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/CheckboxSelectionModel.html#cls-Ext.grid.CheckboxSelectionModel">CheckboxSelectionModel</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.grid.RowSelectionModel.html" ext:cls="Ext.grid.RowSelectionModel" ext:member="">RowSelectionModel</a></td></tr><tr><td class="hd-info"></td></tr></table><div class="description">A custom selection model that renders a column of checkboxes that can be toggled to select or deselect rows.</div><div class="hr"></div><a id="Ext.grid.CheckboxSelectionModel-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.grid.CheckboxSelectionModel-checkOnly"></a><b><a href="source/CheckboxSelectionModel.html#cfg-Ext.grid.CheckboxSelectionModel-checkOnly">checkOnly</a></b> : Boolean<div class="mdesc"><tt>true</tt> if rows can only be selected by clicking on the\r
+<div xmlns:ext="http://www.extjs.com" class="body-wrap"><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif"><a href="output/Ext.grid.AbstractSelectionModel.html" ext:member="" ext:cls="Ext.grid.AbstractSelectionModel">AbstractSelectionModel</a>&#13;&nbsp;&nbsp;&nbsp;&nbsp;<img src="resources/elbow-end.gif"><a href="output/Ext.grid.RowSelectionModel.html" ext:member="" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a>&#13;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src="resources/elbow-end.gif">CheckboxSelectionModel</pre></div><h1>Class <a href="source/CheckboxSelectionModel.html#cls-Ext.grid.CheckboxSelectionModel">Ext.grid.CheckboxSelectionModel</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.grid</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">CheckboxSelectionModel.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/CheckboxSelectionModel.html#cls-Ext.grid.CheckboxSelectionModel">CheckboxSelectionModel</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.grid.RowSelectionModel.html" ext:cls="Ext.grid.RowSelectionModel" ext:member="">RowSelectionModel</a></td></tr></table><div class="description">A custom selection model that renders a column of checkboxes that can be toggled to select or deselect rows.</div><div class="hr"></div><a id="Ext.grid.CheckboxSelectionModel-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.grid.CheckboxSelectionModel-checkOnly"></a><b><a href="source/CheckboxSelectionModel.html#cfg-Ext.grid.CheckboxSelectionModel-checkOnly">checkOnly</a></b> : Boolean<div class="mdesc"><tt>true</tt> if rows can only be selected by clicking on the\r
 checkbox column (defaults to <tt>false</tt>).</div></td><td class="msource">CheckboxSelectionModel</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.grid.CheckboxSelectionModel-header"></a><b><a href="source/CheckboxSelectionModel.html#cfg-Ext.grid.CheckboxSelectionModel-header">header</a></b> : String<div class="mdesc"><div class="short">Any valid text or HTML fragment to display in the header cell for the&#13;\r
 checkbox column.  Defaults to:'&amp;lt;div class="...</div><div class="long">Any valid text or HTML fragment to display in the header cell for the\r
 checkbox column.  Defaults to:<pre><code><em>'&lt;div class=<em>"x-grid3-hd-checker"</em>>&#38;#160;&lt;/div>'</em></tt></code></pre>\r
@@ -145,7 +145,7 @@ prevent notifying the view (disables updating the selected appearance)</div></li
                                         Boolean<div class="mdesc"><div class="short">Calls the passed function with each selection. If the function returns\r
 false, iteration is stopped and this function ...</div><div class="long">Calls the passed function with each selection. If the function returns
 <tt>false</tt>, iteration is stopped and this function returns
-<tt>false</tt>. Otherwise it returns <tt>true</tt>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional)</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">true if all selections were iterated</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#each" ext:member="#each" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>(&nbsp;<code>Object&nbsp;events</code>&nbsp;)\r
+<tt>false</tt>. Otherwise it returns <tt>true</tt>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc">The function to call upon each iteration. It is passed the selected <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">Record</a>.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this RowSelectionModel.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">true if all selections were iterated</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#each" ext:member="#each" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>(&nbsp;<code>String/Array&nbsp;events</code>&nbsp;)\r
     :\r
                                         void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling&#13;\r
 this.getBubbleTarget() if present...</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\r
@@ -154,13 +154,13 @@ this.getBubbleTarget() if present...</div><div class="long"><p>Enables events fi
 implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\r
 access the required target more quickly.</p>\r
 <p>Example:</p><pre><code>Ext.override(Ext.form.Field, {\r
-<i>//  Add functionality to Field<em>'s initComponent to enable the change event to bubble\r</i>
-    initComponent: Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {\r
-        this.enableBubble('</em>change<em>');\r
+    <i>//  Add functionality to Field&#39;s initComponent to enable the change event to bubble\r</i>
+    initComponent : Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {\r
+        this.enableBubble(<em>'change'</em>);\r
     }),\r
 \r
-<i>//  We know that we want Field'</em>s events to bubble directly to the FormPanel.\r</i>
-    getBubbleTarget: <b>function</b>() {\r
+    <i>//  We know that we want Field&#39;s events to bubble directly to the FormPanel.\r</i>
+    getBubbleTarget : <b>function</b>() {\r
         <b>if</b> (!this.formPanel) {\r
             this.formPanel = this.findParentByType(<em>'form'</em>);\r
         }\r
@@ -175,11 +175,11 @@ access the required target more quickly.</p>
     }],\r
     listeners: {\r
         change: <b>function</b>() {\r
-<i>//          Title goes red <b>if</b> form has been modified.\r</i>
-            myForm.header.setStyle(<em>"color"</em>, <em>"red"</em>);\r
+            <i>// Title goes red <b>if</b> form has been modified.\r</i>
+            myForm.header.setStyle(<em>'color'</em>, <em>'red'</em>);\r
         }\r
     }\r
-});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : Object<div class="sub-desc">The event name to bubble, or an Array of event names.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-fireEvent"></a><b><a href="source/Observable.html#method-Ext.util.Observable-fireEvent">fireEvent</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Object...&nbsp;args</code>&nbsp;)\r
+});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : String/Array<div class="sub-desc">The event name to bubble, or an Array of event names.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-fireEvent"></a><b><a href="source/Observable.html#method-Ext.util.Observable-fireEvent">fireEvent</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Object...&nbsp;args</code>&nbsp;)\r
     :\r
                                         Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).\r
 An event may be set to bubble up an Obse...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>