1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.bootstrap.PagingToolbar</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
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>
43 <!-- ============================== inheritance Block. ================================= -->
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
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.bootstrap.PagingToolbar
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.bootstrap</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_bootstrap_PagingToolbar.js.html">Roo/bootstrap/PagingToolbar.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">PagingToolbar</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
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.
89 <!-- ============================== Class comment block... ========================== -->
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>
95 <iframe frameborder="0" id="comments-Roo.bootstrap" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.bootstrap.PagingToolbar.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.bootstrap.PagingToolbar-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0 notInherited">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
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
139 <div class="short">container The id or element that will contain the toolbar</div>
144 container The id or element that will contain the toolbar
154 Roo.bootstrap.PagingToolbar
160 <tr class="config-row expandable config-row-alt1 notInherited">
161 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
172 <div class="short">The underlying data store providing the paged data</div>
177 The underlying data store providing the paged data
187 Roo.bootstrap.PagingToolbar
193 <tr class="config-row expandable config-row-alt0 notInherited">
194 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
205 <div class="short">True to display the displayMsg (defaults to false)</div>
210 True to display the displayMsg (defaults to false)
220 Roo.bootstrap.PagingToolbar
226 <tr class="config-row expandable config-row-alt1 notInherited">
227 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
238 <div class="short">The paging status message to display (defaults to "Displaying {start} - {end} of {total}")</div>
243 The paging status message to display (defaults to "Displaying {start} - {end} of {total}")
253 Roo.bootstrap.PagingToolbar
259 <tr class="config-row expandable config-row-alt0 notInherited">
260 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
271 <div class="short">The message to display when no records are found (defaults to "No data to display")</div>
276 The message to display when no records are found (defaults to "No data to display")
286 Roo.bootstrap.PagingToolbar
292 <tr class="config-row expandable config-row-alt1 notInherited">
293 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
304 <div class="short">The number of records to display per page (defaults to 20)</div>
309 The number of records to display per page (defaults to 20)
319 Roo.bootstrap.PagingToolbar
335 <!-- ============================== public properties ==================== -->
339 <a id="Roo.bootstrap.PagingToolbar-props"></a>
345 <table cellspacing="0" class="member-table">
346 <caption class="Empty">Public Properties - Has None</caption>
352 <!-- ============================== methods summary / details ======================== -->
355 <a id="Roo.bootstrap.PagingToolbar-methods"></a>
356 <!-- constructor?? -->
363 <!-- then dynamics first -->
370 <table cellspacing="0" class="member-table">
371 <caption>Public Methods</caption>
373 <th class="sig-header" colspan="2">Method</th>
374 <th class="msource-header">Defined By</th>
384 <tr class="method-row config-row-alt0 expandable notInherited">
385 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
393 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
401 <div class="short">Create a new Roo.bootstrap.PagingToolbar</div>
408 Create a new Roo.bootstrap.PagingToolbar
411 <dl class="detailList">
412 <dt class="heading">Parameters:</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>
418 <dd>The config object</dd>
442 <tr class="method-row config-row-alt1 expandable notInherited">
443 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
451 (<a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a> <B><i>store</i></B>)
458 <div class="short">Binds the paging toolbar to the specified {<b>link</b> Roo.data.Store}</div>
464 Binds the paging toolbar to the specified {<b>link</b> Roo.data.Store}
471 <dl class="detailList">
472 <dt class="heading">Parameters:</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>
478 <dd>The data store to bind</dd>
498 Roo.bootstrap.PagingToolbar
504 <tr class="method-row config-row-alt0 expandable notInherited">
505 <td class="micon"><a class="exi" href="#expand"> </a></td>
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>
513 (<a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a> <B><i>store</i></B>)
520 <div class="short">Unbinds the paging toolbar from the specified {<b>link</b> Roo.data.Store}</div>
526 Unbinds the paging toolbar from the specified {<b>link</b> Roo.data.Store}
533 <dl class="detailList">
534 <dt class="heading">Parameters:</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>
540 <dd>The data store to unbind</dd>
560 Roo.bootstrap.PagingToolbar
569 <!-- ============================== events summary / details ======================== -->
572 <a id="Roo.bootstrap.PagingToolbar-events"></a>
578 <table cellspacing="0" class="member-table">
579 <caption class="Empty">Events - Has None</caption>
590 <!-- ============================== footer ================================= -->
591 <div class="fineprint" style="clear:both">
593 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Mon Aug 31 2015 12:52:14 GMT+0800 (HKT)
595 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>