1 <div class="body-wrap">
2 <div class="top-tools">
3 <a class="inner-link" href="#Ext.grid.RowSelectionModel-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4 <a class="inner-link" href="#Ext.grid.RowSelectionModel-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5 <a class="inner-link" href="#Ext.grid.RowSelectionModel-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6 <a class="inner-link" href="#Ext.grid.RowSelectionModel-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.RowSelectionModel"><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"/>RowSelectionModel</pre></div>
13 <h1>Class Ext.grid.RowSelectionModel</h1>
14 <table cellspacing="0">
15 <tr><td class="label">Package:</td><td class="hd-info">Ext.grid</td></tr>
16 <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/RowSelectionModel.js" target="_blank">RowSelectionModel.js</a></td></tr>
17 <tr><td class="label">Class:</td><td class="hd-info">RowSelectionModel</td></tr>
18 <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.grid.CheckboxSelectionModel" href="output/Ext.grid.CheckboxSelectionModel.html">CheckboxSelectionModel</a></td></tr>
19 <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="" href="output/Ext.grid.AbstractSelectionModel.html">AbstractSelectionModel</a></td></tr>
21 <div class="description">
23 The default SelectionModel used by <a ext:cls="Ext.grid.GridPanel" href="output/Ext.grid.GridPanel.html">Ext.grid.GridPanel</a>.
24 It supports multiple selections and keyboard selection/navigation. The objects stored
25 as selections and returned by <a ext:cls="Ext.grid.RowSelectionModel" ext:member="getSelected" href="output/Ext.grid.RowSelectionModel.html#getSelected">getSelected</a>, and <a ext:cls="Ext.grid.RowSelectionModel" ext:member="getSelections" href="output/Ext.grid.RowSelectionModel.html#getSelections">getSelections</a> are
26 the <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Record</a>s which provide the data for the selected rows. </div>
28 <div class="hr"></div>
29 <a id="Ext.grid.RowSelectionModel-configs"></a>
30 <h2>Config Options</h2>
31 <table cellspacing="0" class="member-table">
33 <th class="sig-header" colspan="2">Config Options</th>
34 <th class="msource-header">Defined By</th>
36 <tr class="config-row inherited expandable">
\r
37 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
39 <a id="Ext.grid.RowSelectionModel-listeners"></a>
\r
40 <b>listeners</b> : Object <div class="mdesc">
\r
41 <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>
\r
43 (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
46 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
\r
48 <tr class="config-row alt">
\r
49 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
51 <a id="Ext.grid.RowSelectionModel-moveEditorOnEnter"></a>
\r
52 <b>moveEditorOnEnter</b> : Boolean <div class="mdesc">
\r
53 False to turn off moving the editor to the next cell when the enter key is pressed </div>
\r
55 <td class="msource">RowSelectionModel</td>
\r
57 <tr class="config-row">
\r
58 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
60 <a id="Ext.grid.RowSelectionModel-singleSelect"></a>
\r
61 <b>singleSelect</b> : Boolean <div class="mdesc">
\r
62 True to allow selection of only one row at a time (defaults to false) </div>
\r
64 <td class="msource">RowSelectionModel</td>
\r
67 <a id="Ext.grid.RowSelectionModel-props"></a>
68 <h2>Public Properties</h2>
69 <div class="no-members">This class has no public properties.</div> <a id="Ext.grid.RowSelectionModel-methods"></a>
70 <h2>Public Methods</h2>
71 <table cellspacing="0" class="member-table">
73 <th class="sig-header" colspan="2">Method</th>
74 <th class="msource-header">Defined By</th>
76 <tr class="method-row expandable">
\r
77 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
79 <a id="Ext.grid.RowSelectionModel-RowSelectionModel"></a>
\r
80 <b>RowSelectionModel</b>( <code>Object config</code> ) <div class="mdesc">
\r
81 <div class="short"></div>
\r
83 <div class="mdetail-params">
\r
84 <strong>Parameters:</strong>
\r
85 <ul><li><code>config</code> : Object<div class="sub-desc"></div></li> </ul>
\r
86 <strong>Returns:</strong>
\r
88 <li><code></code></li>
\r
94 <td class="msource">RowSelectionModel</td>
\r
96 <tr class="method-row inherited alt expandable">
\r
97 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
99 <a id="Ext.grid.RowSelectionModel-addEvents"></a>
\r
100 <b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc">
\r
101 <div class="short">Used to define events on this Observable</div>
\r
103 Used to define events on this Observable <div class="mdetail-params">
\r
104 <strong>Parameters:</strong>
\r
105 <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul>
\r
106 <strong>Returns:</strong>
\r
108 <li><code>void</code></li>
\r
114 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
\r
116 <tr class="method-row inherited expandable">
\r
117 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
119 <a id="Ext.grid.RowSelectionModel-addListener"></a>
\r
120 <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
121 <div class="short">Appends an event handler to this component</div>
\r
123 Appends an event handler to this component <div class="mdetail-params">
\r
124 <strong>Parameters:</strong>
\r
125 <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
126 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
127 properties. This may contain any of the following properties:<ul>
128 <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>
129 <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>
130 <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>
131 <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
132 by the specified number of milliseconds. If the event fires again within that time, the original
133 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
136 <b>Combining Options</b><br>
137 Using the options argument, it is possible to combine different types of listeners:<br>
139 A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
140 <pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
146 <b>Attaching multiple handlers in 1 call</b><br>
147 The method also allows for a single argument to be passed which is a config object containing properties
148 which specify multiple handlers.
152 fn: <b>this</b>.onClick,
156 <em>'mouseover'</em> : {
157 fn: <b>this</b>.onMouseOver,
160 <em>'mouseout'</em> : {
161 fn: <b>this</b>.onMouseOut,
166 Or a shorthand syntax:<br>
168 <em>'click'</em> : <b>this</b>.onClick,
169 <em>'mouseover'</em> : <b>this</b>.onMouseOver,
170 <em>'mouseout'</em> : <b>this</b>.onMouseOut,
172 });</code></pre></div></li> </ul>
\r
173 <strong>Returns:</strong>
\r
175 <li><code>void</code></li>
\r
181 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
\r
183 <tr class="method-row alt expandable">
\r
184 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
186 <a id="Ext.grid.RowSelectionModel-clearSelections"></a>
\r
187 <b>clearSelections</b>() : void <div class="mdesc">
\r
188 <div class="short">Clears all selections.</div>
\r
190 Clears all selections. <div class="mdetail-params">
\r
191 <strong>Parameters:</strong>
\r
192 <ul><li>None.</li> </ul>
\r
193 <strong>Returns:</strong>
\r
195 <li><code>void</code></li>
\r
201 <td class="msource">RowSelectionModel</td>
\r
203 <tr class="method-row expandable">
\r
204 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
206 <a id="Ext.grid.RowSelectionModel-deselectRange"></a>
\r
207 <b>deselectRange</b>( <code>Number startRow</code>, <code>Number endRow</code> ) : void <div class="mdesc">
\r
208 <div class="short">Deselects a range of rows. All rows in between startRow and endRow are also deselected.</div>
\r
210 Deselects a range of rows. All rows in between startRow and endRow are also deselected. <div class="mdetail-params">
\r
211 <strong>Parameters:</strong>
\r
212 <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
213 <strong>Returns:</strong>
\r
215 <li><code>void</code></li>
\r
221 <td class="msource">RowSelectionModel</td>
\r
223 <tr class="method-row alt expandable">
\r
224 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
226 <a id="Ext.grid.RowSelectionModel-deselectRow"></a>
\r
227 <b>deselectRow</b>( <code>Number row</code> ) : void <div class="mdesc">
\r
228 <div class="short">Deselects a row.</div>
\r
230 Deselects a row. <div class="mdetail-params">
\r
231 <strong>Parameters:</strong>
\r
232 <ul><li><code>row</code> : Number<div class="sub-desc">The index of the row to deselect</div></li> </ul>
\r
233 <strong>Returns:</strong>
\r
235 <li><code>void</code></li>
\r
241 <td class="msource">RowSelectionModel</td>
\r
243 <tr class="method-row expandable">
\r
244 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
246 <a id="Ext.grid.RowSelectionModel-each"></a>
\r
247 <b>each</b>( <code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : Boolean <div class="mdesc">
\r
248 <div class="short">Calls the passed function with each selection. If the function returns false, iteration is
249 stopped and this function ...</div>
\r
251 Calls the passed function with each selection. If the function returns false, iteration is
252 stopped and this function returns false. Otherwise it returns true. <div class="mdetail-params">
\r
253 <strong>Parameters:</strong>
\r
254 <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
255 <strong>Returns:</strong>
\r
257 <li><code>Boolean</code><div class="sub-desc">true if all selections were iterated</div></li>
\r
263 <td class="msource">RowSelectionModel</td>
\r
265 <tr class="method-row inherited alt expandable">
\r
266 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
268 <a id="Ext.grid.RowSelectionModel-fireEvent"></a>
\r
269 <b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc">
\r
270 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
\r
272 Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params">
\r
273 <strong>Parameters:</strong>
\r
274 <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
275 <strong>Returns:</strong>
\r
277 <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
\r
283 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
\r
285 <tr class="method-row expandable">
\r
286 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
288 <a id="Ext.grid.RowSelectionModel-getCount"></a>
\r
289 <b>getCount</b>() : Number <div class="mdesc">
\r
290 <div class="short">Gets the number of selected rows.</div>
\r
292 Gets the number of selected rows. <div class="mdetail-params">
\r
293 <strong>Parameters:</strong>
\r
294 <ul><li>None.</li> </ul>
\r
295 <strong>Returns:</strong>
\r
297 <li><code>Number</code></li>
\r
303 <td class="msource">RowSelectionModel</td>
\r
305 <tr class="method-row alt expandable">
\r
306 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
308 <a id="Ext.grid.RowSelectionModel-getSelected"></a>
\r
309 <b>getSelected</b>() : Record <div class="mdesc">
\r
310 <div class="short">Returns the first selected record.</div>
\r
312 Returns the first selected record. <div class="mdetail-params">
\r
313 <strong>Parameters:</strong>
\r
314 <ul><li>None.</li> </ul>
\r
315 <strong>Returns:</strong>
\r
317 <li><code>Record</code></li>
\r
323 <td class="msource">RowSelectionModel</td>
\r
325 <tr class="method-row expandable">
\r
326 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
328 <a id="Ext.grid.RowSelectionModel-getSelections"></a>
\r
329 <b>getSelections</b>() : Array <div class="mdesc">
\r
330 <div class="short">Returns the selected records</div>
\r
332 Returns the selected records <div class="mdetail-params">
\r
333 <strong>Parameters:</strong>
\r
334 <ul><li>None.</li> </ul>
\r
335 <strong>Returns:</strong>
\r
337 <li><code>Array</code><div class="sub-desc">Array of selected records</div></li>
\r
343 <td class="msource">RowSelectionModel</td>
\r
345 <tr class="method-row inherited alt expandable">
\r
346 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
348 <a id="Ext.grid.RowSelectionModel-hasListener"></a>
\r
349 <b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc">
\r
350 <div class="short">Checks to see if this object has any listeners for a specified event</div>
\r
352 Checks to see if this object has any listeners for a specified event <div class="mdetail-params">
\r
353 <strong>Parameters:</strong>
\r
354 <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>
\r
355 <strong>Returns:</strong>
\r
357 <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
\r
363 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
\r
365 <tr class="method-row expandable">
\r
366 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
368 <a id="Ext.grid.RowSelectionModel-hasNext"></a>
\r
369 <b>hasNext</b>() : Boolean <div class="mdesc">
\r
370 <div class="short">Returns true if there is a next record to select</div>
\r
372 Returns true if there is a next record to select <div class="mdetail-params">
\r
373 <strong>Parameters:</strong>
\r
374 <ul><li>None.</li> </ul>
\r
375 <strong>Returns:</strong>
\r
377 <li><code>Boolean</code></li>
\r
383 <td class="msource">RowSelectionModel</td>
\r
385 <tr class="method-row alt expandable">
\r
386 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
388 <a id="Ext.grid.RowSelectionModel-hasPrevious"></a>
\r
389 <b>hasPrevious</b>() : Boolean <div class="mdesc">
\r
390 <div class="short">Returns true if there is a previous record to select</div>
\r
392 Returns true if there is a previous record to select <div class="mdetail-params">
\r
393 <strong>Parameters:</strong>
\r
394 <ul><li>None.</li> </ul>
\r
395 <strong>Returns:</strong>
\r
397 <li><code>Boolean</code></li>
\r
403 <td class="msource">RowSelectionModel</td>
\r
405 <tr class="method-row expandable">
\r
406 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
408 <a id="Ext.grid.RowSelectionModel-hasSelection"></a>
\r
409 <b>hasSelection</b>() : Boolean <div class="mdesc">
\r
410 <div class="short">Returns True if there is a selection.</div>
\r
412 Returns True if there is a selection. <div class="mdetail-params">
\r
413 <strong>Parameters:</strong>
\r
414 <ul><li>None.</li> </ul>
\r
415 <strong>Returns:</strong>
\r
417 <li><code>Boolean</code></li>
\r
423 <td class="msource">RowSelectionModel</td>
\r
425 <tr class="method-row alt expandable">
\r
426 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
428 <a id="Ext.grid.RowSelectionModel-isIdSelected"></a>
\r
429 <b>isIdSelected</b>( <code>String id</code> ) : Boolean <div class="mdesc">
\r
430 <div class="short">Returns True if the specified record id is selected.</div>
\r
432 Returns True if the specified record id is selected. <div class="mdetail-params">
\r
433 <strong>Parameters:</strong>
\r
434 <ul><li><code>id</code> : String<div class="sub-desc">The id of record to check</div></li> </ul>
\r
435 <strong>Returns:</strong>
\r
437 <li><code>Boolean</code></li>
\r
443 <td class="msource">RowSelectionModel</td>
\r
445 <tr class="method-row inherited expandable">
\r
446 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
448 <a id="Ext.grid.RowSelectionModel-isLocked"></a>
\r
449 <b>isLocked</b>() : Boolean <div class="mdesc">
\r
450 <div class="short">Returns true if the selections are locked.</div>
\r
452 Returns true if the selections are locked. <div class="mdetail-params">
\r
453 <strong>Parameters:</strong>
\r
454 <ul><li>None.</li> </ul>
\r
455 <strong>Returns:</strong>
\r
457 <li><code>Boolean</code></li>
\r
463 <td class="msource"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="#isLocked" href="output/Ext.grid.AbstractSelectionModel.html#isLocked">AbstractSelectionModel</a></td>
\r
465 <tr class="method-row alt expandable">
\r
466 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
468 <a id="Ext.grid.RowSelectionModel-isSelected"></a>
\r
469 <b>isSelected</b>( <code>Number/Record record</code> ) : Boolean <div class="mdesc">
\r
470 <div class="short">Returns True if the specified row is selected.</div>
\r
472 Returns True if the specified row is selected. <div class="mdetail-params">
\r
473 <strong>Parameters:</strong>
\r
474 <ul><li><code>record</code> : Number/Record<div class="sub-desc">The record or index of the record to check</div></li> </ul>
\r
475 <strong>Returns:</strong>
\r
477 <li><code>Boolean</code></li>
\r
483 <td class="msource">RowSelectionModel</td>
\r
485 <tr class="method-row inherited expandable">
\r
486 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
488 <a id="Ext.grid.RowSelectionModel-lock"></a>
\r
489 <b>lock</b>() : void <div class="mdesc">
\r
490 <div class="short">Locks the selections.</div>
\r
492 Locks the selections. <div class="mdetail-params">
\r
493 <strong>Parameters:</strong>
\r
494 <ul><li>None.</li> </ul>
\r
495 <strong>Returns:</strong>
\r
497 <li><code>void</code></li>
\r
503 <td class="msource"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="#lock" href="output/Ext.grid.AbstractSelectionModel.html#lock">AbstractSelectionModel</a></td>
\r
505 <tr class="method-row inherited alt expandable">
\r
506 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
508 <a id="Ext.grid.RowSelectionModel-on"></a>
\r
509 <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
510 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
\r
512 Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params">
\r
513 <strong>Parameters:</strong>
\r
514 <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
515 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
\r
516 <strong>Returns:</strong>
\r
518 <li><code>void</code></li>
\r
524 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
\r
526 <tr class="method-row inherited expandable">
\r
527 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
529 <a id="Ext.grid.RowSelectionModel-purgeListeners"></a>
\r
530 <b>purgeListeners</b>() : void <div class="mdesc">
\r
531 <div class="short">Removes all listeners for this object</div>
\r
533 Removes all listeners for this object <div class="mdetail-params">
\r
534 <strong>Parameters:</strong>
\r
535 <ul><li>None.</li> </ul>
\r
536 <strong>Returns:</strong>
\r
538 <li><code>void</code></li>
\r
544 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
\r
546 <tr class="method-row inherited alt expandable">
\r
547 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
549 <a id="Ext.grid.RowSelectionModel-relayEvents"></a>
\r
550 <b>relayEvents</b>( <code>Object o</code>, <code>Array events</code> ) : void <div class="mdesc">
\r
551 <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>
\r
553 Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>. <div class="mdetail-params">
\r
554 <strong>Parameters:</strong>
\r
555 <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
556 <strong>Returns:</strong>
\r
558 <li><code>void</code></li>
\r
564 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>
\r
566 <tr class="method-row inherited expandable">
\r
567 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
569 <a id="Ext.grid.RowSelectionModel-removeListener"></a>
\r
570 <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
571 <div class="short">Removes a listener</div>
\r
573 Removes a listener <div class="mdetail-params">
\r
574 <strong>Parameters:</strong>
\r
575 <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
576 <strong>Returns:</strong>
\r
578 <li><code>void</code></li>
\r
584 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
\r
586 <tr class="method-row inherited alt expandable">
\r
587 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
589 <a id="Ext.grid.RowSelectionModel-resumeEvents"></a>
\r
590 <b>resumeEvents</b>() : void <div class="mdesc">
\r
591 <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
593 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
594 <strong>Parameters:</strong>
\r
595 <ul><li>None.</li> </ul>
\r
596 <strong>Returns:</strong>
\r
598 <li><code>void</code></li>
\r
604 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
\r
606 <tr class="method-row expandable">
\r
607 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
609 <a id="Ext.grid.RowSelectionModel-selectAll"></a>
\r
610 <b>selectAll</b>() : void <div class="mdesc">
\r
611 <div class="short">Selects all rows.</div>
\r
613 Selects all rows. <div class="mdetail-params">
\r
614 <strong>Parameters:</strong>
\r
615 <ul><li>None.</li> </ul>
\r
616 <strong>Returns:</strong>
\r
618 <li><code>void</code></li>
\r
624 <td class="msource">RowSelectionModel</td>
\r
626 <tr class="method-row alt expandable">
\r
627 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
629 <a id="Ext.grid.RowSelectionModel-selectFirstRow"></a>
\r
630 <b>selectFirstRow</b>() : void <div class="mdesc">
\r
631 <div class="short">Selects the first row in the grid.</div>
\r
633 Selects the first row in the grid. <div class="mdetail-params">
\r
634 <strong>Parameters:</strong>
\r
635 <ul><li>None.</li> </ul>
\r
636 <strong>Returns:</strong>
\r
638 <li><code>void</code></li>
\r
644 <td class="msource">RowSelectionModel</td>
\r
646 <tr class="method-row expandable">
\r
647 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
649 <a id="Ext.grid.RowSelectionModel-selectLastRow"></a>
\r
650 <b>selectLastRow</b>( <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : void <div class="mdesc">
\r
651 <div class="short">Select the last row.</div>
\r
653 Select the last row. <div class="mdetail-params">
\r
654 <strong>Parameters:</strong>
\r
655 <ul><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to keep existing selections</div></li> </ul>
\r
656 <strong>Returns:</strong>
\r
658 <li><code>void</code></li>
\r
664 <td class="msource">RowSelectionModel</td>
\r
666 <tr class="method-row alt expandable">
\r
667 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
669 <a id="Ext.grid.RowSelectionModel-selectNext"></a>
\r
670 <b>selectNext</b>( <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : Boolean <div class="mdesc">
\r
671 <div class="short">Selects the row immediately following the last selected row.</div>
\r
673 Selects the row immediately following the last selected row. <div class="mdetail-params">
\r
674 <strong>Parameters:</strong>
\r
675 <ul><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to keep existing selections</div></li> </ul>
\r
676 <strong>Returns:</strong>
\r
678 <li><code>Boolean</code><div class="sub-desc">True if there is a next row, else false</div></li>
\r
684 <td class="msource">RowSelectionModel</td>
\r
686 <tr class="method-row expandable">
\r
687 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
689 <a id="Ext.grid.RowSelectionModel-selectPrevious"></a>
\r
690 <b>selectPrevious</b>( <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : Boolean <div class="mdesc">
\r
691 <div class="short">Selects the row that precedes the last selected row.</div>
\r
693 Selects the row that precedes the last selected row. <div class="mdetail-params">
\r
694 <strong>Parameters:</strong>
\r
695 <ul><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to keep existing selections</div></li> </ul>
\r
696 <strong>Returns:</strong>
\r
698 <li><code>Boolean</code><div class="sub-desc">True if there is a previous row, else false</div></li>
\r
704 <td class="msource">RowSelectionModel</td>
\r
706 <tr class="method-row alt expandable">
\r
707 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
709 <a id="Ext.grid.RowSelectionModel-selectRange"></a>
\r
710 <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
711 <div class="short">Selects a range of rows. All rows in between startRow and endRow are also selected.</div>
\r
713 Selects a range of rows. All rows in between startRow and endRow are also selected. <div class="mdetail-params">
\r
714 <strong>Parameters:</strong>
\r
715 <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
716 <strong>Returns:</strong>
\r
718 <li><code>void</code></li>
\r
724 <td class="msource">RowSelectionModel</td>
\r
726 <tr class="method-row expandable">
\r
727 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
729 <a id="Ext.grid.RowSelectionModel-selectRecords"></a>
\r
730 <b>selectRecords</b>( <code>Array records</code>, <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : void <div class="mdesc">
\r
731 <div class="short">Select records.</div>
\r
733 Select records. <div class="mdetail-params">
\r
734 <strong>Parameters:</strong>
\r
735 <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
736 <strong>Returns:</strong>
\r
738 <li><code>void</code></li>
\r
744 <td class="msource">RowSelectionModel</td>
\r
746 <tr class="method-row alt expandable">
\r
747 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
749 <a id="Ext.grid.RowSelectionModel-selectRow"></a>
\r
750 <b>selectRow</b>( <code>Number row</code>, <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : void <div class="mdesc">
\r
751 <div class="short">Selects a row.</div>
\r
753 Selects a row. <div class="mdetail-params">
\r
754 <strong>Parameters:</strong>
\r
755 <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
756 <strong>Returns:</strong>
\r
758 <li><code>void</code></li>
\r
764 <td class="msource">RowSelectionModel</td>
\r
766 <tr class="method-row expandable">
\r
767 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
769 <a id="Ext.grid.RowSelectionModel-selectRows"></a>
\r
770 <b>selectRows</b>( <code>Array rows</code>, <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span> ) : void <div class="mdesc">
\r
771 <div class="short">Selects multiple rows.</div>
\r
773 Selects multiple rows. <div class="mdetail-params">
\r
774 <strong>Parameters:</strong>
\r
775 <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
776 <strong>Returns:</strong>
\r
778 <li><code>void</code></li>
\r
784 <td class="msource">RowSelectionModel</td>
\r
786 <tr class="method-row inherited alt expandable">
\r
787 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
789 <a id="Ext.grid.RowSelectionModel-suspendEvents"></a>
\r
790 <b>suspendEvents</b>() : void <div class="mdesc">
\r
791 <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
793 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
794 <strong>Parameters:</strong>
\r
795 <ul><li>None.</li> </ul>
\r
796 <strong>Returns:</strong>
\r
798 <li><code>void</code></li>
\r
804 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
\r
806 <tr class="method-row inherited expandable">
\r
807 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
809 <a id="Ext.grid.RowSelectionModel-un"></a>
\r
810 <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
811 <div class="short">Removes a listener (shorthand for removeListener)</div>
\r
813 Removes a listener (shorthand for removeListener) <div class="mdetail-params">
\r
814 <strong>Parameters:</strong>
\r
815 <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
816 <strong>Returns:</strong>
\r
818 <li><code>void</code></li>
\r
824 <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
\r
826 <tr class="method-row inherited alt expandable">
\r
827 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
829 <a id="Ext.grid.RowSelectionModel-unlock"></a>
\r
830 <b>unlock</b>() : void <div class="mdesc">
\r
831 <div class="short">Unlocks the selections.</div>
\r
833 Unlocks the selections. <div class="mdetail-params">
\r
834 <strong>Parameters:</strong>
\r
835 <ul><li>None.</li> </ul>
\r
836 <strong>Returns:</strong>
\r
838 <li><code>void</code></li>
\r
844 <td class="msource"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="#unlock" href="output/Ext.grid.AbstractSelectionModel.html#unlock">AbstractSelectionModel</a></td>
\r
847 <a id="Ext.grid.RowSelectionModel-events"></a>
848 <h2>Public Events</h2>
849 <table cellspacing="0" class="member-table">
851 <th class="sig-header" colspan="2">Event</th>
852 <th class="msource-header">Defined By</th>
854 <tr class="event-row expandable">
\r
855 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
857 <a id="Ext.grid.RowSelectionModel-beforerowselect"></a>
\r
858 <b>beforerowselect</b> : ( <code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Boolean keepExisting</code>, <code>Record record</code> ) <div class="mdesc">
\r
859 <div class="short">Fires when a row is being selected, return false to cancel.</div>
\r
861 Fires when a row is being selected, return false to cancel. <div class="mdetail-params">
\r
862 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
863 <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
868 <td class="msource">RowSelectionModel</td>
\r
870 <tr class="event-row alt expandable">
\r
871 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
873 <a id="Ext.grid.RowSelectionModel-rowdeselect"></a>
\r
874 <b>rowdeselect</b> : ( <code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Record record</code> ) <div class="mdesc">
\r
875 <div class="short">Fires when a row is deselected.</div>
\r
877 Fires when a row is deselected. <div class="mdetail-params">
\r
878 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
879 <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
884 <td class="msource">RowSelectionModel</td>
\r
886 <tr class="event-row expandable">
\r
887 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
889 <a id="Ext.grid.RowSelectionModel-rowselect"></a>
\r
890 <b>rowselect</b> : ( <code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Ext.data.Record r</code> ) <div class="mdesc">
\r
891 <div class="short">Fires when a row is selected.</div>
\r
893 Fires when a row is selected. <div class="mdetail-params">
\r
894 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
895 <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
900 <td class="msource">RowSelectionModel</td>
\r
902 <tr class="event-row alt expandable">
\r
903 <td class="micon"><a class="exi" href="#expand"> </a></td>
\r
905 <a id="Ext.grid.RowSelectionModel-selectionchange"></a>
\r
906 <b>selectionchange</b> : ( <code>SelectionModel this</code> ) <div class="mdesc">
\r
907 <div class="short">Fires when the selection changes</div>
\r
909 Fires when the selection changes <div class="mdetail-params">
\r
910 <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
\r
911 <ul><li><code>this</code> : SelectionModel<div class="sub-desc"></div></li> </ul>
\r
916 <td class="msource">RowSelectionModel</td>
\r