-<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> <img src="resources/elbow-end.gif"><a href="output/Ext.grid.AbstractSelectionModel.html" ext:member="" ext:cls="Ext.grid.AbstractSelectionModel">AbstractSelectionModel</a> <img src="resources/elbow-end.gif"><a href="output/Ext.grid.RowSelectionModel.html" ext:member="" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a> <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"> </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"> </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
-checkbox column. Defaults to:'&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>'<div class=<em>"x-grid3-hd-checker"</em>>&#160;</div>'</em></tt></code></pre>\r
-The default CSS class of <tt>'x-grid3-hd-checker'</tt> displays a checkbox in the header\r
-and provides support for automatic check all/none behavior on header click. This string\r
-can be replaced by any valid HTML fragment, including a simple text string (e.g.,\r
-<tt>'Select Rows'</tt>), but the automatic check all/none behavior will only work if the\r
+<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> <a class="inner-link" href="#Ext.grid.CheckboxSelectionModel-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> <a class="inner-link" href="#Ext.grid.CheckboxSelectionModel-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> <a class="inner-link" href="#Ext.grid.CheckboxSelectionModel-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> <a class="bookmark" href="../docs/?class=Ext.grid.CheckboxSelectionModel"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> </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> <img src="resources/elbow-end.gif"><a href="output/Ext.grid.AbstractSelectionModel.html" ext:member="" ext:cls="Ext.grid.AbstractSelectionModel">AbstractSelectionModel</a> <img src="resources/elbow-end.gif"><a href="output/Ext.grid.RowSelectionModel.html" ext:member="" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a> <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"><a href="source/CheckboxSelectionModel.html#cls-Ext.grid.CheckboxSelectionModel">CheckboxSelectionModel.js</a></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"> </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
+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"> </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
+checkbox column. Defaults to:'&lt;div class="x...</div><div class="long">Any valid text or HTML fragment to display in the header cell for the
+checkbox column. Defaults to:<pre><code><em>'<div class=<em>"x-grid3-hd-checker"</em>>&#160;</div>'</em></tt></code></pre>
+The default CSS class of <tt>'x-grid3-hd-checker'</tt> displays a checkbox in the header
+and provides support for automatic check all/none behavior on header click. This string
+can be replaced by any valid HTML fragment, including a simple text string (e.g.,
+<tt>'Select Rows'</tt>), but the automatic check all/none behavior will only work if the
<tt>'x-grid3-hd-checker'</tt> class is supplied.</div></div></td><td class="msource">CheckboxSelectionModel</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-listeners"></a><b><a href="source/Observable.html#cfg-Ext.util.Observable-listeners">listeners</a></b> : Object<div class="mdesc"><div class="short">A config object containing one or more event handlers to be added to this
object during initialization. This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
object during initialization. This should be a valid listeners config object as specified in the
});</code></pre></p></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#listeners" ext:member="#listeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-moveEditorOnEnter"></a><b><a href="source/RowSelectionModel.html#cfg-Ext.grid.RowSelectionModel-moveEditorOnEnter">moveEditorOnEnter</a></b> : Boolean<div class="mdesc"><div class="short">false to turn off moving the editor to the next row down when the enter key is pressed
or the next row up when shift ...</div><div class="long"><tt>false</tt> to turn off moving the editor to the next row down when the enter key is pressed
or the next row up when shift + enter keys are pressed.</div></div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#moveEditorOnEnter" ext:member="#moveEditorOnEnter" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="config-row inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.RowSelectionModel-singleSelect"></a><b><a href="source/RowSelectionModel.html#cfg-Ext.grid.RowSelectionModel-singleSelect">singleSelect</a></b> : Boolean<div class="mdesc"><tt>true</tt> to allow selection of only one row at a time (defaults to <tt>false</tt>
-allowing multiple selections)</div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#singleSelect" ext:member="#singleSelect" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.CheckboxSelectionModel-sortable"></a><b><a href="source/CheckboxSelectionModel.html#cfg-Ext.grid.CheckboxSelectionModel-sortable">sortable</a></b> : Boolean<div class="mdesc"><tt>true</tt> if the checkbox column is sortable (defaults to\r
+allowing multiple selections)</div></td><td class="msource"><a href="output/Ext.grid.RowSelectionModel.html#singleSelect" ext:member="#singleSelect" ext:cls="Ext.grid.RowSelectionModel">RowSelectionModel</a></td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.CheckboxSelectionModel-sortable"></a><b><a href="source/CheckboxSelectionModel.html#cfg-Ext.grid.CheckboxSelectionModel-sortable">sortable</a></b> : Boolean<div class="mdesc"><tt>true</tt> if the checkbox column is sortable (defaults to
<tt>false</tt>).</div></td><td class="msource">CheckboxSelectionModel</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.CheckboxSelectionModel-width"></a><b><a href="source/CheckboxSelectionModel.html#cfg-Ext.grid.CheckboxSelectionModel-width">width</a></b> : Number<div class="mdesc">The default width in pixels of the checkbox column (defaults to <tt>20</tt>).</div></td><td class="msource">CheckboxSelectionModel</td></tr></tbody></table><a id="Ext.grid.CheckboxSelectionModel-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 inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.AbstractSelectionModel-grid"></a><b><a href="source/AbstractSelectionModel.html#prop-Ext.grid.AbstractSelectionModel-grid">grid</a></b> : Object<div class="mdesc">The GridPanel for which this SelectionModel is handling selection. Read-only.</div></td><td class="msource"><a href="output/Ext.grid.AbstractSelectionModel.html#grid" ext:member="#grid" ext:cls="Ext.grid.AbstractSelectionModel">AbstractSelectionModel</a></td></tr></tbody></table><a id="Ext.grid.CheckboxSelectionModel-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"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.grid.CheckboxSelectionModel-CheckboxSelectionModel"></a><b><a href="source/CheckboxSelectionModel.html#cls-Ext.grid.CheckboxSelectionModel">CheckboxSelectionModel</a></b>( <code>Object config</code> )
<div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc">The configuration options</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">CheckboxSelectionModel</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-addEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addEvents">addEvents</a></b>( <code>Object|String o</code>, <code>string Optional.</code> )
:
<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">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"> </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>( <code>String/Array events</code> )
:
- void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
-this.getBubbleTarget() if present...</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\r
-<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\r
-<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="output/Ext.Component.getBubbleTarget.html" ext:cls="Ext.Component.getBubbleTarget">Ext.Component.getBubbleTarget</a>. The default\r
-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'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'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
- <b>return</b> this.formPanel;\r
- }\r
-});\r
-\r
-<b>var</b> myForm = <b>new</b> Ext.formPanel({\r
- title: <em>'User Details'</em>,\r
- items: [{\r
- ...\r
- }],\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
- }\r
- }\r
+ void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
+<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
+<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="output/Ext.Component.getBubbleTarget.html" ext:cls="Ext.Component.getBubbleTarget">Ext.Component.getBubbleTarget</a>. The default
+implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
+access the required target more quickly.</p>
+<p>Example:</p><pre><code>Ext.override(Ext.form.Field, {
+ <i>// Add functionality to Field's initComponent to enable the change event to bubble</i>
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {
+ this.enableBubble(<em>'change'</em>);
+ }),
+
+ <i>// We know that we want Field's events to bubble directly to the FormPanel.</i>
+ getBubbleTarget : <b>function</b>() {
+ <b>if</b> (!this.formPanel) {
+ this.formPanel = this.findParentByType(<em>'form'</em>);
+ }
+ <b>return</b> this.formPanel;
+ }
+});
+
+<b>var</b> myForm = <b>new</b> Ext.formPanel({
+ title: <em>'User Details'</em>,
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: <b>function</b>() {
+ <i>// Title goes red <b>if</b> form has been modified.</i>
+ myForm.header.setStyle(<em>'color'</em>, <em>'red'</em>);
+ }
+ }
});</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"> </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>( <code>String eventName</code>, <code>Object... args</code> )
:
Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).
git.ithinksw.org / extjs.git / blobdiff