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.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.CellSelectionModel
  49
  50                    </pre>
  51                 </div>
  52
  53 <!-- ============================== class title / details ============================ -->
  54
  55
  56     <h1 class="classTitle">
  57
  58                                 Class Roo.grid.CellSelectionModel
  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_CellSelectionModel.js.html">Roo/grid/CellSelectionModel.js</a>.
  68
  69         </td></tr>
  70         <tr><td class="label">Class:</td><td class="hd-info">CellSelectionModel</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         This class provides the basic implementation for cell selection in a grid.
  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.CellSelectionModel';">[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.CellSelectionModel.html"></iframe>
  98 </div>
  99
 100
 101
 102 <!-- ============================== config options ========================== -->
 103
 104
 105
 106
 107     <div class="hr"></div>
 108     <a id="Roo.grid.CellSelectionModel-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">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           ..... <br/>        } ,<br/>        .... <br/>    } <br/>  </code></pre></div>
 145                         </div>
 146
 147
 148
 149                     </td>
 150                     <td class="msource">
 151
 152                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 153
 154                     </td>
 155                 </tr>
 156
 157
 158     </table>
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168   <!-- ============================== public properties ==================== -->
 169
 170
 171
 172     <a id="Roo.grid.CellSelectionModel-props"></a>
 173
 174
 175
 176
 177
 178      <table cellspacing="0" class="member-table">
 179       <caption class="Empty">Public Properties - Has None</caption>
 180      </table>
 181
 182
 183
 184
 185   <!-- ============================== methods summary / details ======================== -->
 186
 187
 188   <a id="Roo.grid.CellSelectionModel-methods"></a>
 189         <!-- constructor?? -->
 190
 191         <!-- static's first
 192
 193
 194         -->
 195
 196         <!-- then dynamics first -->
 197
 198
 199
 200
 201
 202
 203       <table cellspacing="0" class="member-table">
 204       <caption>Public Methods</caption>
 205         <tr>
 206             <th class="sig-header" colspan="2">Method</th>
 207             <th class="msource-header">Defined By</th>
 208
 209         </tr>
 210
 211
 212
 213
 214
 215
 216
 217           <tr class="method-row config-row-alt0 expandable notInherited">
 218             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 219
 220
 221             <td class="sig">
 222                 <a id="Roo.grid-method-CellSelectionModel"   name=".CellSelectionModel"></a>
 223                 <div class="fixedFont">
 224                         <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">CellSelectionModel</b>
 225
 226                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 227
 228
 229
 230                 </div>
 231                 <div class="mdesc">
 232
 233
 234                         <div class="short">Create a new Roo.grid.CellSelectionModel</div>
 235
 236
 237                     <div class="long">
 238
 239
 240
 241                                 Create a new Roo.grid.CellSelectionModel
 242
 243
 244                                 <dl class="detailList">
 245                                 <dt class="heading">Parameters:</dt>
 246
 247                                         <dt>
 248                                                 <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>
 249
 250                                         </dt>
 251                                         <dd>The object containing the configuration of this model.</dd>
 252
 253                                 </dl>
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265                     </div>
 266                 </div>
 267
 268             </td>
 269             <td class="msource">
 270                 &nbsp;
 271             </td>
 272         </tr>
 273
 274
 275           <tr class="method-row config-row-alt1 expandable">
 276             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 277
 278
 279             <td class="sig">
 280                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
 281                 <div class="fixedFont">
 282                         <span class="attributes"></span><b class="itemname">addEvents</b>
 283
 284                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
 285
 286
 287
 288                 </div>
 289                 <div class="mdesc">
 290
 291                    <div class="short">Used to define events on this Observable</div>
 292
 293
 294
 295                     <div class="long">
 296
 297                                 Used to define events on this Observable
 298
 299
 300
 301
 302
 303
 304                                 <dl class="detailList">
 305                                 <dt class="heading">Parameters:</dt>
 306
 307                                         <dt>
 308                                                 <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>
 309
 310                                         </dt>
 311                                         <dd>The object with the events defined</dd>
 312
 313                                 </dl>
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325                     </div>
 326                 </div>
 327
 328             </td>
 329             <td class="msource">
 330
 331                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 332                 &nbsp;
 333             </td>
 334         </tr>
 335
 336
 337           <tr class="method-row config-row-alt0 expandable">
 338             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 339
 340
 341             <td class="sig">
 342                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
 343                 <div class="fixedFont">
 344                         <span class="attributes"></span><b class="itemname">addListener</b>
 345
 346                                  (<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>)
 347
 348
 349
 350                 </div>
 351                 <div class="mdesc">
 352
 353                    <div class="short">Appends an event handler to this component</div>
 354
 355
 356
 357                     <div class="long">
 358
 359                                 Appends an event handler to this component
 360
 361
 362
 363
 364
 365
 366                                 <dl class="detailList">
 367                                 <dt class="heading">Parameters:</dt>
 368
 369                                         <dt>
 370                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 371
 372                                         </dt>
 373                                         <dd>The type of event to listen for</dd>
 374
 375                                         <dt>
 376                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 377
 378                                         </dt>
 379                                         <dd>The method the event invokes</dd>
 380
 381                                         <dt>
 382                                                 <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>
 383
 384                                         </dt>
 385                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 386
 387                                         <dt>
 388                                                 <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>
 389
 390                                         </dt>
 391                                         <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>
 392
 393                                 </dl>
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405                     </div>
 406                 </div>
 407
 408             </td>
 409             <td class="msource">
 410
 411                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 412                 &nbsp;
 413             </td>
 414         </tr>
 415
 416
 417           <tr class="method-row config-row-alt1 expandable notInherited">
 418             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 419
 420
 421             <td class="sig">
 422                 <a id="Roo.grid.CellSelectionModel-method-clearSelections"   name=".clearSelections"></a>
 423                 <div class="fixedFont">
 424                         <span class="attributes"></span><b class="itemname">clearSelections</b>
 425
 426                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>true</i></B>)
 427
 428
 429
 430                 </div>
 431                 <div class="mdesc">
 432
 433                    <div class="short">Clears all selections.</div>
 434
 435
 436
 437                     <div class="long">
 438
 439                                 Clears all selections.
 440
 441
 442
 443
 444
 445
 446                                 <dl class="detailList">
 447                                 <dt class="heading">Parameters:</dt>
 448
 449                                         <dt>
 450                                                 <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>
 451
 452                                         </dt>
 453                                         <dd>to prevent the gridview from being notified about the change.</dd>
 454
 455                                 </dl>
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467                     </div>
 468                 </div>
 469
 470             </td>
 471             <td class="msource">
 472
 473                         Roo.grid.CellSelectionModel
 474                 &nbsp;
 475             </td>
 476         </tr>
 477
 478
 479           <tr class="method-row config-row-alt0 expandable">
 480             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 481
 482
 483             <td class="sig">
 484                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
 485                 <div class="fixedFont">
 486                         <span class="attributes"></span><b class="itemname">fireEvent</b>
 487
 488                                  (<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>)
 489
 490
 491                                          :
 492
 493
 494                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 495
 496
 497
 498
 499
 500                 </div>
 501                 <div class="mdesc">
 502
 503                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
 504
 505
 506
 507                     <div class="long">
 508
 509                                 Fires the specified event with the passed parameters (minus the event name).
 510
 511
 512
 513
 514
 515
 516                                 <dl class="detailList">
 517                                 <dt class="heading">Parameters:</dt>
 518
 519                                         <dt>
 520                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 521
 522                                         </dt>
 523                                         <dd></dd>
 524
 525                                         <dt>
 526                                                 <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>
 527
 528                                         </dt>
 529                                         <dd>Variable number of parameters are passed to handlers</dd>
 530
 531                                 </dl>
 532
 533
 534
 535
 536
 537                                 <dl class="detailList">
 538                                 <dt class="heading">Returns:</dt>
 539
 540                                         <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>
 541
 542                                 </dl>
 543
 544
 545
 546
 547
 548
 549
 550                     </div>
 551                 </div>
 552
 553             </td>
 554             <td class="msource">
 555
 556                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 557                 &nbsp;
 558             </td>
 559         </tr>
 560
 561
 562           <tr class="method-row config-row-alt1 expandable notInherited">
 563             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 564
 565
 566             <td class="sig">
 567                 <a id="Roo.grid.CellSelectionModel-method-getSelectedCell"   name=".getSelectedCell"></a>
 568                 <div class="fixedFont">
 569                         <span class="attributes"></span><b class="itemname">getSelectedCell</b>
 570
 571                                  ()
 572
 573
 574                                          :
 575
 576
 577                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 578
 579
 580
 581
 582
 583                 </div>
 584                 <div class="mdesc">
 585
 586                    <div class="short">Returns the currently selected cell,.</div>
 587
 588
 589
 590                     <div class="long">
 591
 592                                 Returns the currently selected cell,.
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603                                 <dl class="detailList">
 604                                 <dt class="heading">Returns:</dt>
 605
 606                                         <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>
 607
 608                                 </dl>
 609
 610
 611
 612
 613
 614
 615
 616                     </div>
 617                 </div>
 618
 619             </td>
 620             <td class="msource">
 621
 622                         Roo.grid.CellSelectionModel
 623                 &nbsp;
 624             </td>
 625         </tr>
 626
 627
 628           <tr class="method-row config-row-alt0 expandable">
 629             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 630
 631
 632             <td class="sig">
 633                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
 634                 <div class="fixedFont">
 635                         <span class="attributes"></span><b class="itemname">hasListener</b>
 636
 637                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
 638
 639
 640                                          :
 641
 642
 643                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 644
 645
 646
 647
 648
 649                 </div>
 650                 <div class="mdesc">
 651
 652                    <div class="short">Checks to see if this object has any listeners for a specified event</div>
 653
 654
 655
 656                     <div class="long">
 657
 658                                 Checks to see if this object has any listeners for a specified event
 659
 660
 661
 662
 663
 664
 665                                 <dl class="detailList">
 666                                 <dt class="heading">Parameters:</dt>
 667
 668                                         <dt>
 669                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 670
 671                                         </dt>
 672                                         <dd>The name of the event to check for</dd>
 673
 674                                 </dl>
 675
 676
 677
 678
 679
 680                                 <dl class="detailList">
 681                                 <dt class="heading">Returns:</dt>
 682
 683                                         <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>
 684
 685                                 </dl>
 686
 687
 688
 689
 690
 691
 692
 693                     </div>
 694                 </div>
 695
 696             </td>
 697             <td class="msource">
 698
 699                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 700                 &nbsp;
 701             </td>
 702         </tr>
 703
 704
 705           <tr class="method-row config-row-alt1 expandable notInherited">
 706             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 707
 708
 709             <td class="sig">
 710                 <a id="Roo.grid.CellSelectionModel-method-hasSelection"   name=".hasSelection"></a>
 711                 <div class="fixedFont">
 712                         <span class="attributes"></span><b class="itemname">hasSelection</b>
 713
 714                                  ()
 715
 716
 717                                          :
 718
 719
 720                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 721
 722
 723
 724
 725
 726                 </div>
 727                 <div class="mdesc">
 728
 729                    <div class="short">Returns true if there is a selection.</div>
 730
 731
 732
 733                     <div class="long">
 734
 735                                 Returns true if there is a selection.
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746                                 <dl class="detailList">
 747                                 <dt class="heading">Returns:</dt>
 748
 749                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
 750
 751                                 </dl>
 752
 753
 754
 755
 756
 757
 758
 759                     </div>
 760                 </div>
 761
 762             </td>
 763             <td class="msource">
 764
 765                         Roo.grid.CellSelectionModel
 766                 &nbsp;
 767             </td>
 768         </tr>
 769
 770
 771           <tr class="method-row config-row-alt0 expandable">
 772             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 773
 774
 775             <td class="sig">
 776                 <a id="Roo.grid.AbstractSelectionModel-method-isLocked"   name=".isLocked"></a>
 777                 <div class="fixedFont">
 778                         <span class="attributes"></span><b class="itemname">isLocked</b>
 779
 780                                  ()
 781
 782
 783                                          :
 784
 785
 786                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 787
 788
 789
 790
 791
 792                 </div>
 793                 <div class="mdesc">
 794
 795                    <div class="short">Returns true if the selections are locked.</div>
 796
 797
 798
 799                     <div class="long">
 800
 801                                 Returns true if the selections are locked.
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812                                 <dl class="detailList">
 813                                 <dt class="heading">Returns:</dt>
 814
 815                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
 816
 817                                 </dl>
 818
 819
 820
 821
 822
 823
 824
 825                     </div>
 826                 </div>
 827
 828             </td>
 829             <td class="msource">
 830
 831                         <a href="./Roo.grid.AbstractSelectionModel.html#constructor" roo:cls="Roo.grid.AbstractSelectionModel.html#constructor">Roo.grid.AbstractSelectionModel</a>
 832                 &nbsp;
 833             </td>
 834         </tr>
 835
 836
 837           <tr class="method-row config-row-alt1 expandable">
 838             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 839
 840
 841             <td class="sig">
 842                 <a id="Roo.grid.AbstractSelectionModel-method-lock"   name=".lock"></a>
 843                 <div class="fixedFont">
 844                         <span class="attributes"></span><b class="itemname">lock</b>
 845
 846                                  ()
 847
 848
 849
 850                 </div>
 851                 <div class="mdesc">
 852
 853                    <div class="short">Locks the selections.</div>
 854
 855
 856
 857                     <div class="long">
 858
 859                                 Locks the selections.
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876                     </div>
 877                 </div>
 878
 879             </td>
 880             <td class="msource">
 881
 882                         <a href="./Roo.grid.AbstractSelectionModel.html#constructor" roo:cls="Roo.grid.AbstractSelectionModel.html#constructor">Roo.grid.AbstractSelectionModel</a>
 883                 &nbsp;
 884             </td>
 885         </tr>
 886
 887
 888           <tr class="method-row config-row-alt0 expandable">
 889             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 890
 891
 892             <td class="sig">
 893                 <a id="Roo.util.Observable-method-on"   name=".on"></a>
 894                 <div class="fixedFont">
 895                         <span class="attributes"></span><b class="itemname">on</b>
 896
 897                                  (<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>)
 898
 899
 900
 901                 </div>
 902                 <div class="mdesc">
 903
 904                    <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
 905
 906
 907
 908                     <div class="long">
 909
 910                                 Appends an event handler to this element (shorthand for addListener)
 911
 912
 913
 914
 915
 916
 917                                 <dl class="detailList">
 918                                 <dt class="heading">Parameters:</dt>
 919
 920                                         <dt>
 921                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 922
 923                                         </dt>
 924                                         <dd>The type of event to listen for</dd>
 925
 926                                         <dt>
 927                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 928
 929                                         </dt>
 930                                         <dd>The method the event invokes</dd>
 931
 932                                         <dt>
 933                                                 <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>
 934
 935                                         </dt>
 936                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 937
 938                                         <dt>
 939                                                 <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>
 940
 941                                         </dt>
 942                                         <dd>(optional)</dd>
 943
 944                                 </dl>
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956                     </div>
 957                 </div>
 958
 959             </td>
 960             <td class="msource">
 961
 962                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 963                 &nbsp;
 964             </td>
 965         </tr>
 966
 967
 968           <tr class="method-row config-row-alt1 expandable notInherited">
 969             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 970
 971
 972             <td class="sig">
 973                 <a id="Roo.grid.CellSelectionModel-method-onEditorKey"   name=".onEditorKey"></a>
 974                 <div class="fixedFont">
 975                         <span class="attributes"></span><b class="itemname">onEditorKey</b>
 976
 977                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>field</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>e</i></B>)
 978
 979
 980
 981                 </div>
 982                 <div class="mdesc">
 983
 984                    <div class="short">Selects a cell.</div>
 985
 986
 987
 988                     <div class="long">
 989
 990                                 Selects a cell.
 991
 992
 993
 994
 995
 996
 997                                 <dl class="detailList">
 998                                 <dt class="heading">Parameters:</dt>
 999
1000                                         <dt>
1001                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>field</b>
1002
1003                                         </dt>
1004                                         <dd>(not used) - as it's normally used as a listener</dd>
1005
1006                                         <dt>
1007                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>e</b>
1008
1009                                         </dt>
1010                                         <dd>- event - fake it by using<br/><br/>var e = Roo.EventObjectImpl.prototype;<br/>e.keyCode = e.TAB</dd>
1011
1012                                 </dl>
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024                     </div>
1025                 </div>
1026
1027             </td>
1028             <td class="msource">
1029
1030                         Roo.grid.CellSelectionModel
1031                 &nbsp;
1032             </td>
1033         </tr>
1034
1035
1036           <tr class="method-row config-row-alt0 expandable">
1037             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1038
1039
1040             <td class="sig">
1041                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
1042                 <div class="fixedFont">
1043                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
1044
1045                                  ()
1046
1047
1048
1049                 </div>
1050                 <div class="mdesc">
1051
1052                    <div class="short">Removes all listeners for this object</div>
1053
1054
1055
1056                     <div class="long">
1057
1058                                 Removes all listeners for this object
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075                     </div>
1076                 </div>
1077
1078             </td>
1079             <td class="msource">
1080
1081                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1082                 &nbsp;
1083             </td>
1084         </tr>
1085
1086
1087           <tr class="method-row config-row-alt1 expandable">
1088             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1089
1090
1091             <td class="sig">
1092                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
1093                 <div class="fixedFont">
1094                         <span class="attributes"></span><b class="itemname">removeListener</b>
1095
1096                                  (<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>)
1097
1098
1099
1100                 </div>
1101                 <div class="mdesc">
1102
1103                    <div class="short">Removes a listener</div>
1104
1105
1106
1107                     <div class="long">
1108
1109                                 Removes a listener
1110
1111
1112
1113
1114
1115
1116                                 <dl class="detailList">
1117                                 <dt class="heading">Parameters:</dt>
1118
1119                                         <dt>
1120                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1121
1122                                         </dt>
1123                                         <dd>The type of event to listen for</dd>
1124
1125                                         <dt>
1126                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1127
1128                                         </dt>
1129                                         <dd>The handler to remove</dd>
1130
1131                                         <dt>
1132                                                 <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>
1133
1134                                         </dt>
1135                                         <dd>(optional) The scope (this object) for the handler</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                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1156                 &nbsp;
1157             </td>
1158         </tr>
1159
1160
1161           <tr class="method-row config-row-alt0 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.CellSelectionModel-method-select"   name=".select"></a>
1167                 <div class="fixedFont">
1168                         <span class="attributes"></span><b class="itemname">select</b>
1169
1170                                  (<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>)
1171
1172
1173
1174                 </div>
1175                 <div class="mdesc">
1176
1177                    <div class="short">Selects a cell.</div>
1178
1179
1180
1181                     <div class="long">
1182
1183                                 Selects a cell.
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>rowIndex</b>
1195
1196                                         </dt>
1197                                         <dd></dd>
1198
1199                                         <dt>
1200                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>collIndex</b>
1201
1202                                         </dt>
1203                                         <dd></dd>
1204
1205                                 </dl>
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217                     </div>
1218                 </div>
1219
1220             </td>
1221             <td class="msource">
1222
1223                         Roo.grid.CellSelectionModel
1224                 &nbsp;
1225             </td>
1226         </tr>
1227
1228
1229           <tr class="method-row config-row-alt1 expandable">
1230             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1231
1232
1233             <td class="sig">
1234                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
1235                 <div class="fixedFont">
1236                         <span class="attributes"></span><b class="itemname">un</b>
1237
1238                                  (<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>)
1239
1240
1241
1242                 </div>
1243                 <div class="mdesc">
1244
1245                    <div class="short">Removes a listener (shorthand for removeListener)</div>
1246
1247
1248
1249                     <div class="long">
1250
1251                                 Removes a listener (shorthand for removeListener)
1252
1253
1254
1255
1256
1257
1258                                 <dl class="detailList">
1259                                 <dt class="heading">Parameters:</dt>
1260
1261                                         <dt>
1262                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1263
1264                                         </dt>
1265                                         <dd>The type of event to listen for</dd>
1266
1267                                         <dt>
1268                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1269
1270                                         </dt>
1271                                         <dd>The handler to remove</dd>
1272
1273                                         <dt>
1274                                                 <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>
1275
1276                                         </dt>
1277                                         <dd>(optional) The scope (this object) for the handler</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                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1298                 &nbsp;
1299             </td>
1300         </tr>
1301
1302
1303           <tr class="method-row config-row-alt0 expandable">
1304             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1305
1306
1307             <td class="sig">
1308                 <a id="Roo.grid.AbstractSelectionModel-method-unlock"   name=".unlock"></a>
1309                 <div class="fixedFont">
1310                         <span class="attributes"></span><b class="itemname">unlock</b>
1311
1312                                  ()
1313
1314
1315
1316                 </div>
1317                 <div class="mdesc">
1318
1319                    <div class="short">Unlocks the selections.</div>
1320
1321
1322
1323                     <div class="long">
1324
1325                                 Unlocks the selections.
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342                     </div>
1343                 </div>
1344
1345             </td>
1346             <td class="msource">
1347
1348                         <a href="./Roo.grid.AbstractSelectionModel.html#constructor" roo:cls="Roo.grid.AbstractSelectionModel.html#constructor">Roo.grid.AbstractSelectionModel</a>
1349                 &nbsp;
1350             </td>
1351         </tr>
1352
1353
1354     </table>
1355
1356
1357   <!-- ============================== events summary / details ======================== -->
1358
1359
1360   <a id="Roo.grid.CellSelectionModel-events"></a>
1361
1362
1363
1364
1365
1366
1367
1368
1369       <table cellspacing="0" class="member-table">
1370                 <caption>Events</caption>
1371               <thead>
1372                 <tr>
1373                     <th class="sig-header" colspan="2">Event</th>
1374                     <th class="msource-header">Defined By</th>
1375
1376                 </tr>
1377               </thead>
1378
1379
1380
1381
1382
1383           <tr class="method-row expandable config-row-alt0 notInherited">
1384             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1385
1386             <td class="sig">
1387                 <a id="Roo.grid.CellSelectionModel-event-*beforerowselect"></a>
1388
1389                <div class="fixedFont">
1390                 <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>)
1391
1392                 </div>
1393
1394                 <div class="mdesc">
1395
1396                    <div class="short">Fires before a cell is selected.
1397
1398                 </div>
1399
1400                     <div class="long">
1401
1402                         Fires before a cell is selected.
1403
1404
1405
1406
1407
1408                                 <dl class="detailList">
1409                                 <dt class="heading">Parameters:</dt>
1410
1411                                         <dt>
1412                                                 <span class="fixedFont">SelectionModel</span> <b>this</b>
1413
1414                                         </dt>
1415                                         <dd></dd>
1416
1417                                         <dt>
1418                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
1419
1420                                         </dt>
1421                                         <dd>The selected row index</dd>
1422
1423                                         <dt>
1424                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
1425
1426                                         </dt>
1427                                         <dd>The selected cell index</dd>
1428
1429                                 </dl>
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441                     </div>
1442                 </div>
1443
1444             </td>
1445             <td class="msource">
1446                 Roo.grid.CellSelectionModel
1447             </td>
1448         </tr>
1449
1450           <tr class="method-row expandable config-row-alt1 notInherited">
1451             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1452
1453             <td class="sig">
1454                 <a id="Roo.grid.CellSelectionModel-event-*cellselect"></a>
1455
1456                <div class="fixedFont">
1457                 <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>)
1458
1459                 </div>
1460
1461                 <div class="mdesc">
1462
1463                    <div class="short">Fires when a cell is selected.
1464
1465                 </div>
1466
1467                     <div class="long">
1468
1469                         Fires when a cell is selected.
1470
1471
1472
1473
1474
1475                                 <dl class="detailList">
1476                                 <dt class="heading">Parameters:</dt>
1477
1478                                         <dt>
1479                                                 <span class="fixedFont">SelectionModel</span> <b>this</b>
1480
1481                                         </dt>
1482                                         <dd></dd>
1483
1484                                         <dt>
1485                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
1486
1487                                         </dt>
1488                                         <dd>The selected row index</dd>
1489
1490                                         <dt>
1491                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
1492
1493                                         </dt>
1494                                         <dd>The selected cell index</dd>
1495
1496                                 </dl>
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508                     </div>
1509                 </div>
1510
1511             </td>
1512             <td class="msource">
1513                 Roo.grid.CellSelectionModel
1514             </td>
1515         </tr>
1516
1517           <tr class="method-row expandable config-row-alt0 notInherited">
1518             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1519
1520             <td class="sig">
1521                 <a id="Roo.grid.CellSelectionModel-event-*selectionchange"></a>
1522
1523                <div class="fixedFont">
1524                 <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>)
1525
1526                 </div>
1527
1528                 <div class="mdesc">
1529
1530                    <div class="short">Fires when the active selection changes.
1531
1532                 </div>
1533
1534                     <div class="long">
1535
1536                         Fires when the active selection changes.
1537
1538
1539
1540
1541
1542                                 <dl class="detailList">
1543                                 <dt class="heading">Parameters:</dt>
1544
1545                                         <dt>
1546                                                 <span class="fixedFont">SelectionModel</span> <b>this</b>
1547
1548                                         </dt>
1549                                         <dd></dd>
1550
1551                                         <dt>
1552                                                 <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>
1553
1554                                         </dt>
1555                                         <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>
1556
1557                                 </dl>
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569                     </div>
1570                 </div>
1571
1572             </td>
1573             <td class="msource">
1574                 Roo.grid.CellSelectionModel
1575             </td>
1576         </tr>
1577
1578
1579     </table>
1580
1581
1582
1583
1584
1585 <!-- ============================== footer ================================= -->
1586                 <div class="fineprint" style="clear:both">
1587
1588                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Wed Nov 02 2011 16:45:15 GMT+0800 (HKT)
1589                         Based on
1590                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1591                 </div>
1592         </body>
1593 </html>