git.roojs.org Git - roojs1/blob - docs/symbols/Roo.grid.CellSelectionModel.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.CellSelectionModel</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.CellSelectionModel-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.grid.CellSelectionModel-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.grid.CellSelectionModel-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.grid.CellSelectionModel-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.CellSelectionModel
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.grid.CellSelectionModel
  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_CellSelectionModel.js.html">Roo/grid/CellSelectionModel.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">CellSelectionModel</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         This class provides the basic implementation for cell selection in a grid.
  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.CellSelectionModel';">[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.CellSelectionModel.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.grid.CellSelectionModel-configs"></a>
 108
 109
 110
 111      <table cellspacing="0" class="member-table">
 112       <caption class="Empty">Config Options - Has None</caption>
 113      </table>
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126   <!-- ============================== public properties ==================== -->
 127
 128
 129
 130     <a id="Roo.grid.CellSelectionModel-props"></a>
 131
 132
 133
 134
 135
 136      <table cellspacing="0" class="member-table">
 137       <caption class="Empty">Public Properties - Has None</caption>
 138      </table>
 139
 140
 141
 142
 143   <!-- ============================== methods summary / details ======================== -->
 144
 145
 146   <a id="Roo.grid.CellSelectionModel-methods"></a>
 147         <!-- constructor?? -->
 148
 149         <!-- static's first
 150
 151
 152         -->
 153
 154         <!-- then dynamics first -->
 155
 156
 157
 158
 159
 160
 161       <table cellspacing="0" class="member-table">
 162       <caption>Public Methods</caption>
 163         <tr>
 164             <th class="sig-header" colspan="2">Method</th>
 165             <th class="msource-header">Defined By</th>
 166
 167         </tr>
 168
 169
 170
 171
 172
 173
 174
 175           <tr class="method-row config-row-alt0 expandable notInherited">
 176             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 177
 178
 179             <td class="sig">
 180                 <a id="Roo.grid-method-CellSelectionModel"   name=".CellSelectionModel"></a>
 181                 <div class="fixedFont">
 182                         <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">CellSelectionModel</b>
 183
 184                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 185
 186
 187
 188                 </div>
 189                 <div class="mdesc">
 190
 191
 192                         <div class="short">Create a new Roo.grid.CellSelectionModel</div>
 193
 194
 195                     <div class="long">
 196
 197
 198
 199                                 Create a new Roo.grid.CellSelectionModel
 200
 201
 202                                 <dl class="detailList">
 203                                 <dt class="heading">Parameters:</dt>
 204
 205                                         <dt>
 206                                                 <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>
 207
 208                                         </dt>
 209                                         <dd>The object containing the configuration of this model.</dd>
 210
 211                                 </dl>
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223                     </div>
 224                 </div>
 225
 226             </td>
 227             <td class="msource">
 228                 &nbsp;
 229             </td>
 230         </tr>
 231
 232
 233           <tr class="method-row config-row-alt1 expandable notInherited">
 234             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 235
 236
 237             <td class="sig">
 238                 <a id="Roo.grid.CellSelectionModel-method-clearSelections"   name=".clearSelections"></a>
 239                 <div class="fixedFont">
 240                         <span class="attributes"></span><b class="itemname">clearSelections</b>
 241
 242                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>true</i></B>)
 243
 244
 245
 246                 </div>
 247                 <div class="mdesc">
 248
 249                    <div class="short">Clears all selections.</div>
 250
 251
 252
 253                     <div class="long">
 254
 255                                 Clears all selections.
 256
 257
 258
 259
 260
 261
 262                                 <dl class="detailList">
 263                                 <dt class="heading">Parameters:</dt>
 264
 265                                         <dt>
 266                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>true</b>
 267
 268                                         </dt>
 269                                         <dd>to prevent the gridview from being notified about the change.</dd>
 270
 271                                 </dl>
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283                     </div>
 284                 </div>
 285
 286             </td>
 287             <td class="msource">
 288
 289                         Roo.grid.CellSelectionModel
 290                 &nbsp;
 291             </td>
 292         </tr>
 293
 294
 295           <tr class="method-row config-row-alt0 expandable notInherited">
 296             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 297
 298
 299             <td class="sig">
 300                 <a id="Roo.grid.CellSelectionModel-method-getSelectedCell"   name=".getSelectedCell"></a>
 301                 <div class="fixedFont">
 302                         <span class="attributes"></span><b class="itemname">getSelectedCell</b>
 303
 304                                  ()
 305
 306
 307                                          :
 308
 309
 310                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 311
 312
 313
 314
 315
 316                 </div>
 317                 <div class="mdesc">
 318
 319                    <div class="short">Returns the currently selected cell,.</div>
 320
 321
 322
 323                     <div class="long">
 324
 325                                 Returns the currently selected cell,.
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336                                 <dl class="detailList">
 337                                 <dt class="heading">Returns:</dt>
 338
 339                                         <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  The selected cell (row, column) or null if none selected.</dd>
 340
 341                                 </dl>
 342
 343
 344
 345
 346
 347
 348
 349                     </div>
 350                 </div>
 351
 352             </td>
 353             <td class="msource">
 354
 355                         Roo.grid.CellSelectionModel
 356                 &nbsp;
 357             </td>
 358         </tr>
 359
 360
 361           <tr class="method-row config-row-alt1 expandable notInherited">
 362             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 363
 364
 365             <td class="sig">
 366                 <a id="Roo.grid.CellSelectionModel-method-hasSelection"   name=".hasSelection"></a>
 367                 <div class="fixedFont">
 368                         <span class="attributes"></span><b class="itemname">hasSelection</b>
 369
 370                                  ()
 371
 372
 373                                          :
 374
 375
 376                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 377
 378
 379
 380
 381
 382                 </div>
 383                 <div class="mdesc">
 384
 385                    <div class="short">Returns true if there is a selection.</div>
 386
 387
 388
 389                     <div class="long">
 390
 391                                 Returns true if there is a selection.
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402                                 <dl class="detailList">
 403                                 <dt class="heading">Returns:</dt>
 404
 405                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
 406
 407                                 </dl>
 408
 409
 410
 411
 412
 413
 414
 415                     </div>
 416                 </div>
 417
 418             </td>
 419             <td class="msource">
 420
 421                         Roo.grid.CellSelectionModel
 422                 &nbsp;
 423             </td>
 424         </tr>
 425
 426
 427           <tr class="method-row config-row-alt0 expandable notInherited">
 428             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 429
 430
 431             <td class="sig">
 432                 <a id="Roo.grid.CellSelectionModel-method-select"   name=".select"></a>
 433                 <div class="fixedFont">
 434                         <span class="attributes"></span><b class="itemname">select</b>
 435
 436                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rowIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>collIndex</i></B>)
 437
 438
 439
 440                 </div>
 441                 <div class="mdesc">
 442
 443                    <div class="short">Selects a cell.</div>
 444
 445
 446
 447                     <div class="long">
 448
 449                                 Selects a cell.
 450
 451
 452
 453
 454
 455
 456                                 <dl class="detailList">
 457                                 <dt class="heading">Parameters:</dt>
 458
 459                                         <dt>
 460                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>rowIndex</b>
 461
 462                                         </dt>
 463                                         <dd></dd>
 464
 465                                         <dt>
 466                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>collIndex</b>
 467
 468                                         </dt>
 469                                         <dd></dd>
 470
 471                                 </dl>
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483                     </div>
 484                 </div>
 485
 486             </td>
 487             <td class="msource">
 488
 489                         Roo.grid.CellSelectionModel
 490                 &nbsp;
 491             </td>
 492         </tr>
 493
 494
 495     </table>
 496
 497
 498   <!-- ============================== events summary / details ======================== -->
 499
 500
 501   <a id="Roo.grid.CellSelectionModel-events"></a>
 502
 503
 504
 505
 506
 507
 508
 509
 510       <table cellspacing="0" class="member-table">
 511                 <caption>Events</caption>
 512               <thead>
 513                 <tr>
 514                     <th class="sig-header" colspan="2">Event</th>
 515                     <th class="msource-header">Defined By</th>
 516
 517                 </tr>
 518               </thead>
 519
 520
 521
 522
 523
 524           <tr class="method-row expandable config-row-alt0 notInherited">
 525             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 526
 527             <td class="sig">
 528                 <a id="Roo.grid.CellSelectionModel-event-*beforerowselect"></a>
 529
 530                <div class="fixedFont">
 531                 <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="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>colIndex</i></B>)
 532
 533                 </div>
 534
 535                 <div class="mdesc">
 536
 537                    <div class="short">Fires before a cell is selected.
 538
 539                 </div>
 540
 541                     <div class="long">
 542
 543                         Fires before a cell is selected.
 544
 545
 546
 547
 548
 549                                 <dl class="detailList">
 550                                 <dt class="heading">Parameters:</dt>
 551
 552                                         <dt>
 553                                                 <span class="fixedFont">SelectionModel</span> <b>this</b>
 554
 555                                         </dt>
 556                                         <dd></dd>
 557
 558                                         <dt>
 559                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
 560
 561                                         </dt>
 562                                         <dd>The selected row index</dd>
 563
 564                                         <dt>
 565                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
 566
 567                                         </dt>
 568                                         <dd>The selected cell index</dd>
 569
 570                                 </dl>
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582                     </div>
 583                 </div>
 584
 585             </td>
 586             <td class="msource">
 587                 Roo.grid.CellSelectionModel
 588             </td>
 589         </tr>
 590
 591           <tr class="method-row expandable config-row-alt1 notInherited">
 592             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 593
 594             <td class="sig">
 595                 <a id="Roo.grid.CellSelectionModel-event-*cellselect"></a>
 596
 597                <div class="fixedFont">
 598                 <b class="itemname">cellselect</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="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>colIndex</i></B>)
 599
 600                 </div>
 601
 602                 <div class="mdesc">
 603
 604                    <div class="short">Fires when a cell is selected.
 605
 606                 </div>
 607
 608                     <div class="long">
 609
 610                         Fires when a cell is selected.
 611
 612
 613
 614
 615
 616                                 <dl class="detailList">
 617                                 <dt class="heading">Parameters:</dt>
 618
 619                                         <dt>
 620                                                 <span class="fixedFont">SelectionModel</span> <b>this</b>
 621
 622                                         </dt>
 623                                         <dd></dd>
 624
 625                                         <dt>
 626                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
 627
 628                                         </dt>
 629                                         <dd>The selected row index</dd>
 630
 631                                         <dt>
 632                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
 633
 634                                         </dt>
 635                                         <dd>The selected cell index</dd>
 636
 637                                 </dl>
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649                     </div>
 650                 </div>
 651
 652             </td>
 653             <td class="msource">
 654                 Roo.grid.CellSelectionModel
 655             </td>
 656         </tr>
 657
 658           <tr class="method-row expandable config-row-alt0 notInherited">
 659             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 660
 661             <td class="sig">
 662                 <a id="Roo.grid.CellSelectionModel-event-*selectionchange"></a>
 663
 664                <div class="fixedFont">
 665                 <b class="itemname">selectionchange</b> (SelectionModel <B><i>this</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>selection</i></B>)
 666
 667                 </div>
 668
 669                 <div class="mdesc">
 670
 671                    <div class="short">Fires when the active selection changes.
 672
 673                 </div>
 674
 675                     <div class="long">
 676
 677                         Fires when the active selection changes.
 678
 679
 680
 681
 682
 683                                 <dl class="detailList">
 684                                 <dt class="heading">Parameters:</dt>
 685
 686                                         <dt>
 687                                                 <span class="fixedFont">SelectionModel</span> <b>this</b>
 688
 689                                         </dt>
 690                                         <dd></dd>
 691
 692                                         <dt>
 693                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>selection</b>
 694
 695                                         </dt>
 696                                         <dd>null for no selection or an object (o) with two properties<br/>             <ul><br/>               <li>o.record: the record object for the row the selection is in</li><br/>               <li>o.cell: An array of [rowIndex, columnIndex]</li><br/>               </ul></dd>
 697
 698                                 </dl>
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710                     </div>
 711                 </div>
 712
 713             </td>
 714             <td class="msource">
 715                 Roo.grid.CellSelectionModel
 716             </td>
 717         </tr>
 718
 719
 720     </table>
 721
 722
 723
 724
 725
 726 <!-- ============================== footer ================================= -->
 727                 <div class="fineprint" style="clear:both">
 728
 729                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 19:32:54 GMT+0800 (HKT)
 730                         Based on
 731                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 732                 </div>
 733         </body>
 734 </html>