1 <div class="body-wrap">
2 <div class="top-tools">
3 <a class="inner-link" href="#Ext.grid.CheckboxSelectionModel-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4 <a class="inner-link" href="#Ext.grid.CheckboxSelectionModel-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5 <a class="inner-link" href="#Ext.grid.CheckboxSelectionModel-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6 <a class="inner-link" href="#Ext.grid.CheckboxSelectionModel-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
7 <a class="bookmark" href="../docs/?class=Ext.grid.CheckboxSelectionModel"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
9 <div class="inheritance res-block">
10 <pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
11 <img src="resources/elbow-end.gif"/><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="" href="output/Ext.grid.AbstractSelectionModel.html">AbstractSelectionModel</a>
12 <img src="resources/elbow-end.gif"/><a ext:cls="Ext.grid.RowSelectionModel" ext:member="" href="output/Ext.grid.RowSelectionModel.html">RowSelectionModel</a>
13 <img src="resources/elbow-end.gif"/>CheckboxSelectionModel</pre></div>
14 <h1>Class Ext.grid.CheckboxSelectionModel</h1>
15 <table cellspacing="0">
16 <tr><td class="label">Package:</td><td class="hd-info">Ext.grid</td></tr>
17 <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/CheckboxSelectionModel.js" target="_blank">CheckboxSelectionModel.js</a></td></tr>
18 <tr><td class="label">Class:</td><td class="hd-info">CheckboxSelectionModel</td></tr>
19 <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="" href="output/Ext.grid.RowSelectionModel.html">RowSelectionModel</a></td></tr>
21 <div class="description">
23 A custom selection model that renders a column of checkboxes that can be toggled to select or deselect rows. </div>
25 <div class="hr"></div>
26 <a id="Ext.grid.CheckboxSelectionModel-configs"></a>
27 <h2>Config Options</h2>
28 <table cellspacing="0" class="member-table">
30 <th class="sig-header" colspan="2">Config Options</th>
31 <th class="msource-header">Defined By</th>
33 <tr class="config-row expandable">
\r
34 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
36 <a id="Ext.grid.CheckboxSelectionModel-header"></a>
\r
37 <b>header</b> : String <div class="mdesc">
\r
38 <div class="short">Any valid text or HTML fragment to display in the header cell for the checkbox column (defaults to '<div class="x-...</div>
\r
40 Any valid text or HTML fragment to display in the header cell for the checkbox column (defaults to '<div class="x-grid3-hd-checker"> </div>'). The default CSS class of 'x-grid3-hd-checker' 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., 'Select Rows'), but the automatic check all/none behavior will only work if the 'x-grid3-hd-checker' class is supplied. </div>
\r
43 <td class="msource">CheckboxSelectionModel</td>
\r
45 <tr class="config-row inherited alt expandable">
\r
46 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
48 <a id="Ext.grid.CheckboxSelectionModel-listeners"></a>
\r
49 <b>listeners</b> : Object <div class="mdesc">
\r
50 <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>
\r
52 (optional) 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 <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once. </div>
\r
55 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
\r
57 <tr class="config-row inherited">
\r
58 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
60 <a id="Ext.grid.CheckboxSelectionModel-moveEditorOnEnter"></a>
\r
61 <b>moveEditorOnEnter</b> : Boolean <div class="mdesc">
\r
62 False to turn off moving the editor to the next cell when the enter key is pressed </div>
\r
64 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#moveEditorOnEnter" href="output/Ext.grid.RowSelectionModel.html#moveEditorOnEnter">RowSelectionModel</a></td>
\r
66 <tr class="config-row inherited alt">
\r
67 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
69 <a id="Ext.grid.CheckboxSelectionModel-singleSelect"></a>
\r
70 <b>singleSelect</b> : Boolean <div class="mdesc">
\r
71 True to allow selection of only one row at a time (defaults to false) </div>
\r
73 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#singleSelect" href="output/Ext.grid.RowSelectionModel.html#singleSelect">RowSelectionModel</a></td>
\r
75 <tr class="config-row">
\r
76 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
78 <a id="Ext.grid.CheckboxSelectionModel-sortable"></a>
\r
79 <b>sortable</b> : Boolean <div class="mdesc">
\r
80 True if the checkbox column is sortable (defaults to false). </div>
\r
82 <td class="msource">CheckboxSelectionModel</td>
\r
84 <tr class="config-row alt">
\r
85 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
87 <a id="Ext.grid.CheckboxSelectionModel-width"></a>
\r
88 <b>width</b> : Number <div class="mdesc">
\r
89 The default width in pixels of the checkbox column (defaults to 20). </div>
\r
91 <td class="msource">CheckboxSelectionModel</td>
\r
94 <a id="Ext.grid.CheckboxSelectionModel-props"></a>
95 <h2>Public Properties</h2>
96 <div class="no-members">This class has no public properties.</div> <a id="Ext.grid.CheckboxSelectionModel-methods"></a>
97 <h2>Public Methods</h2>
98 <table cellspacing="0" class="member-table">
100 <th class="sig-header" colspan="2">Method</th>
101 <th class="msource-header">Defined By</th>
103 <tr class="method-row expandable">
\r
104 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
106 <a id="Ext.grid.CheckboxSelectionModel-CheckboxSelectionModel"></a>
\r
107 <b>CheckboxSelectionModel</b>( <code>Object config</code> ) <div class="mdesc">
\r
108 <div class="short"></div>
\r
110 <div class="mdetail-params">
\r
111 <strong>Parameters:</strong>
\r
112 <ul><li><code>config</code> : Object<div class="sub-desc">The configuration options</div></li> </ul>
\r
113 <strong>Returns:</strong>
\r
115 <li><code></code></li>
\r
121 <td class="msource">CheckboxSelectionModel</td>
\r
123 <tr class="method-row inherited alt expandable">
\r
124 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
126 <a id="Ext.grid.CheckboxSelectionModel-addEvents"></a>
\r
127 <b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc">
\r
128 <div class="short">Used to define events on this Observable</div>
\r
130 Used to define events on this Observable <div class="mdetail-params">
\r
131 <strong>Parameters:</strong>
\r
132 <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul>
\r
133 <strong>Returns:</strong>
\r
135 <li><code>void</code></li>
\r
141 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
\r
143 <tr class="method-row inherited expandable">
\r
144 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
146 <a id="Ext.grid.CheckboxSelectionModel-addListener"></a>
\r
147 <b>addListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">
\r
148 <div class="short">Appends an event handler to this component</div>
\r
150 Appends an event handler to this component <div class="mdetail-params">
\r
151 <strong>Parameters:</strong>
\r
152 <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
153 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
154 properties. This may contain any of the following properties:<ul>
155 <li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
156 <li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
157 <li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
158 <li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
159 by the specified number of milliseconds. If the event fires again within that time, the original
160 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
163 <b>Combining Options</b><br>
164 Using the options argument, it is possible to combine different types of listeners:<br>
166 A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
167 <pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
173 <b>Attaching multiple handlers in 1 call</b><br>
174 The method also allows for a single argument to be passed which is a config object containing properties
175 which specify multiple handlers.
179 fn: <b>this</b>.onClick,
183 <em>'mouseover'</em> : {
184 fn: <b>this</b>.onMouseOver,
187 <em>'mouseout'</em> : {
188 fn: <b>this</b>.onMouseOut,
193 Or a shorthand syntax:<br>
195 <em>'click'</em> : <b>this</b>.onClick,
196 <em>'mouseover'</em> : <b>this</b>.onMouseOver,
197 <em>'mouseout'</em> : <b>this</b>.onMouseOut,
199 });</code></pre></div></li> </ul>
\r
200 <strong>Returns:</strong>
\r
202 <li><code>void</code></li>
\r
208 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
\r
210 <tr class="method-row inherited alt expandable">
\r
211 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
213 <a id="Ext.grid.CheckboxSelectionModel-clearSelections"></a>
\r
214 <b>clearSelections</b>() : void <div class="mdesc">
\r
215 <div class="short">Clears all selections.</div>
\r
217 Clears all selections. <div class="mdetail-params">
\r
218 <strong>Parameters:</strong>
\r
219 <ul><li>None.</li> </ul>
\r
220 <strong>Returns:</strong>
\r
222 <li><code>void</code></li>
\r
228 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#clearSelections" href="output/Ext.grid.RowSelectionModel.html#clearSelections">RowSelectionModel</a></td>
\r
230 <tr class="method-row inherited expandable">
\r
231 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
233 <a id="Ext.grid.CheckboxSelectionModel-deselectRange"></a>
\r
234 <b>deselectRange</b>( <code>Number startRow</code>, <code>Number endRow</code> ) : void <div class="mdesc">
\r
235 <div class="short">Deselects a range of rows. All rows in between startRow and endRow are also deselected.</div>
\r
237 Deselects a range of rows. All rows in between startRow and endRow are also deselected. <div class="mdetail-params">
\r
238 <strong>Parameters:</strong>
\r
239 <ul><li><code>startRow</code> : Number<div class="sub-desc">The index of the first row in the range</div></li><li><code>endRow</code> : Number<div class="sub-desc">The index of the last row in the range</div></li> </ul>
\r
240 <strong>Returns:</strong>
\r
242 <li><code>void</code></li>
\r
248 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#deselectRange" href="output/Ext.grid.RowSelectionModel.html#deselectRange">RowSelectionModel</a></td>
\r
250 <tr class="method-row inherited alt expandable">
\r
251 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
253 <a id="Ext.grid.CheckboxSelectionModel-deselectRow"></a>
\r
254 <b>deselectRow</b>( <code>Number row</code> ) : void <div class="mdesc">
\r
255 <div class="short">Deselects a row.</div>
\r
257 Deselects a row. <div class="mdetail-params">
\r
258 <strong>Parameters:</strong>
\r
259 <ul><li><code>row</code> : Number<div class="sub-desc">The index of the row to deselect</div></li> </ul>
\r
260 <strong>Returns:</strong>
\r
262 <li><code>void</code></li>
\r
268 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#deselectRow" href="output/Ext.grid.RowSelectionModel.html#deselectRow">RowSelectionModel</a></td>
\r
270 <tr class="method-row inherited expandable">
\r
271 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
273 <a id="Ext.grid.CheckboxSelectionModel-each"></a>
\r
274 <b>each</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : Boolean <div class="mdesc">
\r
275 <div class="short">Calls the passed function with each selection. If the function returns false, iteration is
276 stopped and this function ...</div>
\r
278 Calls the passed function with each selection. If the function returns false, iteration is
279 stopped and this function returns false. Otherwise it returns true. <div class="mdetail-params">
\r
280 <strong>Parameters:</strong>
\r
281 <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>
\r
282 <strong>Returns:</strong>
\r
284 <li><code>Boolean</code><div class="sub-desc">true if all selections were iterated</div></li>
\r
290 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#each" href="output/Ext.grid.RowSelectionModel.html#each">RowSelectionModel</a></td>
\r
292 <tr class="method-row inherited alt expandable">
\r
293 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
295 <a id="Ext.grid.CheckboxSelectionModel-fireEvent"></a>
\r
296 <b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc">
\r
297 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
\r
299 Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params">
\r
300 <strong>Parameters:</strong>
\r
301 <ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li> </ul>
\r
302 <strong>Returns:</strong>
\r
304 <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
\r
310 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
\r
312 <tr class="method-row inherited expandable">
\r
313 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
315 <a id="Ext.grid.CheckboxSelectionModel-getCount"></a>
\r
316 <b>getCount</b>() : Number <div class="mdesc">
\r
317 <div class="short">Gets the number of selected rows.</div>
\r
319 Gets the number of selected rows. <div class="mdetail-params">
\r
320 <strong>Parameters:</strong>
\r
321 <ul><li>None.</li> </ul>
\r
322 <strong>Returns:</strong>
\r
324 <li><code>Number</code></li>
\r
330 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#getCount" href="output/Ext.grid.RowSelectionModel.html#getCount">RowSelectionModel</a></td>
\r
332 <tr class="method-row inherited alt expandable">
\r
333 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
335 <a id="Ext.grid.CheckboxSelectionModel-getSelected"></a>
\r
336 <b>getSelected</b>() : Record <div class="mdesc">
\r
337 <div class="short">Returns the first selected record.</div>
\r
339 Returns the first selected record. <div class="mdetail-params">
\r
340 <strong>Parameters:</strong>
\r
341 <ul><li>None.</li> </ul>
\r
342 <strong>Returns:</strong>
\r
344 <li><code>Record</code></li>
\r
350 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#getSelected" href="output/Ext.grid.RowSelectionModel.html#getSelected">RowSelectionModel</a></td>
\r
352 <tr class="method-row inherited expandable">
\r
353 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
355 <a id="Ext.grid.CheckboxSelectionModel-getSelections"></a>
\r
356 <b>getSelections</b>() : Array <div class="mdesc">
\r
357 <div class="short">Returns the selected records</div>
\r
359 Returns the selected records <div class="mdetail-params">
\r
360 <strong>Parameters:</strong>
\r
361 <ul><li>None.</li> </ul>
\r
362 <strong>Returns:</strong>
\r
364 <li><code>Array</code><div class="sub-desc">Array of selected records</div></li>
\r
370 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#getSelections" href="output/Ext.grid.RowSelectionModel.html#getSelections">RowSelectionModel</a></td>
\r
372 <tr class="method-row inherited alt expandable">
\r
373 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
375 <a id="Ext.grid.CheckboxSelectionModel-hasListener"></a>
\r
376 <b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc">
\r
377 <div class="short">Checks to see if this object has any listeners for a specified event</div>
\r
379 Checks to see if this object has any listeners for a specified event <div class="mdetail-params">
\r
380 <strong>Parameters:</strong>
\r
381 <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>
\r
382 <strong>Returns:</strong>
\r
384 <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
\r
390 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
\r
392 <tr class="method-row inherited expandable">
\r
393 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
395 <a id="Ext.grid.CheckboxSelectionModel-hasNext"></a>
\r
396 <b>hasNext</b>() : Boolean <div class="mdesc">
\r
397 <div class="short">Returns true if there is a next record to select</div>
\r
399 Returns true if there is a next record to select <div class="mdetail-params">
\r
400 <strong>Parameters:</strong>
\r
401 <ul><li>None.</li> </ul>
\r
402 <strong>Returns:</strong>
\r
404 <li><code>Boolean</code></li>
\r
410 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#hasNext" href="output/Ext.grid.RowSelectionModel.html#hasNext">RowSelectionModel</a></td>
\r
412 <tr class="method-row inherited alt expandable">
\r
413 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
415 <a id="Ext.grid.CheckboxSelectionModel-hasPrevious"></a>
\r
416 <b>hasPrevious</b>() : Boolean <div class="mdesc">
\r
417 <div class="short">Returns true if there is a previous record to select</div>
\r
419 Returns true if there is a previous record to select <div class="mdetail-params">
\r
420 <strong>Parameters:</strong>
\r
421 <ul><li>None.</li> </ul>
\r
422 <strong>Returns:</strong>
\r
424 <li><code>Boolean</code></li>
\r
430 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#hasPrevious" href="output/Ext.grid.RowSelectionModel.html#hasPrevious">RowSelectionModel</a></td>
\r
432 <tr class="method-row inherited expandable">
\r
433 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
435 <a id="Ext.grid.CheckboxSelectionModel-hasSelection"></a>
\r
436 <b>hasSelection</b>() : Boolean <div class="mdesc">
\r
437 <div class="short">Returns True if there is a selection.</div>
\r
439 Returns True if there is a selection. <div class="mdetail-params">
\r
440 <strong>Parameters:</strong>
\r
441 <ul><li>None.</li> </ul>
\r
442 <strong>Returns:</strong>
\r
444 <li><code>Boolean</code></li>
\r
450 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#hasSelection" href="output/Ext.grid.RowSelectionModel.html#hasSelection">RowSelectionModel</a></td>
\r
452 <tr class="method-row inherited alt expandable">
\r
453 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
455 <a id="Ext.grid.CheckboxSelectionModel-isIdSelected"></a>
\r
456 <b>isIdSelected</b>( <code>String id</code> ) : Boolean <div class="mdesc">
\r
457 <div class="short">Returns True if the specified record id is selected.</div>
\r
459 Returns True if the specified record id is selected. <div class="mdetail-params">
\r
460 <strong>Parameters:</strong>
\r
461 <ul><li><code>id</code> : String<div class="sub-desc">The id of record to check</div></li> </ul>
\r
462 <strong>Returns:</strong>
\r
464 <li><code>Boolean</code></li>
\r
470 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#isIdSelected" href="output/Ext.grid.RowSelectionModel.html#isIdSelected">RowSelectionModel</a></td>
\r
472 <tr class="method-row inherited expandable">
\r
473 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
475 <a id="Ext.grid.CheckboxSelectionModel-isLocked"></a>
\r
476 <b>isLocked</b>() : Boolean <div class="mdesc">
\r
477 <div class="short">Returns true if the selections are locked.</div>
\r
479 Returns true if the selections are locked. <div class="mdetail-params">
\r
480 <strong>Parameters:</strong>
\r
481 <ul><li>None.</li> </ul>
\r
482 <strong>Returns:</strong>
\r
484 <li><code>Boolean</code></li>
\r
490 <td class="msource"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="#isLocked" href="output/Ext.grid.AbstractSelectionModel.html#isLocked">AbstractSelectionModel</a></td>
\r
492 <tr class="method-row inherited alt expandable">
\r
493 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
495 <a id="Ext.grid.CheckboxSelectionModel-isSelected"></a>
\r
496 <b>isSelected</b>( <code>Number/Record record</code> ) : Boolean <div class="mdesc">
\r
497 <div class="short">Returns True if the specified row is selected.</div>
\r
499 Returns True if the specified row is selected. <div class="mdetail-params">
\r
500 <strong>Parameters:</strong>
\r
501 <ul><li><code>record</code> : Number/Record<div class="sub-desc">The record or index of the record to check</div></li> </ul>
\r
502 <strong>Returns:</strong>
\r
504 <li><code>Boolean</code></li>
\r
510 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#isSelected" href="output/Ext.grid.RowSelectionModel.html#isSelected">RowSelectionModel</a></td>
\r
512 <tr class="method-row inherited expandable">
\r
513 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
515 <a id="Ext.grid.CheckboxSelectionModel-lock"></a>
\r
516 <b>lock</b>() : void <div class="mdesc">
\r
517 <div class="short">Locks the selections.</div>
\r
519 Locks the selections. <div class="mdetail-params">
\r
520 <strong>Parameters:</strong>
\r
521 <ul><li>None.</li> </ul>
\r
522 <strong>Returns:</strong>
\r
524 <li><code>void</code></li>
\r
530 <td class="msource"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="#lock" href="output/Ext.grid.AbstractSelectionModel.html#lock">AbstractSelectionModel</a></td>
\r
532 <tr class="method-row inherited alt expandable">
\r
533 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
535 <a id="Ext.grid.CheckboxSelectionModel-on"></a>
\r
536 <b>on</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">
\r
537 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
\r
539 Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params">
\r
540 <strong>Parameters:</strong>
\r
541 <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
542 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
\r
543 <strong>Returns:</strong>
\r
545 <li><code>void</code></li>
\r
551 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
\r
553 <tr class="method-row inherited expandable">
\r
554 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
556 <a id="Ext.grid.CheckboxSelectionModel-purgeListeners"></a>
\r
557 <b>purgeListeners</b>() : void <div class="mdesc">
\r
558 <div class="short">Removes all listeners for this object</div>
\r
560 Removes all listeners for this object <div class="mdetail-params">
\r
561 <strong>Parameters:</strong>
\r
562 <ul><li>None.</li> </ul>
\r
563 <strong>Returns:</strong>
\r
565 <li><code>void</code></li>
\r
571 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
\r
573 <tr class="method-row inherited alt expandable">
\r
574 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
576 <a id="Ext.grid.CheckboxSelectionModel-relayEvents"></a>
\r
577 <b>relayEvents</b>( <code>Object o</code>, <code>Array events</code> ) : void <div class="mdesc">
\r
578 <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>
\r
580 Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>. <div class="mdetail-params">
\r
581 <strong>Parameters:</strong>
\r
582 <ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li> </ul>
\r
583 <strong>Returns:</strong>
\r
585 <li><code>void</code></li>
\r
591 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>
\r
593 <tr class="method-row inherited expandable">
\r
594 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
596 <a id="Ext.grid.CheckboxSelectionModel-removeListener"></a>
\r
597 <b>removeListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">
\r
598 <div class="short">Removes a listener</div>
\r
600 Removes a listener <div class="mdetail-params">
\r
601 <strong>Parameters:</strong>
\r
602 <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>
\r
603 <strong>Returns:</strong>
\r
605 <li><code>void</code></li>
\r
611 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
\r
613 <tr class="method-row inherited alt expandable">
\r
614 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
616 <a id="Ext.grid.CheckboxSelectionModel-resumeEvents"></a>
\r
617 <b>resumeEvents</b>() : void <div class="mdesc">
\r
618 <div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>
\r
620 Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>) <div class="mdetail-params">
\r
621 <strong>Parameters:</strong>
\r
622 <ul><li>None.</li> </ul>
\r
623 <strong>Returns:</strong>
\r
625 <li><code>void</code></li>
\r
631 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
\r
633 <tr class="method-row inherited expandable">
\r
634 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
636 <a id="Ext.grid.CheckboxSelectionModel-selectAll"></a>
\r
637 <b>selectAll</b>() : void <div class="mdesc">
\r
638 <div class="short">Selects all rows.</div>
\r
640 Selects all rows. <div class="mdetail-params">
\r
641 <strong>Parameters:</strong>
\r
642 <ul><li>None.</li> </ul>
\r
643 <strong>Returns:</strong>
\r
645 <li><code>void</code></li>
\r
651 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#selectAll" href="output/Ext.grid.RowSelectionModel.html#selectAll">RowSelectionModel</a></td>
\r
653 <tr class="method-row inherited alt expandable">
\r
654 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
656 <a id="Ext.grid.CheckboxSelectionModel-selectFirstRow"></a>
\r
657 <b>selectFirstRow</b>() : void <div class="mdesc">
\r
658 <div class="short">Selects the first row in the grid.</div>
\r
660 Selects the first row in the grid. <div class="mdetail-params">
\r
661 <strong>Parameters:</strong>
\r
662 <ul><li>None.</li> </ul>
\r
663 <strong>Returns:</strong>
\r
665 <li><code>void</code></li>
\r
671 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#selectFirstRow" href="output/Ext.grid.RowSelectionModel.html#selectFirstRow">RowSelectionModel</a></td>
\r
673 <tr class="method-row inherited expandable">
\r
674 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
676 <a id="Ext.grid.CheckboxSelectionModel-selectLastRow"></a>
\r
677 <b>selectLastRow</b>( <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : void <div class="mdesc">
\r
678 <div class="short">Select the last row.</div>
\r
680 Select the last row. <div class="mdetail-params">
\r
681 <strong>Parameters:</strong>
\r
682 <ul><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to keep existing selections</div></li> </ul>
\r
683 <strong>Returns:</strong>
\r
685 <li><code>void</code></li>
\r
691 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#selectLastRow" href="output/Ext.grid.RowSelectionModel.html#selectLastRow">RowSelectionModel</a></td>
\r
693 <tr class="method-row inherited alt expandable">
\r
694 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
696 <a id="Ext.grid.CheckboxSelectionModel-selectNext"></a>
\r
697 <b>selectNext</b>( <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : Boolean <div class="mdesc">
\r
698 <div class="short">Selects the row immediately following the last selected row.</div>
\r
700 Selects the row immediately following the last selected row. <div class="mdetail-params">
\r
701 <strong>Parameters:</strong>
\r
702 <ul><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to keep existing selections</div></li> </ul>
\r
703 <strong>Returns:</strong>
\r
705 <li><code>Boolean</code><div class="sub-desc">True if there is a next row, else false</div></li>
\r
711 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#selectNext" href="output/Ext.grid.RowSelectionModel.html#selectNext">RowSelectionModel</a></td>
\r
713 <tr class="method-row inherited expandable">
\r
714 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
716 <a id="Ext.grid.CheckboxSelectionModel-selectPrevious"></a>
\r
717 <b>selectPrevious</b>( <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : Boolean <div class="mdesc">
\r
718 <div class="short">Selects the row that precedes the last selected row.</div>
\r
720 Selects the row that precedes the last selected row. <div class="mdetail-params">
\r
721 <strong>Parameters:</strong>
\r
722 <ul><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to keep existing selections</div></li> </ul>
\r
723 <strong>Returns:</strong>
\r
725 <li><code>Boolean</code><div class="sub-desc">True if there is a previous row, else false</div></li>
\r
731 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#selectPrevious" href="output/Ext.grid.RowSelectionModel.html#selectPrevious">RowSelectionModel</a></td>
\r
733 <tr class="method-row inherited alt expandable">
\r
734 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
736 <a id="Ext.grid.CheckboxSelectionModel-selectRange"></a>
\r
737 <b>selectRange</b>( <code>Number startRow</code>, <code>Number endRow</code>, <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : void <div class="mdesc">
\r
738 <div class="short">Selects a range of rows. All rows in between startRow and endRow are also selected.</div>
\r
740 Selects a range of rows. All rows in between startRow and endRow are also selected. <div class="mdetail-params">
\r
741 <strong>Parameters:</strong>
\r
742 <ul><li><code>startRow</code> : Number<div class="sub-desc">The index of the first row in the range</div></li><li><code>endRow</code> : Number<div class="sub-desc">The index of the last row in the range</div></li><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to retain existing selections</div></li> </ul>
\r
743 <strong>Returns:</strong>
\r
745 <li><code>void</code></li>
\r
751 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#selectRange" href="output/Ext.grid.RowSelectionModel.html#selectRange">RowSelectionModel</a></td>
\r
753 <tr class="method-row inherited expandable">
\r
754 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
756 <a id="Ext.grid.CheckboxSelectionModel-selectRecords"></a>
\r
757 <b>selectRecords</b>( <code>Array records</code>, <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : void <div class="mdesc">
\r
758 <div class="short">Select records.</div>
\r
760 Select records. <div class="mdetail-params">
\r
761 <strong>Parameters:</strong>
\r
762 <ul><li><code>records</code> : Array<div class="sub-desc">The records to select</div></li><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to keep existing selections</div></li> </ul>
\r
763 <strong>Returns:</strong>
\r
765 <li><code>void</code></li>
\r
771 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#selectRecords" href="output/Ext.grid.RowSelectionModel.html#selectRecords">RowSelectionModel</a></td>
\r
773 <tr class="method-row inherited alt expandable">
\r
774 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
776 <a id="Ext.grid.CheckboxSelectionModel-selectRow"></a>
\r
777 <b>selectRow</b>( <code>Number row</code>, <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : void <div class="mdesc">
\r
778 <div class="short">Selects a row.</div>
\r
780 Selects a row. <div class="mdetail-params">
\r
781 <strong>Parameters:</strong>
\r
782 <ul><li><code>row</code> : Number<div class="sub-desc">The index of the row to select</div></li><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to keep existing selections</div></li> </ul>
\r
783 <strong>Returns:</strong>
\r
785 <li><code>void</code></li>
\r
791 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#selectRow" href="output/Ext.grid.RowSelectionModel.html#selectRow">RowSelectionModel</a></td>
\r
793 <tr class="method-row inherited expandable">
\r
794 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
796 <a id="Ext.grid.CheckboxSelectionModel-selectRows"></a>
\r
797 <b>selectRows</b>( <code>Array rows</code>, <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : void <div class="mdesc">
\r
798 <div class="short">Selects multiple rows.</div>
\r
800 Selects multiple rows. <div class="mdetail-params">
\r
801 <strong>Parameters:</strong>
\r
802 <ul><li><code>rows</code> : Array<div class="sub-desc">Array of the indexes of the row to select</div></li><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to keep existing selections (defaults to false)</div></li> </ul>
\r
803 <strong>Returns:</strong>
\r
805 <li><code>void</code></li>
\r
811 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#selectRows" href="output/Ext.grid.RowSelectionModel.html#selectRows">RowSelectionModel</a></td>
\r
813 <tr class="method-row inherited alt expandable">
\r
814 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
816 <a id="Ext.grid.CheckboxSelectionModel-suspendEvents"></a>
\r
817 <b>suspendEvents</b>() : void <div class="mdesc">
\r
818 <div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>
\r
820 Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>) <div class="mdetail-params">
\r
821 <strong>Parameters:</strong>
\r
822 <ul><li>None.</li> </ul>
\r
823 <strong>Returns:</strong>
\r
825 <li><code>void</code></li>
\r
831 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
\r
833 <tr class="method-row inherited expandable">
\r
834 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
836 <a id="Ext.grid.CheckboxSelectionModel-un"></a>
\r
837 <b>un</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">
\r
838 <div class="short">Removes a listener (shorthand for removeListener)</div>
\r
840 Removes a listener (shorthand for removeListener) <div class="mdetail-params">
\r
841 <strong>Parameters:</strong>
\r
842 <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>
\r
843 <strong>Returns:</strong>
\r
845 <li><code>void</code></li>
\r
851 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
\r
853 <tr class="method-row inherited alt expandable">
\r
854 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
856 <a id="Ext.grid.CheckboxSelectionModel-unlock"></a>
\r
857 <b>unlock</b>() : void <div class="mdesc">
\r
858 <div class="short">Unlocks the selections.</div>
\r
860 Unlocks the selections. <div class="mdetail-params">
\r
861 <strong>Parameters:</strong>
\r
862 <ul><li>None.</li> </ul>
\r
863 <strong>Returns:</strong>
\r
865 <li><code>void</code></li>
\r
871 <td class="msource"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="#unlock" href="output/Ext.grid.AbstractSelectionModel.html#unlock">AbstractSelectionModel</a></td>
\r
874 <a id="Ext.grid.CheckboxSelectionModel-events"></a>
875 <h2>Public Events</h2>
876 <table cellspacing="0" class="member-table">
878 <th class="sig-header" colspan="2">Event</th>
879 <th class="msource-header">Defined By</th>
881 <tr class="event-row inherited expandable">
\r
882 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
884 <a id="Ext.grid.CheckboxSelectionModel-beforerowselect"></a>
\r
885 <b>beforerowselect</b> : ( <code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Boolean keepExisting</code>, <code>Record record</code> ) <div class="mdesc">
\r
886 <div class="short">Fires when a row is being selected, return false to cancel.</div>
\r
888 Fires when a row is being selected, return false to cancel. <div class="mdetail-params">
\r
889 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
890 <ul><li><code>this</code> : SelectionModel<div class="sub-desc"></div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The index to be selected</div></li><li><code>keepExisting</code> : Boolean<div class="sub-desc">False if other selections will be cleared</div></li><li><code>record</code> : Record<div class="sub-desc">The record to be selected</div></li> </ul>
\r
895 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#event-beforerowselect" href="output/Ext.grid.RowSelectionModel.html#event-beforerowselect">RowSelectionModel</a></td>
\r
897 <tr class="event-row inherited alt expandable">
\r
898 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
900 <a id="Ext.grid.CheckboxSelectionModel-rowdeselect"></a>
\r
901 <b>rowdeselect</b> : ( <code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Record record</code> ) <div class="mdesc">
\r
902 <div class="short">Fires when a row is deselected.</div>
\r
904 Fires when a row is deselected. <div class="mdetail-params">
\r
905 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
906 <ul><li><code>this</code> : SelectionModel<div class="sub-desc"></div></li><li><code>rowIndex</code> : Number<div class="sub-desc"></div></li><li><code>record</code> : Record<div class="sub-desc"></div></li> </ul>
\r
911 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#event-rowdeselect" href="output/Ext.grid.RowSelectionModel.html#event-rowdeselect">RowSelectionModel</a></td>
\r
913 <tr class="event-row inherited expandable">
\r
914 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
916 <a id="Ext.grid.CheckboxSelectionModel-rowselect"></a>
\r
917 <b>rowselect</b> : ( <code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Ext.data.Record r</code> ) <div class="mdesc">
\r
918 <div class="short">Fires when a row is selected.</div>
\r
920 Fires when a row is selected. <div class="mdetail-params">
\r
921 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
922 <ul><li><code>this</code> : SelectionModel<div class="sub-desc"></div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The selected index</div></li><li><code>r</code> : Ext.data.Record<div class="sub-desc">The selected record</div></li> </ul>
\r
927 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#event-rowselect" href="output/Ext.grid.RowSelectionModel.html#event-rowselect">RowSelectionModel</a></td>
\r
929 <tr class="event-row inherited alt expandable">
\r
930 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
932 <a id="Ext.grid.CheckboxSelectionModel-selectionchange"></a>
\r
933 <b>selectionchange</b> : ( <code>SelectionModel this</code> ) <div class="mdesc">
\r
934 <div class="short">Fires when the selection changes</div>
\r
936 Fires when the selection changes <div class="mdetail-params">
\r
937 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
938 <ul><li><code>this</code> : SelectionModel<div class="sub-desc"></div></li> </ul>
\r
943 <td class="msource"><a ext:cls="Ext.grid.RowSelectionModel" ext:member="#event-selectionchange" href="output/Ext.grid.RowSelectionModel.html#event-selectionchange">RowSelectionModel</a></td>
\r