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>
150 <div class="long">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></div>
158 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
174 <!-- ============================== public properties ==================== -->
178 <a id="Roo.grid.AbstractSelectionModel-props"></a>
184 <table cellspacing="0" class="member-table">
185 <caption class="Empty">Public Properties - Has None</caption>
191 <!-- ============================== methods summary / details ======================== -->
194 <a id="Roo.grid.AbstractSelectionModel-methods"></a>
195 <!-- constructor?? -->
202 <!-- then dynamics first -->
209 <table cellspacing="0" class="member-table">
210 <caption>Public Methods</caption>
212 <th class="sig-header" colspan="2">Method</th>
213 <th class="msource-header">Defined By</th>
223 <tr class="method-row config-row-alt0 notInherited">
224 <td class="micon"><a class="exi" href="#expand"> </a></td>
228 <a id="Roo.grid-method-AbstractSelectionModel" name=".AbstractSelectionModel"></a>
229 <div class="fixedFont">
230 <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">AbstractSelectionModel</b>
240 <div class="short">Create a new Roo.grid.AbstractSelectionModel</div>
247 Create a new Roo.grid.AbstractSelectionModel
270 <tr class="method-row config-row-alt1 expandable">
271 <td class="micon"><a class="exi" href="#expand"> </a></td>
275 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
276 <div class="fixedFont">
277 <span class="attributes"></span><b class="itemname">addEvents</b>
279 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
286 <div class="short">Used to define events on this Observable</div>
292 Used to define events on this Observable
299 <dl class="detailList">
300 <dt class="heading">Parameters:</dt>
303 <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>
306 <dd>The object with the events defined</dd>
326 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
332 <tr class="method-row config-row-alt0 expandable">
333 <td class="micon"><a class="exi" href="#expand"> </a></td>
337 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
338 <div class="fixedFont">
339 <span class="attributes"></span><b class="itemname">addListener</b>
341 (<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>)
348 <div class="short">Appends an event handler to this component</div>
354 Appends an event handler to this component
361 <dl class="detailList">
362 <dt class="heading">Parameters:</dt>
365 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
368 <dd>The type of event to listen for</dd>
371 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
374 <dd>The method the event invokes</dd>
377 <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>
380 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
383 <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>
386 <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>
406 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
412 <tr class="method-row config-row-alt1 expandable">
413 <td class="micon"><a class="exi" href="#expand"> </a></td>
417 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
418 <div class="fixedFont">
419 <span class="attributes"></span><b class="itemname">fireEvent</b>
421 (<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>)
427 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
436 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
442 Fires the specified event with the passed parameters (minus the event name).
449 <dl class="detailList">
450 <dt class="heading">Parameters:</dt>
453 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
459 <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>
462 <dd>Variable number of parameters are passed to handlers</dd>
470 <dl class="detailList">
471 <dt class="heading">Returns:</dt>
473 <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>
489 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
495 <tr class="method-row config-row-alt0 expandable">
496 <td class="micon"><a class="exi" href="#expand"> </a></td>
500 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
501 <div class="fixedFont">
502 <span class="attributes"></span><b class="itemname">hasListener</b>
504 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
510 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
519 <div class="short">Checks to see if this object has any listeners for a specified event</div>
525 Checks to see if this object has any listeners for a specified event
532 <dl class="detailList">
533 <dt class="heading">Parameters:</dt>
536 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
539 <dd>The name of the event to check for</dd>
547 <dl class="detailList">
548 <dt class="heading">Returns:</dt>
550 <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>
566 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
572 <tr class="method-row config-row-alt1 expandable notInherited">
573 <td class="micon"><a class="exi" href="#expand"> </a></td>
577 <a id="Roo.grid.AbstractSelectionModel-method-isLocked" name=".isLocked"></a>
578 <div class="fixedFont">
579 <span class="attributes"></span><b class="itemname">isLocked</b>
587 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
596 <div class="short">Returns true if the selections are locked.</div>
602 Returns true if the selections are locked.
613 <dl class="detailList">
614 <dt class="heading">Returns:</dt>
616 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
632 Roo.grid.AbstractSelectionModel
638 <tr class="method-row config-row-alt0 expandable notInherited">
639 <td class="micon"><a class="exi" href="#expand"> </a></td>
643 <a id="Roo.grid.AbstractSelectionModel-method-lock" name=".lock"></a>
644 <div class="fixedFont">
645 <span class="attributes"></span><b class="itemname">lock</b>
654 <div class="short">Locks the selections.</div>
660 Locks the selections.
683 Roo.grid.AbstractSelectionModel
689 <tr class="method-row config-row-alt1 expandable">
690 <td class="micon"><a class="exi" href="#expand"> </a></td>
694 <a id="Roo.util.Observable-method-on" name=".on"></a>
695 <div class="fixedFont">
696 <span class="attributes"></span><b class="itemname">on</b>
698 (<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>)
705 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
711 Appends an event handler to this element (shorthand for addListener)
718 <dl class="detailList">
719 <dt class="heading">Parameters:</dt>
722 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
725 <dd>The type of event to listen for</dd>
728 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
731 <dd>The method the event invokes</dd>
734 <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>
737 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
740 <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>
763 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
769 <tr class="method-row config-row-alt0 expandable">
770 <td class="micon"><a class="exi" href="#expand"> </a></td>
774 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
775 <div class="fixedFont">
776 <span class="attributes"></span><b class="itemname">purgeListeners</b>
785 <div class="short">Removes all listeners for this object</div>
791 Removes all listeners for this object
814 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
820 <tr class="method-row config-row-alt1 expandable">
821 <td class="micon"><a class="exi" href="#expand"> </a></td>
825 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
826 <div class="fixedFont">
827 <span class="attributes"></span><b class="itemname">removeListener</b>
829 (<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>)
836 <div class="short">Removes a listener</div>
849 <dl class="detailList">
850 <dt class="heading">Parameters:</dt>
853 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
856 <dd>The type of event to listen for</dd>
859 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
862 <dd>The handler to remove</dd>
865 <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>
868 <dd>(optional) The scope (this object) for the handler</dd>
888 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
894 <tr class="method-row config-row-alt0 expandable">
895 <td class="micon"><a class="exi" href="#expand"> </a></td>
899 <a id="Roo.util.Observable-method-un" name=".un"></a>
900 <div class="fixedFont">
901 <span class="attributes"></span><b class="itemname">un</b>
903 (<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>)
910 <div class="short">Removes a listener (shorthand for removeListener)</div>
916 Removes a listener (shorthand for removeListener)
923 <dl class="detailList">
924 <dt class="heading">Parameters:</dt>
927 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
930 <dd>The type of event to listen for</dd>
933 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
936 <dd>The handler to remove</dd>
939 <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>
942 <dd>(optional) The scope (this object) for the handler</dd>
962 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
968 <tr class="method-row config-row-alt1 expandable notInherited">
969 <td class="micon"><a class="exi" href="#expand"> </a></td>
973 <a id="Roo.grid.AbstractSelectionModel-method-unlock" name=".unlock"></a>
974 <div class="fixedFont">
975 <span class="attributes"></span><b class="itemname">unlock</b>
984 <div class="short">Unlocks the selections.</div>
990 Unlocks the selections.
1011 <td class="msource">
1013 Roo.grid.AbstractSelectionModel
1022 <!-- ============================== events summary / details ======================== -->
1025 <a id="Roo.grid.AbstractSelectionModel-events"></a>
1031 <table cellspacing="0" class="member-table">
1032 <caption class="Empty">Events - Has None</caption>
1043 <!-- ============================== footer ================================= -->
1044 <div class="fineprint" style="clear:both">
1046 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Mon Apr 07 2014 16:08:34 GMT+0800 (HKT)
1048 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>