Partial Fix #5654 - roojspacker - get it working as a doc tool...
[roojs1] / docs.old / symbols / Roo.grid.AbstractSelectionModel.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
3
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
6         <head>
7                 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8                 <meta name="generator" content="JsDoc Toolkit" />
9                 
10                 
11                 <title>JsDoc Reference - Roo.grid.AbstractSelectionModel</title>
12                 
13                 
14         <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />            
15         <link rel="stylesheet" type="text/css" href="../default.css" />
16         
17         
18         <script type="text/javascript" src="../page.js">
19         
20         </script>
21          
22                 
23         </head>
24
25         <body onload="RooDocsPage.onload();">
26          
27         
28 <div class="body-wrap">
29
30     <!-- ============================== links to methods. ================================= --> 
31
32     <div class="top-tools">
33     <!--
34         <a class="inner-link" href="#Roo.grid.AbstractSelectionModel-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35         <a class="inner-link" href="#Roo.grid.AbstractSelectionModel-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36         <a class="inner-link" href="#Roo.grid.AbstractSelectionModel-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37         <a class="inner-link" href="#Roo.grid.AbstractSelectionModel-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38         <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
39         -->
40     </div>
41
42     
43 <!-- ============================== inheritance Block. ================================= -->    
44         
45                 <div class="inheritance res-block">
46                    <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.grid.AbstractSelectionModel 
48
49                    </pre>
50                 </div>
51        
52 <!-- ============================== class title / details ============================ -->
53     
54     
55     <h1 class="classTitle">
56                                 
57                                 Class Roo.grid.AbstractSelectionModel
58                         </h1>
59                         
60     <table cellspacing="0" class="class-summary-table">
61         
62                 <tr><td class="label">Package:</td><td class="hd-info">Roo.grid</td></tr>
63         
64         <tr><td class="label">Defined In:</td><td class="hd-info">
65                         
66                                         <a href="./src/Roo_grid_AbstractSelectionModel.js.html">Roo/grid/AbstractSelectionModel.js</a>.
67                         
68         </td></tr>
69         <tr><td class="label">Class:</td><td class="hd-info">AbstractSelectionModel</td></tr>
70         
71         
72         <tr><td class="label">Subclasses:</td><td class="hd-info">
73                 <a href="./Roo.grid.CellSelectionModel.html#constructor" roo:cls="Roo.grid.CellSelectionModel.html#constructor">Roo.grid.CellSelectionModel</a>, <a href="./Roo.grid.RowSelectionModel.html#constructor" roo:cls="Roo.grid.RowSelectionModel.html#constructor">Roo.grid.RowSelectionModel</a>
74
75         
76         
77         </td></tr>
78         
79         
80         
81                 <tr><td class="label">Extends:</td><td class="hd-info">
82                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
83         
84                 </td></tr>    
85         
86         
87     </table>
88
89     
90 <!-- ============================== class summary ========================== -->                        
91     <div class="description">
92         Abstract base class for grid SelectionModels.  It provides the interface that should be<br/>implemented by descendant classes.  This class should not be directly instantiated.
93     </div>
94
95         
96 <!-- ============================== Class comment block... ========================== -->                                       
97
98 <div class="comments">
99         <b>Class Comments / Notes</B> =>  
100         <u onclick="parent.CommentDialog.showCommentId = 'Roo.grid.AbstractSelectionModel';">[Add Your comment/notes about this class]</u>
101         <br/>
102         <iframe frameborder="0"  id="comments-Roo.grid" style="border: none;width:100%;" 
103                 src="/blog.php/GtkDjsComments/Roo.grid.AbstractSelectionModel.html"></iframe>
104 </div>
105         
106
107                 
108 <!-- ============================== config options ========================== -->                                               
109                  
110     
111     
112                 
113     <div class="hr"></div>
114     <a id="Roo.grid.AbstractSelectionModel-configs"></a>
115                 
116     
117      
118     
119         
120       <table cellspacing="0" class="member-table">   
121       <caption>Config Options (Usually are also Properties)</caption>
122     
123         
124         <tr>
125             <th class="sig-header" colspan="2">Options</th>
126             
127             <th class="msource-header">Defined By</th>
128         </tr>
129         
130         
131         
132         
133         
134                 <tr class="config-row expandable config-row-alt0">
135                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
136                     <td class="sig">
137
138                         <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
139                         <div class="fixedFont">
140                                 <b  class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
141                                 
142                                 
143                         </div>
144                   
145                         <div class="mdesc">
146                             <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           .</div> 
147                         </div>
148                         
149                         <div class="mdesc">
150                             <div class="long">
151                     list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           ..... <br/>        } ,<br/>        .... <br/>    } <br/>  </code></pre>
152                     
153                 </div> 
154                         </div>
155                         
156                         
157
158                     </td>
159                     <td class="msource">
160                         
161                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
162                                 
163                     </td>
164                 </tr>
165         
166         
167     </table>
168                 
169   
170   
171   
172   
173   
174   
175   
176   
177   <!-- ============================== public properties ==================== -->        
178   
179   
180   
181     <a id="Roo.grid.AbstractSelectionModel-props"></a>      
182     
183     
184
185     
186     
187      <table cellspacing="0" class="member-table">
188       <caption class="Empty">Public Properties - Has None</caption>
189      </table>
190     
191     
192      
193     
194   <!-- ============================== methods summary / details ======================== -->
195   
196   
197   <a id="Roo.grid.AbstractSelectionModel-methods"></a>
198         <!-- constructor?? -->
199         
200         <!-- static's first 
201         
202         
203         -->
204         
205         <!-- then dynamics first -->
206         
207   
208   
209     
210     
211     
212       <table cellspacing="0" class="member-table">
213       <caption>Public Methods</caption>
214         <tr>
215             <th class="sig-header" colspan="2">Method</th>            
216             <th class="msource-header">Defined By</th>
217
218         </tr>
219         
220         
221         
222          
223         
224         
225           
226           <tr class="method-row config-row-alt0 notInherited">
227             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
228            
229            
230             <td class="sig">
231                 <a id="Roo.grid-method-AbstractSelectionModel"   name=".AbstractSelectionModel"></a>
232                 <div class="fixedFont">
233                         <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">AbstractSelectionModel</b>
234                                 
235                                  () 
236                         
237                                 
238                         
239                 </div>
240                 <div class="mdesc">
241                 
242                  
243                         <div class="short">Create a new Roo.grid.AbstractSelectionModel</div> 
244                  
245                  
246                     <div class="long">
247                         
248                         
249                         
250                                 Create a new Roo.grid.AbstractSelectionModel
251                         
252                         
253                         
254                         
255                         
256                         
257                         
258                         
259
260                     
261                     
262                      
263                     </div>                    
264                 </div>
265
266             </td>
267             <td class="msource">
268                 &nbsp;
269             </td>
270         </tr>
271         
272           
273           <tr class="method-row config-row-alt1 expandable">
274             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
275            
276            
277             <td class="sig">
278                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
279                 <div class="fixedFont">
280                         <span class="attributes"></span><b class="itemname">addEvents</b>
281                                 
282                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>) 
283                         
284                                 
285                         
286                 </div>
287                 <div class="mdesc">
288                 
289                    <div class="short">Used to define events on this Observable</div> 
290                  
291                  
292                  
293                     <div class="long">
294                         
295                                 Used to define events on this Observable
296                     
297                                 
298                         
299                         
300                         
301                         
302                                 <dl class="detailList">
303                                 <dt class="heading">Parameters:</dt>
304                                 
305                                         <dt>
306                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>object</b>
307                                                 
308                                         </dt>
309                                         <dd>The object with the events defined</dd>
310                                 
311                                 </dl>
312                         
313                         
314                         
315                         
316                         
317                         
318                         
319
320                     
321                     
322                      
323                     </div>                    
324                 </div>
325
326             </td>
327             <td class="msource">
328                 
329                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
330                 &nbsp;
331             </td>
332         </tr>
333         
334           
335           <tr class="method-row config-row-alt0 expandable">
336             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
337            
338            
339             <td class="sig">
340                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
341                 <div class="fixedFont">
342                         <span class="attributes"></span><b class="itemname">addListener</b>
343                                 
344                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>) 
345                         
346                                 
347                         
348                 </div>
349                 <div class="mdesc">
350                 
351                    <div class="short">Appends an event handler to this component</div> 
352                  
353                  
354                  
355                     <div class="long">
356                         
357                                 Appends an event handler to this component
358                     
359                                 
360                         
361                         
362                         
363                         
364                                 <dl class="detailList">
365                                 <dt class="heading">Parameters:</dt>
366                                 
367                                         <dt>
368                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
369                                                 
370                                         </dt>
371                                         <dd>The type of event to listen for</dd>
372                                 
373                                         <dt>
374                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
375                                                 
376                                         </dt>
377                                         <dd>The method the event invokes</dd>
378                                 
379                                         <dt>
380                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
381                                                 
382                                         </dt>
383                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
384                                 
385                                         <dt>
386                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
387                                                 
388                                         </dt>
389                                         <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/>             <pre><code><br/>                el.on('click', this.onClick, this, {<br/>                       single: true,<br/>              delay: 100,<br/>                forumId: 4<br/>         });<br/>                </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/>               el.on({<br/>                    'click': {<br/>                 fn: this.onClick,<br/>                  scope: this,<br/>                       delay: 100<br/>                 }, <br/>                'mouseover': {<br/>                     fn: this.onMouseOver,<br/>                      scope: this<br/>                },<br/>                 'mouseout': {<br/>                      fn: this.onMouseOut,<br/>                       scope: this<br/>                }<br/>          });<br/>                </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/>        <pre><code><br/>                el.on({<br/>                    'click': this.onClick,<br/>             'mouseover': this.onMouseOver,<br/>             'mouseout': this.onMouseOut,<br/>               scope: this<br/>                });<br/>                </code></pre></dd>
390                                 
391                                 </dl>
392                         
393                         
394                         
395                         
396                         
397                         
398                         
399
400                     
401                     
402                      
403                     </div>                    
404                 </div>
405
406             </td>
407             <td class="msource">
408                 
409                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
410                 &nbsp;
411             </td>
412         </tr>
413         
414           
415           <tr class="method-row config-row-alt1 expandable">
416             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
417            
418            
419             <td class="sig">
420                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
421                 <div class="fixedFont">
422                         <span class="attributes"></span><b class="itemname">fireEvent</b>
423                                 
424                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>) 
425                         
426                                 
427                                          : 
428                                         
429                                                 
430                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
431                                         
432                                         
433                                         
434                                 
435                         
436                 </div>
437                 <div class="mdesc">
438                 
439                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div> 
440                  
441                  
442                  
443                     <div class="long">
444                         
445                                 Fires the specified event with the passed parameters (minus the event name).
446                     
447                                 
448                         
449                         
450                         
451                         
452                                 <dl class="detailList">
453                                 <dt class="heading">Parameters:</dt>
454                                 
455                                         <dt>
456                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
457                                                 
458                                         </dt>
459                                         <dd></dd>
460                                 
461                                         <dt>
462                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span>  <b>args</b>
463                                                 
464                                         </dt>
465                                         <dd>Variable number of parameters are passed to handlers</dd>
466                                 
467                                 </dl>
468                         
469                         
470                         
471                         
472                         
473                                 <dl class="detailList">
474                                 <dt class="heading">Returns:</dt>
475                                 
476                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  returns false if any of the handlers return false otherwise it returns true</dd>
477                                 
478                                 </dl>
479                         
480                         
481                         
482
483                     
484                     
485                      
486                     </div>                    
487                 </div>
488
489             </td>
490             <td class="msource">
491                 
492                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
493                 &nbsp;
494             </td>
495         </tr>
496         
497           
498           <tr class="method-row config-row-alt0 expandable">
499             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
500            
501            
502             <td class="sig">
503                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
504                 <div class="fixedFont">
505                         <span class="attributes"></span><b class="itemname">hasListener</b>
506                                 
507                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>) 
508                         
509                                 
510                                          : 
511                                         
512                                                 
513                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
514                                         
515                                         
516                                         
517                                 
518                         
519                 </div>
520                 <div class="mdesc">
521                 
522                    <div class="short">Checks to see if this object has any listeners for a specified event</div> 
523                  
524                  
525                  
526                     <div class="long">
527                         
528                                 Checks to see if this object has any listeners for a specified event
529                     
530                                 
531                         
532                         
533                         
534                         
535                                 <dl class="detailList">
536                                 <dt class="heading">Parameters:</dt>
537                                 
538                                         <dt>
539                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
540                                                 
541                                         </dt>
542                                         <dd>The name of the event to check for</dd>
543                                 
544                                 </dl>
545                         
546                         
547                         
548                         
549                         
550                                 <dl class="detailList">
551                                 <dt class="heading">Returns:</dt>
552                                 
553                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  True if the event is being listened for, else false</dd>
554                                 
555                                 </dl>
556                         
557                         
558                         
559
560                     
561                     
562                      
563                     </div>                    
564                 </div>
565
566             </td>
567             <td class="msource">
568                 
569                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
570                 &nbsp;
571             </td>
572         </tr>
573         
574           
575           <tr class="method-row config-row-alt1 expandable notInherited">
576             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
577            
578            
579             <td class="sig">
580                 <a id="Roo.grid.AbstractSelectionModel-method-isLocked"   name=".isLocked"></a>
581                 <div class="fixedFont">
582                         <span class="attributes"></span><b class="itemname">isLocked</b>
583                                 
584                                  () 
585                         
586                                 
587                                          : 
588                                         
589                                                 
590                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
591                                         
592                                         
593                                         
594                                 
595                         
596                 </div>
597                 <div class="mdesc">
598                 
599                    <div class="short">Returns true if the selections are locked.</div> 
600                  
601                  
602                  
603                     <div class="long">
604                         
605                                 Returns true if the selections are locked.
606                     
607                                 
608                         
609                         
610                         
611                         
612                         
613                         
614                         
615                         
616                                 <dl class="detailList">
617                                 <dt class="heading">Returns:</dt>
618                                 
619                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
620                                 
621                                 </dl>
622                         
623                         
624                         
625
626                     
627                     
628                      
629                     </div>                    
630                 </div>
631
632             </td>
633             <td class="msource">
634                 
635                         Roo.grid.AbstractSelectionModel
636                 &nbsp;
637             </td>
638         </tr>
639         
640           
641           <tr class="method-row config-row-alt0 expandable notInherited">
642             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
643            
644            
645             <td class="sig">
646                 <a id="Roo.grid.AbstractSelectionModel-method-lock"   name=".lock"></a>
647                 <div class="fixedFont">
648                         <span class="attributes"></span><b class="itemname">lock</b>
649                                 
650                                  () 
651                         
652                                 
653                         
654                 </div>
655                 <div class="mdesc">
656                 
657                    <div class="short">Locks the selections.</div> 
658                  
659                  
660                  
661                     <div class="long">
662                         
663                                 Locks the selections.
664                     
665                                 
666                         
667                         
668                         
669                         
670                         
671                         
672                         
673                         
674                         
675                         
676
677                     
678                     
679                      
680                     </div>                    
681                 </div>
682
683             </td>
684             <td class="msource">
685                 
686                         Roo.grid.AbstractSelectionModel
687                 &nbsp;
688             </td>
689         </tr>
690         
691           
692           <tr class="method-row config-row-alt1 expandable">
693             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
694            
695            
696             <td class="sig">
697                 <a id="Roo.util.Observable-method-on"   name=".on"></a>
698                 <div class="fixedFont">
699                         <span class="attributes"></span><b class="itemname">on</b>
700                                 
701                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>) 
702                         
703                                 
704                         
705                 </div>
706                 <div class="mdesc">
707                 
708                    <div class="short">Appends an event handler to this element (shorthand for addListener)</div> 
709                  
710                  
711                  
712                     <div class="long">
713                         
714                                 Appends an event handler to this element (shorthand for addListener)
715                     
716                                 
717                         
718                         
719                         
720                         
721                                 <dl class="detailList">
722                                 <dt class="heading">Parameters:</dt>
723                                 
724                                         <dt>
725                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
726                                                 
727                                         </dt>
728                                         <dd>The type of event to listen for</dd>
729                                 
730                                         <dt>
731                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
732                                                 
733                                         </dt>
734                                         <dd>The method the event invokes</dd>
735                                 
736                                         <dt>
737                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
738                                                 
739                                         </dt>
740                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
741                                 
742                                         <dt>
743                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
744                                                 
745                                         </dt>
746                                         <dd>(optional)</dd>
747                                 
748                                 </dl>
749                         
750                         
751                         
752                         
753                         
754                         
755                         
756
757                     
758                     
759                      
760                     </div>                    
761                 </div>
762
763             </td>
764             <td class="msource">
765                 
766                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
767                 &nbsp;
768             </td>
769         </tr>
770         
771           
772           <tr class="method-row config-row-alt0 expandable">
773             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
774            
775            
776             <td class="sig">
777                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
778                 <div class="fixedFont">
779                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
780                                 
781                                  () 
782                         
783                                 
784                         
785                 </div>
786                 <div class="mdesc">
787                 
788                    <div class="short">Removes all listeners for this object</div> 
789                  
790                  
791                  
792                     <div class="long">
793                         
794                                 Removes all listeners for this object
795                     
796                                 
797                         
798                         
799                         
800                         
801                         
802                         
803                         
804                         
805                         
806                         
807
808                     
809                     
810                      
811                     </div>                    
812                 </div>
813
814             </td>
815             <td class="msource">
816                 
817                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
818                 &nbsp;
819             </td>
820         </tr>
821         
822           
823           <tr class="method-row config-row-alt1 expandable">
824             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
825            
826            
827             <td class="sig">
828                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
829                 <div class="fixedFont">
830                         <span class="attributes"></span><b class="itemname">removeListener</b>
831                                 
832                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>) 
833                         
834                                 
835                         
836                 </div>
837                 <div class="mdesc">
838                 
839                    <div class="short">Removes a listener</div> 
840                  
841                  
842                  
843                     <div class="long">
844                         
845                                 Removes a listener
846                     
847                                 
848                         
849                         
850                         
851                         
852                                 <dl class="detailList">
853                                 <dt class="heading">Parameters:</dt>
854                                 
855                                         <dt>
856                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
857                                                 
858                                         </dt>
859                                         <dd>The type of event to listen for</dd>
860                                 
861                                         <dt>
862                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
863                                                 
864                                         </dt>
865                                         <dd>The handler to remove</dd>
866                                 
867                                         <dt>
868                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
869                                                 
870                                         </dt>
871                                         <dd>(optional) The scope (this object) for the handler</dd>
872                                 
873                                 </dl>
874                         
875                         
876                         
877                         
878                         
879                         
880                         
881
882                     
883                     
884                      
885                     </div>                    
886                 </div>
887
888             </td>
889             <td class="msource">
890                 
891                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
892                 &nbsp;
893             </td>
894         </tr>
895         
896           
897           <tr class="method-row config-row-alt0 expandable">
898             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
899            
900            
901             <td class="sig">
902                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
903                 <div class="fixedFont">
904                         <span class="attributes"></span><b class="itemname">un</b>
905                                 
906                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>) 
907                         
908                                 
909                         
910                 </div>
911                 <div class="mdesc">
912                 
913                    <div class="short">Removes a listener (shorthand for removeListener)</div> 
914                  
915                  
916                  
917                     <div class="long">
918                         
919                                 Removes a listener (shorthand for removeListener)
920                     
921                                 
922                         
923                         
924                         
925                         
926                                 <dl class="detailList">
927                                 <dt class="heading">Parameters:</dt>
928                                 
929                                         <dt>
930                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
931                                                 
932                                         </dt>
933                                         <dd>The type of event to listen for</dd>
934                                 
935                                         <dt>
936                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
937                                                 
938                                         </dt>
939                                         <dd>The handler to remove</dd>
940                                 
941                                         <dt>
942                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
943                                                 
944                                         </dt>
945                                         <dd>(optional) The scope (this object) for the handler</dd>
946                                 
947                                 </dl>
948                         
949                         
950                         
951                         
952                         
953                         
954                         
955
956                     
957                     
958                      
959                     </div>                    
960                 </div>
961
962             </td>
963             <td class="msource">
964                 
965                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
966                 &nbsp;
967             </td>
968         </tr>
969         
970           
971           <tr class="method-row config-row-alt1 expandable notInherited">
972             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
973            
974            
975             <td class="sig">
976                 <a id="Roo.grid.AbstractSelectionModel-method-unlock"   name=".unlock"></a>
977                 <div class="fixedFont">
978                         <span class="attributes"></span><b class="itemname">unlock</b>
979                                 
980                                  () 
981                         
982                                 
983                         
984                 </div>
985                 <div class="mdesc">
986                 
987                    <div class="short">Unlocks the selections.</div> 
988                  
989                  
990                  
991                     <div class="long">
992                         
993                                 Unlocks the selections.
994                     
995                                 
996                         
997                         
998                         
999                         
1000                         
1001                         
1002                         
1003                         
1004                         
1005                         
1006
1007                     
1008                     
1009                      
1010                     </div>                    
1011                 </div>
1012
1013             </td>
1014             <td class="msource">
1015                 
1016                         Roo.grid.AbstractSelectionModel
1017                 &nbsp;
1018             </td>
1019         </tr>
1020         
1021                                                        
1022     </table>
1023
1024   
1025   <!-- ============================== events summary / details ======================== -->
1026   
1027   
1028   <a id="Roo.grid.AbstractSelectionModel-events"></a>
1029     
1030   
1031         
1032    
1033     
1034      <table cellspacing="0" class="member-table">
1035       <caption class="Empty">Events - Has None</caption>
1036      </table>
1037     
1038     
1039   
1040     
1041     
1042   
1043   
1044   
1045  
1046 <!-- ============================== footer ================================= -->
1047                 <div class="fineprint" style="clear:both">
1048                         
1049                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 13 2018 14:10:54 GMT+0800 (HKT)
1050                         Based on 
1051                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>  
1052                 </div>
1053         </body>
1054 </html>