git.roojs.org Git - roojs1/blob - docs/symbols/Roo.grid.GridView.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.GridView</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.GridView-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.grid.GridView-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.grid.GridView-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.grid.GridView-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 class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.grid.GridView
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.grid.GridView
  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_GridView.js.html">Roo/grid/GridView.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">GridView</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85
  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.GridView';">[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.GridView.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.grid.GridView-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">
 128                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 129                     <td class="sig">
 130
 131                         <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <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>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <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>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 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.GridView-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.GridView-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-GridView"   name=".GridView"></a>
 222                 <div class="fixedFont">
 223                         <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">GridView</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.GridView</div>
 234
 235
 236                     <div class="long">
 237
 238
 239
 240                                 Create a new Roo.grid.GridView
 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">
 275             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 276
 277
 278             <td class="sig">
 279                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
 280                 <div class="fixedFont">
 281                         <span class="attributes"></span><b class="itemname">addEvents</b>
 282
 283                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
 284
 285
 286
 287                 </div>
 288                 <div class="mdesc">
 289
 290                    <div class="short">Used to define events on this Observable</div>
 291
 292
 293
 294                     <div class="long">
 295
 296                                 Used to define events on this Observable
 297
 298
 299
 300
 301
 302
 303                                 <dl class="detailList">
 304                                 <dt class="heading">Parameters:</dt>
 305
 306                                         <dt>
 307                                                 <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>
 308
 309                                         </dt>
 310                                         <dd>The object with the events defined</dd>
 311
 312                                 </dl>
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324                     </div>
 325                 </div>
 326
 327             </td>
 328             <td class="msource">
 329
 330                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 331                 &nbsp;
 332             </td>
 333         </tr>
 334
 335
 336           <tr class="method-row config-row-alt0 expandable">
 337             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 338
 339
 340             <td class="sig">
 341                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
 342                 <div class="fixedFont">
 343                         <span class="attributes"></span><b class="itemname">addListener</b>
 344
 345                                  (<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>)
 346
 347
 348
 349                 </div>
 350                 <div class="mdesc">
 351
 352                    <div class="short">Appends an event handler to this component</div>
 353
 354
 355
 356                     <div class="long">
 357
 358                                 Appends an event handler to this component
 359
 360
 361
 362
 363
 364
 365                                 <dl class="detailList">
 366                                 <dt class="heading">Parameters:</dt>
 367
 368                                         <dt>
 369                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 370
 371                                         </dt>
 372                                         <dd>The type of event to listen for</dd>
 373
 374                                         <dt>
 375                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 376
 377                                         </dt>
 378                                         <dd>The method the event invokes</dd>
 379
 380                                         <dt>
 381                                                 <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>
 382
 383                                         </dt>
 384                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 385
 386                                         <dt>
 387                                                 <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>
 388
 389                                         </dt>
 390                                         <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>
 391
 392                                 </dl>
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404                     </div>
 405                 </div>
 406
 407             </td>
 408             <td class="msource">
 409
 410                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 411                 &nbsp;
 412             </td>
 413         </tr>
 414
 415
 416           <tr class="method-row config-row-alt1 expandable notInherited">
 417             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 418
 419
 420             <td class="sig">
 421                 <a id="Roo.grid.GridView-method-autoSizeColumn"   name=".autoSizeColumn"></a>
 422                 <div class="fixedFont">
 423                         <span class="attributes"></span><b class="itemname">autoSizeColumn</b>
 424
 425                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>colIndex</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>forceMinSize</i></B>)
 426
 427
 428
 429                 </div>
 430                 <div class="mdesc">
 431
 432                    <div class="short">Autofit a column to its content.</div>
 433
 434
 435
 436                     <div class="long">
 437
 438                                 Autofit a column to its content.
 439
 440
 441
 442
 443
 444
 445                                 <dl class="detailList">
 446                                 <dt class="heading">Parameters:</dt>
 447
 448                                         <dt>
 449                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>colIndex</b>
 450
 451                                         </dt>
 452                                         <dd></dd>
 453
 454                                         <dt>
 455                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>forceMinSize</b>
 456
 457                                         </dt>
 458                                         <dd>true to force the column to go smaller if possible</dd>
 459
 460                                 </dl>
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472                     </div>
 473                 </div>
 474
 475             </td>
 476             <td class="msource">
 477
 478                         Roo.grid.GridView
 479                 &nbsp;
 480             </td>
 481         </tr>
 482
 483
 484           <tr class="method-row config-row-alt0 expandable notInherited">
 485             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 486
 487
 488             <td class="sig">
 489                 <a id="Roo.grid.GridView-method-autoSizeColumns"   name=".autoSizeColumns"></a>
 490                 <div class="fixedFont">
 491                         <span class="attributes"></span><b class="itemname">autoSizeColumns</b>
 492
 493                                  ()
 494
 495
 496
 497                 </div>
 498                 <div class="mdesc">
 499
 500                    <div class="short">Autofits all columns to their content and then expands to fit any extra space in the grid</div>
 501
 502
 503
 504                     <div class="long">
 505
 506                                 Autofits all columns to their content and then expands to fit any extra space in the grid
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523                     </div>
 524                 </div>
 525
 526             </td>
 527             <td class="msource">
 528
 529                         Roo.grid.GridView
 530                 &nbsp;
 531             </td>
 532         </tr>
 533
 534
 535           <tr class="method-row config-row-alt1 expandable notInherited">
 536             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 537
 538
 539             <td class="sig">
 540                 <a id="Roo.grid.GridView-method-ensureVisible"   name=".ensureVisible"></a>
 541                 <div class="fixedFont">
 542                         <span class="attributes"></span><b class="itemname">ensureVisible</b>
 543
 544                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>row</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>hscroll</i></B>)
 545
 546
 547
 548                 </div>
 549                 <div class="mdesc">
 550
 551                    <div class="short">Scrolls the specified cell into view</div>
 552
 553
 554
 555                     <div class="long">
 556
 557                                 Scrolls the specified cell into view
 558
 559
 560
 561
 562
 563
 564                                 <dl class="detailList">
 565                                 <dt class="heading">Parameters:</dt>
 566
 567                                         <dt>
 568                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>row</b>
 569
 570                                         </dt>
 571                                         <dd>The row index</dd>
 572
 573                                         <dt>
 574                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>col</b>
 575
 576                                         </dt>
 577                                         <dd>The column index</dd>
 578
 579                                         <dt>
 580                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>hscroll</b>
 581
 582                                         </dt>
 583                                         <dd>false to disable horizontal scrolling</dd>
 584
 585                                 </dl>
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597                     </div>
 598                 </div>
 599
 600             </td>
 601             <td class="msource">
 602
 603                         Roo.grid.GridView
 604                 &nbsp;
 605             </td>
 606         </tr>
 607
 608
 609           <tr class="method-row config-row-alt0 expandable">
 610             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 611
 612
 613             <td class="sig">
 614                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
 615                 <div class="fixedFont">
 616                         <span class="attributes"></span><b class="itemname">fireEvent</b>
 617
 618                                  (<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>)
 619
 620
 621                                          :
 622
 623
 624                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 625
 626
 627
 628
 629
 630                 </div>
 631                 <div class="mdesc">
 632
 633                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
 634
 635
 636
 637                     <div class="long">
 638
 639                                 Fires the specified event with the passed parameters (minus the event name).
 640
 641
 642
 643
 644
 645
 646                                 <dl class="detailList">
 647                                 <dt class="heading">Parameters:</dt>
 648
 649                                         <dt>
 650                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 651
 652                                         </dt>
 653                                         <dd></dd>
 654
 655                                         <dt>
 656                                                 <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>
 657
 658                                         </dt>
 659                                         <dd>Variable number of parameters are passed to handlers</dd>
 660
 661                                 </dl>
 662
 663
 664
 665
 666
 667                                 <dl class="detailList">
 668                                 <dt class="heading">Returns:</dt>
 669
 670                                         <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>
 671
 672                                 </dl>
 673
 674
 675
 676
 677
 678
 679
 680                     </div>
 681                 </div>
 682
 683             </td>
 684             <td class="msource">
 685
 686                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 687                 &nbsp;
 688             </td>
 689         </tr>
 690
 691
 692           <tr class="method-row config-row-alt1 expandable notInherited">
 693             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 694
 695
 696             <td class="sig">
 697                 <a id="Roo.grid.GridView-method-fitColumns"   name=".fitColumns"></a>
 698                 <div class="fixedFont">
 699                         <span class="attributes"></span><b class="itemname">fitColumns</b>
 700
 701                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>reserveScrollSpace</i></B>)
 702
 703
 704
 705                 </div>
 706                 <div class="mdesc">
 707
 708                    <div class="short">Autofits all columns to the grid's width proportionate with their current size</div>
 709
 710
 711
 712                     <div class="long">
 713
 714                                 Autofits all columns to the grid's width proportionate with their current size
 715
 716
 717
 718
 719
 720
 721                                 <dl class="detailList">
 722                                 <dt class="heading">Parameters:</dt>
 723
 724                                         <dt>
 725                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>reserveScrollSpace</b>
 726
 727                                         </dt>
 728                                         <dd>Reserve space for a scrollbar</dd>
 729
 730                                 </dl>
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742                     </div>
 743                 </div>
 744
 745             </td>
 746             <td class="msource">
 747
 748                         Roo.grid.GridView
 749                 &nbsp;
 750             </td>
 751         </tr>
 752
 753
 754           <tr class="method-row config-row-alt0 expandable notInherited">
 755             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 756
 757
 758             <td class="sig">
 759                 <a id="Roo.grid.GridView-method-focusCell"   name=".focusCell"></a>
 760                 <div class="fixedFont">
 761                         <span class="attributes"></span><b class="itemname">focusCell</b>
 762
 763                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>row</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>hscroll</i></B>)
 764
 765
 766
 767                 </div>
 768                 <div class="mdesc">
 769
 770                    <div class="short">Focuses the specified cell.</div>
 771
 772
 773
 774                     <div class="long">
 775
 776                                 Focuses the specified cell.
 777
 778
 779
 780
 781
 782
 783                                 <dl class="detailList">
 784                                 <dt class="heading">Parameters:</dt>
 785
 786                                         <dt>
 787                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>row</b>
 788
 789                                         </dt>
 790                                         <dd>The row index</dd>
 791
 792                                         <dt>
 793                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>col</b>
 794
 795                                         </dt>
 796                                         <dd>The column index</dd>
 797
 798                                         <dt>
 799                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>hscroll</b>
 800
 801                                         </dt>
 802                                         <dd>false to disable horizontal scrolling</dd>
 803
 804                                 </dl>
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816                     </div>
 817                 </div>
 818
 819             </td>
 820             <td class="msource">
 821
 822                         Roo.grid.GridView
 823                 &nbsp;
 824             </td>
 825         </tr>
 826
 827
 828           <tr class="method-row config-row-alt1 expandable notInherited">
 829             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 830
 831
 832             <td class="sig">
 833                 <a id="Roo.grid.GridView-method-focusRow"   name=".focusRow"></a>
 834                 <div class="fixedFont">
 835                         <span class="attributes"></span><b class="itemname">focusRow</b>
 836
 837                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>row</i></B>)
 838
 839
 840
 841                 </div>
 842                 <div class="mdesc">
 843
 844                    <div class="short">Focuses the specified row.</div>
 845
 846
 847
 848                     <div class="long">
 849
 850                                 Focuses the specified row.
 851
 852
 853
 854
 855
 856
 857                                 <dl class="detailList">
 858                                 <dt class="heading">Parameters:</dt>
 859
 860                                         <dt>
 861                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>row</b>
 862
 863                                         </dt>
 864                                         <dd>The row index</dd>
 865
 866                                 </dl>
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878                     </div>
 879                 </div>
 880
 881             </td>
 882             <td class="msource">
 883
 884                         Roo.grid.GridView
 885                 &nbsp;
 886             </td>
 887         </tr>
 888
 889
 890           <tr class="method-row config-row-alt0 expandable notInherited">
 891             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 892
 893
 894             <td class="sig">
 895                 <a id="Roo.grid.GridView-method-getFooterPanel"   name=".getFooterPanel"></a>
 896                 <div class="fixedFont">
 897                         <span class="attributes"></span><b class="itemname">getFooterPanel</b>
 898
 899                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>doShow</i></B>)
 900
 901
 902                                          :
 903
 904
 905
 906
 907
 908
 909
 910
 911                 </div>
 912                 <div class="mdesc">
 913
 914                    <div class="short">Gets a panel in the footer of the grid that can be used for toolbars etc.</div>
 915
 916
 917
 918                     <div class="long">
 919
 920                                 Gets a panel in the footer of the grid that can be used for toolbars etc.<br/>After modifying the contents of this panel a call to grid.autoSize() may be<br/>required to register any changes in size.
 921
 922
 923
 924
 925
 926
 927                                 <dl class="detailList">
 928                                 <dt class="heading">Parameters:</dt>
 929
 930                                         <dt>
 931                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>doShow</b>
 932
 933                                         </dt>
 934                                         <dd>By default the footer is hidden. Pass true to show the panel</dd>
 935
 936                                 </dl>
 937
 938
 939
 940
 941
 942                                 <dl class="detailList">
 943                                 <dt class="heading">Returns:</dt>
 944
 945                                         <dd> Roo.Element</dd>
 946
 947                                 </dl>
 948
 949
 950
 951
 952
 953
 954
 955                     </div>
 956                 </div>
 957
 958             </td>
 959             <td class="msource">
 960
 961                         Roo.grid.GridView
 962                 &nbsp;
 963             </td>
 964         </tr>
 965
 966
 967           <tr class="method-row config-row-alt1 expandable notInherited">
 968             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 969
 970
 971             <td class="sig">
 972                 <a id="Roo.grid.GridView-method-getHeaderPanel"   name=".getHeaderPanel"></a>
 973                 <div class="fixedFont">
 974                         <span class="attributes"></span><b class="itemname">getHeaderPanel</b>
 975
 976                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>doShow</i></B>)
 977
 978
 979                                          :
 980
 981
 982
 983
 984
 985
 986
 987
 988                 </div>
 989                 <div class="mdesc">
 990
 991                    <div class="short">Gets a panel in the header of the grid that can be used for toolbars etc.</div>
 992
 993
 994
 995                     <div class="long">
 996
 997                                 Gets a panel in the header of the grid that can be used for toolbars etc.<br/>After modifying the contents of this panel a call to grid.autoSize() may be<br/>required to register any changes in size.
 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>doShow</b>
1009
1010                                         </dt>
1011                                         <dd>By default the header is hidden. Pass true to show the panel</dd>
1012
1013                                 </dl>
1014
1015
1016
1017
1018
1019                                 <dl class="detailList">
1020                                 <dt class="heading">Returns:</dt>
1021
1022                                         <dd> Roo.Element</dd>
1023
1024                                 </dl>
1025
1026
1027
1028
1029
1030
1031
1032                     </div>
1033                 </div>
1034
1035             </td>
1036             <td class="msource">
1037
1038                         Roo.grid.GridView
1039                 &nbsp;
1040             </td>
1041         </tr>
1042
1043
1044           <tr class="method-row config-row-alt0 expandable">
1045             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1046
1047
1048             <td class="sig">
1049                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
1050                 <div class="fixedFont">
1051                         <span class="attributes"></span><b class="itemname">hasListener</b>
1052
1053                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1054
1055
1056                                          :
1057
1058
1059                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1060
1061
1062
1063
1064
1065                 </div>
1066                 <div class="mdesc">
1067
1068                    <div class="short">Checks to see if this object has any listeners for a specified event</div>
1069
1070
1071
1072                     <div class="long">
1073
1074                                 Checks to see if this object has any listeners for a specified event
1075
1076
1077
1078
1079
1080
1081                                 <dl class="detailList">
1082                                 <dt class="heading">Parameters:</dt>
1083
1084                                         <dt>
1085                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1086
1087                                         </dt>
1088                                         <dd>The name of the event to check for</dd>
1089
1090                                 </dl>
1091
1092
1093
1094
1095
1096                                 <dl class="detailList">
1097                                 <dt class="heading">Returns:</dt>
1098
1099                                         <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>
1100
1101                                 </dl>
1102
1103
1104
1105
1106
1107
1108
1109                     </div>
1110                 </div>
1111
1112             </td>
1113             <td class="msource">
1114
1115                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1116                 &nbsp;
1117             </td>
1118         </tr>
1119
1120
1121           <tr class="method-row config-row-alt1 expandable">
1122             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1123
1124
1125             <td class="sig">
1126                 <a id="Roo.util.Observable-method-on"   name=".on"></a>
1127                 <div class="fixedFont">
1128                         <span class="attributes"></span><b class="itemname">on</b>
1129
1130                                  (<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>)
1131
1132
1133
1134                 </div>
1135                 <div class="mdesc">
1136
1137                    <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1138
1139
1140
1141                     <div class="long">
1142
1143                                 Appends an event handler to this element (shorthand for addListener)
1144
1145
1146
1147
1148
1149
1150                                 <dl class="detailList">
1151                                 <dt class="heading">Parameters:</dt>
1152
1153                                         <dt>
1154                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1155
1156                                         </dt>
1157                                         <dd>The type of event to listen for</dd>
1158
1159                                         <dt>
1160                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1161
1162                                         </dt>
1163                                         <dd>The method the event invokes</dd>
1164
1165                                         <dt>
1166                                                 <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>
1167
1168                                         </dt>
1169                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1170
1171                                         <dt>
1172                                                 <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>
1173
1174                                         </dt>
1175                                         <dd>(optional)</dd>
1176
1177                                 </dl>
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189                     </div>
1190                 </div>
1191
1192             </td>
1193             <td class="msource">
1194
1195                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1196                 &nbsp;
1197             </td>
1198         </tr>
1199
1200
1201           <tr class="method-row config-row-alt0 expandable">
1202             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1203
1204
1205             <td class="sig">
1206                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
1207                 <div class="fixedFont">
1208                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
1209
1210                                  ()
1211
1212
1213
1214                 </div>
1215                 <div class="mdesc">
1216
1217                    <div class="short">Removes all listeners for this object</div>
1218
1219
1220
1221                     <div class="long">
1222
1223                                 Removes all listeners for this object
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240                     </div>
1241                 </div>
1242
1243             </td>
1244             <td class="msource">
1245
1246                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1247                 &nbsp;
1248             </td>
1249         </tr>
1250
1251
1252           <tr class="method-row config-row-alt1 expandable notInherited">
1253             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1254
1255
1256             <td class="sig">
1257                 <a id="Roo.grid.GridView-method-refresh"   name=".refresh"></a>
1258                 <div class="fixedFont">
1259                         <span class="attributes"></span><b class="itemname">refresh</b>
1260
1261                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>headersToo</i></B>)
1262
1263
1264
1265                 </div>
1266                 <div class="mdesc">
1267
1268                    <div class="short">Refreshes the grid</div>
1269
1270
1271
1272                     <div class="long">
1273
1274                                 Refreshes the grid
1275
1276
1277
1278
1279
1280
1281                                 <dl class="detailList">
1282                                 <dt class="heading">Parameters:</dt>
1283
1284                                         <dt>
1285                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>headersToo</b>
1286
1287                                         </dt>
1288                                         <dd></dd>
1289
1290                                 </dl>
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302                     </div>
1303                 </div>
1304
1305             </td>
1306             <td class="msource">
1307
1308                         Roo.grid.GridView
1309                 &nbsp;
1310             </td>
1311         </tr>
1312
1313
1314           <tr class="method-row config-row-alt0 expandable">
1315             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1316
1317
1318             <td class="sig">
1319                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
1320                 <div class="fixedFont">
1321                         <span class="attributes"></span><b class="itemname">removeListener</b>
1322
1323                                  (<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>)
1324
1325
1326
1327                 </div>
1328                 <div class="mdesc">
1329
1330                    <div class="short">Removes a listener</div>
1331
1332
1333
1334                     <div class="long">
1335
1336                                 Removes a listener
1337
1338
1339
1340
1341
1342
1343                                 <dl class="detailList">
1344                                 <dt class="heading">Parameters:</dt>
1345
1346                                         <dt>
1347                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1348
1349                                         </dt>
1350                                         <dd>The type of event to listen for</dd>
1351
1352                                         <dt>
1353                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1354
1355                                         </dt>
1356                                         <dd>The handler to remove</dd>
1357
1358                                         <dt>
1359                                                 <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>
1360
1361                                         </dt>
1362                                         <dd>(optional) The scope (this object) for the handler</dd>
1363
1364                                 </dl>
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376                     </div>
1377                 </div>
1378
1379             </td>
1380             <td class="msource">
1381
1382                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1383                 &nbsp;
1384             </td>
1385         </tr>
1386
1387
1388           <tr class="method-row config-row-alt1 expandable notInherited">
1389             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1390
1391
1392             <td class="sig">
1393                 <a id="Roo.grid.GridView-method-rowClass"   name=".rowClass"></a>
1394                 <div class="fixedFont">
1395                         <span class="attributes"></span><b class="itemname">rowClass</b>
1396
1397                                  (Record <B><i>record</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
1398
1399
1400
1401                 </div>
1402                 <div class="mdesc">
1403
1404                    <div class="short">Override this function to apply custom css classes to rows during rendering</div>
1405
1406
1407
1408                     <div class="long">
1409
1410                                 Override this function to apply custom css classes to rows during rendering
1411
1412
1413
1414
1415
1416
1417                                 <dl class="detailList">
1418                                 <dt class="heading">Parameters:</dt>
1419
1420                                         <dt>
1421                                                 <span class="fixedFont">Record</span>  <b>record</b>
1422
1423                                         </dt>
1424                                         <dd>The record</dd>
1425
1426                                         <dt>
1427                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>index</b>
1428
1429                                         </dt>
1430                                         <dd></dd>
1431
1432                                 </dl>
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444                     </div>
1445                 </div>
1446
1447             </td>
1448             <td class="msource">
1449
1450                         Roo.grid.GridView
1451                 &nbsp;
1452             </td>
1453         </tr>
1454
1455
1456           <tr class="method-row config-row-alt0 expandable notInherited">
1457             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1458
1459
1460             <td class="sig">
1461                 <a id="Roo.grid.GridView-method-scrollToTop"   name=".scrollToTop"></a>
1462                 <div class="fixedFont">
1463                         <span class="attributes"></span><b class="itemname">scrollToTop</b>
1464
1465                                  ()
1466
1467
1468
1469                 </div>
1470                 <div class="mdesc">
1471
1472                    <div class="short">Scrolls the grid to the top</div>
1473
1474
1475
1476                     <div class="long">
1477
1478                                 Scrolls the grid to the top
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495                     </div>
1496                 </div>
1497
1498             </td>
1499             <td class="msource">
1500
1501                         Roo.grid.GridView
1502                 &nbsp;
1503             </td>
1504         </tr>
1505
1506
1507           <tr class="method-row config-row-alt1 expandable">
1508             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1509
1510
1511             <td class="sig">
1512                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
1513                 <div class="fixedFont">
1514                         <span class="attributes"></span><b class="itemname">un</b>
1515
1516                                  (<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>)
1517
1518
1519
1520                 </div>
1521                 <div class="mdesc">
1522
1523                    <div class="short">Removes a listener (shorthand for removeListener)</div>
1524
1525
1526
1527                     <div class="long">
1528
1529                                 Removes a listener (shorthand for removeListener)
1530
1531
1532
1533
1534
1535
1536                                 <dl class="detailList">
1537                                 <dt class="heading">Parameters:</dt>
1538
1539                                         <dt>
1540                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1541
1542                                         </dt>
1543                                         <dd>The type of event to listen for</dd>
1544
1545                                         <dt>
1546                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1547
1548                                         </dt>
1549                                         <dd>The handler to remove</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>scope</b>
1553
1554                                         </dt>
1555                                         <dd>(optional) The scope (this object) for the handler</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
1575                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1576                 &nbsp;
1577             </td>
1578         </tr>
1579
1580
1581     </table>
1582
1583
1584   <!-- ============================== events summary / details ======================== -->
1585
1586
1587   <a id="Roo.grid.GridView-events"></a>
1588
1589
1590
1591
1592
1593      <table cellspacing="0" class="member-table">
1594       <caption class="Empty">Events - Has None</caption>
1595      </table>
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605 <!-- ============================== footer ================================= -->
1606                 <div class="fineprint" style="clear:both">
1607
1608                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Tue Jul 27 2010 11:05:08 GMT+0800 (HKT)
1609                         Based on
1610                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1611                 </div>
1612         </body>
1613 </html>