commit extjs-2.2.1
[extjs.git] / docs / output / Ext.grid.CellSelectionModel.html
1         <div class="body-wrap">
2         <div class="top-tools">
3             <a class="inner-link" href="#Ext.grid.CellSelectionModel-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4             <a class="inner-link" href="#Ext.grid.CellSelectionModel-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5             <a class="inner-link" href="#Ext.grid.CellSelectionModel-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                             <a class="inner-link" href="#Ext.grid.CellSelectionModel-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.CellSelectionModel"><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"/>CellSelectionModel</pre></div>
13                 <h1>Class Ext.grid.CellSelectionModel</h1>
14         <table cellspacing="0">
15             <tr><td class="label">Package:</td><td class="hd-info">Ext.grid</td></tr>
16             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/CellSelectionModel.js" target="_blank">CellSelectionModel.js</a></td></tr>
17             <tr><td class="label">Class:</td><td class="hd-info">CellSelectionModel</td></tr>
18                                     <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>
19                     </table>
20         <div class="description">
21             *
22 This class provides the basic implementation for single cell selection in a grid. The object stored
23 as the selection and returned by <a ext:cls="getSelectedCell" href="output/getSelectedCell.html">getSelectedCell</a> contains the following properties:
24 <div class="mdetail-params"><ul>
25 <li><b>record</b> : Ext.data.record<p class="sub-desc">The <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Record</a>
26 which provides the data for the row containing the selection</p></li>
27 <li><b>cell</b> : Ext.data.record<p class="sub-desc">An object containing the
28 following properties:
29 <div class="mdetail-params"><ul>
30 <li><b>rowIndex</b> : Number<p class="sub-desc">The index of the selected row</p></li>
31 <li><b>cellIndex</b> : Number<p class="sub-desc">The index of the selected cell<br>
32 <b>Note that due to possible column reordering, the cellIndex should not be used as an index into
33 the Record's data. Instead, the <i>name</i> of the selected field should be determined
34 in order to retrieve the data value from the record by name:</b><pre><code>var fieldName = grid.getColumnModel().getDataIndex(cellIndex);
35     <b>var</b> data = record.get(fieldName);</code></pre></p></li>
36 </ul></div></p></li>
37 </ul></div>        </div>
38         
39         <div class="hr"></div>
40                 <a id="Ext.grid.CellSelectionModel-configs"></a>
41         <h2>Config Options</h2>
42         <table cellspacing="0" class="member-table">
43             <tr>
44                 <th class="sig-header" colspan="2">Config Options</th>
45                 <th class="msource-header">Defined By</th>
46             </tr>
47                 <tr class="config-row inherited expandable">\r
48         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
49         <td class="sig">\r
50         <a id="Ext.grid.CellSelectionModel-listeners"></a>\r
51             <b>listeners</b> : Object            <div class="mdesc">\r
52                         <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>\r
53             <div class="long">\r
54                 (optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once.            </div>\r
55                         </div>\r
56         </td>\r
57         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>\r
58     </tr>\r
59             </table>
60                 <a id="Ext.grid.CellSelectionModel-props"></a>
61         <h2>Public Properties</h2>
62         <div class="no-members">This class has no public properties.</div>        <a id="Ext.grid.CellSelectionModel-methods"></a>
63         <h2>Public Methods</h2>
64                 <table cellspacing="0" class="member-table">
65             <tr>
66                 <th class="sig-header" colspan="2">Method</th>
67                 <th class="msource-header">Defined By</th>
68             </tr>
69                 <tr class="method-row expandable">\r
70         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
71         <td class="sig">\r
72         <a id="Ext.grid.CellSelectionModel-CellSelectionModel"></a>\r
73             <b>CellSelectionModel</b>(&nbsp;<code>Object config</code>&nbsp;)            <div class="mdesc">\r
74                         <div class="short"></div>\r
75             <div class="long">\r
76                     <div class="mdetail-params">\r
77         <strong>Parameters:</strong>\r
78         <ul><li><code>config</code> : Object<div class="sub-desc">The object containing the configuration of this model.</div></li>        </ul>\r
79         <strong>Returns:</strong>\r
80         <ul>\r
81             <li><code></code></li>\r
82         </ul>\r
83     </div>\r
84                 </div>\r
85                         </div>\r
86         </td>\r
87         <td class="msource">CellSelectionModel</td>\r
88     </tr>\r
89         <tr class="method-row inherited alt expandable">\r
90         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
91         <td class="sig">\r
92         <a id="Ext.grid.CellSelectionModel-addEvents"></a>\r
93             <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void            <div class="mdesc">\r
94                         <div class="short">Used to define events on this Observable</div>\r
95             <div class="long">\r
96                 Used to define events on this Observable    <div class="mdetail-params">\r
97         <strong>Parameters:</strong>\r
98         <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li>        </ul>\r
99         <strong>Returns:</strong>\r
100         <ul>\r
101             <li><code>void</code></li>\r
102         </ul>\r
103     </div>\r
104                 </div>\r
105                         </div>\r
106         </td>\r
107         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>\r
108     </tr>\r
109         <tr class="method-row inherited expandable">\r
110         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
111         <td class="sig">\r
112         <a id="Ext.grid.CellSelectionModel-addListener"></a>\r
113             <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">\r
114                         <div class="short">Appends an event handler to this component</div>\r
115             <div class="long">\r
116                 Appends an event handler to this component    <div class="mdetail-params">\r
117         <strong>Parameters:</strong>\r
118         <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
119 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
120 properties. This may contain any of the following properties:<ul>
121 <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>
122 <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>
123 <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>
124 <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
125 by the specified number of milliseconds. If the event fires again within that time, the original
126 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
127 </ul><br>
128 <p>
129 <b>Combining Options</b><br>
130 Using the options argument, it is possible to combine different types of listeners:<br>
131 <br>
132 A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
133 <pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
134     single: true,
135     delay: 100,
136     forumId: 4
137 });</code></pre>
138 <p>
139 <b>Attaching multiple handlers in 1 call</b><br>
140 The method also allows for a single argument to be passed which is a config object containing properties
141 which specify multiple handlers.
142 <p>
143 <pre><code>foo.on({
144     <em>'click'</em> : {
145         fn: <b>this</b>.onClick,
146         scope: <b>this</b>,
147         delay: 100
148     },
149     <em>'mouseover'</em> : {
150         fn: <b>this</b>.onMouseOver,
151         scope: <b>this</b>
152     },
153     <em>'mouseout'</em> : {
154         fn: <b>this</b>.onMouseOut,
155         scope: <b>this</b>
156     }
157 });</code></pre>
158 <p>
159 Or a shorthand syntax:<br>
160 <pre><code>foo.on({
161     <em>'click'</em> : <b>this</b>.onClick,
162     <em>'mouseover'</em> : <b>this</b>.onMouseOver,
163     <em>'mouseout'</em> : <b>this</b>.onMouseOut,
164      scope: <b>this</b>
165 });</code></pre></div></li>        </ul>\r
166         <strong>Returns:</strong>\r
167         <ul>\r
168             <li><code>void</code></li>\r
169         </ul>\r
170     </div>\r
171                 </div>\r
172                         </div>\r
173         </td>\r
174         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>\r
175     </tr>\r
176         <tr class="method-row alt expandable">\r
177         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
178         <td class="sig">\r
179         <a id="Ext.grid.CellSelectionModel-clearSelections"></a>\r
180             <b>clearSelections</b>(&nbsp;<code>Boolean true</code>&nbsp;) : void            <div class="mdesc">\r
181                         <div class="short">Clears all selections.</div>\r
182             <div class="long">\r
183                 Clears all selections.    <div class="mdetail-params">\r
184         <strong>Parameters:</strong>\r
185         <ul><li><code>true</code> : Boolean<div class="sub-desc">to prevent the gridview from being notified about the change.</div></li>        </ul>\r
186         <strong>Returns:</strong>\r
187         <ul>\r
188             <li><code>void</code></li>\r
189         </ul>\r
190     </div>\r
191                 </div>\r
192                         </div>\r
193         </td>\r
194         <td class="msource">CellSelectionModel</td>\r
195     </tr>\r
196         <tr class="method-row inherited expandable">\r
197         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
198         <td class="sig">\r
199         <a id="Ext.grid.CellSelectionModel-fireEvent"></a>\r
200             <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean            <div class="mdesc">\r
201                         <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>\r
202             <div class="long">\r
203                 Fires the specified event with the passed parameters (minus the event name).    <div class="mdetail-params">\r
204         <strong>Parameters:</strong>\r
205         <ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li>        </ul>\r
206         <strong>Returns:</strong>\r
207         <ul>\r
208             <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>\r
209         </ul>\r
210     </div>\r
211                 </div>\r
212                         </div>\r
213         </td>\r
214         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>\r
215     </tr>\r
216         <tr class="method-row alt expandable">\r
217         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
218         <td class="sig">\r
219         <a id="Ext.grid.CellSelectionModel-getSelectedCell"></a>\r
220             <b>getSelectedCell</b>() : Array            <div class="mdesc">\r
221                         <div class="short">Returns the currently selected cell's row and column indexes as an array (e.g., [0, 0]).</div>\r
222             <div class="long">\r
223                 Returns the currently selected cell's row and column indexes as an array (e.g., [0, 0]).    <div class="mdetail-params">\r
224         <strong>Parameters:</strong>\r
225         <ul><li>None.</li>        </ul>\r
226         <strong>Returns:</strong>\r
227         <ul>\r
228             <li><code>Array</code><div class="sub-desc">An array containing the row and column indexes of the selected cell, or null if none selected.</div></li>\r
229         </ul>\r
230     </div>\r
231                 </div>\r
232                         </div>\r
233         </td>\r
234         <td class="msource">CellSelectionModel</td>\r
235     </tr>\r
236         <tr class="method-row inherited expandable">\r
237         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
238         <td class="sig">\r
239         <a id="Ext.grid.CellSelectionModel-hasListener"></a>\r
240             <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean            <div class="mdesc">\r
241                         <div class="short">Checks to see if this object has any listeners for a specified event</div>\r
242             <div class="long">\r
243                 Checks to see if this object has any listeners for a specified event    <div class="mdetail-params">\r
244         <strong>Parameters:</strong>\r
245         <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li>        </ul>\r
246         <strong>Returns:</strong>\r
247         <ul>\r
248             <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>\r
249         </ul>\r
250     </div>\r
251                 </div>\r
252                         </div>\r
253         </td>\r
254         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>\r
255     </tr>\r
256         <tr class="method-row alt expandable">\r
257         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
258         <td class="sig">\r
259         <a id="Ext.grid.CellSelectionModel-hasSelection"></a>\r
260             <b>hasSelection</b>() : Boolean            <div class="mdesc">\r
261                         <div class="short">Returns true if there is a selection.</div>\r
262             <div class="long">\r
263                 Returns true if there is a selection.    <div class="mdetail-params">\r
264         <strong>Parameters:</strong>\r
265         <ul><li>None.</li>        </ul>\r
266         <strong>Returns:</strong>\r
267         <ul>\r
268             <li><code>Boolean</code></li>\r
269         </ul>\r
270     </div>\r
271                 </div>\r
272                         </div>\r
273         </td>\r
274         <td class="msource">CellSelectionModel</td>\r
275     </tr>\r
276         <tr class="method-row inherited expandable">\r
277         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
278         <td class="sig">\r
279         <a id="Ext.grid.CellSelectionModel-isLocked"></a>\r
280             <b>isLocked</b>() : Boolean            <div class="mdesc">\r
281                         <div class="short">Returns true if the selections are locked.</div>\r
282             <div class="long">\r
283                 Returns true if the selections are locked.    <div class="mdetail-params">\r
284         <strong>Parameters:</strong>\r
285         <ul><li>None.</li>        </ul>\r
286         <strong>Returns:</strong>\r
287         <ul>\r
288             <li><code>Boolean</code></li>\r
289         </ul>\r
290     </div>\r
291                 </div>\r
292                         </div>\r
293         </td>\r
294         <td class="msource"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="#isLocked" href="output/Ext.grid.AbstractSelectionModel.html#isLocked">AbstractSelectionModel</a></td>\r
295     </tr>\r
296         <tr class="method-row inherited alt expandable">\r
297         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
298         <td class="sig">\r
299         <a id="Ext.grid.CellSelectionModel-lock"></a>\r
300             <b>lock</b>() : void            <div class="mdesc">\r
301                         <div class="short">Locks the selections.</div>\r
302             <div class="long">\r
303                 Locks the selections.    <div class="mdetail-params">\r
304         <strong>Parameters:</strong>\r
305         <ul><li>None.</li>        </ul>\r
306         <strong>Returns:</strong>\r
307         <ul>\r
308             <li><code>void</code></li>\r
309         </ul>\r
310     </div>\r
311                 </div>\r
312                         </div>\r
313         </td>\r
314         <td class="msource"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="#lock" href="output/Ext.grid.AbstractSelectionModel.html#lock">AbstractSelectionModel</a></td>\r
315     </tr>\r
316         <tr class="method-row inherited expandable">\r
317         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
318         <td class="sig">\r
319         <a id="Ext.grid.CellSelectionModel-on"></a>\r
320             <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">\r
321                         <div class="short">Appends an event handler to this element (shorthand for addListener)</div>\r
322             <div class="long">\r
323                 Appends an event handler to this element (shorthand for addListener)    <div class="mdetail-params">\r
324         <strong>Parameters:</strong>\r
325         <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
326 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li>        </ul>\r
327         <strong>Returns:</strong>\r
328         <ul>\r
329             <li><code>void</code></li>\r
330         </ul>\r
331     </div>\r
332                 </div>\r
333                         </div>\r
334         </td>\r
335         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>\r
336     </tr>\r
337         <tr class="method-row inherited alt expandable">\r
338         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
339         <td class="sig">\r
340         <a id="Ext.grid.CellSelectionModel-purgeListeners"></a>\r
341             <b>purgeListeners</b>() : void            <div class="mdesc">\r
342                         <div class="short">Removes all listeners for this object</div>\r
343             <div class="long">\r
344                 Removes all listeners for this object    <div class="mdetail-params">\r
345         <strong>Parameters:</strong>\r
346         <ul><li>None.</li>        </ul>\r
347         <strong>Returns:</strong>\r
348         <ul>\r
349             <li><code>void</code></li>\r
350         </ul>\r
351     </div>\r
352                 </div>\r
353                         </div>\r
354         </td>\r
355         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>\r
356     </tr>\r
357         <tr class="method-row inherited expandable">\r
358         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
359         <td class="sig">\r
360         <a id="Ext.grid.CellSelectionModel-relayEvents"></a>\r
361             <b>relayEvents</b>(&nbsp;<code>Object o</code>, <code>Array events</code>&nbsp;) : void            <div class="mdesc">\r
362                         <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>\r
363             <div class="long">\r
364                 Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.    <div class="mdetail-params">\r
365         <strong>Parameters:</strong>\r
366         <ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li>        </ul>\r
367         <strong>Returns:</strong>\r
368         <ul>\r
369             <li><code>void</code></li>\r
370         </ul>\r
371     </div>\r
372                 </div>\r
373                         </div>\r
374         </td>\r
375         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>\r
376     </tr>\r
377         <tr class="method-row inherited alt expandable">\r
378         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
379         <td class="sig">\r
380         <a id="Ext.grid.CellSelectionModel-removeListener"></a>\r
381             <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">\r
382                         <div class="short">Removes a listener</div>\r
383             <div class="long">\r
384                 Removes a listener    <div class="mdetail-params">\r
385         <strong>Parameters:</strong>\r
386         <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>\r
387         <strong>Returns:</strong>\r
388         <ul>\r
389             <li><code>void</code></li>\r
390         </ul>\r
391     </div>\r
392                 </div>\r
393                         </div>\r
394         </td>\r
395         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>\r
396     </tr>\r
397         <tr class="method-row inherited expandable">\r
398         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
399         <td class="sig">\r
400         <a id="Ext.grid.CellSelectionModel-resumeEvents"></a>\r
401             <b>resumeEvents</b>() : void            <div class="mdesc">\r
402                         <div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>\r
403             <div class="long">\r
404                 Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)    <div class="mdetail-params">\r
405         <strong>Parameters:</strong>\r
406         <ul><li>None.</li>        </ul>\r
407         <strong>Returns:</strong>\r
408         <ul>\r
409             <li><code>void</code></li>\r
410         </ul>\r
411     </div>\r
412                 </div>\r
413                         </div>\r
414         </td>\r
415         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>\r
416     </tr>\r
417         <tr class="method-row alt expandable">\r
418         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
419         <td class="sig">\r
420         <a id="Ext.grid.CellSelectionModel-select"></a>\r
421             <b>select</b>(&nbsp;<code>Number rowIndex</code>, <code>Number collIndex</code>&nbsp;) : void            <div class="mdesc">\r
422                         <div class="short">Selects a cell.</div>\r
423             <div class="long">\r
424                 Selects a cell.    <div class="mdetail-params">\r
425         <strong>Parameters:</strong>\r
426         <ul><li><code>rowIndex</code> : Number<div class="sub-desc"></div></li><li><code>collIndex</code> : Number<div class="sub-desc"></div></li>        </ul>\r
427         <strong>Returns:</strong>\r
428         <ul>\r
429             <li><code>void</code></li>\r
430         </ul>\r
431     </div>\r
432                 </div>\r
433                         </div>\r
434         </td>\r
435         <td class="msource">CellSelectionModel</td>\r
436     </tr>\r
437         <tr class="method-row inherited expandable">\r
438         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
439         <td class="sig">\r
440         <a id="Ext.grid.CellSelectionModel-suspendEvents"></a>\r
441             <b>suspendEvents</b>() : void            <div class="mdesc">\r
442                         <div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>\r
443             <div class="long">\r
444                 Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)    <div class="mdetail-params">\r
445         <strong>Parameters:</strong>\r
446         <ul><li>None.</li>        </ul>\r
447         <strong>Returns:</strong>\r
448         <ul>\r
449             <li><code>void</code></li>\r
450         </ul>\r
451     </div>\r
452                 </div>\r
453                         </div>\r
454         </td>\r
455         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>\r
456     </tr>\r
457         <tr class="method-row inherited alt expandable">\r
458         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
459         <td class="sig">\r
460         <a id="Ext.grid.CellSelectionModel-un"></a>\r
461             <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">\r
462                         <div class="short">Removes a listener (shorthand for removeListener)</div>\r
463             <div class="long">\r
464                 Removes a listener (shorthand for removeListener)    <div class="mdetail-params">\r
465         <strong>Parameters:</strong>\r
466         <ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>\r
467         <strong>Returns:</strong>\r
468         <ul>\r
469             <li><code>void</code></li>\r
470         </ul>\r
471     </div>\r
472                 </div>\r
473                         </div>\r
474         </td>\r
475         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>\r
476     </tr>\r
477         <tr class="method-row inherited expandable">\r
478         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
479         <td class="sig">\r
480         <a id="Ext.grid.CellSelectionModel-unlock"></a>\r
481             <b>unlock</b>() : void            <div class="mdesc">\r
482                         <div class="short">Unlocks the selections.</div>\r
483             <div class="long">\r
484                 Unlocks the selections.    <div class="mdetail-params">\r
485         <strong>Parameters:</strong>\r
486         <ul><li>None.</li>        </ul>\r
487         <strong>Returns:</strong>\r
488         <ul>\r
489             <li><code>void</code></li>\r
490         </ul>\r
491     </div>\r
492                 </div>\r
493                         </div>\r
494         </td>\r
495         <td class="msource"><a ext:cls="Ext.grid.AbstractSelectionModel" ext:member="#unlock" href="output/Ext.grid.AbstractSelectionModel.html#unlock">AbstractSelectionModel</a></td>\r
496     </tr>\r
497             </table>
498                 <a id="Ext.grid.CellSelectionModel-events"></a>
499         <h2>Public Events</h2>
500                 <table cellspacing="0" class="member-table">
501             <tr>
502                 <th class="sig-header" colspan="2">Event</th>
503                 <th class="msource-header">Defined By</th>
504             </tr>
505                 <tr class="event-row expandable">\r
506         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
507         <td class="sig">\r
508         <a id="Ext.grid.CellSelectionModel-beforecellselect"></a>\r
509             <b>beforecellselect</b> : (&nbsp;<code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Number colIndex</code>&nbsp;)            <div class="mdesc">\r
510                         <div class="short">Fires before a cell is selected.</div>\r
511             <div class="long">\r
512                 Fires before a cell is selected.    <div class="mdetail-params">\r
513         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
514         <ul><li><code>this</code> : SelectionModel<div class="sub-desc"></div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The selected row index</div></li><li><code>colIndex</code> : Number<div class="sub-desc">The selected cell index</div></li>        </ul>\r
515     </div>\r
516                 </div>\r
517                         </div>\r
518         </td>\r
519         <td class="msource">CellSelectionModel</td>\r
520     </tr>\r
521         <tr class="event-row alt expandable">\r
522         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
523         <td class="sig">\r
524         <a id="Ext.grid.CellSelectionModel-cellselect"></a>\r
525             <b>cellselect</b> : (&nbsp;<code>SelectionModel this</code>, <code>Number rowIndex</code>, <code>Number colIndex</code>&nbsp;)            <div class="mdesc">\r
526                         <div class="short">Fires when a cell is selected.</div>\r
527             <div class="long">\r
528                 Fires when a cell is selected.    <div class="mdetail-params">\r
529         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
530         <ul><li><code>this</code> : SelectionModel<div class="sub-desc"></div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The selected row index</div></li><li><code>colIndex</code> : Number<div class="sub-desc">The selected cell index</div></li>        </ul>\r
531     </div>\r
532                 </div>\r
533                         </div>\r
534         </td>\r
535         <td class="msource">CellSelectionModel</td>\r
536     </tr>\r
537         <tr class="event-row expandable">\r
538         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
539         <td class="sig">\r
540         <a id="Ext.grid.CellSelectionModel-selectionchange"></a>\r
541             <b>selectionchange</b> : (&nbsp;<code>SelectionModel this</code>, <code>Object selection</code>&nbsp;)            <div class="mdesc">\r
542                         <div class="short">Fires when the active selection changes.</div>\r
543             <div class="long">\r
544                 Fires when the active selection changes.    <div class="mdetail-params">\r
545         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
546         <ul><li><code>this</code> : SelectionModel<div class="sub-desc"></div></li><li><code>selection</code> : Object<div class="sub-desc">null for no selection or an object (o) with two properties\r
547          <ul>\r
548          <li>o.record: the record object for the row the selection is in</li>\r
549          <li>o.cell: An array of [rowIndex, columnIndex]</li>\r
550          </ul></div></li>        </ul>\r
551     </div>\r
552                 </div>\r
553                         </div>\r
554         </td>\r
555         <td class="msource">CellSelectionModel</td>\r
556     </tr>\r
557             </table>
558         
559         </div>