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