git.roojs.org Git - roojs1/blob - docs/symbols/Roo.grid.RowSelectionModel.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.RowSelectionModel</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.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>
  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 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
  49
  50                    </pre>
  51                 </div>
  52
  53 <!-- ============================== class title / details ============================ -->
  54
  55
  56     <h1 class="classTitle">
  57
  58                                 Class Roo.grid.RowSelectionModel
  59                         </h1>
  60
  61     <table cellspacing="0" class="class-summary-table">
  62
  63                 <tr><td class="label">Package:</td><td class="hd-info">Roo.grid</td></tr>
  64
  65         <tr><td class="label">Defined In:</td><td class="hd-info">
  66
  67                                         <a href="./src/Roo_grid_RowSelectionModel.js.html">Roo/grid/RowSelectionModel.js</a>.
  68
  69         </td></tr>
  70         <tr><td class="label">Class:</td><td class="hd-info">RowSelectionModel</td></tr>
  71
  72
  73
  74
  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>
  77
  78                 </td></tr>
  79
  80
  81     </table>
  82
  83
  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.
  87     </div>
  88
  89
  90 <!-- ============================== Class comment block... ========================== -->
  91
  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>
  95         <br/>
  96         <iframe frameborder="0"  id="comments-Roo.grid" style="border: none;width:100%;"
  97                 src="/blog.php/GtkDjsComments/Roo.grid.RowSelectionModel.html"></iframe>
  98 </div>
  99
 100
 101
 102 <!-- ============================== config options ========================== -->
 103
 104
 105
 106
 107     <div class="hr"></div>
 108     <a id="Roo.grid.RowSelectionModel-configs"></a>
 109
 110
 111
 112
 113
 114       <table cellspacing="0" class="member-table">
 115       <caption>Config Options (Usually are also Properties)</caption>
 116
 117
 118         <tr>
 119             <th class="sig-header" colspan="2">Options</th>
 120
 121             <th class="msource-header">Defined By</th>
 122         </tr>
 123
 124
 125
 126
 127
 128                 <tr class="config-row expandable config-row-alt0">
 129                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 130                     <td class="sig">
 131
 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>
 135
 136
 137                         </div>
 138
 139                         <div class="mdesc">
 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>
 141                         </div>
 142
 143                         <div class="mdesc">
 144                             <div class="long">
 145                     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>
 146
 147                 </div>
 148                         </div>
 149
 150
 151
 152                     </td>
 153                     <td class="msource">
 154
 155                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 156
 157                     </td>
 158                 </tr>
 159
 160
 161                 <tr class="config-row expandable config-row-alt1 notInherited">
 162                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 163                     <td class="sig">
 164
 165                         <a id="Roo.grid.RowSelectionModel-cfg-singleSelect" name=".singleSelect"></a>
 166                         <div class="fixedFont">
 167                                 <b  class="itemname">singleSelect</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 168
 169
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="short">True to allow selection of only one row at a time (defaults to false)</div>
 174                         </div>
 175
 176                         <div class="mdesc">
 177                             <div class="long">
 178                     True to allow selection of only one row at a time (defaults to false)
 179
 180                 </div>
 181                         </div>
 182
 183
 184
 185                     </td>
 186                     <td class="msource">
 187
 188                         Roo.grid.RowSelectionModel
 189
 190                     </td>
 191                 </tr>
 192
 193
 194     </table>
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204   <!-- ============================== public properties ==================== -->
 205
 206
 207
 208     <a id="Roo.grid.RowSelectionModel-props"></a>
 209
 210
 211
 212
 213
 214      <table cellspacing="0" class="member-table">
 215       <caption class="Empty">Public Properties - Has None</caption>
 216      </table>
 217
 218
 219
 220
 221   <!-- ============================== methods summary / details ======================== -->
 222
 223
 224   <a id="Roo.grid.RowSelectionModel-methods"></a>
 225         <!-- constructor?? -->
 226
 227         <!-- static's first
 228
 229
 230         -->
 231
 232         <!-- then dynamics first -->
 233
 234
 235
 236
 237
 238
 239       <table cellspacing="0" class="member-table">
 240       <caption>Public Methods</caption>
 241         <tr>
 242             <th class="sig-header" colspan="2">Method</th>
 243             <th class="msource-header">Defined By</th>
 244
 245         </tr>
 246
 247
 248
 249
 250
 251
 252
 253           <tr class="method-row config-row-alt0 expandable notInherited">
 254             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 255
 256
 257             <td class="sig">
 258                 <a id="Roo.grid-method-RowSelectionModel"   name=".RowSelectionModel"></a>
 259                 <div class="fixedFont">
 260                         <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">RowSelectionModel</b>
 261
 262                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 263
 264
 265
 266                 </div>
 267                 <div class="mdesc">
 268
 269
 270                         <div class="short">Create a new Roo.grid.RowSelectionModel</div>
 271
 272
 273                     <div class="long">
 274
 275
 276
 277                                 Create a new Roo.grid.RowSelectionModel
 278
 279
 280                                 <dl class="detailList">
 281                                 <dt class="heading">Parameters:</dt>
 282
 283                                         <dt>
 284                                                 <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>
 285
 286                                         </dt>
 287                                         <dd></dd>
 288
 289                                 </dl>
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301                     </div>
 302                 </div>
 303
 304             </td>
 305             <td class="msource">
 306                 &nbsp;
 307             </td>
 308         </tr>
 309
 310
 311           <tr class="method-row config-row-alt1 expandable">
 312             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 313
 314
 315             <td class="sig">
 316                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
 317                 <div class="fixedFont">
 318                         <span class="attributes"></span><b class="itemname">addEvents</b>
 319
 320                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
 321
 322
 323
 324                 </div>
 325                 <div class="mdesc">
 326
 327                    <div class="short">Used to define events on this Observable</div>
 328
 329
 330
 331                     <div class="long">
 332
 333                                 Used to define events on this Observable
 334
 335
 336
 337
 338
 339
 340                                 <dl class="detailList">
 341                                 <dt class="heading">Parameters:</dt>
 342
 343                                         <dt>
 344                                                 <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>
 345
 346                                         </dt>
 347                                         <dd>The object with the events defined</dd>
 348
 349                                 </dl>
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361                     </div>
 362                 </div>
 363
 364             </td>
 365             <td class="msource">
 366
 367                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 368                 &nbsp;
 369             </td>
 370         </tr>
 371
 372
 373           <tr class="method-row config-row-alt0 expandable">
 374             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 375
 376
 377             <td class="sig">
 378                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
 379                 <div class="fixedFont">
 380                         <span class="attributes"></span><b class="itemname">addListener</b>
 381
 382                                  (<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
 384
 385
 386                 </div>
 387                 <div class="mdesc">
 388
 389                    <div class="short">Appends an event handler to this component</div>
 390
 391
 392
 393                     <div class="long">
 394
 395                                 Appends an event handler to this component
 396
 397
 398
 399
 400
 401
 402                                 <dl class="detailList">
 403                                 <dt class="heading">Parameters:</dt>
 404
 405                                         <dt>
 406                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 407
 408                                         </dt>
 409                                         <dd>The type of event to listen for</dd>
 410
 411                                         <dt>
 412                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 413
 414                                         </dt>
 415                                         <dd>The method the event invokes</dd>
 416
 417                                         <dt>
 418                                                 <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>
 419
 420                                         </dt>
 421                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 422
 423                                         <dt>
 424                                                 <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>
 425
 426                                         </dt>
 427                                         <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>
 428
 429                                 </dl>
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441                     </div>
 442                 </div>
 443
 444             </td>
 445             <td class="msource">
 446
 447                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 448                 &nbsp;
 449             </td>
 450         </tr>
 451
 452
 453           <tr class="method-row config-row-alt1 expandable notInherited">
 454             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 455
 456
 457             <td class="sig">
 458                 <a id="Roo.grid.RowSelectionModel-method-clearSelections"   name=".clearSelections"></a>
 459                 <div class="fixedFont">
 460                         <span class="attributes"></span><b class="itemname">clearSelections</b>
 461
 462                                  ()
 463
 464
 465
 466                 </div>
 467                 <div class="mdesc">
 468
 469                    <div class="short">Clears all selections.</div>
 470
 471
 472
 473                     <div class="long">
 474
 475                                 Clears all selections.
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492                     </div>
 493                 </div>
 494
 495             </td>
 496             <td class="msource">
 497
 498                         Roo.grid.RowSelectionModel
 499                 &nbsp;
 500             </td>
 501         </tr>
 502
 503
 504           <tr class="method-row config-row-alt0 expandable notInherited">
 505             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 506
 507
 508             <td class="sig">
 509                 <a id="Roo.grid.RowSelectionModel-method-deselectRange"   name=".deselectRange"></a>
 510                 <div class="fixedFont">
 511                         <span class="attributes"></span><b class="itemname">deselectRange</b>
 512
 513                                  (<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
 515
 516
 517                 </div>
 518                 <div class="mdesc">
 519
 520                    <div class="short">Deselects a range of rows.</div>
 521
 522
 523
 524                     <div class="long">
 525
 526                                 Deselects a range of rows. All rows in between startRow and endRow are also deselected.
 527
 528
 529
 530
 531
 532
 533                                 <dl class="detailList">
 534                                 <dt class="heading">Parameters:</dt>
 535
 536                                         <dt>
 537                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>startRow</b>
 538
 539                                         </dt>
 540                                         <dd>The index of the first row in the range</dd>
 541
 542                                         <dt>
 543                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>endRow</b>
 544
 545                                         </dt>
 546                                         <dd>The index of the last row in the range</dd>
 547
 548                                 </dl>
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560                     </div>
 561                 </div>
 562
 563             </td>
 564             <td class="msource">
 565
 566                         Roo.grid.RowSelectionModel
 567                 &nbsp;
 568             </td>
 569         </tr>
 570
 571
 572           <tr class="method-row config-row-alt1 expandable notInherited">
 573             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 574
 575
 576             <td class="sig">
 577                 <a id="Roo.grid.RowSelectionModel-method-deselectRow"   name=".deselectRow"></a>
 578                 <div class="fixedFont">
 579                         <span class="attributes"></span><b class="itemname">deselectRow</b>
 580
 581                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>row</i></B>)
 582
 583
 584
 585                 </div>
 586                 <div class="mdesc">
 587
 588                    <div class="short">Deselects a row.</div>
 589
 590
 591
 592                     <div class="long">
 593
 594                                 Deselects a row.
 595
 596
 597
 598
 599
 600
 601                                 <dl class="detailList">
 602                                 <dt class="heading">Parameters:</dt>
 603
 604                                         <dt>
 605                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>row</b>
 606
 607                                         </dt>
 608                                         <dd>The index of the row to deselect</dd>
 609
 610                                 </dl>
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622                     </div>
 623                 </div>
 624
 625             </td>
 626             <td class="msource">
 627
 628                         Roo.grid.RowSelectionModel
 629                 &nbsp;
 630             </td>
 631         </tr>
 632
 633
 634           <tr class="method-row config-row-alt0 expandable">
 635             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 636
 637
 638             <td class="sig">
 639                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
 640                 <div class="fixedFont">
 641                         <span class="attributes"></span><b class="itemname">fireEvent</b>
 642
 643                                  (<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>)
 644
 645
 646                                          :
 647
 648
 649                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 650
 651
 652
 653
 654
 655                 </div>
 656                 <div class="mdesc">
 657
 658                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
 659
 660
 661
 662                     <div class="long">
 663
 664                                 Fires the specified event with the passed parameters (minus the event name).
 665
 666
 667
 668
 669
 670
 671                                 <dl class="detailList">
 672                                 <dt class="heading">Parameters:</dt>
 673
 674                                         <dt>
 675                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 676
 677                                         </dt>
 678                                         <dd></dd>
 679
 680                                         <dt>
 681                                                 <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>
 682
 683                                         </dt>
 684                                         <dd>Variable number of parameters are passed to handlers</dd>
 685
 686                                 </dl>
 687
 688
 689
 690
 691
 692                                 <dl class="detailList">
 693                                 <dt class="heading">Returns:</dt>
 694
 695                                         <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>
 696
 697                                 </dl>
 698
 699
 700
 701
 702
 703
 704
 705                     </div>
 706                 </div>
 707
 708             </td>
 709             <td class="msource">
 710
 711                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 712                 &nbsp;
 713             </td>
 714         </tr>
 715
 716
 717           <tr class="method-row config-row-alt1 expandable notInherited">
 718             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 719
 720
 721             <td class="sig">
 722                 <a id="Roo.grid.RowSelectionModel-method-getCount"   name=".getCount"></a>
 723                 <div class="fixedFont">
 724                         <span class="attributes"></span><b class="itemname">getCount</b>
 725
 726                                  ()
 727
 728
 729                                          :
 730
 731
 732                                                 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 733
 734
 735
 736
 737
 738                 </div>
 739                 <div class="mdesc">
 740
 741                    <div class="short">Gets the number of selected rows.</div>
 742
 743
 744
 745                     <div class="long">
 746
 747                                 Gets the number of selected rows.
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758                                 <dl class="detailList">
 759                                 <dt class="heading">Returns:</dt>
 760
 761                                         <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  </dd>
 762
 763                                 </dl>
 764
 765
 766
 767
 768
 769
 770
 771                     </div>
 772                 </div>
 773
 774             </td>
 775             <td class="msource">
 776
 777                         Roo.grid.RowSelectionModel
 778                 &nbsp;
 779             </td>
 780         </tr>
 781
 782
 783           <tr class="method-row config-row-alt0 expandable notInherited">
 784             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 785
 786
 787             <td class="sig">
 788                 <a id="Roo.grid.RowSelectionModel-method-getSelected"   name=".getSelected"></a>
 789                 <div class="fixedFont">
 790                         <span class="attributes"></span><b class="itemname">getSelected</b>
 791
 792                                  ()
 793
 794
 795                                          :
 796
 797
 798                                                 Record
 799
 800
 801
 802
 803
 804                 </div>
 805                 <div class="mdesc">
 806
 807                    <div class="short">Returns the first selected record.</div>
 808
 809
 810
 811                     <div class="long">
 812
 813                                 Returns the first selected record.
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824                                 <dl class="detailList">
 825                                 <dt class="heading">Returns:</dt>
 826
 827                                         <dd><span class="fixedFont">Record</span>  </dd>
 828
 829                                 </dl>
 830
 831
 832
 833
 834
 835
 836
 837                     </div>
 838                 </div>
 839
 840             </td>
 841             <td class="msource">
 842
 843                         Roo.grid.RowSelectionModel
 844                 &nbsp;
 845             </td>
 846         </tr>
 847
 848
 849           <tr class="method-row config-row-alt1 expandable notInherited">
 850             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 851
 852
 853             <td class="sig">
 854                 <a id="Roo.grid.RowSelectionModel-method-getSelections"   name=".getSelections"></a>
 855                 <div class="fixedFont">
 856                         <span class="attributes"></span><b class="itemname">getSelections</b>
 857
 858                                  ()
 859
 860
 861                                          :
 862
 863
 864                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 865
 866
 867
 868
 869
 870                 </div>
 871                 <div class="mdesc">
 872
 873                    <div class="short">Returns the selected records</div>
 874
 875
 876
 877                     <div class="long">
 878
 879                                 Returns the selected records
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890                                 <dl class="detailList">
 891                                 <dt class="heading">Returns:</dt>
 892
 893                                         <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  Array of selected records</dd>
 894
 895                                 </dl>
 896
 897
 898
 899
 900
 901
 902
 903                     </div>
 904                 </div>
 905
 906             </td>
 907             <td class="msource">
 908
 909                         Roo.grid.RowSelectionModel
 910                 &nbsp;
 911             </td>
 912         </tr>
 913
 914
 915           <tr class="method-row config-row-alt0 expandable">
 916             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 917
 918
 919             <td class="sig">
 920                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
 921                 <div class="fixedFont">
 922                         <span class="attributes"></span><b class="itemname">hasListener</b>
 923
 924                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
 925
 926
 927                                          :
 928
 929
 930                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 931
 932
 933
 934
 935
 936                 </div>
 937                 <div class="mdesc">
 938
 939                    <div class="short">Checks to see if this object has any listeners for a specified event</div>
 940
 941
 942
 943                     <div class="long">
 944
 945                                 Checks to see if this object has any listeners for a specified event
 946
 947
 948
 949
 950
 951
 952                                 <dl class="detailList">
 953                                 <dt class="heading">Parameters:</dt>
 954
 955                                         <dt>
 956                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 957
 958                                         </dt>
 959                                         <dd>The name of the event to check for</dd>
 960
 961                                 </dl>
 962
 963
 964
 965
 966
 967                                 <dl class="detailList">
 968                                 <dt class="heading">Returns:</dt>
 969
 970                                         <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>
 971
 972                                 </dl>
 973
 974
 975
 976
 977
 978
 979
 980                     </div>
 981                 </div>
 982
 983             </td>
 984             <td class="msource">
 985
 986                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 987                 &nbsp;
 988             </td>
 989         </tr>
 990
 991
 992           <tr class="method-row config-row-alt1 expandable notInherited">
 993             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 994
 995
 996             <td class="sig">
 997                 <a id="Roo.grid.RowSelectionModel-method-hasSelection"   name=".hasSelection"></a>
 998                 <div class="fixedFont">
 999                         <span class="attributes"></span><b class="itemname">hasSelection</b>
1000
1001                                  ()
1002
1003
1004                                          :
1005
1006
1007                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1008
1009
1010
1011
1012
1013                 </div>
1014                 <div class="mdesc">
1015
1016                    <div class="short">Returns True if there is a selection.</div>
1017
1018
1019
1020                     <div class="long">
1021
1022                                 Returns True if there is a selection.
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033                                 <dl class="detailList">
1034                                 <dt class="heading">Returns:</dt>
1035
1036                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
1037
1038                                 </dl>
1039
1040
1041
1042
1043
1044
1045
1046                     </div>
1047                 </div>
1048
1049             </td>
1050             <td class="msource">
1051
1052                         Roo.grid.RowSelectionModel
1053                 &nbsp;
1054             </td>
1055         </tr>
1056
1057
1058           <tr class="method-row config-row-alt0 expandable notInherited">
1059             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1060
1061
1062             <td class="sig">
1063                 <a id="Roo.grid.RowSelectionModel-method-isIdSelected"   name=".isIdSelected"></a>
1064                 <div class="fixedFont">
1065                         <span class="attributes"></span><b class="itemname">isIdSelected</b>
1066
1067                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1068
1069
1070                                          :
1071
1072
1073                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1074
1075
1076
1077
1078
1079                 </div>
1080                 <div class="mdesc">
1081
1082                    <div class="short">Returns True if the specified record id is selected.</div>
1083
1084
1085
1086                     <div class="long">
1087
1088                                 Returns True if the specified record id is selected.
1089
1090
1091
1092
1093
1094
1095                                 <dl class="detailList">
1096                                 <dt class="heading">Parameters:</dt>
1097
1098                                         <dt>
1099                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
1100
1101                                         </dt>
1102                                         <dd>The id of record to check</dd>
1103
1104                                 </dl>
1105
1106
1107
1108
1109
1110                                 <dl class="detailList">
1111                                 <dt class="heading">Returns:</dt>
1112
1113                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
1114
1115                                 </dl>
1116
1117
1118
1119
1120
1121
1122
1123                     </div>
1124                 </div>
1125
1126             </td>
1127             <td class="msource">
1128
1129                         Roo.grid.RowSelectionModel
1130                 &nbsp;
1131             </td>
1132         </tr>
1133
1134
1135           <tr class="method-row config-row-alt1 expandable">
1136             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1137
1138
1139             <td class="sig">
1140                 <a id="Roo.grid.AbstractSelectionModel-method-isLocked"   name=".isLocked"></a>
1141                 <div class="fixedFont">
1142                         <span class="attributes"></span><b class="itemname">isLocked</b>
1143
1144                                  ()
1145
1146
1147                                          :
1148
1149
1150                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1151
1152
1153
1154
1155
1156                 </div>
1157                 <div class="mdesc">
1158
1159                    <div class="short">Returns true if the selections are locked.</div>
1160
1161
1162
1163                     <div class="long">
1164
1165                                 Returns true if the selections are locked.
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176                                 <dl class="detailList">
1177                                 <dt class="heading">Returns:</dt>
1178
1179                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
1180
1181                                 </dl>
1182
1183
1184
1185
1186
1187
1188
1189                     </div>
1190                 </div>
1191
1192             </td>
1193             <td class="msource">
1194
1195                         <a href="./Roo.grid.AbstractSelectionModel.html#constructor" roo:cls="Roo.grid.AbstractSelectionModel.html#constructor">Roo.grid.AbstractSelectionModel</a>
1196                 &nbsp;
1197             </td>
1198         </tr>
1199
1200
1201           <tr class="method-row config-row-alt0 expandable notInherited">
1202             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1203
1204
1205             <td class="sig">
1206                 <a id="Roo.grid.RowSelectionModel-method-isSelected"   name=".isSelected"></a>
1207                 <div class="fixedFont">
1208                         <span class="attributes"></span><b class="itemname">isSelected</b>
1209
1210                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/Record <B><i>record</i></B>)
1211
1212
1213                                          :
1214
1215
1216                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1217
1218
1219
1220
1221
1222                 </div>
1223                 <div class="mdesc">
1224
1225                    <div class="short">Returns True if the specified row is selected.</div>
1226
1227
1228
1229                     <div class="long">
1230
1231                                 Returns True if the specified row is selected.
1232
1233
1234
1235
1236
1237
1238                                 <dl class="detailList">
1239                                 <dt class="heading">Parameters:</dt>
1240
1241                                         <dt>
1242                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/Record</span>  <b>record</b>
1243
1244                                         </dt>
1245                                         <dd>The record or index of the record to check</dd>
1246
1247                                 </dl>
1248
1249
1250
1251
1252
1253                                 <dl class="detailList">
1254                                 <dt class="heading">Returns:</dt>
1255
1256                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
1257
1258                                 </dl>
1259
1260
1261
1262
1263
1264
1265
1266                     </div>
1267                 </div>
1268
1269             </td>
1270             <td class="msource">
1271
1272                         Roo.grid.RowSelectionModel
1273                 &nbsp;
1274             </td>
1275         </tr>
1276
1277
1278           <tr class="method-row config-row-alt1 expandable">
1279             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1280
1281
1282             <td class="sig">
1283                 <a id="Roo.grid.AbstractSelectionModel-method-lock"   name=".lock"></a>
1284                 <div class="fixedFont">
1285                         <span class="attributes"></span><b class="itemname">lock</b>
1286
1287                                  ()
1288
1289
1290
1291                 </div>
1292                 <div class="mdesc">
1293
1294                    <div class="short">Locks the selections.</div>
1295
1296
1297
1298                     <div class="long">
1299
1300                                 Locks the selections.
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317                     </div>
1318                 </div>
1319
1320             </td>
1321             <td class="msource">
1322
1323                         <a href="./Roo.grid.AbstractSelectionModel.html#constructor" roo:cls="Roo.grid.AbstractSelectionModel.html#constructor">Roo.grid.AbstractSelectionModel</a>
1324                 &nbsp;
1325             </td>
1326         </tr>
1327
1328
1329           <tr class="method-row config-row-alt0 expandable">
1330             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1331
1332
1333             <td class="sig">
1334                 <a id="Roo.util.Observable-method-on"   name=".on"></a>
1335                 <div class="fixedFont">
1336                         <span class="attributes"></span><b class="itemname">on</b>
1337
1338                                  (<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
1340
1341
1342                 </div>
1343                 <div class="mdesc">
1344
1345                    <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1346
1347
1348
1349                     <div class="long">
1350
1351                                 Appends an event handler to this element (shorthand for addListener)
1352
1353
1354
1355
1356
1357
1358                                 <dl class="detailList">
1359                                 <dt class="heading">Parameters:</dt>
1360
1361                                         <dt>
1362                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1363
1364                                         </dt>
1365                                         <dd>The type of event to listen for</dd>
1366
1367                                         <dt>
1368                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1369
1370                                         </dt>
1371                                         <dd>The method the event invokes</dd>
1372
1373                                         <dt>
1374                                                 <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>
1375
1376                                         </dt>
1377                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1378
1379                                         <dt>
1380                                                 <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>
1381
1382                                         </dt>
1383                                         <dd>(optional)</dd>
1384
1385                                 </dl>
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397                     </div>
1398                 </div>
1399
1400             </td>
1401             <td class="msource">
1402
1403                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1404                 &nbsp;
1405             </td>
1406         </tr>
1407
1408
1409           <tr class="method-row config-row-alt1 expandable">
1410             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1411
1412
1413             <td class="sig">
1414                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
1415                 <div class="fixedFont">
1416                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
1417
1418                                  ()
1419
1420
1421
1422                 </div>
1423                 <div class="mdesc">
1424
1425                    <div class="short">Removes all listeners for this object</div>
1426
1427
1428
1429                     <div class="long">
1430
1431                                 Removes all listeners for this object
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448                     </div>
1449                 </div>
1450
1451             </td>
1452             <td class="msource">
1453
1454                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1455                 &nbsp;
1456             </td>
1457         </tr>
1458
1459
1460           <tr class="method-row config-row-alt0 expandable">
1461             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1462
1463
1464             <td class="sig">
1465                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
1466                 <div class="fixedFont">
1467                         <span class="attributes"></span><b class="itemname">removeListener</b>
1468
1469                                  (<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
1471
1472
1473                 </div>
1474                 <div class="mdesc">
1475
1476                    <div class="short">Removes a listener</div>
1477
1478
1479
1480                     <div class="long">
1481
1482                                 Removes a listener
1483
1484
1485
1486
1487
1488
1489                                 <dl class="detailList">
1490                                 <dt class="heading">Parameters:</dt>
1491
1492                                         <dt>
1493                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1494
1495                                         </dt>
1496                                         <dd>The type of event to listen for</dd>
1497
1498                                         <dt>
1499                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1500
1501                                         </dt>
1502                                         <dd>The handler to remove</dd>
1503
1504                                         <dt>
1505                                                 <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>
1506
1507                                         </dt>
1508                                         <dd>(optional) The scope (this object) for the handler</dd>
1509
1510                                 </dl>
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522                     </div>
1523                 </div>
1524
1525             </td>
1526             <td class="msource">
1527
1528                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1529                 &nbsp;
1530             </td>
1531         </tr>
1532
1533
1534           <tr class="method-row config-row-alt1 expandable notInherited">
1535             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1536
1537
1538             <td class="sig">
1539                 <a id="Roo.grid.RowSelectionModel-method-selectAll"   name=".selectAll"></a>
1540                 <div class="fixedFont">
1541                         <span class="attributes"></span><b class="itemname">selectAll</b>
1542
1543                                  ()
1544
1545
1546
1547                 </div>
1548                 <div class="mdesc">
1549
1550                    <div class="short">Selects all rows.</div>
1551
1552
1553
1554                     <div class="long">
1555
1556                                 Selects all rows.
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573                     </div>
1574                 </div>
1575
1576             </td>
1577             <td class="msource">
1578
1579                         Roo.grid.RowSelectionModel
1580                 &nbsp;
1581             </td>
1582         </tr>
1583
1584
1585           <tr class="method-row config-row-alt0 expandable notInherited">
1586             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1587
1588
1589             <td class="sig">
1590                 <a id="Roo.grid.RowSelectionModel-method-selectFirstRow"   name=".selectFirstRow"></a>
1591                 <div class="fixedFont">
1592                         <span class="attributes"></span><b class="itemname">selectFirstRow</b>
1593
1594                                  ()
1595
1596
1597
1598                 </div>
1599                 <div class="mdesc">
1600
1601                    <div class="short">Selects the first row in the grid.</div>
1602
1603
1604
1605                     <div class="long">
1606
1607                                 Selects the first row in the grid.
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624                     </div>
1625                 </div>
1626
1627             </td>
1628             <td class="msource">
1629
1630                         Roo.grid.RowSelectionModel
1631                 &nbsp;
1632             </td>
1633         </tr>
1634
1635
1636           <tr class="method-row config-row-alt1 expandable notInherited">
1637             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1638
1639
1640             <td class="sig">
1641                 <a id="Roo.grid.RowSelectionModel-method-selectLastRow"   name=".selectLastRow"></a>
1642                 <div class="fixedFont">
1643                         <span class="attributes"></span><b class="itemname">selectLastRow</b>
1644
1645                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>keepExisting</i></B>)
1646
1647
1648
1649                 </div>
1650                 <div class="mdesc">
1651
1652                    <div class="short">Select the last row.</div>
1653
1654
1655
1656                     <div class="long">
1657
1658                                 Select the last row.
1659
1660
1661
1662
1663
1664
1665                                 <dl class="detailList">
1666                                 <dt class="heading">Parameters:</dt>
1667
1668                                         <dt>
1669                                                 <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>
1670
1671                                         </dt>
1672                                         <dd>(optional) True to keep existing selections</dd>
1673
1674                                 </dl>
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686                     </div>
1687                 </div>
1688
1689             </td>
1690             <td class="msource">
1691
1692                         Roo.grid.RowSelectionModel
1693                 &nbsp;
1694             </td>
1695         </tr>
1696
1697
1698           <tr class="method-row config-row-alt0 expandable notInherited">
1699             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1700
1701
1702             <td class="sig">
1703                 <a id="Roo.grid.RowSelectionModel-method-selectNext"   name=".selectNext"></a>
1704                 <div class="fixedFont">
1705                         <span class="attributes"></span><b class="itemname">selectNext</b>
1706
1707                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>keepExisting</i></B>)
1708
1709
1710
1711                 </div>
1712                 <div class="mdesc">
1713
1714                    <div class="short">Selects the row immediately following the last selected row.</div>
1715
1716
1717
1718                     <div class="long">
1719
1720                                 Selects the row immediately following the last selected row.
1721
1722
1723
1724
1725
1726
1727                                 <dl class="detailList">
1728                                 <dt class="heading">Parameters:</dt>
1729
1730                                         <dt>
1731                                                 <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>
1732
1733                                         </dt>
1734                                         <dd>(optional) True to keep existing selections</dd>
1735
1736                                 </dl>
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748                     </div>
1749                 </div>
1750
1751             </td>
1752             <td class="msource">
1753
1754                         Roo.grid.RowSelectionModel
1755                 &nbsp;
1756             </td>
1757         </tr>
1758
1759
1760           <tr class="method-row config-row-alt1 expandable notInherited">
1761             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1762
1763
1764             <td class="sig">
1765                 <a id="Roo.grid.RowSelectionModel-method-selectPrevious"   name=".selectPrevious"></a>
1766                 <div class="fixedFont">
1767                         <span class="attributes"></span><b class="itemname">selectPrevious</b>
1768
1769                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>keepExisting</i></B>)
1770
1771
1772
1773                 </div>
1774                 <div class="mdesc">
1775
1776                    <div class="short">Selects the row that precedes the last selected row.</div>
1777
1778
1779
1780                     <div class="long">
1781
1782                                 Selects the row that precedes the last selected row.
1783
1784
1785
1786
1787
1788
1789                                 <dl class="detailList">
1790                                 <dt class="heading">Parameters:</dt>
1791
1792                                         <dt>
1793                                                 <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>
1794
1795                                         </dt>
1796                                         <dd>(optional) True to keep existing selections</dd>
1797
1798                                 </dl>
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810                     </div>
1811                 </div>
1812
1813             </td>
1814             <td class="msource">
1815
1816                         Roo.grid.RowSelectionModel
1817                 &nbsp;
1818             </td>
1819         </tr>
1820
1821
1822           <tr class="method-row config-row-alt0 expandable notInherited">
1823             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1824
1825
1826             <td class="sig">
1827                 <a id="Roo.grid.RowSelectionModel-method-selectRange"   name=".selectRange"></a>
1828                 <div class="fixedFont">
1829                         <span class="attributes"></span><b class="itemname">selectRange</b>
1830
1831                                  (<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
1833
1834
1835                 </div>
1836                 <div class="mdesc">
1837
1838                    <div class="short">Selects a range of rows.</div>
1839
1840
1841
1842                     <div class="long">
1843
1844                                 Selects a range of rows. All rows in between startRow and endRow are also selected.
1845
1846
1847
1848
1849
1850
1851                                 <dl class="detailList">
1852                                 <dt class="heading">Parameters:</dt>
1853
1854                                         <dt>
1855                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>startRow</b>
1856
1857                                         </dt>
1858                                         <dd>The index of the first row in the range</dd>
1859
1860                                         <dt>
1861                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>endRow</b>
1862
1863                                         </dt>
1864                                         <dd>The index of the last row in the range</dd>
1865
1866                                         <dt>
1867                                                 <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>
1868
1869                                         </dt>
1870                                         <dd>(optional) True to retain existing selections</dd>
1871
1872                                 </dl>
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884                     </div>
1885                 </div>
1886
1887             </td>
1888             <td class="msource">
1889
1890                         Roo.grid.RowSelectionModel
1891                 &nbsp;
1892             </td>
1893         </tr>
1894
1895
1896           <tr class="method-row config-row-alt1 expandable notInherited">
1897             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1898
1899
1900             <td class="sig">
1901                 <a id="Roo.grid.RowSelectionModel-method-selectRecords"   name=".selectRecords"></a>
1902                 <div class="fixedFont">
1903                         <span class="attributes"></span><b class="itemname">selectRecords</b>
1904
1905                                  (<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
1907
1908
1909                 </div>
1910                 <div class="mdesc">
1911
1912                    <div class="short">Select records.</div>
1913
1914
1915
1916                     <div class="long">
1917
1918                                 Select records.
1919
1920
1921
1922
1923
1924
1925                                 <dl class="detailList">
1926                                 <dt class="heading">Parameters:</dt>
1927
1928                                         <dt>
1929                                                 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  <b>records</b>
1930
1931                                         </dt>
1932                                         <dd>The records to select</dd>
1933
1934                                         <dt>
1935                                                 <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>
1936
1937                                         </dt>
1938                                         <dd>(optional) True to keep existing selections</dd>
1939
1940                                 </dl>
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952                     </div>
1953                 </div>
1954
1955             </td>
1956             <td class="msource">
1957
1958                         Roo.grid.RowSelectionModel
1959                 &nbsp;
1960             </td>
1961         </tr>
1962
1963
1964           <tr class="method-row config-row-alt0 expandable notInherited">
1965             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1966
1967
1968             <td class="sig">
1969                 <a id="Roo.grid.RowSelectionModel-method-selectRow"   name=".selectRow"></a>
1970                 <div class="fixedFont">
1971                         <span class="attributes"></span><b class="itemname">selectRow</b>
1972
1973                                  (<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
1975
1976
1977                 </div>
1978                 <div class="mdesc">
1979
1980                    <div class="short">Selects a row.</div>
1981
1982
1983
1984                     <div class="long">
1985
1986                                 Selects a row.
1987
1988
1989
1990
1991
1992
1993                                 <dl class="detailList">
1994                                 <dt class="heading">Parameters:</dt>
1995
1996                                         <dt>
1997                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>row</b>
1998
1999                                         </dt>
2000                                         <dd>The index of the row to select</dd>
2001
2002                                         <dt>
2003                                                 <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>
2004
2005                                         </dt>
2006                                         <dd>(optional) True to keep existing selections</dd>
2007
2008                                 </dl>
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020                     </div>
2021                 </div>
2022
2023             </td>
2024             <td class="msource">
2025
2026                         Roo.grid.RowSelectionModel
2027                 &nbsp;
2028             </td>
2029         </tr>
2030
2031
2032           <tr class="method-row config-row-alt1 expandable notInherited">
2033             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2034
2035
2036             <td class="sig">
2037                 <a id="Roo.grid.RowSelectionModel-method-selectRows"   name=".selectRows"></a>
2038                 <div class="fixedFont">
2039                         <span class="attributes"></span><b class="itemname">selectRows</b>
2040
2041                                  (<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
2043
2044
2045                 </div>
2046                 <div class="mdesc">
2047
2048                    <div class="short">Selects multiple rows.</div>
2049
2050
2051
2052                     <div class="long">
2053
2054                                 Selects multiple rows.
2055
2056
2057
2058
2059
2060
2061                                 <dl class="detailList">
2062                                 <dt class="heading">Parameters:</dt>
2063
2064                                         <dt>
2065                                                 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  <b>rows</b>
2066
2067                                         </dt>
2068                                         <dd>Array of the indexes of the row to select</dd>
2069
2070                                         <dt>
2071                                                 <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>
2072
2073                                         </dt>
2074                                         <dd>(optional) True to keep existing selections</dd>
2075
2076                                 </dl>
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088                     </div>
2089                 </div>
2090
2091             </td>
2092             <td class="msource">
2093
2094                         Roo.grid.RowSelectionModel
2095                 &nbsp;
2096             </td>
2097         </tr>
2098
2099
2100           <tr class="method-row config-row-alt0 expandable">
2101             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2102
2103
2104             <td class="sig">
2105                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
2106                 <div class="fixedFont">
2107                         <span class="attributes"></span><b class="itemname">un</b>
2108
2109                                  (<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
2111
2112
2113                 </div>
2114                 <div class="mdesc">
2115
2116                    <div class="short">Removes a listener (shorthand for removeListener)</div>
2117
2118
2119
2120                     <div class="long">
2121
2122                                 Removes a listener (shorthand for removeListener)
2123
2124
2125
2126
2127
2128
2129                                 <dl class="detailList">
2130                                 <dt class="heading">Parameters:</dt>
2131
2132                                         <dt>
2133                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
2134
2135                                         </dt>
2136                                         <dd>The type of event to listen for</dd>
2137
2138                                         <dt>
2139                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
2140
2141                                         </dt>
2142                                         <dd>The handler to remove</dd>
2143
2144                                         <dt>
2145                                                 <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>
2146
2147                                         </dt>
2148                                         <dd>(optional) The scope (this object) for the handler</dd>
2149
2150                                 </dl>
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162                     </div>
2163                 </div>
2164
2165             </td>
2166             <td class="msource">
2167
2168                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2169                 &nbsp;
2170             </td>
2171         </tr>
2172
2173
2174           <tr class="method-row config-row-alt1 expandable">
2175             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2176
2177
2178             <td class="sig">
2179                 <a id="Roo.grid.AbstractSelectionModel-method-unlock"   name=".unlock"></a>
2180                 <div class="fixedFont">
2181                         <span class="attributes"></span><b class="itemname">unlock</b>
2182
2183                                  ()
2184
2185
2186
2187                 </div>
2188                 <div class="mdesc">
2189
2190                    <div class="short">Unlocks the selections.</div>
2191
2192
2193
2194                     <div class="long">
2195
2196                                 Unlocks the selections.
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213                     </div>
2214                 </div>
2215
2216             </td>
2217             <td class="msource">
2218
2219                         <a href="./Roo.grid.AbstractSelectionModel.html#constructor" roo:cls="Roo.grid.AbstractSelectionModel.html#constructor">Roo.grid.AbstractSelectionModel</a>
2220                 &nbsp;
2221             </td>
2222         </tr>
2223
2224
2225     </table>
2226
2227
2228   <!-- ============================== events summary / details ======================== -->
2229
2230
2231   <a id="Roo.grid.RowSelectionModel-events"></a>
2232
2233
2234
2235
2236
2237
2238
2239
2240       <table cellspacing="0" class="member-table">
2241                 <caption>Events</caption>
2242               <thead>
2243                 <tr>
2244                     <th class="sig-header" colspan="2">Event</th>
2245                     <th class="msource-header">Defined By</th>
2246
2247                 </tr>
2248               </thead>
2249
2250
2251
2252
2253
2254           <tr class="method-row expandable config-row-alt0 notInherited">
2255             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2256
2257             <td class="sig">
2258                 <a id="Roo.grid.RowSelectionModel-event-*afterselectionchange"></a>
2259
2260                <div class="fixedFont">
2261                 <b class="itemname">afterselectionchange</b> (SelectionModel <B><i>this</i></B>)
2262
2263                 </div>
2264
2265                 <div class="mdesc">
2266
2267                    <div class="short">Fires after the selection changes (eg.
2268
2269                 </div>
2270
2271                     <div class="long">
2272
2273                         Fires after the selection changes (eg. by key press or clicking)
2274
2275
2276
2277
2278
2279                                 <dl class="detailList">
2280                                 <dt class="heading">Parameters:</dt>
2281
2282                                         <dt>
2283                                                 <span class="fixedFont">SelectionModel</span> <b>this</b>
2284
2285                                         </dt>
2286                                         <dd></dd>
2287
2288                                 </dl>
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300                     </div>
2301                 </div>
2302
2303             </td>
2304             <td class="msource">
2305                 Roo.grid.RowSelectionModel
2306             </td>
2307         </tr>
2308
2309           <tr class="method-row expandable config-row-alt1 notInherited">
2310             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2311
2312             <td class="sig">
2313                 <a id="Roo.grid.RowSelectionModel-event-*beforerowselect"></a>
2314
2315                <div class="fixedFont">
2316                 <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>)
2317
2318                 </div>
2319
2320                 <div class="mdesc">
2321
2322                    <div class="short">Fires when a row is selected being selected, return false to cancel.
2323
2324                 </div>
2325
2326                     <div class="long">
2327
2328                         Fires when a row is selected being selected, return false to cancel.
2329
2330
2331
2332
2333
2334                                 <dl class="detailList">
2335                                 <dt class="heading">Parameters:</dt>
2336
2337                                         <dt>
2338                                                 <span class="fixedFont">SelectionModel</span> <b>this</b>
2339
2340                                         </dt>
2341                                         <dd></dd>
2342
2343                                         <dt>
2344                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
2345
2346                                         </dt>
2347                                         <dd>The selected index</dd>
2348
2349                                         <dt>
2350                                                 <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>
2351
2352                                         </dt>
2353                                         <dd>False if other selections will be cleared</dd>
2354
2355                                 </dl>
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367                     </div>
2368                 </div>
2369
2370             </td>
2371             <td class="msource">
2372                 Roo.grid.RowSelectionModel
2373             </td>
2374         </tr>
2375
2376           <tr class="method-row expandable config-row-alt0 notInherited">
2377             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2378
2379             <td class="sig">
2380                 <a id="Roo.grid.RowSelectionModel-event-*rowdeselect"></a>
2381
2382                <div class="fixedFont">
2383                 <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>)
2384
2385                 </div>
2386
2387                 <div class="mdesc">
2388
2389                    <div class="short">Fires when a row is deselected.
2390
2391                 </div>
2392
2393                     <div class="long">
2394
2395                         Fires when a row is deselected.
2396
2397
2398
2399
2400
2401                                 <dl class="detailList">
2402                                 <dt class="heading">Parameters:</dt>
2403
2404                                         <dt>
2405                                                 <span class="fixedFont">SelectionModel</span> <b>this</b>
2406
2407                                         </dt>
2408                                         <dd></dd>
2409
2410                                         <dt>
2411                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
2412
2413                                         </dt>
2414                                         <dd>The selected index</dd>
2415
2416                                 </dl>
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428                     </div>
2429                 </div>
2430
2431             </td>
2432             <td class="msource">
2433                 Roo.grid.RowSelectionModel
2434             </td>
2435         </tr>
2436
2437           <tr class="method-row expandable config-row-alt1 notInherited">
2438             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2439
2440             <td class="sig">
2441                 <a id="Roo.grid.RowSelectionModel-event-*rowselect"></a>
2442
2443                <div class="fixedFont">
2444                 <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>)
2445
2446                 </div>
2447
2448                 <div class="mdesc">
2449
2450                    <div class="short">Fires when a row is selected.
2451
2452                 </div>
2453
2454                     <div class="long">
2455
2456                         Fires when a row is selected.
2457
2458
2459
2460
2461
2462                                 <dl class="detailList">
2463                                 <dt class="heading">Parameters:</dt>
2464
2465                                         <dt>
2466                                                 <span class="fixedFont">SelectionModel</span> <b>this</b>
2467
2468                                         </dt>
2469                                         <dd></dd>
2470
2471                                         <dt>
2472                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
2473
2474                                         </dt>
2475                                         <dd>The selected index</dd>
2476
2477                                         <dt>
2478                                                 <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>
2479
2480                                         </dt>
2481                                         <dd>The record</dd>
2482
2483                                 </dl>
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495                     </div>
2496                 </div>
2497
2498             </td>
2499             <td class="msource">
2500                 Roo.grid.RowSelectionModel
2501             </td>
2502         </tr>
2503
2504           <tr class="method-row expandable config-row-alt0 notInherited">
2505             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2506
2507             <td class="sig">
2508                 <a id="Roo.grid.RowSelectionModel-event-*selectionchange"></a>
2509
2510                <div class="fixedFont">
2511                 <b class="itemname">selectionchange</b> (SelectionModel <B><i>this</i></B>)
2512
2513                 </div>
2514
2515                 <div class="mdesc">
2516
2517                    <div class="short">Fires when the selection changes
2518
2519                 </div>
2520
2521                     <div class="long">
2522
2523                         Fires when the selection changes
2524
2525
2526
2527
2528
2529                                 <dl class="detailList">
2530                                 <dt class="heading">Parameters:</dt>
2531
2532                                         <dt>
2533                                                 <span class="fixedFont">SelectionModel</span> <b>this</b>
2534
2535                                         </dt>
2536                                         <dd></dd>
2537
2538                                 </dl>
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550                     </div>
2551                 </div>
2552
2553             </td>
2554             <td class="msource">
2555                 Roo.grid.RowSelectionModel
2556             </td>
2557         </tr>
2558
2559
2560     </table>
2561
2562
2563
2564
2565
2566 <!-- ============================== footer ================================= -->
2567                 <div class="fineprint" style="clear:both">
2568
2569                         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)
2570                         Based on
2571                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
2572                 </div>
2573         </body>
2574 </html>