git.roojs.org Git - roojs1/blob - docs/symbols/Roo.PagingToolbar.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.PagingToolbar</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.PagingToolbar-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.PagingToolbar-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.PagingToolbar-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.PagingToolbar-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.Toolbar.html#constructor" roo:cls="Roo.Toolbar.html#constructor">Roo.Toolbar</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.PagingToolbar
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.PagingToolbar
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_PagingToolbar.js.html">Roo/PagingToolbar.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">PagingToolbar</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.Toolbar.html#constructor" roo:cls="Roo.Toolbar.html#constructor">Roo.Toolbar</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         A specialized toolbar that is bound to a {<b>link</b> Roo.data.Store} and provides automatic paging controls.
  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.PagingToolbar';">[Add Your comment/notes about this class]</u>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.PagingToolbar.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.PagingToolbar-configs"></a>
 108
 109
 110
 111
 112
 113       <table cellspacing="0" class="member-table">
 114       <caption>Config Options (Usually are also Properties)</caption>
 115
 116
 117         <tr>
 118             <th class="sig-header" colspan="2">Options</th>
 119
 120             <th class="msource-header">Defined By</th>
 121         </tr>
 122
 123
 124
 125
 126
 127                 <tr class="config-row expandable config-row-alt0 notInherited">
 128                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 129                     <td class="sig">
 130
 131                         <a id="Roo.PagingToolbar-cfg-container" name=".container"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">container</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">container The id or element that will contain the toolbar</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">container The id or element that will contain the toolbar</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.PagingToolbar
 152
 153                     </td>
 154                 </tr>
 155
 156
 157                 <tr class="config-row expandable config-row-alt1 notInherited">
 158                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 159                     <td class="sig">
 160
 161                         <a id="Roo.PagingToolbar-cfg-dataSource" name=".dataSource"></a>
 162                         <div class="fixedFont">
 163                                 <b  class="itemname">dataSource</b> : <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
 164
 165
 166                         </div>
 167
 168                         <div class="mdesc">
 169                             <div class="short">The underlying data store providing the paged data</div>
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="long">The underlying data store providing the paged data</div>
 174                         </div>
 175
 176
 177
 178                     </td>
 179                     <td class="msource">
 180
 181                         Roo.PagingToolbar
 182
 183                     </td>
 184                 </tr>
 185
 186
 187                 <tr class="config-row expandable config-row-alt0 notInherited">
 188                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 189                     <td class="sig">
 190
 191                         <a id="Roo.PagingToolbar-cfg-displayInfo" name=".displayInfo"></a>
 192                         <div class="fixedFont">
 193                                 <b  class="itemname">displayInfo</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 194
 195
 196                         </div>
 197
 198                         <div class="mdesc">
 199                             <div class="short">True to display the displayMsg (defaults to false)</div>
 200                         </div>
 201
 202                         <div class="mdesc">
 203                             <div class="long">True to display the displayMsg (defaults to false)</div>
 204                         </div>
 205
 206
 207
 208                     </td>
 209                     <td class="msource">
 210
 211                         Roo.PagingToolbar
 212
 213                     </td>
 214                 </tr>
 215
 216
 217                 <tr class="config-row expandable config-row-alt1 notInherited">
 218                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 219                     <td class="sig">
 220
 221                         <a id="Roo.PagingToolbar-cfg-displayMsg" name=".displayMsg"></a>
 222                         <div class="fixedFont">
 223                                 <b  class="itemname">displayMsg</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 224
 225
 226                         </div>
 227
 228                         <div class="mdesc">
 229                             <div class="short">The paging status message to display (defaults to "Displaying {start} - {end} of {total}")</div>
 230                         </div>
 231
 232                         <div class="mdesc">
 233                             <div class="long">The paging status message to display (defaults to "Displaying {start} - {end} of {total}")</div>
 234                         </div>
 235
 236
 237
 238                     </td>
 239                     <td class="msource">
 240
 241                         Roo.PagingToolbar
 242
 243                     </td>
 244                 </tr>
 245
 246
 247                 <tr class="config-row expandable config-row-alt0 notInherited">
 248                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 249                     <td class="sig">
 250
 251                         <a id="Roo.PagingToolbar-cfg-emptyMsg" name=".emptyMsg"></a>
 252                         <div class="fixedFont">
 253                                 <b  class="itemname">emptyMsg</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 254
 255
 256                         </div>
 257
 258                         <div class="mdesc">
 259                             <div class="short">The message to display when no records are found (defaults to "No data to display")</div>
 260                         </div>
 261
 262                         <div class="mdesc">
 263                             <div class="long">The message to display when no records are found (defaults to "No data to display")</div>
 264                         </div>
 265
 266
 267
 268                     </td>
 269                     <td class="msource">
 270
 271                         Roo.PagingToolbar
 272
 273                     </td>
 274                 </tr>
 275
 276
 277                 <tr class="config-row expandable config-row-alt1 notInherited">
 278                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 279                     <td class="sig">
 280
 281                         <a id="Roo.PagingToolbar-cfg-pageSize" name=".pageSize"></a>
 282                         <div class="fixedFont">
 283                                 <b  class="itemname">pageSize</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 284
 285
 286                         </div>
 287
 288                         <div class="mdesc">
 289                             <div class="short">The number of records to display per page (defaults to 20)</div>
 290                         </div>
 291
 292                         <div class="mdesc">
 293                             <div class="long">The number of records to display per page (defaults to 20)</div>
 294                         </div>
 295
 296
 297
 298                     </td>
 299                     <td class="msource">
 300
 301                         Roo.PagingToolbar
 302
 303                     </td>
 304                 </tr>
 305
 306
 307     </table>
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317   <!-- ============================== public properties ==================== -->
 318
 319
 320
 321     <a id="Roo.PagingToolbar-props"></a>
 322
 323
 324
 325
 326
 327      <table cellspacing="0" class="member-table">
 328       <caption class="Empty">Public Properties - Has None</caption>
 329      </table>
 330
 331
 332
 333
 334   <!-- ============================== methods summary / details ======================== -->
 335
 336
 337   <a id="Roo.PagingToolbar-methods"></a>
 338         <!-- constructor?? -->
 339
 340         <!-- static's first
 341
 342
 343         -->
 344
 345         <!-- then dynamics first -->
 346
 347
 348
 349
 350
 351
 352       <table cellspacing="0" class="member-table">
 353       <caption>Public Methods</caption>
 354         <tr>
 355             <th class="sig-header" colspan="2">Method</th>
 356             <th class="msource-header">Defined By</th>
 357
 358         </tr>
 359
 360
 361
 362
 363
 364
 365
 366           <tr class="method-row config-row-alt0 expandable notInherited">
 367             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 368
 369
 370             <td class="sig">
 371                 <a id="Roo-method-PagingToolbar"   name=".PagingToolbar"></a>
 372                 <div class="fixedFont">
 373                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">PagingToolbar</b>
 374
 375                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 376
 377
 378
 379                 </div>
 380                 <div class="mdesc">
 381
 382
 383                         <div class="short">Create a new Roo.PagingToolbar</div>
 384
 385
 386                     <div class="long">
 387
 388
 389
 390                                 Create a new Roo.PagingToolbar
 391
 392
 393                                 <dl class="detailList">
 394                                 <dt class="heading">Parameters:</dt>
 395
 396                                         <dt>
 397                                                 <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>
 398
 399                                         </dt>
 400                                         <dd>The config object</dd>
 401
 402                                 </dl>
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414                     </div>
 415                 </div>
 416
 417             </td>
 418             <td class="msource">
 419                 &nbsp;
 420             </td>
 421         </tr>
 422
 423
 424           <tr class="method-row config-row-alt1 expandable notInherited">
 425             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 426
 427
 428             <td class="sig">
 429                 <a id="Roo.PagingToolbar-method-bind"   name=".bind"></a>
 430                 <div class="fixedFont">
 431                         <span class="attributes"></span><b class="itemname">bind</b>
 432
 433                                  (<a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a> <B><i>store</i></B>)
 434
 435
 436
 437                 </div>
 438                 <div class="mdesc">
 439
 440                    <div class="short">Binds the paging toolbar to the specified {<b>link</b> Roo.data.Store}</div>
 441
 442
 443
 444                     <div class="long">
 445
 446                                 Binds the paging toolbar to the specified {<b>link</b> Roo.data.Store}
 447
 448
 449
 450
 451
 452
 453                                 <dl class="detailList">
 454                                 <dt class="heading">Parameters:</dt>
 455
 456                                         <dt>
 457                                                 <span class="fixedFont"><a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a></span>  <b>store</b>
 458
 459                                         </dt>
 460                                         <dd>The data store to bind</dd>
 461
 462                                 </dl>
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474                     </div>
 475                 </div>
 476
 477             </td>
 478             <td class="msource">
 479
 480                         Roo.PagingToolbar
 481                 &nbsp;
 482             </td>
 483         </tr>
 484
 485
 486           <tr class="method-row config-row-alt0 expandable notInherited">
 487             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 488
 489
 490             <td class="sig">
 491                 <a id="Roo.PagingToolbar-method-unbind"   name=".unbind"></a>
 492                 <div class="fixedFont">
 493                         <span class="attributes"></span><b class="itemname">unbind</b>
 494
 495                                  (<a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a> <B><i>store</i></B>)
 496
 497
 498
 499                 </div>
 500                 <div class="mdesc">
 501
 502                    <div class="short">Unbinds the paging toolbar from the specified {<b>link</b> Roo.data.Store}</div>
 503
 504
 505
 506                     <div class="long">
 507
 508                                 Unbinds the paging toolbar from the specified {<b>link</b> Roo.data.Store}
 509
 510
 511
 512
 513
 514
 515                                 <dl class="detailList">
 516                                 <dt class="heading">Parameters:</dt>
 517
 518                                         <dt>
 519                                                 <span class="fixedFont"><a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a></span>  <b>store</b>
 520
 521                                         </dt>
 522                                         <dd>The data store to unbind</dd>
 523
 524                                 </dl>
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536                     </div>
 537                 </div>
 538
 539             </td>
 540             <td class="msource">
 541
 542                         Roo.PagingToolbar
 543                 &nbsp;
 544             </td>
 545         </tr>
 546
 547
 548     </table>
 549
 550
 551   <!-- ============================== events summary / details ======================== -->
 552
 553
 554   <a id="Roo.PagingToolbar-events"></a>
 555
 556
 557
 558
 559
 560      <table cellspacing="0" class="member-table">
 561       <caption class="Empty">Events - Has None</caption>
 562      </table>
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572 <!-- ============================== footer ================================= -->
 573                 <div class="fineprint" style="clear:both">
 574
 575                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 16:05:45 GMT+0800 (HKT)
 576                         Based on
 577                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 578                 </div>
 579         </body>
 580 </html>