source: trunk/web/addons/job_monarch/lib/extjs/docs/output/Ext.grid.AbstractSelectionModel.html @ 619

Last change on this file since 619 was 619, checked in by ramonb, 15 years ago

lib/:

  • added new AJAX dependancies: ExtJS, pChart, Lightbox2
File size: 23.5 KB
Line 
1        <div class="body-wrap">
2        <div class="top-tools">
3            <a class="inner-link" href="#Ext.grid.AbstractSelectionModel-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4            <a class="inner-link" href="#Ext.grid.AbstractSelectionModel-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5            <a class="inner-link" href="#Ext.grid.AbstractSelectionModel-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                            <a class="inner-link" href="#Ext.grid.AbstractSelectionModel-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.AbstractSelectionModel"><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"/>AbstractSelectionModel</pre></div>
12                <h1>Class Ext.grid.AbstractSelectionModel</h1>
13        <table cellspacing="0">
14            <tr><td class="label">Package:</td><td class="hd-info">Ext.grid</td></tr>
15            <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/AbstractSelectionModel.js" target="_blank">AbstractSelectionModel.js</a></td></tr>
16            <tr><td class="label">Class:</td><td class="hd-info">AbstractSelectionModel</td></tr>
17                        <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.grid.CellSelectionModel" href="output/Ext.grid.CellSelectionModel.html">CellSelectionModel</a>, <a ext:cls="Ext.grid.RowSelectionModel" href="output/Ext.grid.RowSelectionModel.html">RowSelectionModel</a></td></tr>
18                                    <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a></td></tr>
19                    </table>
20        <div class="description">
21            *
22Abstract base class for grid SelectionModels.  It provides the interface that should be
23implemented by descendant classes.  This class should not be directly instantiated.        </div>
24       
25        <div class="hr"></div>
26                <a id="Ext.grid.AbstractSelectionModel-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 inherited expandable">
34        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
35        <td class="sig">
36        <a id="Ext.grid.AbstractSelectionModel-listeners"></a>
37            <b>listeners</b> : Object            <div class="mdesc">
38                        <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>
39            <div class="long">
40                (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>
41                        </div>
42        </td>
43        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
44    </tr>
45            </table>
46                <a id="Ext.grid.AbstractSelectionModel-props"></a>
47        <h2>Public Properties</h2>
48        <div class="no-members">This class has no public properties.</div>        <a id="Ext.grid.AbstractSelectionModel-methods"></a>
49        <h2>Public Methods</h2>
50                <table cellspacing="0" class="member-table">
51            <tr>
52                <th class="sig-header" colspan="2">Method</th>
53                <th class="msource-header">Defined By</th>
54            </tr>
55                <tr class="method-row expandable">
56        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
57        <td class="sig">
58        <a id="Ext.grid.AbstractSelectionModel-AbstractSelectionModel"></a>
59            <b>AbstractSelectionModel</b>()            <div class="mdesc">
60                        <div class="short"></div>
61            <div class="long">
62                    <div class="mdetail-params">
63        <strong>Parameters:</strong>
64        <ul><li>None.</li>        </ul>
65        <strong>Returns:</strong>
66        <ul>
67            <li><code></code></li>
68        </ul>
69    </div>
70                </div>
71                        </div>
72        </td>
73        <td class="msource">AbstractSelectionModel</td>
74    </tr>
75        <tr class="method-row inherited alt expandable">
76        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
77        <td class="sig">
78        <a id="Ext.grid.AbstractSelectionModel-addEvents"></a>
79            <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void            <div class="mdesc">
80                        <div class="short">Used to define events on this Observable</div>
81            <div class="long">
82                Used to define events on this Observable    <div class="mdetail-params">
83        <strong>Parameters:</strong>
84        <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li>        </ul>
85        <strong>Returns:</strong>
86        <ul>
87            <li><code>void</code></li>
88        </ul>
89    </div>
90                </div>
91                        </div>
92        </td>
93        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
94    </tr>
95        <tr class="method-row inherited expandable">
96        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
97        <td class="sig">
98        <a id="Ext.grid.AbstractSelectionModel-addListener"></a>
99            <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">
100                        <div class="short">Appends an event handler to this component</div>
101            <div class="long">
102                Appends an event handler to this component    <div class="mdetail-params">
103        <strong>Parameters:</strong>
104        <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
105function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
106properties. This may contain any of the following properties:<ul>
107<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>
108<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>
109<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>
110<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
111by the specified number of milliseconds. If the event fires again within that time, the original
112handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
113</ul><br>
114<p>
115<b>Combining Options</b><br>
116Using the options argument, it is possible to combine different types of listeners:<br>
117<br>
118A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
119<pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
120    single: true,
121    delay: 100,
122    forumId: 4
123});</code></pre>
124<p>
125<b>Attaching multiple handlers in 1 call</b><br>
126The method also allows for a single argument to be passed which is a config object containing properties
127which specify multiple handlers.
128<p>
129<pre><code>foo.on({
130    <em>'click'</em> : {
131        fn: <b>this</b>.onClick,
132        scope: <b>this</b>,
133        delay: 100
134    },
135    <em>'mouseover'</em> : {
136        fn: <b>this</b>.onMouseOver,
137        scope: <b>this</b>
138    },
139    <em>'mouseout'</em> : {
140        fn: <b>this</b>.onMouseOut,
141        scope: <b>this</b>
142    }
143});</code></pre>
144<p>
145Or a shorthand syntax:<br>
146<pre><code>foo.on({
147    <em>'click'</em> : <b>this</b>.onClick,
148    <em>'mouseover'</em> : <b>this</b>.onMouseOver,
149    <em>'mouseout'</em> : <b>this</b>.onMouseOut,
150     scope: <b>this</b>
151});</code></pre></div></li>        </ul>
152        <strong>Returns:</strong>
153        <ul>
154            <li><code>void</code></li>
155        </ul>
156    </div>
157                </div>
158                        </div>
159        </td>
160        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
161    </tr>
162        <tr class="method-row inherited alt expandable">
163        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
164        <td class="sig">
165        <a id="Ext.grid.AbstractSelectionModel-fireEvent"></a>
166            <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean            <div class="mdesc">
167                        <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
168            <div class="long">
169                Fires the specified event with the passed parameters (minus the event name).    <div class="mdetail-params">
170        <strong>Parameters:</strong>
171        <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>
172        <strong>Returns:</strong>
173        <ul>
174            <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
175        </ul>
176    </div>
177                </div>
178                        </div>
179        </td>
180        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
181    </tr>
182        <tr class="method-row inherited expandable">
183        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
184        <td class="sig">
185        <a id="Ext.grid.AbstractSelectionModel-hasListener"></a>
186            <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean            <div class="mdesc">
187                        <div class="short">Checks to see if this object has any listeners for a specified event</div>
188            <div class="long">
189                Checks to see if this object has any listeners for a specified event    <div class="mdetail-params">
190        <strong>Parameters:</strong>
191        <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li>        </ul>
192        <strong>Returns:</strong>
193        <ul>
194            <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
195        </ul>
196    </div>
197                </div>
198                        </div>
199        </td>
200        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
201    </tr>
202        <tr class="method-row alt expandable">
203        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
204        <td class="sig">
205        <a id="Ext.grid.AbstractSelectionModel-isLocked"></a>
206            <b>isLocked</b>() : Boolean            <div class="mdesc">
207                        <div class="short">Returns true if the selections are locked.</div>
208            <div class="long">
209                Returns true if the selections are locked.    <div class="mdetail-params">
210        <strong>Parameters:</strong>
211        <ul><li>None.</li>        </ul>
212        <strong>Returns:</strong>
213        <ul>
214            <li><code>Boolean</code></li>
215        </ul>
216    </div>
217                </div>
218                        </div>
219        </td>
220        <td class="msource">AbstractSelectionModel</td>
221    </tr>
222        <tr class="method-row expandable">
223        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
224        <td class="sig">
225        <a id="Ext.grid.AbstractSelectionModel-lock"></a>
226            <b>lock</b>() : void            <div class="mdesc">
227                        <div class="short">Locks the selections.</div>
228            <div class="long">
229                Locks the selections.    <div class="mdetail-params">
230        <strong>Parameters:</strong>
231        <ul><li>None.</li>        </ul>
232        <strong>Returns:</strong>
233        <ul>
234            <li><code>void</code></li>
235        </ul>
236    </div>
237                </div>
238                        </div>
239        </td>
240        <td class="msource">AbstractSelectionModel</td>
241    </tr>
242        <tr class="method-row inherited alt expandable">
243        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
244        <td class="sig">
245        <a id="Ext.grid.AbstractSelectionModel-on"></a>
246            <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">
247                        <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
248            <div class="long">
249                Appends an event handler to this element (shorthand for addListener)    <div class="mdetail-params">
250        <strong>Parameters:</strong>
251        <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
252function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li>        </ul>
253        <strong>Returns:</strong>
254        <ul>
255            <li><code>void</code></li>
256        </ul>
257    </div>
258                </div>
259                        </div>
260        </td>
261        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
262    </tr>
263        <tr class="method-row inherited expandable">
264        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
265        <td class="sig">
266        <a id="Ext.grid.AbstractSelectionModel-purgeListeners"></a>
267            <b>purgeListeners</b>() : void            <div class="mdesc">
268                        <div class="short">Removes all listeners for this object</div>
269            <div class="long">
270                Removes all listeners for this object    <div class="mdetail-params">
271        <strong>Parameters:</strong>
272        <ul><li>None.</li>        </ul>
273        <strong>Returns:</strong>
274        <ul>
275            <li><code>void</code></li>
276        </ul>
277    </div>
278                </div>
279                        </div>
280        </td>
281        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
282    </tr>
283        <tr class="method-row inherited alt expandable">
284        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
285        <td class="sig">
286        <a id="Ext.grid.AbstractSelectionModel-relayEvents"></a>
287            <b>relayEvents</b>(&nbsp;<code>Object o</code>, <code>Array events</code>&nbsp;) : void            <div class="mdesc">
288                        <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>
289            <div class="long">
290                Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.    <div class="mdetail-params">
291        <strong>Parameters:</strong>
292        <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>
293        <strong>Returns:</strong>
294        <ul>
295            <li><code>void</code></li>
296        </ul>
297    </div>
298                </div>
299                        </div>
300        </td>
301        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>
302    </tr>
303        <tr class="method-row inherited expandable">
304        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
305        <td class="sig">
306        <a id="Ext.grid.AbstractSelectionModel-removeListener"></a>
307            <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">
308                        <div class="short">Removes a listener</div>
309            <div class="long">
310                Removes a listener    <div class="mdetail-params">
311        <strong>Parameters:</strong>
312        <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>
313        <strong>Returns:</strong>
314        <ul>
315            <li><code>void</code></li>
316        </ul>
317    </div>
318                </div>
319                        </div>
320        </td>
321        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
322    </tr>
323        <tr class="method-row inherited alt expandable">
324        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
325        <td class="sig">
326        <a id="Ext.grid.AbstractSelectionModel-resumeEvents"></a>
327            <b>resumeEvents</b>() : void            <div class="mdesc">
328                        <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>
329            <div class="long">
330                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">
331        <strong>Parameters:</strong>
332        <ul><li>None.</li>        </ul>
333        <strong>Returns:</strong>
334        <ul>
335            <li><code>void</code></li>
336        </ul>
337    </div>
338                </div>
339                        </div>
340        </td>
341        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
342    </tr>
343        <tr class="method-row inherited expandable">
344        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
345        <td class="sig">
346        <a id="Ext.grid.AbstractSelectionModel-suspendEvents"></a>
347            <b>suspendEvents</b>() : void            <div class="mdesc">
348                        <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>
349            <div class="long">
350                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">
351        <strong>Parameters:</strong>
352        <ul><li>None.</li>        </ul>
353        <strong>Returns:</strong>
354        <ul>
355            <li><code>void</code></li>
356        </ul>
357    </div>
358                </div>
359                        </div>
360        </td>
361        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
362    </tr>
363        <tr class="method-row inherited alt expandable">
364        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
365        <td class="sig">
366        <a id="Ext.grid.AbstractSelectionModel-un"></a>
367            <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">
368                        <div class="short">Removes a listener (shorthand for removeListener)</div>
369            <div class="long">
370                Removes a listener (shorthand for removeListener)    <div class="mdetail-params">
371        <strong>Parameters:</strong>
372        <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>
373        <strong>Returns:</strong>
374        <ul>
375            <li><code>void</code></li>
376        </ul>
377    </div>
378                </div>
379                        </div>
380        </td>
381        <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
382    </tr>
383        <tr class="method-row expandable">
384        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
385        <td class="sig">
386        <a id="Ext.grid.AbstractSelectionModel-unlock"></a>
387            <b>unlock</b>() : void            <div class="mdesc">
388                        <div class="short">Unlocks the selections.</div>
389            <div class="long">
390                Unlocks the selections.    <div class="mdetail-params">
391        <strong>Parameters:</strong>
392        <ul><li>None.</li>        </ul>
393        <strong>Returns:</strong>
394        <ul>
395            <li><code>void</code></li>
396        </ul>
397    </div>
398                </div>
399                        </div>
400        </td>
401        <td class="msource">AbstractSelectionModel</td>
402    </tr>
403            </table>
404                <a id="Ext.grid.AbstractSelectionModel-events"></a>
405        <h2>Public Events</h2>
406        <div class="no-members">This class has no public events.</div>
407        </div>
Note: See TracBrowser for help on using the repository browser.