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>
143 <div class="long">container The id or element that will contain the toolbar</div>
151 Roo.bootstrap.PagingToolbar
157 <tr class="config-row expandable config-row-alt1 notInherited">
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
161 <a id="Roo.bootstrap.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>
169 <div class="short">The underlying data store providing the paged data</div>
173 <div class="long">The underlying data store providing the paged data</div>
181 Roo.bootstrap.PagingToolbar
187 <tr class="config-row expandable config-row-alt0 notInherited">
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
191 <a id="Roo.bootstrap.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>
199 <div class="short">True to display the displayMsg (defaults to false)</div>
203 <div class="long">True to display the displayMsg (defaults to false)</div>
211 Roo.bootstrap.PagingToolbar
217 <tr class="config-row expandable config-row-alt1 notInherited">
218 <td class="micon"><a class="exi" href="#expand"> </a></td>
221 <a id="Roo.bootstrap.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>
229 <div class="short">The paging status message to display (defaults to "Displaying {start} - {end} of {total}")</div>
233 <div class="long">The paging status message to display (defaults to "Displaying {start} - {end} of {total}")</div>
241 Roo.bootstrap.PagingToolbar
247 <tr class="config-row expandable config-row-alt0 notInherited">
248 <td class="micon"><a class="exi" href="#expand"> </a></td>
251 <a id="Roo.bootstrap.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>
259 <div class="short">The message to display when no records are found (defaults to "No data to display")</div>
263 <div class="long">The message to display when no records are found (defaults to "No data to display")</div>
271 Roo.bootstrap.PagingToolbar
277 <tr class="config-row expandable config-row-alt1 notInherited">
278 <td class="micon"><a class="exi" href="#expand"> </a></td>
281 <a id="Roo.bootstrap.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>
289 <div class="short">The number of records to display per page (defaults to 20)</div>
293 <div class="long">The number of records to display per page (defaults to 20)</div>
301 Roo.bootstrap.PagingToolbar
317 <!-- ============================== public properties ==================== -->
321 <a id="Roo.bootstrap.PagingToolbar-props"></a>
327 <table cellspacing="0" class="member-table">
328 <caption class="Empty">Public Properties - Has None</caption>
334 <!-- ============================== methods summary / details ======================== -->
337 <a id="Roo.bootstrap.PagingToolbar-methods"></a>
338 <!-- constructor?? -->
345 <!-- then dynamics first -->
352 <table cellspacing="0" class="member-table">
353 <caption>Public Methods</caption>
355 <th class="sig-header" colspan="2">Method</th>
356 <th class="msource-header">Defined By</th>
366 <tr class="method-row config-row-alt0 expandable notInherited">
367 <td class="micon"><a class="exi" href="#expand"> </a></td>
371 <a id="Roo.bootstrap-method-PagingToolbar" name=".PagingToolbar"></a>
372 <div class="fixedFont">
373 <span class="attributes">new <B>Roo.bootstrap.</B></span><b class="itemname">PagingToolbar</b>
375 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
383 <div class="short">Create a new Roo.bootstrap.PagingToolbar</div>
390 Create a new Roo.bootstrap.PagingToolbar
393 <dl class="detailList">
394 <dt class="heading">Parameters:</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>
400 <dd>The config object</dd>
424 <tr class="method-row config-row-alt1 expandable notInherited">
425 <td class="micon"><a class="exi" href="#expand"> </a></td>
429 <a id="Roo.bootstrap.PagingToolbar-method-bind" name=".bind"></a>
430 <div class="fixedFont">
431 <span class="attributes"></span><b class="itemname">bind</b>
433 (<a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a> <B><i>store</i></B>)
440 <div class="short">Binds the paging toolbar to the specified {<b>link</b> Roo.data.Store}</div>
446 Binds the paging toolbar to the specified {<b>link</b> Roo.data.Store}
453 <dl class="detailList">
454 <dt class="heading">Parameters:</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>
460 <dd>The data store to bind</dd>
480 Roo.bootstrap.PagingToolbar
486 <tr class="method-row config-row-alt0 expandable notInherited">
487 <td class="micon"><a class="exi" href="#expand"> </a></td>
491 <a id="Roo.bootstrap.PagingToolbar-method-unbind" name=".unbind"></a>
492 <div class="fixedFont">
493 <span class="attributes"></span><b class="itemname">unbind</b>
495 (<a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a> <B><i>store</i></B>)
502 <div class="short">Unbinds the paging toolbar from the specified {<b>link</b> Roo.data.Store}</div>
508 Unbinds the paging toolbar from the specified {<b>link</b> Roo.data.Store}
515 <dl class="detailList">
516 <dt class="heading">Parameters:</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>
522 <dd>The data store to unbind</dd>
542 Roo.bootstrap.PagingToolbar
551 <!-- ============================== events summary / details ======================== -->
554 <a id="Roo.bootstrap.PagingToolbar-events"></a>
560 <table cellspacing="0" class="member-table">
561 <caption class="Empty">Events - Has None</caption>
572 <!-- ============================== footer ================================= -->
573 <div class="fineprint" style="clear:both">
575 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu Feb 05 2015 18:14:23 GMT+0800 (HKT)
577 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>