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.RowSelectionModel</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.RowSelectionModel-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.grid.RowSelectionModel-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.grid.RowSelectionModel-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.grid.RowSelectionModel-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 src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.grid.AbstractSelectionModel.html#constructor" roo:cls="Roo.grid.AbstractSelectionModel.html#constructor">Roo.grid.AbstractSelectionModel</a>
48 <img src="../../images/default/s.gif" height="1" width="40"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.grid.RowSelectionModel
53 <!-- ============================== class title / details ============================ -->
56 <h1 class="classTitle">
58 Class Roo.grid.RowSelectionModel
61 <table cellspacing="0" class="class-summary-table">
63 <tr><td class="label">Package:</td><td class="hd-info">Roo.grid</td></tr>
65 <tr><td class="label">Defined In:</td><td class="hd-info">
67 <a href="./src/Roo_grid_RowSelectionModel.js.html">Roo/grid/RowSelectionModel.js</a>.
70 <tr><td class="label">Class:</td><td class="hd-info">RowSelectionModel</td></tr>
75 <tr><td class="label">Extends:</td><td class="hd-info">
76 <a href="./Roo.grid.AbstractSelectionModel.html#constructor" roo:cls="Roo.grid.AbstractSelectionModel.html#constructor">Roo.grid.AbstractSelectionModel</a>
84 <!-- ============================== class summary ========================== -->
85 <div class="description">
86 The default SelectionModel used by {<b>link</b> Roo.grid.Grid}.<br/>It supports multiple selections and keyboard selection/navigation.
90 <!-- ============================== Class comment block... ========================== -->
92 <div class="comments">
93 <b>Class Comments / Notes</B> =>
94 <u onclick="parent.CommentDialog.showCommentId = 'Roo.grid.RowSelectionModel';">[Add Your comment/notes about this class]</u>
96 <iframe frameborder="0" id="comments-Roo.grid" style="border: none;width:100%;"
97 src="/blog.php/GtkDjsComments/Roo.grid.RowSelectionModel.html"></iframe>
102 <!-- ============================== config options ========================== -->
107 <div class="hr"></div>
108 <a id="Roo.grid.RowSelectionModel-configs"></a>
114 <table cellspacing="0" class="member-table">
115 <caption>Config Options (Usually are also Properties)</caption>
119 <th class="sig-header" colspan="2">Options</th>
121 <th class="msource-header">Defined By</th>
128 <tr class="config-row expandable config-row-alt0">
129 <td class="micon"><a class="exi" href="#expand"> </a></td>
132 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
133 <div class="fixedFont">
134 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
140 <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>
144 <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>
152 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
158 <tr class="config-row expandable config-row-alt1 notInherited">
159 <td class="micon"><a class="exi" href="#expand"> </a></td>
162 <a id="Roo.grid.RowSelectionModel-cfg-singleSelect" name=".singleSelect"></a>
163 <div class="fixedFont">
164 <b class="itemname">singleSelect</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
170 <div class="short">True to allow selection of only one row at a time (defaults to false)</div>
174 <div class="long">True to allow selection of only one row at a time (defaults to false)</div>
182 Roo.grid.RowSelectionModel
198 <!-- ============================== public properties ==================== -->
202 <a id="Roo.grid.RowSelectionModel-props"></a>
208 <table cellspacing="0" class="member-table">
209 <caption class="Empty">Public Properties - Has None</caption>
215 <!-- ============================== methods summary / details ======================== -->
218 <a id="Roo.grid.RowSelectionModel-methods"></a>
219 <!-- constructor?? -->
226 <!-- then dynamics first -->
233 <table cellspacing="0" class="member-table">
234 <caption>Public Methods</caption>
236 <th class="sig-header" colspan="2">Method</th>
237 <th class="msource-header">Defined By</th>
247 <tr class="method-row config-row-alt0 expandable notInherited">
248 <td class="micon"><a class="exi" href="#expand"> </a></td>
252 <a id="Roo.grid-method-RowSelectionModel" name=".RowSelectionModel"></a>
253 <div class="fixedFont">
254 <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">RowSelectionModel</b>
256 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
264 <div class="short">Create a new Roo.grid.RowSelectionModel</div>
271 Create a new Roo.grid.RowSelectionModel
274 <dl class="detailList">
275 <dt class="heading">Parameters:</dt>
278 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
305 <tr class="method-row config-row-alt1 expandable">
306 <td class="micon"><a class="exi" href="#expand"> </a></td>
310 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
311 <div class="fixedFont">
312 <span class="attributes"></span><b class="itemname">addEvents</b>
314 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
321 <div class="short">Used to define events on this Observable</div>
327 Used to define events on this Observable
334 <dl class="detailList">
335 <dt class="heading">Parameters:</dt>
338 <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>
341 <dd>The object with the events defined</dd>
361 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
367 <tr class="method-row config-row-alt0 expandable">
368 <td class="micon"><a class="exi" href="#expand"> </a></td>
372 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
373 <div class="fixedFont">
374 <span class="attributes"></span><b class="itemname">addListener</b>
376 (<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>)
383 <div class="short">Appends an event handler to this component</div>
389 Appends an event handler to this component
396 <dl class="detailList">
397 <dt class="heading">Parameters:</dt>
400 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
403 <dd>The type of event to listen for</dd>
406 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
409 <dd>The method the event invokes</dd>
412 <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>
415 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
418 <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>
421 <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>
441 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
447 <tr class="method-row config-row-alt1 expandable notInherited">
448 <td class="micon"><a class="exi" href="#expand"> </a></td>
452 <a id="Roo.grid.RowSelectionModel-method-clearSelections" name=".clearSelections"></a>
453 <div class="fixedFont">
454 <span class="attributes"></span><b class="itemname">clearSelections</b>
463 <div class="short">Clears all selections.</div>
469 Clears all selections.
492 Roo.grid.RowSelectionModel
498 <tr class="method-row config-row-alt0 expandable notInherited">
499 <td class="micon"><a class="exi" href="#expand"> </a></td>
503 <a id="Roo.grid.RowSelectionModel-method-deselectRange" name=".deselectRange"></a>
504 <div class="fixedFont">
505 <span class="attributes"></span><b class="itemname">deselectRange</b>
507 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>startRow</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>endRow</i></B>)
514 <div class="short">Deselects a range of rows.</div>
520 Deselects a range of rows. All rows in between startRow and endRow are also deselected.
527 <dl class="detailList">
528 <dt class="heading">Parameters:</dt>
531 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>startRow</b>
534 <dd>The index of the first row in the range</dd>
537 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>endRow</b>
540 <dd>The index of the last row in the range</dd>
560 Roo.grid.RowSelectionModel
566 <tr class="method-row config-row-alt1 expandable notInherited">
567 <td class="micon"><a class="exi" href="#expand"> </a></td>
571 <a id="Roo.grid.RowSelectionModel-method-deselectRow" name=".deselectRow"></a>
572 <div class="fixedFont">
573 <span class="attributes"></span><b class="itemname">deselectRow</b>
575 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>row</i></B>)
582 <div class="short">Deselects a row.</div>
595 <dl class="detailList">
596 <dt class="heading">Parameters:</dt>
599 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>row</b>
602 <dd>The index of the row to deselect</dd>
622 Roo.grid.RowSelectionModel
628 <tr class="method-row config-row-alt0 expandable">
629 <td class="micon"><a class="exi" href="#expand"> </a></td>
633 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
634 <div class="fixedFont">
635 <span class="attributes"></span><b class="itemname">fireEvent</b>
637 (<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>)
643 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
652 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
658 Fires the specified event with the passed parameters (minus the event name).
665 <dl class="detailList">
666 <dt class="heading">Parameters:</dt>
669 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
675 <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>
678 <dd>Variable number of parameters are passed to handlers</dd>
686 <dl class="detailList">
687 <dt class="heading">Returns:</dt>
689 <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>
705 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
711 <tr class="method-row config-row-alt1 expandable notInherited">
712 <td class="micon"><a class="exi" href="#expand"> </a></td>
716 <a id="Roo.grid.RowSelectionModel-method-getCount" name=".getCount"></a>
717 <div class="fixedFont">
718 <span class="attributes"></span><b class="itemname">getCount</b>
726 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
735 <div class="short">Gets the number of selected rows.</div>
741 Gets the number of selected rows.
752 <dl class="detailList">
753 <dt class="heading">Returns:</dt>
755 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
771 Roo.grid.RowSelectionModel
777 <tr class="method-row config-row-alt0 expandable notInherited">
778 <td class="micon"><a class="exi" href="#expand"> </a></td>
782 <a id="Roo.grid.RowSelectionModel-method-getSelected" name=".getSelected"></a>
783 <div class="fixedFont">
784 <span class="attributes"></span><b class="itemname">getSelected</b>
801 <div class="short">Returns the first selected record.</div>
807 Returns the first selected record.
818 <dl class="detailList">
819 <dt class="heading">Returns:</dt>
821 <dd><span class="fixedFont">Record</span> </dd>
837 Roo.grid.RowSelectionModel
843 <tr class="method-row config-row-alt1 expandable notInherited">
844 <td class="micon"><a class="exi" href="#expand"> </a></td>
848 <a id="Roo.grid.RowSelectionModel-method-getSelections" name=".getSelections"></a>
849 <div class="fixedFont">
850 <span class="attributes"></span><b class="itemname">getSelections</b>
858 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
867 <div class="short">Returns the selected records</div>
873 Returns the selected records
884 <dl class="detailList">
885 <dt class="heading">Returns:</dt>
887 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> Array of selected records</dd>
903 Roo.grid.RowSelectionModel
909 <tr class="method-row config-row-alt0 expandable">
910 <td class="micon"><a class="exi" href="#expand"> </a></td>
914 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
915 <div class="fixedFont">
916 <span class="attributes"></span><b class="itemname">hasListener</b>
918 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
924 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
933 <div class="short">Checks to see if this object has any listeners for a specified event</div>
939 Checks to see if this object has any listeners for a specified event
946 <dl class="detailList">
947 <dt class="heading">Parameters:</dt>
950 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
953 <dd>The name of the event to check for</dd>
961 <dl class="detailList">
962 <dt class="heading">Returns:</dt>
964 <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>
980 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
986 <tr class="method-row config-row-alt1 expandable notInherited">
987 <td class="micon"><a class="exi" href="#expand"> </a></td>
991 <a id="Roo.grid.RowSelectionModel-method-hasSelection" name=".hasSelection"></a>
992 <div class="fixedFont">
993 <span class="attributes"></span><b class="itemname">hasSelection</b>
1001 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1010 <div class="short">Returns True if there is a selection.</div>
1016 Returns True if there is a selection.
1027 <dl class="detailList">
1028 <dt class="heading">Returns:</dt>
1030 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
1044 <td class="msource">
1046 Roo.grid.RowSelectionModel
1052 <tr class="method-row config-row-alt0 expandable notInherited">
1053 <td class="micon"><a class="exi" href="#expand"> </a></td>
1057 <a id="Roo.grid.RowSelectionModel-method-isIdSelected" name=".isIdSelected"></a>
1058 <div class="fixedFont">
1059 <span class="attributes"></span><b class="itemname">isIdSelected</b>
1061 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1067 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1076 <div class="short">Returns True if the specified record id is selected.</div>
1082 Returns True if the specified record id is selected.
1089 <dl class="detailList">
1090 <dt class="heading">Parameters:</dt>
1093 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1096 <dd>The id of record to check</dd>
1104 <dl class="detailList">
1105 <dt class="heading">Returns:</dt>
1107 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
1121 <td class="msource">
1123 Roo.grid.RowSelectionModel
1129 <tr class="method-row config-row-alt1 expandable">
1130 <td class="micon"><a class="exi" href="#expand"> </a></td>
1134 <a id="Roo.grid.AbstractSelectionModel-method-isLocked" name=".isLocked"></a>
1135 <div class="fixedFont">
1136 <span class="attributes"></span><b class="itemname">isLocked</b>
1144 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1153 <div class="short">Returns true if the selections are locked.</div>
1159 Returns true if the selections are locked.
1170 <dl class="detailList">
1171 <dt class="heading">Returns:</dt>
1173 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
1187 <td class="msource">
1189 <a href="./Roo.grid.AbstractSelectionModel.html#constructor" roo:cls="Roo.grid.AbstractSelectionModel.html#constructor">Roo.grid.AbstractSelectionModel</a>
1195 <tr class="method-row config-row-alt0 expandable notInherited">
1196 <td class="micon"><a class="exi" href="#expand"> </a></td>
1200 <a id="Roo.grid.RowSelectionModel-method-isSelected" name=".isSelected"></a>
1201 <div class="fixedFont">
1202 <span class="attributes"></span><b class="itemname">isSelected</b>
1204 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/Record <B><i>record</i></B>)
1210 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1219 <div class="short">Returns True if the specified row is selected.</div>
1225 Returns True if the specified row is selected.
1232 <dl class="detailList">
1233 <dt class="heading">Parameters:</dt>
1236 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/Record</span> <b>record</b>
1239 <dd>The record or index of the record to check</dd>
1247 <dl class="detailList">
1248 <dt class="heading">Returns:</dt>
1250 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
1264 <td class="msource">
1266 Roo.grid.RowSelectionModel
1272 <tr class="method-row config-row-alt1 expandable">
1273 <td class="micon"><a class="exi" href="#expand"> </a></td>
1277 <a id="Roo.grid.AbstractSelectionModel-method-lock" name=".lock"></a>
1278 <div class="fixedFont">
1279 <span class="attributes"></span><b class="itemname">lock</b>
1288 <div class="short">Locks the selections.</div>
1294 Locks the selections.
1315 <td class="msource">
1317 <a href="./Roo.grid.AbstractSelectionModel.html#constructor" roo:cls="Roo.grid.AbstractSelectionModel.html#constructor">Roo.grid.AbstractSelectionModel</a>
1323 <tr class="method-row config-row-alt0 expandable">
1324 <td class="micon"><a class="exi" href="#expand"> </a></td>
1328 <a id="Roo.util.Observable-method-on" name=".on"></a>
1329 <div class="fixedFont">
1330 <span class="attributes"></span><b class="itemname">on</b>
1332 (<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>)
1339 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1345 Appends an event handler to this element (shorthand for addListener)
1352 <dl class="detailList">
1353 <dt class="heading">Parameters:</dt>
1356 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1359 <dd>The type of event to listen for</dd>
1362 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1365 <dd>The method the event invokes</dd>
1368 <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>
1371 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1374 <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>
1395 <td class="msource">
1397 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1403 <tr class="method-row config-row-alt1 expandable">
1404 <td class="micon"><a class="exi" href="#expand"> </a></td>
1408 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1409 <div class="fixedFont">
1410 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1419 <div class="short">Removes all listeners for this object</div>
1425 Removes all listeners for this object
1446 <td class="msource">
1448 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1454 <tr class="method-row config-row-alt0 expandable">
1455 <td class="micon"><a class="exi" href="#expand"> </a></td>
1459 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1460 <div class="fixedFont">
1461 <span class="attributes"></span><b class="itemname">removeListener</b>
1463 (<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>)
1470 <div class="short">Removes a listener</div>
1483 <dl class="detailList">
1484 <dt class="heading">Parameters:</dt>
1487 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1490 <dd>The type of event to listen for</dd>
1493 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1496 <dd>The handler to remove</dd>
1499 <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>
1502 <dd>(optional) The scope (this object) for the handler</dd>
1520 <td class="msource">
1522 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1528 <tr class="method-row config-row-alt1 expandable notInherited">
1529 <td class="micon"><a class="exi" href="#expand"> </a></td>
1533 <a id="Roo.grid.RowSelectionModel-method-selectAll" name=".selectAll"></a>
1534 <div class="fixedFont">
1535 <span class="attributes"></span><b class="itemname">selectAll</b>
1544 <div class="short">Selects all rows.</div>
1571 <td class="msource">
1573 Roo.grid.RowSelectionModel
1579 <tr class="method-row config-row-alt0 expandable notInherited">
1580 <td class="micon"><a class="exi" href="#expand"> </a></td>
1584 <a id="Roo.grid.RowSelectionModel-method-selectFirstRow" name=".selectFirstRow"></a>
1585 <div class="fixedFont">
1586 <span class="attributes"></span><b class="itemname">selectFirstRow</b>
1595 <div class="short">Selects the first row in the grid.</div>
1601 Selects the first row in the grid.
1622 <td class="msource">
1624 Roo.grid.RowSelectionModel
1630 <tr class="method-row config-row-alt1 expandable notInherited">
1631 <td class="micon"><a class="exi" href="#expand"> </a></td>
1635 <a id="Roo.grid.RowSelectionModel-method-selectLastRow" name=".selectLastRow"></a>
1636 <div class="fixedFont">
1637 <span class="attributes"></span><b class="itemname">selectLastRow</b>
1639 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>keepExisting</i></B>)
1646 <div class="short">Select the last row.</div>
1652 Select the last row.
1659 <dl class="detailList">
1660 <dt class="heading">Parameters:</dt>
1663 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>keepExisting</b>
1666 <dd>(optional) True to keep existing selections</dd>
1684 <td class="msource">
1686 Roo.grid.RowSelectionModel
1692 <tr class="method-row config-row-alt0 expandable notInherited">
1693 <td class="micon"><a class="exi" href="#expand"> </a></td>
1697 <a id="Roo.grid.RowSelectionModel-method-selectNext" name=".selectNext"></a>
1698 <div class="fixedFont">
1699 <span class="attributes"></span><b class="itemname">selectNext</b>
1701 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>keepExisting</i></B>)
1708 <div class="short">Selects the row immediately following the last selected row.</div>
1714 Selects the row immediately following the last selected row.
1721 <dl class="detailList">
1722 <dt class="heading">Parameters:</dt>
1725 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>keepExisting</b>
1728 <dd>(optional) True to keep existing selections</dd>
1746 <td class="msource">
1748 Roo.grid.RowSelectionModel
1754 <tr class="method-row config-row-alt1 expandable notInherited">
1755 <td class="micon"><a class="exi" href="#expand"> </a></td>
1759 <a id="Roo.grid.RowSelectionModel-method-selectPrevious" name=".selectPrevious"></a>
1760 <div class="fixedFont">
1761 <span class="attributes"></span><b class="itemname">selectPrevious</b>
1763 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>keepExisting</i></B>)
1770 <div class="short">Selects the row that precedes the last selected row.</div>
1776 Selects the row that precedes the last selected row.
1783 <dl class="detailList">
1784 <dt class="heading">Parameters:</dt>
1787 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>keepExisting</b>
1790 <dd>(optional) True to keep existing selections</dd>
1808 <td class="msource">
1810 Roo.grid.RowSelectionModel
1816 <tr class="method-row config-row-alt0 expandable notInherited">
1817 <td class="micon"><a class="exi" href="#expand"> </a></td>
1821 <a id="Roo.grid.RowSelectionModel-method-selectRange" name=".selectRange"></a>
1822 <div class="fixedFont">
1823 <span class="attributes"></span><b class="itemname">selectRange</b>
1825 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>startRow</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>endRow</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>keepExisting</i></B>)
1832 <div class="short">Selects a range of rows.</div>
1838 Selects a range of rows. All rows in between startRow and endRow are also selected.
1845 <dl class="detailList">
1846 <dt class="heading">Parameters:</dt>
1849 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>startRow</b>
1852 <dd>The index of the first row in the range</dd>
1855 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>endRow</b>
1858 <dd>The index of the last row in the range</dd>
1861 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>keepExisting</b>
1864 <dd>(optional) True to retain existing selections</dd>
1882 <td class="msource">
1884 Roo.grid.RowSelectionModel
1890 <tr class="method-row config-row-alt1 expandable notInherited">
1891 <td class="micon"><a class="exi" href="#expand"> </a></td>
1895 <a id="Roo.grid.RowSelectionModel-method-selectRecords" name=".selectRecords"></a>
1896 <div class="fixedFont">
1897 <span class="attributes"></span><b class="itemname">selectRecords</b>
1899 (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a> <B><i>records</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>keepExisting</i></B>)
1906 <div class="short">Select records.</div>
1919 <dl class="detailList">
1920 <dt class="heading">Parameters:</dt>
1923 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> <b>records</b>
1926 <dd>The records to select</dd>
1929 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>keepExisting</b>
1932 <dd>(optional) True to keep existing selections</dd>
1950 <td class="msource">
1952 Roo.grid.RowSelectionModel
1958 <tr class="method-row config-row-alt0 expandable notInherited">
1959 <td class="micon"><a class="exi" href="#expand"> </a></td>
1963 <a id="Roo.grid.RowSelectionModel-method-selectRow" name=".selectRow"></a>
1964 <div class="fixedFont">
1965 <span class="attributes"></span><b class="itemname">selectRow</b>
1967 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>row</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>keepExisting</i></B>)
1974 <div class="short">Selects a row.</div>
1987 <dl class="detailList">
1988 <dt class="heading">Parameters:</dt>
1991 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>row</b>
1994 <dd>The index of the row to select</dd>
1997 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>keepExisting</b>
2000 <dd>(optional) True to keep existing selections</dd>
2018 <td class="msource">
2020 Roo.grid.RowSelectionModel
2026 <tr class="method-row config-row-alt1 expandable notInherited">
2027 <td class="micon"><a class="exi" href="#expand"> </a></td>
2031 <a id="Roo.grid.RowSelectionModel-method-selectRows" name=".selectRows"></a>
2032 <div class="fixedFont">
2033 <span class="attributes"></span><b class="itemname">selectRows</b>
2035 (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a> <B><i>rows</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>keepExisting</i></B>)
2042 <div class="short">Selects multiple rows.</div>
2048 Selects multiple rows.
2055 <dl class="detailList">
2056 <dt class="heading">Parameters:</dt>
2059 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> <b>rows</b>
2062 <dd>Array of the indexes of the row to select</dd>
2065 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>keepExisting</b>
2068 <dd>(optional) True to keep existing selections</dd>
2086 <td class="msource">
2088 Roo.grid.RowSelectionModel
2094 <tr class="method-row config-row-alt0 expandable">
2095 <td class="micon"><a class="exi" href="#expand"> </a></td>
2099 <a id="Roo.util.Observable-method-un" name=".un"></a>
2100 <div class="fixedFont">
2101 <span class="attributes"></span><b class="itemname">un</b>
2103 (<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>)
2110 <div class="short">Removes a listener (shorthand for removeListener)</div>
2116 Removes a listener (shorthand for removeListener)
2123 <dl class="detailList">
2124 <dt class="heading">Parameters:</dt>
2127 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2130 <dd>The type of event to listen for</dd>
2133 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2136 <dd>The handler to remove</dd>
2139 <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>
2142 <dd>(optional) The scope (this object) for the handler</dd>
2160 <td class="msource">
2162 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2168 <tr class="method-row config-row-alt1 expandable">
2169 <td class="micon"><a class="exi" href="#expand"> </a></td>
2173 <a id="Roo.grid.AbstractSelectionModel-method-unlock" name=".unlock"></a>
2174 <div class="fixedFont">
2175 <span class="attributes"></span><b class="itemname">unlock</b>
2184 <div class="short">Unlocks the selections.</div>
2190 Unlocks the selections.
2211 <td class="msource">
2213 <a href="./Roo.grid.AbstractSelectionModel.html#constructor" roo:cls="Roo.grid.AbstractSelectionModel.html#constructor">Roo.grid.AbstractSelectionModel</a>
2222 <!-- ============================== events summary / details ======================== -->
2225 <a id="Roo.grid.RowSelectionModel-events"></a>
2234 <table cellspacing="0" class="member-table">
2235 <caption>Events</caption>
2238 <th class="sig-header" colspan="2">Event</th>
2239 <th class="msource-header">Defined By</th>
2248 <tr class="method-row expandable config-row-alt0 notInherited">
2249 <td class="micon"><a class="exi" href="#expand"> </a></td>
2252 <a id="Roo.grid.RowSelectionModel-event-*afterselectionchange"></a>
2254 <div class="fixedFont">
2255 <b class="itemname">afterselectionchange</b> (SelectionModel <B><i>this</i></B>)
2261 <div class="short">Fires after the selection changes (eg.
2267 Fires after the selection changes (eg. by key press or clicking)
2273 <dl class="detailList">
2274 <dt class="heading">Parameters:</dt>
2277 <span class="fixedFont">SelectionModel</span> <b>this</b>
2298 <td class="msource">
2299 Roo.grid.RowSelectionModel
2303 <tr class="method-row expandable config-row-alt1 notInherited">
2304 <td class="micon"><a class="exi" href="#expand"> </a></td>
2307 <a id="Roo.grid.RowSelectionModel-event-*beforerowselect"></a>
2309 <div class="fixedFont">
2310 <b class="itemname">beforerowselect</b> (SelectionModel <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rowIndex</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>keepExisting</i></B>)
2316 <div class="short">Fires when a row is selected being selected, return false to cancel.
2322 Fires when a row is selected being selected, return false to cancel.
2328 <dl class="detailList">
2329 <dt class="heading">Parameters:</dt>
2332 <span class="fixedFont">SelectionModel</span> <b>this</b>
2338 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
2341 <dd>The selected index</dd>
2344 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>keepExisting</b>
2347 <dd>False if other selections will be cleared</dd>
2365 <td class="msource">
2366 Roo.grid.RowSelectionModel
2370 <tr class="method-row expandable config-row-alt0 notInherited">
2371 <td class="micon"><a class="exi" href="#expand"> </a></td>
2374 <a id="Roo.grid.RowSelectionModel-event-*rowdeselect"></a>
2376 <div class="fixedFont">
2377 <b class="itemname">rowdeselect</b> (SelectionModel <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rowIndex</i></B>)
2383 <div class="short">Fires when a row is deselected.
2389 Fires when a row is deselected.
2395 <dl class="detailList">
2396 <dt class="heading">Parameters:</dt>
2399 <span class="fixedFont">SelectionModel</span> <b>this</b>
2405 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
2408 <dd>The selected index</dd>
2426 <td class="msource">
2427 Roo.grid.RowSelectionModel
2431 <tr class="method-row expandable config-row-alt1 notInherited">
2432 <td class="micon"><a class="exi" href="#expand"> </a></td>
2435 <a id="Roo.grid.RowSelectionModel-event-*rowselect"></a>
2437 <div class="fixedFont">
2438 <b class="itemname">rowselect</b> (SelectionModel <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rowIndex</i></B>, <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a> <B><i>r</i></B>)
2444 <div class="short">Fires when a row is selected.
2450 Fires when a row is selected.
2456 <dl class="detailList">
2457 <dt class="heading">Parameters:</dt>
2460 <span class="fixedFont">SelectionModel</span> <b>this</b>
2466 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
2469 <dd>The selected index</dd>
2472 <span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a></span> <b>r</b>
2493 <td class="msource">
2494 Roo.grid.RowSelectionModel
2498 <tr class="method-row expandable config-row-alt0 notInherited">
2499 <td class="micon"><a class="exi" href="#expand"> </a></td>
2502 <a id="Roo.grid.RowSelectionModel-event-*selectionchange"></a>
2504 <div class="fixedFont">
2505 <b class="itemname">selectionchange</b> (SelectionModel <B><i>this</i></B>)
2511 <div class="short">Fires when the selection changes
2517 Fires when the selection changes
2523 <dl class="detailList">
2524 <dt class="heading">Parameters:</dt>
2527 <span class="fixedFont">SelectionModel</span> <b>this</b>
2548 <td class="msource">
2549 Roo.grid.RowSelectionModel
2560 <!-- ============================== footer ================================= -->
2561 <div class="fineprint" style="clear:both">
2563 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu Apr 24 2014 16:54:40 GMT+0800 (HKT)
2565 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>