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