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.grid.AbstractSelectionModel.html#constructor" roo:cls="Roo.grid.AbstractSelectionModel.html#constructor">Roo.grid.AbstractSelectionModel</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.grid.RowSelectionModel
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.grid.RowSelectionModel
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo.grid</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_grid_RowSelectionModel.js.html">Roo/grid/RowSelectionModel.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">RowSelectionModel</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.grid.AbstractSelectionModel.html#constructor" roo:cls="Roo.grid.AbstractSelectionModel.html#constructor">Roo.grid.AbstractSelectionModel</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         The default SelectionModel used by {<b>link</b> Roo.grid.Grid}.<br/>It supports multiple selections and keyboard selection/navigation.
  86     </div>
  87
  88
  89 <!-- ============================== Class comment block... ========================== -->
  90
  91 <div class="comments">
  92         <b>Class Comments / Notes</B> =>
  93         <u onclick="parent.CommentDialog.showCommentId = 'Roo.grid.RowSelectionModel';">[Add Your comment/notes about this class]</u>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo.grid" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.grid.RowSelectionModel.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.grid.RowSelectionModel-configs"></a>
 108
 109
 110
 111
 112
 113       <table cellspacing="0" class="member-table">
 114       <caption>Config Options (Usually are also Properties)</caption>
 115
 116
 117         <tr>
 118             <th class="sig-header" colspan="2">Options</th>
 119
 120             <th class="msource-header">Defined By</th>
 121         </tr>
 122
 123
 124
 125
 126
 127                 <tr class="config-row expandable config-row-alt0 notInherited">
 128                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 129                     <td class="sig">
 130
 131                         <a id="Roo.grid.RowSelectionModel-cfg-singleSelect" name=".singleSelect"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">singleSelect</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">True to allow selection of only one row at a time (defaults to false)</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">True to allow selection of only one row at a time (defaults to false)</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.grid.RowSelectionModel
 152
 153                     </td>
 154                 </tr>
 155
 156
 157     </table>
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167   <!-- ============================== public properties ==================== -->
 168
 169
 170
 171     <a id="Roo.grid.RowSelectionModel-props"></a>
 172
 173
 174
 175
 176
 177      <table cellspacing="0" class="member-table">
 178       <caption class="Empty">Public Properties - Has None</caption>
 179      </table>
 180
 181
 182
 183
 184   <!-- ============================== methods summary / details ======================== -->
 185
 186
 187   <a id="Roo.grid.RowSelectionModel-methods"></a>
 188         <!-- constructor?? -->
 189
 190         <!-- static's first
 191
 192
 193         -->
 194
 195         <!-- then dynamics first -->
 196
 197
 198
 199
 200
 201
 202       <table cellspacing="0" class="member-table">
 203       <caption>Public Methods</caption>
 204         <tr>
 205             <th class="sig-header" colspan="2">Method</th>
 206             <th class="msource-header">Defined By</th>
 207
 208         </tr>
 209
 210
 211
 212
 213
 214
 215
 216           <tr class="method-row config-row-alt0 expandable notInherited">
 217             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 218
 219
 220             <td class="sig">
 221                 <a id="Roo.grid-method-RowSelectionModel"   name=".RowSelectionModel"></a>
 222                 <div class="fixedFont">
 223                         <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">RowSelectionModel</b>
 224
 225                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 226
 227
 228
 229                 </div>
 230                 <div class="mdesc">
 231
 232
 233                         <div class="short">Create a new Roo.grid.RowSelectionModel</div>
 234
 235
 236                     <div class="long">
 237
 238
 239
 240                                 Create a new Roo.grid.RowSelectionModel
 241
 242
 243                                 <dl class="detailList">
 244                                 <dt class="heading">Parameters:</dt>
 245
 246                                         <dt>
 247                                                 <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>
 248
 249                                         </dt>
 250                                         <dd></dd>
 251
 252                                 </dl>
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264                     </div>
 265                 </div>
 266
 267             </td>
 268             <td class="msource">
 269                 &nbsp;
 270             </td>
 271         </tr>
 272
 273
 274           <tr class="method-row config-row-alt1 expandable notInherited">
 275             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 276
 277
 278             <td class="sig">
 279                 <a id="Roo.grid.RowSelectionModel-method-clearSelections"   name=".clearSelections"></a>
 280                 <div class="fixedFont">
 281                         <span class="attributes"></span><b class="itemname">clearSelections</b>
 282
 283                                  ()
 284
 285
 286
 287                 </div>
 288                 <div class="mdesc">
 289
 290                    <div class="short">Clears all selections.</div>
 291
 292
 293
 294                     <div class="long">
 295
 296                                 Clears all selections.
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313                     </div>
 314                 </div>
 315
 316             </td>
 317             <td class="msource">
 318
 319                         Roo.grid.RowSelectionModel
 320                 &nbsp;
 321             </td>
 322         </tr>
 323
 324
 325           <tr class="method-row config-row-alt0 expandable notInherited">
 326             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 327
 328
 329             <td class="sig">
 330                 <a id="Roo.grid.RowSelectionModel-method-deselectRange"   name=".deselectRange"></a>
 331                 <div class="fixedFont">
 332                         <span class="attributes"></span><b class="itemname">deselectRange</b>
 333
 334                                  (<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>)
 335
 336
 337
 338                 </div>
 339                 <div class="mdesc">
 340
 341                    <div class="short">Deselects a range of rows.</div>
 342
 343
 344
 345                     <div class="long">
 346
 347                                 Deselects a range of rows. All rows in between startRow and endRow are also deselected.
 348
 349
 350
 351
 352
 353
 354                                 <dl class="detailList">
 355                                 <dt class="heading">Parameters:</dt>
 356
 357                                         <dt>
 358                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>startRow</b>
 359
 360                                         </dt>
 361                                         <dd>The index of the first row in the range</dd>
 362
 363                                         <dt>
 364                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>endRow</b>
 365
 366                                         </dt>
 367                                         <dd>The index of the last row in the range</dd>
 368
 369                                 </dl>
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381                     </div>
 382                 </div>
 383
 384             </td>
 385             <td class="msource">
 386
 387                         Roo.grid.RowSelectionModel
 388                 &nbsp;
 389             </td>
 390         </tr>
 391
 392
 393           <tr class="method-row config-row-alt1 expandable notInherited">
 394             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 395
 396
 397             <td class="sig">
 398                 <a id="Roo.grid.RowSelectionModel-method-deselectRow"   name=".deselectRow"></a>
 399                 <div class="fixedFont">
 400                         <span class="attributes"></span><b class="itemname">deselectRow</b>
 401
 402                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>row</i></B>)
 403
 404
 405
 406                 </div>
 407                 <div class="mdesc">
 408
 409                    <div class="short">Deselects a row.</div>
 410
 411
 412
 413                     <div class="long">
 414
 415                                 Deselects a row.
 416
 417
 418
 419
 420
 421
 422                                 <dl class="detailList">
 423                                 <dt class="heading">Parameters:</dt>
 424
 425                                         <dt>
 426                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>row</b>
 427
 428                                         </dt>
 429                                         <dd>The index of the row to deselect</dd>
 430
 431                                 </dl>
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443                     </div>
 444                 </div>
 445
 446             </td>
 447             <td class="msource">
 448
 449                         Roo.grid.RowSelectionModel
 450                 &nbsp;
 451             </td>
 452         </tr>
 453
 454
 455           <tr class="method-row config-row-alt0 expandable notInherited">
 456             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 457
 458
 459             <td class="sig">
 460                 <a id="Roo.grid.RowSelectionModel-method-getCount"   name=".getCount"></a>
 461                 <div class="fixedFont">
 462                         <span class="attributes"></span><b class="itemname">getCount</b>
 463
 464                                  ()
 465
 466
 467                                          :
 468
 469
 470                                                 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 471
 472
 473
 474
 475
 476                 </div>
 477                 <div class="mdesc">
 478
 479                    <div class="short">Gets the number of selected rows.</div>
 480
 481
 482
 483                     <div class="long">
 484
 485                                 Gets the number of selected rows.
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496                                 <dl class="detailList">
 497                                 <dt class="heading">Returns:</dt>
 498
 499                                         <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  </dd>
 500
 501                                 </dl>
 502
 503
 504
 505
 506
 507
 508
 509                     </div>
 510                 </div>
 511
 512             </td>
 513             <td class="msource">
 514
 515                         Roo.grid.RowSelectionModel
 516                 &nbsp;
 517             </td>
 518         </tr>
 519
 520
 521           <tr class="method-row config-row-alt1 expandable notInherited">
 522             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 523
 524
 525             <td class="sig">
 526                 <a id="Roo.grid.RowSelectionModel-method-getSelected"   name=".getSelected"></a>
 527                 <div class="fixedFont">
 528                         <span class="attributes"></span><b class="itemname">getSelected</b>
 529
 530                                  ()
 531
 532
 533                                          :
 534
 535
 536                                                 Record
 537
 538
 539
 540
 541
 542                 </div>
 543                 <div class="mdesc">
 544
 545                    <div class="short">Returns the first selected record.</div>
 546
 547
 548
 549                     <div class="long">
 550
 551                                 Returns the first selected record.
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562                                 <dl class="detailList">
 563                                 <dt class="heading">Returns:</dt>
 564
 565                                         <dd><span class="fixedFont">Record</span>  </dd>
 566
 567                                 </dl>
 568
 569
 570
 571
 572
 573
 574
 575                     </div>
 576                 </div>
 577
 578             </td>
 579             <td class="msource">
 580
 581                         Roo.grid.RowSelectionModel
 582                 &nbsp;
 583             </td>
 584         </tr>
 585
 586
 587           <tr class="method-row config-row-alt0 expandable notInherited">
 588             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 589
 590
 591             <td class="sig">
 592                 <a id="Roo.grid.RowSelectionModel-method-getSelections"   name=".getSelections"></a>
 593                 <div class="fixedFont">
 594                         <span class="attributes"></span><b class="itemname">getSelections</b>
 595
 596                                  ()
 597
 598
 599                                          :
 600
 601
 602                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 603
 604
 605
 606
 607
 608                 </div>
 609                 <div class="mdesc">
 610
 611                    <div class="short">Returns the selected records</div>
 612
 613
 614
 615                     <div class="long">
 616
 617                                 Returns the selected records
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628                                 <dl class="detailList">
 629                                 <dt class="heading">Returns:</dt>
 630
 631                                         <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  Array of selected records</dd>
 632
 633                                 </dl>
 634
 635
 636
 637
 638
 639
 640
 641                     </div>
 642                 </div>
 643
 644             </td>
 645             <td class="msource">
 646
 647                         Roo.grid.RowSelectionModel
 648                 &nbsp;
 649             </td>
 650         </tr>
 651
 652
 653           <tr class="method-row config-row-alt1 expandable notInherited">
 654             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 655
 656
 657             <td class="sig">
 658                 <a id="Roo.grid.RowSelectionModel-method-hasSelection"   name=".hasSelection"></a>
 659                 <div class="fixedFont">
 660                         <span class="attributes"></span><b class="itemname">hasSelection</b>
 661
 662                                  ()
 663
 664
 665                                          :
 666
 667
 668                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 669
 670
 671
 672
 673
 674                 </div>
 675                 <div class="mdesc">
 676
 677                    <div class="short">Returns True if there is a selection.</div>
 678
 679
 680
 681                     <div class="long">
 682
 683                                 Returns True if there is a selection.
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694                                 <dl class="detailList">
 695                                 <dt class="heading">Returns:</dt>
 696
 697                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
 698
 699                                 </dl>
 700
 701
 702
 703
 704
 705
 706
 707                     </div>
 708                 </div>
 709
 710             </td>
 711             <td class="msource">
 712
 713                         Roo.grid.RowSelectionModel
 714                 &nbsp;
 715             </td>
 716         </tr>
 717
 718
 719           <tr class="method-row config-row-alt0 expandable notInherited">
 720             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 721
 722
 723             <td class="sig">
 724                 <a id="Roo.grid.RowSelectionModel-method-isIdSelected"   name=".isIdSelected"></a>
 725                 <div class="fixedFont">
 726                         <span class="attributes"></span><b class="itemname">isIdSelected</b>
 727
 728                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
 729
 730
 731                                          :
 732
 733
 734                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 735
 736
 737
 738
 739
 740                 </div>
 741                 <div class="mdesc">
 742
 743                    <div class="short">Returns True if the specified record id is selected.</div>
 744
 745
 746
 747                     <div class="long">
 748
 749                                 Returns True if the specified record id is selected.
 750
 751
 752
 753
 754
 755
 756                                 <dl class="detailList">
 757                                 <dt class="heading">Parameters:</dt>
 758
 759                                         <dt>
 760                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
 761
 762                                         </dt>
 763                                         <dd>The id of record to check</dd>
 764
 765                                 </dl>
 766
 767
 768
 769
 770
 771                                 <dl class="detailList">
 772                                 <dt class="heading">Returns:</dt>
 773
 774                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
 775
 776                                 </dl>
 777
 778
 779
 780
 781
 782
 783
 784                     </div>
 785                 </div>
 786
 787             </td>
 788             <td class="msource">
 789
 790                         Roo.grid.RowSelectionModel
 791                 &nbsp;
 792             </td>
 793         </tr>
 794
 795
 796           <tr class="method-row config-row-alt1 expandable notInherited">
 797             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 798
 799
 800             <td class="sig">
 801                 <a id="Roo.grid.RowSelectionModel-method-isSelected"   name=".isSelected"></a>
 802                 <div class="fixedFont">
 803                         <span class="attributes"></span><b class="itemname">isSelected</b>
 804
 805                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/Record <B><i>record</i></B>)
 806
 807
 808                                          :
 809
 810
 811                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 812
 813
 814
 815
 816
 817                 </div>
 818                 <div class="mdesc">
 819
 820                    <div class="short">Returns True if the specified row is selected.</div>
 821
 822
 823
 824                     <div class="long">
 825
 826                                 Returns True if the specified row is selected.
 827
 828
 829
 830
 831
 832
 833                                 <dl class="detailList">
 834                                 <dt class="heading">Parameters:</dt>
 835
 836                                         <dt>
 837                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/Record</span>  <b>record</b>
 838
 839                                         </dt>
 840                                         <dd>The record or index of the record to check</dd>
 841
 842                                 </dl>
 843
 844
 845
 846
 847
 848                                 <dl class="detailList">
 849                                 <dt class="heading">Returns:</dt>
 850
 851                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
 852
 853                                 </dl>
 854
 855
 856
 857
 858
 859
 860
 861                     </div>
 862                 </div>
 863
 864             </td>
 865             <td class="msource">
 866
 867                         Roo.grid.RowSelectionModel
 868                 &nbsp;
 869             </td>
 870         </tr>
 871
 872
 873           <tr class="method-row config-row-alt0 expandable notInherited">
 874             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 875
 876
 877             <td class="sig">
 878                 <a id="Roo.grid.RowSelectionModel-method-selectAll"   name=".selectAll"></a>
 879                 <div class="fixedFont">
 880                         <span class="attributes"></span><b class="itemname">selectAll</b>
 881
 882                                  ()
 883
 884
 885
 886                 </div>
 887                 <div class="mdesc">
 888
 889                    <div class="short">Selects all rows.</div>
 890
 891
 892
 893                     <div class="long">
 894
 895                                 Selects all rows.
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912                     </div>
 913                 </div>
 914
 915             </td>
 916             <td class="msource">
 917
 918                         Roo.grid.RowSelectionModel
 919                 &nbsp;
 920             </td>
 921         </tr>
 922
 923
 924           <tr class="method-row config-row-alt1 expandable notInherited">
 925             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 926
 927
 928             <td class="sig">
 929                 <a id="Roo.grid.RowSelectionModel-method-selectFirstRow"   name=".selectFirstRow"></a>
 930                 <div class="fixedFont">
 931                         <span class="attributes"></span><b class="itemname">selectFirstRow</b>
 932
 933                                  ()
 934
 935
 936
 937                 </div>
 938                 <div class="mdesc">
 939
 940                    <div class="short">Selects the first row in the grid.</div>
 941
 942
 943
 944                     <div class="long">
 945
 946                                 Selects the first row in the grid.
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963                     </div>
 964                 </div>
 965
 966             </td>
 967             <td class="msource">
 968
 969                         Roo.grid.RowSelectionModel
 970                 &nbsp;
 971             </td>
 972         </tr>
 973
 974
 975           <tr class="method-row config-row-alt0 expandable notInherited">
 976             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 977
 978
 979             <td class="sig">
 980                 <a id="Roo.grid.RowSelectionModel-method-selectLastRow"   name=".selectLastRow"></a>
 981                 <div class="fixedFont">
 982                         <span class="attributes"></span><b class="itemname">selectLastRow</b>
 983
 984                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>keepExisting</i></B>)
 985
 986
 987
 988                 </div>
 989                 <div class="mdesc">
 990
 991                    <div class="short">Select the last row.</div>
 992
 993
 994
 995                     <div class="long">
 996
 997                                 Select the last row.
 998
 999
1000
1001
1002
1003
1004                                 <dl class="detailList">
1005                                 <dt class="heading">Parameters:</dt>
1006
1007                                         <dt>
1008                                                 <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>
1009
1010                                         </dt>
1011                                         <dd>(optional) True to keep existing selections</dd>
1012
1013                                 </dl>
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025                     </div>
1026                 </div>
1027
1028             </td>
1029             <td class="msource">
1030
1031                         Roo.grid.RowSelectionModel
1032                 &nbsp;
1033             </td>
1034         </tr>
1035
1036
1037           <tr class="method-row config-row-alt1 expandable notInherited">
1038             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1039
1040
1041             <td class="sig">
1042                 <a id="Roo.grid.RowSelectionModel-method-selectNext"   name=".selectNext"></a>
1043                 <div class="fixedFont">
1044                         <span class="attributes"></span><b class="itemname">selectNext</b>
1045
1046                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>keepExisting</i></B>)
1047
1048
1049
1050                 </div>
1051                 <div class="mdesc">
1052
1053                    <div class="short">Selects the row immediately following the last selected row.</div>
1054
1055
1056
1057                     <div class="long">
1058
1059                                 Selects the row immediately following the last selected row.
1060
1061
1062
1063
1064
1065
1066                                 <dl class="detailList">
1067                                 <dt class="heading">Parameters:</dt>
1068
1069                                         <dt>
1070                                                 <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>
1071
1072                                         </dt>
1073                                         <dd>(optional) True to keep existing selections</dd>
1074
1075                                 </dl>
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087                     </div>
1088                 </div>
1089
1090             </td>
1091             <td class="msource">
1092
1093                         Roo.grid.RowSelectionModel
1094                 &nbsp;
1095             </td>
1096         </tr>
1097
1098
1099           <tr class="method-row config-row-alt0 expandable notInherited">
1100             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1101
1102
1103             <td class="sig">
1104                 <a id="Roo.grid.RowSelectionModel-method-selectPrevious"   name=".selectPrevious"></a>
1105                 <div class="fixedFont">
1106                         <span class="attributes"></span><b class="itemname">selectPrevious</b>
1107
1108                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>keepExisting</i></B>)
1109
1110
1111
1112                 </div>
1113                 <div class="mdesc">
1114
1115                    <div class="short">Selects the row that precedes the last selected row.</div>
1116
1117
1118
1119                     <div class="long">
1120
1121                                 Selects the row that precedes the last selected row.
1122
1123
1124
1125
1126
1127
1128                                 <dl class="detailList">
1129                                 <dt class="heading">Parameters:</dt>
1130
1131                                         <dt>
1132                                                 <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>
1133
1134                                         </dt>
1135                                         <dd>(optional) True to keep existing selections</dd>
1136
1137                                 </dl>
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149                     </div>
1150                 </div>
1151
1152             </td>
1153             <td class="msource">
1154
1155                         Roo.grid.RowSelectionModel
1156                 &nbsp;
1157             </td>
1158         </tr>
1159
1160
1161           <tr class="method-row config-row-alt1 expandable notInherited">
1162             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1163
1164
1165             <td class="sig">
1166                 <a id="Roo.grid.RowSelectionModel-method-selectRange"   name=".selectRange"></a>
1167                 <div class="fixedFont">
1168                         <span class="attributes"></span><b class="itemname">selectRange</b>
1169
1170                                  (<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>)
1171
1172
1173
1174                 </div>
1175                 <div class="mdesc">
1176
1177                    <div class="short">Selects a range of rows.</div>
1178
1179
1180
1181                     <div class="long">
1182
1183                                 Selects a range of rows. All rows in between startRow and endRow are also selected.
1184
1185
1186
1187
1188
1189
1190                                 <dl class="detailList">
1191                                 <dt class="heading">Parameters:</dt>
1192
1193                                         <dt>
1194                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>startRow</b>
1195
1196                                         </dt>
1197                                         <dd>The index of the first row in the range</dd>
1198
1199                                         <dt>
1200                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>endRow</b>
1201
1202                                         </dt>
1203                                         <dd>The index of the last row in the range</dd>
1204
1205                                         <dt>
1206                                                 <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>
1207
1208                                         </dt>
1209                                         <dd>(optional) True to retain existing selections</dd>
1210
1211                                 </dl>
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223                     </div>
1224                 </div>
1225
1226             </td>
1227             <td class="msource">
1228
1229                         Roo.grid.RowSelectionModel
1230                 &nbsp;
1231             </td>
1232         </tr>
1233
1234
1235           <tr class="method-row config-row-alt0 expandable notInherited">
1236             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1237
1238
1239             <td class="sig">
1240                 <a id="Roo.grid.RowSelectionModel-method-selectRecords"   name=".selectRecords"></a>
1241                 <div class="fixedFont">
1242                         <span class="attributes"></span><b class="itemname">selectRecords</b>
1243
1244                                  (<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>)
1245
1246
1247
1248                 </div>
1249                 <div class="mdesc">
1250
1251                    <div class="short">Select records.</div>
1252
1253
1254
1255                     <div class="long">
1256
1257                                 Select records.
1258
1259
1260
1261
1262
1263
1264                                 <dl class="detailList">
1265                                 <dt class="heading">Parameters:</dt>
1266
1267                                         <dt>
1268                                                 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  <b>records</b>
1269
1270                                         </dt>
1271                                         <dd>The records to select</dd>
1272
1273                                         <dt>
1274                                                 <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>
1275
1276                                         </dt>
1277                                         <dd>(optional) True to keep existing selections</dd>
1278
1279                                 </dl>
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291                     </div>
1292                 </div>
1293
1294             </td>
1295             <td class="msource">
1296
1297                         Roo.grid.RowSelectionModel
1298                 &nbsp;
1299             </td>
1300         </tr>
1301
1302
1303           <tr class="method-row config-row-alt1 expandable notInherited">
1304             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1305
1306
1307             <td class="sig">
1308                 <a id="Roo.grid.RowSelectionModel-method-selectRow"   name=".selectRow"></a>
1309                 <div class="fixedFont">
1310                         <span class="attributes"></span><b class="itemname">selectRow</b>
1311
1312                                  (<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>)
1313
1314
1315
1316                 </div>
1317                 <div class="mdesc">
1318
1319                    <div class="short">Selects a row.</div>
1320
1321
1322
1323                     <div class="long">
1324
1325                                 Selects a row.
1326
1327
1328
1329
1330
1331
1332                                 <dl class="detailList">
1333                                 <dt class="heading">Parameters:</dt>
1334
1335                                         <dt>
1336                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>row</b>
1337
1338                                         </dt>
1339                                         <dd>The index of the row to select</dd>
1340
1341                                         <dt>
1342                                                 <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>
1343
1344                                         </dt>
1345                                         <dd>(optional) True to keep existing selections</dd>
1346
1347                                 </dl>
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359                     </div>
1360                 </div>
1361
1362             </td>
1363             <td class="msource">
1364
1365                         Roo.grid.RowSelectionModel
1366                 &nbsp;
1367             </td>
1368         </tr>
1369
1370
1371           <tr class="method-row config-row-alt0 expandable notInherited">
1372             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1373
1374
1375             <td class="sig">
1376                 <a id="Roo.grid.RowSelectionModel-method-selectRows"   name=".selectRows"></a>
1377                 <div class="fixedFont">
1378                         <span class="attributes"></span><b class="itemname">selectRows</b>
1379
1380                                  (<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>)
1381
1382
1383
1384                 </div>
1385                 <div class="mdesc">
1386
1387                    <div class="short">Selects multiple rows.</div>
1388
1389
1390
1391                     <div class="long">
1392
1393                                 Selects multiple rows.
1394
1395
1396
1397
1398
1399
1400                                 <dl class="detailList">
1401                                 <dt class="heading">Parameters:</dt>
1402
1403                                         <dt>
1404                                                 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  <b>rows</b>
1405
1406                                         </dt>
1407                                         <dd>Array of the indexes of the row to select</dd>
1408
1409                                         <dt>
1410                                                 <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>
1411
1412                                         </dt>
1413                                         <dd>(optional) True to keep existing selections</dd>
1414
1415                                 </dl>
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427                     </div>
1428                 </div>
1429
1430             </td>
1431             <td class="msource">
1432
1433                         Roo.grid.RowSelectionModel
1434                 &nbsp;
1435             </td>
1436         </tr>
1437
1438
1439     </table>
1440
1441
1442   <!-- ============================== events summary / details ======================== -->
1443
1444
1445   <a id="Roo.grid.RowSelectionModel-events"></a>
1446
1447
1448
1449
1450
1451
1452
1453
1454       <table cellspacing="0" class="member-table">
1455                 <caption>Events</caption>
1456               <thead>
1457                 <tr>
1458                     <th class="sig-header" colspan="2">Event</th>
1459                     <th class="msource-header">Defined By</th>
1460
1461                 </tr>
1462               </thead>
1463
1464
1465
1466
1467
1468           <tr class="method-row expandable config-row-alt0 notInherited">
1469             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1470
1471             <td class="sig">
1472                 <a id="Roo.grid.RowSelectionModel-event-*afterselectionchange"></a>
1473
1474                <div class="fixedFont">
1475                 <b class="itemname">afterselectionchange</b> (SelectionModel <B><i>this</i></B>)
1476
1477                 </div>
1478
1479                 <div class="mdesc">
1480
1481                    <div class="short">Fires after the selection changes (eg.
1482
1483                 </div>
1484
1485                     <div class="long">
1486
1487                         Fires after the selection changes (eg. by key press or clicking)
1488
1489
1490
1491
1492
1493                                 <dl class="detailList">
1494                                 <dt class="heading">Parameters:</dt>
1495
1496                                         <dt>
1497                                                 <span class="fixedFont">SelectionModel</span> <b>this</b>
1498
1499                                         </dt>
1500                                         <dd></dd>
1501
1502                                 </dl>
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514                     </div>
1515                 </div>
1516
1517             </td>
1518             <td class="msource">
1519                 Roo.grid.RowSelectionModel
1520             </td>
1521         </tr>
1522
1523           <tr class="method-row expandable config-row-alt1 notInherited">
1524             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1525
1526             <td class="sig">
1527                 <a id="Roo.grid.RowSelectionModel-event-*beforerowselect"></a>
1528
1529                <div class="fixedFont">
1530                 <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>)
1531
1532                 </div>
1533
1534                 <div class="mdesc">
1535
1536                    <div class="short">Fires when a row is selected being selected, return false to cancel.
1537
1538                 </div>
1539
1540                     <div class="long">
1541
1542                         Fires when a row is selected being selected, return false to cancel.
1543
1544
1545
1546
1547
1548                                 <dl class="detailList">
1549                                 <dt class="heading">Parameters:</dt>
1550
1551                                         <dt>
1552                                                 <span class="fixedFont">SelectionModel</span> <b>this</b>
1553
1554                                         </dt>
1555                                         <dd></dd>
1556
1557                                         <dt>
1558                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
1559
1560                                         </dt>
1561                                         <dd>The selected index</dd>
1562
1563                                         <dt>
1564                                                 <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>
1565
1566                                         </dt>
1567                                         <dd>False if other selections will be cleared</dd>
1568
1569                                 </dl>
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581                     </div>
1582                 </div>
1583
1584             </td>
1585             <td class="msource">
1586                 Roo.grid.RowSelectionModel
1587             </td>
1588         </tr>
1589
1590           <tr class="method-row expandable config-row-alt0 notInherited">
1591             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1592
1593             <td class="sig">
1594                 <a id="Roo.grid.RowSelectionModel-event-*rowdeselect"></a>
1595
1596                <div class="fixedFont">
1597                 <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>)
1598
1599                 </div>
1600
1601                 <div class="mdesc">
1602
1603                    <div class="short">Fires when a row is deselected.
1604
1605                 </div>
1606
1607                     <div class="long">
1608
1609                         Fires when a row is deselected.
1610
1611
1612
1613
1614
1615                                 <dl class="detailList">
1616                                 <dt class="heading">Parameters:</dt>
1617
1618                                         <dt>
1619                                                 <span class="fixedFont">SelectionModel</span> <b>this</b>
1620
1621                                         </dt>
1622                                         <dd></dd>
1623
1624                                         <dt>
1625                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
1626
1627                                         </dt>
1628                                         <dd>The selected index</dd>
1629
1630                                 </dl>
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642                     </div>
1643                 </div>
1644
1645             </td>
1646             <td class="msource">
1647                 Roo.grid.RowSelectionModel
1648             </td>
1649         </tr>
1650
1651           <tr class="method-row expandable config-row-alt1 notInherited">
1652             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1653
1654             <td class="sig">
1655                 <a id="Roo.grid.RowSelectionModel-event-*rowselect"></a>
1656
1657                <div class="fixedFont">
1658                 <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>)
1659
1660                 </div>
1661
1662                 <div class="mdesc">
1663
1664                    <div class="short">Fires when a row is selected.
1665
1666                 </div>
1667
1668                     <div class="long">
1669
1670                         Fires when a row is selected.
1671
1672
1673
1674
1675
1676                                 <dl class="detailList">
1677                                 <dt class="heading">Parameters:</dt>
1678
1679                                         <dt>
1680                                                 <span class="fixedFont">SelectionModel</span> <b>this</b>
1681
1682                                         </dt>
1683                                         <dd></dd>
1684
1685                                         <dt>
1686                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
1687
1688                                         </dt>
1689                                         <dd>The selected index</dd>
1690
1691                                         <dt>
1692                                                 <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>
1693
1694                                         </dt>
1695                                         <dd>The record</dd>
1696
1697                                 </dl>
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709                     </div>
1710                 </div>
1711
1712             </td>
1713             <td class="msource">
1714                 Roo.grid.RowSelectionModel
1715             </td>
1716         </tr>
1717
1718           <tr class="method-row expandable config-row-alt0 notInherited">
1719             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1720
1721             <td class="sig">
1722                 <a id="Roo.grid.RowSelectionModel-event-*selectionchange"></a>
1723
1724                <div class="fixedFont">
1725                 <b class="itemname">selectionchange</b> (SelectionModel <B><i>this</i></B>)
1726
1727                 </div>
1728
1729                 <div class="mdesc">
1730
1731                    <div class="short">Fires when the selection changes
1732
1733                 </div>
1734
1735                     <div class="long">
1736
1737                         Fires when the selection changes
1738
1739
1740
1741
1742
1743                                 <dl class="detailList">
1744                                 <dt class="heading">Parameters:</dt>
1745
1746                                         <dt>
1747                                                 <span class="fixedFont">SelectionModel</span> <b>this</b>
1748
1749                                         </dt>
1750                                         <dd></dd>
1751
1752                                 </dl>
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764                     </div>
1765                 </div>
1766
1767             </td>
1768             <td class="msource">
1769                 Roo.grid.RowSelectionModel
1770             </td>
1771         </tr>
1772
1773
1774     </table>
1775
1776
1777
1778
1779
1780 <!-- ============================== footer ================================= -->
1781                 <div class="fineprint" style="clear:both">
1782
1783                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 19:32:56 GMT+0800 (HKT)
1784                         Based on
1785                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1786                 </div>
1787         </body>
1788 </html>