1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.grid.AbstractSelectionModel</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
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>
43 <!-- ============================== inheritance Block. ================================= -->
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
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.grid.AbstractSelectionModel
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.grid</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_grid_AbstractSelectionModel.js.html">Roo/grid/AbstractSelectionModel.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">AbstractSelectionModel</td></tr>
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>
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>
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.
96 <!-- ============================== Class comment block... ========================== -->
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>
102 <iframe frameborder="0" id="comments-Roo.grid" style="border: none;width:100%;"
103 src="/blog.php/GtkDjsComments/Roo.grid.AbstractSelectionModel.html"></iframe>
108 <!-- ============================== config options ========================== -->
113 <div class="hr"></div>
114 <a id="Roo.grid.AbstractSelectionModel-configs"></a>
120 <table cellspacing="0" class="member-table">
121 <caption>Config Options (Usually are also Properties)</caption>
125 <th class="sig-header" colspan="2">Options</th>
127 <th class="msource-header">Defined By</th>
134 <tr class="config-row expandable config-row-alt0">
135 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>
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>
161 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
177 <!-- ============================== public properties ==================== -->
181 <a id="Roo.grid.AbstractSelectionModel-props"></a>
187 <table cellspacing="0" class="member-table">
188 <caption class="Empty">Public Properties - Has None</caption>
194 <!-- ============================== methods summary / details ======================== -->
197 <a id="Roo.grid.AbstractSelectionModel-methods"></a>
198 <!-- constructor?? -->
205 <!-- then dynamics first -->
212 <table cellspacing="0" class="member-table">
213 <caption>Public Methods</caption>
215 <th class="sig-header" colspan="2">Method</th>
216 <th class="msource-header">Defined By</th>
226 <tr class="method-row config-row-alt0 notInherited">
227 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
243 <div class="short">Create a new Roo.grid.AbstractSelectionModel</div>
250 Create a new Roo.grid.AbstractSelectionModel
273 <tr class="method-row config-row-alt1 expandable">
274 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
282 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
289 <div class="short">Used to define events on this Observable</div>
295 Used to define events on this Observable
302 <dl class="detailList">
303 <dt class="heading">Parameters:</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>
309 <dd>The object with the events defined</dd>
329 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
335 <tr class="method-row config-row-alt0 expandable">
336 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
351 <div class="short">Appends an event handler to this component</div>
357 Appends an event handler to this component
364 <dl class="detailList">
365 <dt class="heading">Parameters:</dt>
368 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
371 <dd>The type of event to listen for</dd>
374 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
377 <dd>The method the event invokes</dd>
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>
383 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
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>
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>
409 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
415 <tr class="method-row config-row-alt1 expandable">
416 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
430 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
439 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
445 Fires the specified event with the passed parameters (minus the event name).
452 <dl class="detailList">
453 <dt class="heading">Parameters:</dt>
456 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
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>
465 <dd>Variable number of parameters are passed to handlers</dd>
473 <dl class="detailList">
474 <dt class="heading">Returns:</dt>
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>
492 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
498 <tr class="method-row config-row-alt0 expandable">
499 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
507 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
513 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
522 <div class="short">Checks to see if this object has any listeners for a specified event</div>
528 Checks to see if this object has any listeners for a specified event
535 <dl class="detailList">
536 <dt class="heading">Parameters:</dt>
539 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
542 <dd>The name of the event to check for</dd>
550 <dl class="detailList">
551 <dt class="heading">Returns:</dt>
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>
569 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
575 <tr class="method-row config-row-alt1 expandable notInherited">
576 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
590 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
599 <div class="short">Returns true if the selections are locked.</div>
605 Returns true if the selections are locked.
616 <dl class="detailList">
617 <dt class="heading">Returns:</dt>
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>
635 Roo.grid.AbstractSelectionModel
641 <tr class="method-row config-row-alt0 expandable notInherited">
642 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
657 <div class="short">Locks the selections.</div>
663 Locks the selections.
686 Roo.grid.AbstractSelectionModel
692 <tr class="method-row config-row-alt1 expandable">
693 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
708 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
714 Appends an event handler to this element (shorthand for addListener)
721 <dl class="detailList">
722 <dt class="heading">Parameters:</dt>
725 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
728 <dd>The type of event to listen for</dd>
731 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
734 <dd>The method the event invokes</dd>
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>
740 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
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>
766 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
772 <tr class="method-row config-row-alt0 expandable">
773 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
788 <div class="short">Removes all listeners for this object</div>
794 Removes all listeners for this object
817 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
823 <tr class="method-row config-row-alt1 expandable">
824 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
839 <div class="short">Removes a listener</div>
852 <dl class="detailList">
853 <dt class="heading">Parameters:</dt>
856 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
859 <dd>The type of event to listen for</dd>
862 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
865 <dd>The handler to remove</dd>
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>
871 <dd>(optional) The scope (this object) for the handler</dd>
891 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
897 <tr class="method-row config-row-alt0 expandable">
898 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
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>)
913 <div class="short">Removes a listener (shorthand for removeListener)</div>
919 Removes a listener (shorthand for removeListener)
926 <dl class="detailList">
927 <dt class="heading">Parameters:</dt>
930 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
933 <dd>The type of event to listen for</dd>
936 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
939 <dd>The handler to remove</dd>
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>
945 <dd>(optional) The scope (this object) for the handler</dd>
965 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
971 <tr class="method-row config-row-alt1 expandable notInherited">
972 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
987 <div class="short">Unlocks the selections.</div>
993 Unlocks the selections.
1014 <td class="msource">
1016 Roo.grid.AbstractSelectionModel
1025 <!-- ============================== events summary / details ======================== -->
1028 <a id="Roo.grid.AbstractSelectionModel-events"></a>
1034 <table cellspacing="0" class="member-table">
1035 <caption class="Empty">Events - Has None</caption>
1046 <!-- ============================== footer ================================= -->
1047 <div class="fineprint" style="clear:both">
1049 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Mon Nov 09 2015 15:44:42 GMT+0800 (HKT)
1051 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>