Subversion Repositories eFlore/Applications.cel

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
2 aperonnet 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>
8
        </div>
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="../source/widgets/grid/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>
20
                    </table>
21
        <div class="description">
22
            The default SelectionModel used by <a ext:cls="Ext.grid.GridPanel" href="output/Ext.grid.GridPanel.html">Ext.grid.GridPanel</a>.
23
It supports multiple selections and keyboard selection/navigation. The objects stored
24
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
25
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>
26
 
27
        <div class="hr"></div>
28
                <a id="Ext.grid.RowSelectionModel-configs"></a>
29
        <h2>Config Options</h2>
30
        <table cellspacing="0" class="member-table">
31
            <tr>
32
                <th class="sig-header" colspan="2">Config Options</th>
33
                <th class="msource-header">Defined By</th>
34
            </tr>
35
                <tr class="config-row inherited expandable">
36
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
37
        <td class="sig">
38
        <a id="Ext.grid.RowSelectionModel-listeners"></a>
39
            <b>listeners</b> : Object            <div class="mdesc">
40
                        <div class="short">A config object containing one or more event handlers to be added to this object during initialization. This should b...</div>
41
            <div class="long">
42
                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>
43
                        </div>
44
        </td>
45
        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
46
    </tr>
47
        <tr class="config-row alt">
48
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
49
        <td class="sig">
50
        <a id="Ext.grid.RowSelectionModel-moveEditorOnEnter"></a>
51
            <b>moveEditorOnEnter</b> : Boolean            <div class="mdesc">
52
                            False to turn off moving the editor to the next cell when the enter key is pressed                        </div>
53
        </td>
54
        <td class="msource">RowSelectionModel</td>
55
    </tr>
56
        <tr class="config-row">
57
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
58
        <td class="sig">
59
        <a id="Ext.grid.RowSelectionModel-singleSelect"></a>
60
            <b>singleSelect</b> : Boolean            <div class="mdesc">
61
                            True to allow selection of only one row at a time (defaults to false)                        </div>
62
        </td>
63
        <td class="msource">RowSelectionModel</td>
64
    </tr>
65
            </table>
66
                <a id="Ext.grid.RowSelectionModel-props"></a>
67
        <h2>Public Properties</h2>
68
        <div class="no-members">This class has no public properties.</div>        <a id="Ext.grid.RowSelectionModel-methods"></a>
69
        <h2>Public Methods</h2>
70
                <table cellspacing="0" class="member-table">
71
            <tr>
72
                <th class="sig-header" colspan="2">Method</th>
73
                <th class="msource-header">Defined By</th>
74
            </tr>
75
                <tr class="method-row expandable">
76
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
77
        <td class="sig">
78
        <a id="Ext.grid.RowSelectionModel-RowSelectionModel"></a>
79
            <b>RowSelectionModel</b>(&nbsp;<code>Object config</code>&nbsp;)            <div class="mdesc">
80
                        <div class="short"></div>
81
            <div class="long">
82
                    <div class="mdetail-params">
83
        <strong>Parameters:</strong>
84
        <ul><li><code>config</code> : Object<div class="sub-desc"></div></li>        </ul>
85
        <strong>Returns:</strong>
86
        <ul>
87
            <li><code></code></li>
88
        </ul>
89
    </div>
90
                </div>
91
                        </div>
92
        </td>
93
        <td class="msource">RowSelectionModel</td>
94
    </tr>
95
        <tr class="method-row inherited alt expandable">
96
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
97
        <td class="sig">
98
        <a id="Ext.grid.RowSelectionModel-addEvents"></a>
99
            <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void            <div class="mdesc">
100
                        <div class="short">Used to define events on this Observable</div>
101
            <div class="long">
102
                Used to define events on this Observable    <div class="mdetail-params">
103
        <strong>Parameters:</strong>
104
        <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li>        </ul>
105
        <strong>Returns:</strong>
106
        <ul>
107
            <li><code>void</code></li>
108
        </ul>
109
    </div>
110
                </div>
111
                        </div>
112
        </td>
113
        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
114
    </tr>
115
        <tr class="method-row inherited expandable">
116
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
117
        <td class="sig">
118
        <a id="Ext.grid.RowSelectionModel-addListener"></a>
119
            <b>addListener</b>(&nbsp;<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>&nbsp;) : void            <div class="mdesc">
120
                        <div class="short">Appends an event handler to this component</div>
121
            <div class="long">
122
                Appends an event handler to this component    <div class="mdetail-params">
123
        <strong>Parameters:</strong>
124
        <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
125
function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
126
properties. This may contain any of the following properties:<ul>
127
<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>
128
<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>
129
<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>
130
<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
131
by the specified number of milliseconds. If the event fires again within that time, the original
132
handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
133
</ul><br>
134
<p>
135
<b>Combining Options</b><br>
136
Using the options argument, it is possible to combine different types of listeners:<br>
137
<br>
138
A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
139
<pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
140
    single: true,
141
    delay: 100,
142
    forumId: 4
143
});</code></pre>
144
<p>
145
<b>Attaching multiple handlers in 1 call</b><br>
146
The method also allows for a single argument to be passed which is a config object containing properties
147
which specify multiple handlers.
148
<p>
149
<pre><code>foo.on({
150
    <em>'click'</em> : {
151
        fn: <b>this</b>.onClick,
152
        scope: <b>this</b>,
153
        delay: 100
154
    },
155
    <em>'mouseover'</em> : {
156
        fn: <b>this</b>.onMouseOver,
157
        scope: <b>this</b>
158
    },
159
    <em>'mouseout'</em> : {
160
        fn: <b>this</b>.onMouseOut,
161
        scope: <b>this</b>
162
    }
163
});</code></pre>
164
<p>
165
Or a shorthand syntax:<br>
166
<pre><code>foo.on({
167
    <em>'click'</em> : <b>this</b>.onClick,
168
    <em>'mouseover'</em> : <b>this</b>.onMouseOver,
169
    <em>'mouseout'</em> : <b>this</b>.onMouseOut,
170
     scope: <b>this</b>
171
});</code></pre></div></li>        </ul>
172
        <strong>Returns:</strong>
173
        <ul>
174
            <li><code>void</code></li>
175
        </ul>
176
    </div>
177
                </div>
178
                        </div>
179
        </td>
180
        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
181
    </tr>
182
        <tr class="method-row alt expandable">
183
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
184
        <td class="sig">
185
        <a id="Ext.grid.RowSelectionModel-clearSelections"></a>
186
            <b>clearSelections</b>() : void            <div class="mdesc">
187
                        <div class="short">Clears all selections.</div>
188
            <div class="long">
189
                Clears all selections.    <div class="mdetail-params">
190
        <strong>Parameters:</strong>
191
        <ul><li>None.</li>        </ul>
192
        <strong>Returns:</strong>
193
        <ul>
194
            <li><code>void</code></li>
195
        </ul>
196
    </div>
197
                </div>
198
                        </div>
199
        </td>
200
        <td class="msource">RowSelectionModel</td>
201
    </tr>
202
        <tr class="method-row expandable">
203
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
204
        <td class="sig">
205
        <a id="Ext.grid.RowSelectionModel-deselectRange"></a>
206
            <b>deselectRange</b>(&nbsp;<code>Number startRow</code>, <code>Number endRow</code>&nbsp;) : void            <div class="mdesc">
207
                        <div class="short">Deselects a range of rows. All rows in between startRow and endRow are also deselected.</div>
208
            <div class="long">
209
                Deselects a range of rows. All rows in between startRow and endRow are also deselected.    <div class="mdetail-params">
210
        <strong>Parameters:</strong>
211
        <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>
212
        <strong>Returns:</strong>
213
        <ul>
214
            <li><code>void</code></li>
215
        </ul>
216
    </div>
217
                </div>
218
                        </div>
219
        </td>
220
        <td class="msource">RowSelectionModel</td>
221
    </tr>
222
        <tr class="method-row alt expandable">
223
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
224
        <td class="sig">
225
        <a id="Ext.grid.RowSelectionModel-deselectRow"></a>
226
            <b>deselectRow</b>(&nbsp;<code>Number row</code>&nbsp;) : void            <div class="mdesc">
227
                        <div class="short">Deselects a row.</div>
228
            <div class="long">
229
                Deselects a row.    <div class="mdetail-params">
230
        <strong>Parameters:</strong>
231
        <ul><li><code>row</code> : Number<div class="sub-desc">The index of the row to deselect</div></li>        </ul>
232
        <strong>Returns:</strong>
233
        <ul>
234
            <li><code>void</code></li>
235
        </ul>
236
    </div>
237
                </div>
238
                        </div>
239
        </td>
240
        <td class="msource">RowSelectionModel</td>
241
    </tr>
242
        <tr class="method-row expandable">
243
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
244
        <td class="sig">
245
        <a id="Ext.grid.RowSelectionModel-each"></a>
246
            <b>each</b>(&nbsp;<code>Function fn</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : Boolean            <div class="mdesc">
247
                        <div class="short">Calls the passed function with each selection. If the function returns false, iteration is
248
stopped and this function ...</div>
249
            <div class="long">
250
                Calls the passed function with each selection. If the function returns false, iteration is
251
stopped and this function returns false. Otherwise it returns true.    <div class="mdetail-params">
252
        <strong>Parameters:</strong>
253
        <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>
254
        <strong>Returns:</strong>
255
        <ul>
256
            <li><code>Boolean</code><div class="sub-desc">true if all selections were iterated</div></li>
257
        </ul>
258
    </div>
259
                </div>
260
                        </div>
261
        </td>
262
        <td class="msource">RowSelectionModel</td>
263
    </tr>
264
        <tr class="method-row inherited alt expandable">
265
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
266
        <td class="sig">
267
        <a id="Ext.grid.RowSelectionModel-fireEvent"></a>
268
            <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean            <div class="mdesc">
269
                        <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
270
            <div class="long">
271
                Fires the specified event with the passed parameters (minus the event name).    <div class="mdetail-params">
272
        <strong>Parameters:</strong>
273
        <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>
274
        <strong>Returns:</strong>
275
        <ul>
276
            <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
277
        </ul>
278
    </div>
279
                </div>
280
                        </div>
281
        </td>
282
        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
283
    </tr>
284
        <tr class="method-row expandable">
285
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
286
        <td class="sig">
287
        <a id="Ext.grid.RowSelectionModel-getCount"></a>
288
            <b>getCount</b>() : Number            <div class="mdesc">
289
                        <div class="short">Gets the number of selected rows.</div>
290
            <div class="long">
291
                Gets the number of selected rows.    <div class="mdetail-params">
292
        <strong>Parameters:</strong>
293
        <ul><li>None.</li>        </ul>
294
        <strong>Returns:</strong>
295
        <ul>
296
            <li><code>Number</code></li>
297
        </ul>
298
    </div>
299
                </div>
300
                        </div>
301
        </td>
302
        <td class="msource">RowSelectionModel</td>
303
    </tr>
304
        <tr class="method-row alt expandable">
305
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
306
        <td class="sig">
307
        <a id="Ext.grid.RowSelectionModel-getSelected"></a>
308
            <b>getSelected</b>() : Record            <div class="mdesc">
309
                        <div class="short">Returns the first selected record.</div>
310
            <div class="long">
311
                Returns the first selected record.    <div class="mdetail-params">
312
        <strong>Parameters:</strong>
313
        <ul><li>None.</li>        </ul>
314
        <strong>Returns:</strong>
315
        <ul>
316
            <li><code>Record</code></li>
317
        </ul>
318
    </div>
319
                </div>
320
                        </div>
321
        </td>
322
        <td class="msource">RowSelectionModel</td>
323
    </tr>
324
        <tr class="method-row expandable">
325
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
326
        <td class="sig">
327
        <a id="Ext.grid.RowSelectionModel-getSelections"></a>
328
            <b>getSelections</b>() : Array            <div class="mdesc">
329
                        <div class="short">Returns the selected records</div>
330
            <div class="long">
331
                Returns the selected records    <div class="mdetail-params">
332
        <strong>Parameters:</strong>
333
        <ul><li>None.</li>        </ul>
334
        <strong>Returns:</strong>
335
        <ul>
336
            <li><code>Array</code><div class="sub-desc">Array of selected records</div></li>
337
        </ul>
338
    </div>
339
                </div>
340
                        </div>
341
        </td>
342
        <td class="msource">RowSelectionModel</td>
343
    </tr>
344
        <tr class="method-row inherited alt expandable">
345
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
346
        <td class="sig">
347
        <a id="Ext.grid.RowSelectionModel-hasListener"></a>
348
            <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean            <div class="mdesc">
349
                        <div class="short">Checks to see if this object has any listeners for a specified event</div>
350
            <div class="long">
351
                Checks to see if this object has any listeners for a specified event    <div class="mdetail-params">
352
        <strong>Parameters:</strong>
353
        <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li>        </ul>
354
        <strong>Returns:</strong>
355
        <ul>
356
            <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
357
        </ul>
358
    </div>
359
                </div>
360
                        </div>
361
        </td>
362
        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
363
    </tr>
364
        <tr class="method-row expandable">
365
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
366
        <td class="sig">
367
        <a id="Ext.grid.RowSelectionModel-hasNext"></a>
368
            <b>hasNext</b>() : Boolean            <div class="mdesc">
369
                        <div class="short">Returns true if there is a next record to select</div>
370
            <div class="long">
371
                Returns true if there is a next record to select    <div class="mdetail-params">
372
        <strong>Parameters:</strong>
373
        <ul><li>None.</li>        </ul>
374
        <strong>Returns:</strong>
375
        <ul>
376
            <li><code>Boolean</code></li>
377
        </ul>
378
    </div>
379
                </div>
380
                        </div>
381
        </td>
382
        <td class="msource">RowSelectionModel</td>
383
    </tr>
384
        <tr class="method-row alt expandable">
385
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
386
        <td class="sig">
387
        <a id="Ext.grid.RowSelectionModel-hasPrevious"></a>
388
            <b>hasPrevious</b>() : Boolean            <div class="mdesc">
389
                        <div class="short">Returns true if there is a previous record to select</div>
390
            <div class="long">
391
                Returns true if there is a previous record to select    <div class="mdetail-params">
392
        <strong>Parameters:</strong>
393
        <ul><li>None.</li>        </ul>
394
        <strong>Returns:</strong>
395
        <ul>
396
            <li><code>Boolean</code></li>
397
        </ul>
398
    </div>
399
                </div>
400
                        </div>
401
        </td>
402
        <td class="msource">RowSelectionModel</td>
403
    </tr>
404
        <tr class="method-row expandable">
405
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
406
        <td class="sig">
407
        <a id="Ext.grid.RowSelectionModel-hasSelection"></a>
408
            <b>hasSelection</b>() : Boolean            <div class="mdesc">
409
                        <div class="short">Returns True if there is a selection.</div>
410
            <div class="long">
411
                Returns True if there is a selection.    <div class="mdetail-params">
412
        <strong>Parameters:</strong>
413
        <ul><li>None.</li>        </ul>
414
        <strong>Returns:</strong>
415
        <ul>
416
            <li><code>Boolean</code></li>
417
        </ul>
418
    </div>
419
                </div>
420
                        </div>
421
        </td>
422
        <td class="msource">RowSelectionModel</td>
423
    </tr>
424
        <tr class="method-row alt expandable">
425
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
426
        <td class="sig">
427
        <a id="Ext.grid.RowSelectionModel-isIdSelected"></a>
428
            <b>isIdSelected</b>(&nbsp;<code>String id</code>&nbsp;) : Boolean            <div class="mdesc">
429
                        <div class="short">Returns True if the specified record id is selected.</div>
430
            <div class="long">
431
                Returns True if the specified record id is selected.    <div class="mdetail-params">
432
        <strong>Parameters:</strong>
433
        <ul><li><code>id</code> : String<div class="sub-desc">The id of record to check</div></li>        </ul>
434
        <strong>Returns:</strong>
435
        <ul>
436
            <li><code>Boolean</code></li>
437
        </ul>
438
    </div>
439
                </div>
440
                        </div>
441
        </td>
442
        <td class="msource">RowSelectionModel</td>
443
    </tr>
444
        <tr class="method-row inherited expandable">
445
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
446
        <td class="sig">
447
        <a id="Ext.grid.RowSelectionModel-isLocked"></a>
448
            <b>isLocked</b>() : Boolean            <div class="mdesc">
449
                        <div class="short">Returns true if the selections are locked.</div>
450
            <div class="long">
451
                Returns true if the selections are locked.    <div class="mdetail-params">
452
        <strong>Parameters:</strong>
453
        <ul><li>None.</li>        </ul>
454
        <strong>Returns:</strong>
455
        <ul>
456
            <li><code>Boolean</code></li>
457
        </ul>
458
    </div>
459
                </div>
460
                        </div>
461
        </td>
462
        <td class="msource"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="#isLocked" href="output/Ext.grid.AbstractSelectionModel.html#isLocked">AbstractSelectionModel</a></td>
463
    </tr>
464
        <tr class="method-row alt expandable">
465
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
466
        <td class="sig">
467
        <a id="Ext.grid.RowSelectionModel-isSelected"></a>
468
            <b>isSelected</b>(&nbsp;<code>Number/Record record</code>&nbsp;) : Boolean            <div class="mdesc">
469
                        <div class="short">Returns True if the specified row is selected.</div>
470
            <div class="long">
471
                Returns True if the specified row is selected.    <div class="mdetail-params">
472
        <strong>Parameters:</strong>
473
        <ul><li><code>record</code> : Number/Record<div class="sub-desc">The record or index of the record to check</div></li>        </ul>
474
        <strong>Returns:</strong>
475
        <ul>
476
            <li><code>Boolean</code></li>
477
        </ul>
478
    </div>
479
                </div>
480
                        </div>
481
        </td>
482
        <td class="msource">RowSelectionModel</td>
483
    </tr>
484
        <tr class="method-row inherited expandable">
485
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
486
        <td class="sig">
487
        <a id="Ext.grid.RowSelectionModel-lock"></a>
488
            <b>lock</b>() : void            <div class="mdesc">
489
                        <div class="short">Locks the selections.</div>
490
            <div class="long">
491
                Locks the selections.    <div class="mdetail-params">
492
        <strong>Parameters:</strong>
493
        <ul><li>None.</li>        </ul>
494
        <strong>Returns:</strong>
495
        <ul>
496
            <li><code>void</code></li>
497
        </ul>
498
    </div>
499
                </div>
500
                        </div>
501
        </td>
502
        <td class="msource"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="#lock" href="output/Ext.grid.AbstractSelectionModel.html#lock">AbstractSelectionModel</a></td>
503
    </tr>
504
        <tr class="method-row inherited alt expandable">
505
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
506
        <td class="sig">
507
        <a id="Ext.grid.RowSelectionModel-on"></a>
508
            <b>on</b>(&nbsp;<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>&nbsp;) : void            <div class="mdesc">
509
                        <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
510
            <div class="long">
511
                Appends an event handler to this element (shorthand for addListener)    <div class="mdetail-params">
512
        <strong>Parameters:</strong>
513
        <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
514
function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li>        </ul>
515
        <strong>Returns:</strong>
516
        <ul>
517
            <li><code>void</code></li>
518
        </ul>
519
    </div>
520
                </div>
521
                        </div>
522
        </td>
523
        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
524
    </tr>
525
        <tr class="method-row inherited expandable">
526
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
527
        <td class="sig">
528
        <a id="Ext.grid.RowSelectionModel-purgeListeners"></a>
529
            <b>purgeListeners</b>() : void            <div class="mdesc">
530
                        <div class="short">Removes all listeners for this object</div>
531
            <div class="long">
532
                Removes all listeners for this object    <div class="mdetail-params">
533
        <strong>Parameters:</strong>
534
        <ul><li>None.</li>        </ul>
535
        <strong>Returns:</strong>
536
        <ul>
537
            <li><code>void</code></li>
538
        </ul>
539
    </div>
540
                </div>
541
                        </div>
542
        </td>
543
        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
544
    </tr>
545
        <tr class="method-row inherited alt expandable">
546
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
547
        <td class="sig">
548
        <a id="Ext.grid.RowSelectionModel-removeListener"></a>
549
            <b>removeListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">
550
                        <div class="short">Removes a listener</div>
551
            <div class="long">
552
                Removes a listener    <div class="mdetail-params">
553
        <strong>Parameters:</strong>
554
        <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>
555
        <strong>Returns:</strong>
556
        <ul>
557
            <li><code>void</code></li>
558
        </ul>
559
    </div>
560
                </div>
561
                        </div>
562
        </td>
563
        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
564
    </tr>
565
        <tr class="method-row inherited expandable">
566
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
567
        <td class="sig">
568
        <a id="Ext.grid.RowSelectionModel-resumeEvents"></a>
569
            <b>resumeEvents</b>() : void            <div class="mdesc">
570
                        <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>
571
            <div class="long">
572
                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">
573
        <strong>Parameters:</strong>
574
        <ul><li>None.</li>        </ul>
575
        <strong>Returns:</strong>
576
        <ul>
577
            <li><code>void</code></li>
578
        </ul>
579
    </div>
580
                </div>
581
                        </div>
582
        </td>
583
        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
584
    </tr>
585
        <tr class="method-row alt expandable">
586
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
587
        <td class="sig">
588
        <a id="Ext.grid.RowSelectionModel-selectAll"></a>
589
            <b>selectAll</b>() : void            <div class="mdesc">
590
                        <div class="short">Selects all rows.</div>
591
            <div class="long">
592
                Selects all rows.    <div class="mdetail-params">
593
        <strong>Parameters:</strong>
594
        <ul><li>None.</li>        </ul>
595
        <strong>Returns:</strong>
596
        <ul>
597
            <li><code>void</code></li>
598
        </ul>
599
    </div>
600
                </div>
601
                        </div>
602
        </td>
603
        <td class="msource">RowSelectionModel</td>
604
    </tr>
605
        <tr class="method-row expandable">
606
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
607
        <td class="sig">
608
        <a id="Ext.grid.RowSelectionModel-selectFirstRow"></a>
609
            <b>selectFirstRow</b>() : void            <div class="mdesc">
610
                        <div class="short">Selects the first row in the grid.</div>
611
            <div class="long">
612
                Selects the first row in the grid.    <div class="mdetail-params">
613
        <strong>Parameters:</strong>
614
        <ul><li>None.</li>        </ul>
615
        <strong>Returns:</strong>
616
        <ul>
617
            <li><code>void</code></li>
618
        </ul>
619
    </div>
620
                </div>
621
                        </div>
622
        </td>
623
        <td class="msource">RowSelectionModel</td>
624
    </tr>
625
        <tr class="method-row alt expandable">
626
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
627
        <td class="sig">
628
        <a id="Ext.grid.RowSelectionModel-selectLastRow"></a>
629
            <b>selectLastRow</b>(&nbsp;<span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span>&nbsp;) : void            <div class="mdesc">
630
                        <div class="short">Select the last row.</div>
631
            <div class="long">
632
                Select the last row.    <div class="mdetail-params">
633
        <strong>Parameters:</strong>
634
        <ul><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to keep existing selections</div></li>        </ul>
635
        <strong>Returns:</strong>
636
        <ul>
637
            <li><code>void</code></li>
638
        </ul>
639
    </div>
640
                </div>
641
                        </div>
642
        </td>
643
        <td class="msource">RowSelectionModel</td>
644
    </tr>
645
        <tr class="method-row expandable">
646
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
647
        <td class="sig">
648
        <a id="Ext.grid.RowSelectionModel-selectNext"></a>
649
            <b>selectNext</b>(&nbsp;<span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span>&nbsp;) : Boolean            <div class="mdesc">
650
                        <div class="short">Selects the row immediately following the last selected row.</div>
651
            <div class="long">
652
                Selects the row immediately following the last selected row.    <div class="mdetail-params">
653
        <strong>Parameters:</strong>
654
        <ul><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to keep existing selections</div></li>        </ul>
655
        <strong>Returns:</strong>
656
        <ul>
657
            <li><code>Boolean</code><div class="sub-desc">True if there is a next row, else false</div></li>
658
        </ul>
659
    </div>
660
                </div>
661
                        </div>
662
        </td>
663
        <td class="msource">RowSelectionModel</td>
664
    </tr>
665
        <tr class="method-row alt expandable">
666
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
667
        <td class="sig">
668
        <a id="Ext.grid.RowSelectionModel-selectPrevious"></a>
669
            <b>selectPrevious</b>(&nbsp;<span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span>&nbsp;) : Boolean            <div class="mdesc">
670
                        <div class="short">Selects the row that precedes the last selected row.</div>
671
            <div class="long">
672
                Selects the row that precedes the last selected row.    <div class="mdetail-params">
673
        <strong>Parameters:</strong>
674
        <ul><li><code>keepExisting</code> : Boolean<div class="sub-desc">(optional) True to keep existing selections</div></li>        </ul>
675
        <strong>Returns:</strong>
676
        <ul>
677
            <li><code>Boolean</code><div class="sub-desc">True if there is a previous row, else false</div></li>
678
        </ul>
679
    </div>
680
                </div>
681
                        </div>
682
        </td>
683
        <td class="msource">RowSelectionModel</td>
684
    </tr>
685
        <tr class="method-row expandable">
686
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
687
        <td class="sig">
688
        <a id="Ext.grid.RowSelectionModel-selectRange"></a>
689
            <b>selectRange</b>(&nbsp;<code>Number startRow</code>, <code>Number endRow</code>, <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span>&nbsp;) : void            <div class="mdesc">
690
                        <div class="short">Selects a range of rows. All rows in between startRow and endRow are also selected.</div>
691
            <div class="long">
692
                Selects a range of rows. All rows in between startRow and endRow are also selected.    <div class="mdetail-params">
693
        <strong>Parameters:</strong>
694
        <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>
695
        <strong>Returns:</strong>
696
        <ul>
697
            <li><code>void</code></li>
698
        </ul>
699
    </div>
700
                </div>
701
                        </div>
702
        </td>
703
        <td class="msource">RowSelectionModel</td>
704
    </tr>
705
        <tr class="method-row alt expandable">
706
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
707
        <td class="sig">
708
        <a id="Ext.grid.RowSelectionModel-selectRecords"></a>
709
            <b>selectRecords</b>(&nbsp;<code>Array records</code>, <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span>&nbsp;) : void            <div class="mdesc">
710
                        <div class="short">Select records.</div>
711
            <div class="long">
712
                Select records.    <div class="mdetail-params">
713
        <strong>Parameters:</strong>
714
        <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>
715
        <strong>Returns:</strong>
716
        <ul>
717
            <li><code>void</code></li>
718
        </ul>
719
    </div>
720
                </div>
721
                        </div>
722
        </td>
723
        <td class="msource">RowSelectionModel</td>
724
    </tr>
725
        <tr class="method-row expandable">
726
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
727
        <td class="sig">
728
        <a id="Ext.grid.RowSelectionModel-selectRow"></a>
729
            <b>selectRow</b>(&nbsp;<code>Number row</code>, <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span>&nbsp;) : void            <div class="mdesc">
730
                        <div class="short">Selects a row.</div>
731
            <div class="long">
732
                Selects a row.    <div class="mdetail-params">
733
        <strong>Parameters:</strong>
734
        <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>
735
        <strong>Returns:</strong>
736
        <ul>
737
            <li><code>void</code></li>
738
        </ul>
739
    </div>
740
                </div>
741
                        </div>
742
        </td>
743
        <td class="msource">RowSelectionModel</td>
744
    </tr>
745
        <tr class="method-row alt expandable">
746
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
747
        <td class="sig">
748
        <a id="Ext.grid.RowSelectionModel-selectRows"></a>
749
            <b>selectRows</b>(&nbsp;<code>Array rows</code>, <span class="optional" title="Optional">[<code>Boolean keepExisting</code>]</span>&nbsp;) : void            <div class="mdesc">
750
                        <div class="short">Selects multiple rows.</div>
751
            <div class="long">
752
                Selects multiple rows.    <div class="mdetail-params">
753
        <strong>Parameters:</strong>
754
        <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>
755
        <strong>Returns:</strong>
756
        <ul>
757
            <li><code>void</code></li>
758
        </ul>
759
    </div>
760
                </div>
761
                        </div>
762
        </td>
763
        <td class="msource">RowSelectionModel</td>
764
    </tr>
765
        <tr class="method-row inherited expandable">
766
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
767
        <td class="sig">
768
        <a id="Ext.grid.RowSelectionModel-suspendEvents"></a>
769
            <b>suspendEvents</b>() : void            <div class="mdesc">
770
                        <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>
771
            <div class="long">
772
                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">
773
        <strong>Parameters:</strong>
774
        <ul><li>None.</li>        </ul>
775
        <strong>Returns:</strong>
776
        <ul>
777
            <li><code>void</code></li>
778
        </ul>
779
    </div>
780
                </div>
781
                        </div>
782
        </td>
783
        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
784
    </tr>
785
        <tr class="method-row inherited alt expandable">
786
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
787
        <td class="sig">
788
        <a id="Ext.grid.RowSelectionModel-un"></a>
789
            <b>un</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">
790
                        <div class="short">Removes a listener (shorthand for removeListener)</div>
791
            <div class="long">
792
                Removes a listener (shorthand for removeListener)    <div class="mdetail-params">
793
        <strong>Parameters:</strong>
794
        <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>
795
        <strong>Returns:</strong>
796
        <ul>
797
            <li><code>void</code></li>
798
        </ul>
799
    </div>
800
                </div>
801
                        </div>
802
        </td>
803
        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
804
    </tr>
805
        <tr class="method-row inherited expandable">
806
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
807
        <td class="sig">
808
        <a id="Ext.grid.RowSelectionModel-unlock"></a>
809
            <b>unlock</b>() : void            <div class="mdesc">
810
                        <div class="short">Unlocks the selections.</div>
811
            <div class="long">
812
                Unlocks the selections.    <div class="mdetail-params">
813
        <strong>Parameters:</strong>
814
        <ul><li>None.</li>        </ul>
815
        <strong>Returns:</strong>
816
        <ul>
817
            <li><code>void</code></li>
818
        </ul>
819
    </div>
820
                </div>
821
                        </div>
822
        </td>
823
        <td class="msource"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="#unlock" href="output/Ext.grid.AbstractSelectionModel.html#unlock">AbstractSelectionModel</a></td>
824
    </tr>
825
            </table>
826
                <a id="Ext.grid.RowSelectionModel-events"></a>
827
        <h2>Public Events</h2>
828
                <table cellspacing="0" class="member-table">
829
            <tr>
830
                <th class="sig-header" colspan="2">Event</th>
831
                <th class="msource-header">Defined By</th>
832
            </tr>
833
                <tr class="event-row expandable">
834
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
835
        <td class="sig">
836
        <a id="Ext.grid.RowSelectionModel-beforerowselect"></a>
837
            <b>beforerowselect</b> : (&nbsp;<code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Boolean keepExisting</code>, <code>Record record</code>&nbsp;)            <div class="mdesc">
838
                        <div class="short">Fires when a row is being selected, return false to cancel.</div>
839
            <div class="long">
840
                Fires when a row is being selected, return false to cancel.    <div class="mdetail-params">
841
        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
842
        <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>
843
    </div>
844
                </div>
845
                        </div>
846
        </td>
847
        <td class="msource">RowSelectionModel</td>
848
    </tr>
849
        <tr class="event-row alt expandable">
850
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
851
        <td class="sig">
852
        <a id="Ext.grid.RowSelectionModel-rowdeselect"></a>
853
            <b>rowdeselect</b> : (&nbsp;<code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Record record</code>&nbsp;)            <div class="mdesc">
854
                        <div class="short">Fires when a row is deselected.</div>
855
            <div class="long">
856
                Fires when a row is deselected.    <div class="mdetail-params">
857
        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
858
        <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>
859
    </div>
860
                </div>
861
                        </div>
862
        </td>
863
        <td class="msource">RowSelectionModel</td>
864
    </tr>
865
        <tr class="event-row expandable">
866
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
867
        <td class="sig">
868
        <a id="Ext.grid.RowSelectionModel-rowselect"></a>
869
            <b>rowselect</b> : (&nbsp;<code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Ext.data.Record r</code>&nbsp;)            <div class="mdesc">
870
                        <div class="short">Fires when a row is selected.</div>
871
            <div class="long">
872
                Fires when a row is selected.    <div class="mdetail-params">
873
        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
874
        <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>
875
    </div>
876
                </div>
877
                        </div>
878
        </td>
879
        <td class="msource">RowSelectionModel</td>
880
    </tr>
881
        <tr class="event-row alt expandable">
882
        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
883
        <td class="sig">
884
        <a id="Ext.grid.RowSelectionModel-selectionchange"></a>
885
            <b>selectionchange</b> : (&nbsp;<code>SelectionModel this</code>&nbsp;)            <div class="mdesc">
886
                        <div class="short">Fires when the selection changes</div>
887
            <div class="long">
888
                Fires when the selection changes    <div class="mdetail-params">
889
        <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
890
        <ul><li><code>this</code> : SelectionModel<div class="sub-desc"></div></li>        </ul>
891
    </div>
892
                </div>
893
                        </div>
894
        </td>
895
        <td class="msource">RowSelectionModel</td>
896
    </tr>
897
            </table>
898
 
899
        </div>