Roo/bootstrap/PagingToolbar.js
[roojs1] / Roo / bootstrap / PagingToolbar.js
1 /*
2  * Based on:
3  * Ext JS Library 1.1.1
4  * Copyright(c) 2006-2007, Ext JS, LLC.
5  *
6  * Originally Released Under LGPL - original licence link has changed is not relivant.
7  *
8  * Fork - LGPL
9  * <script type="text/javascript">
10  */
11  
12 /**
13  * @class Roo.bootstrap.PagingToolbar
14  * @extends Roo.bootstrap.NavSimplebar
15  * A specialized toolbar that is bound to a {@link Roo.data.Store} and provides automatic paging controls.
16  * @constructor
17  * Create a new PagingToolbar
18  * @param {Object} config The config object
19  * @param {Roo.data.Store} store
20  */
21 Roo.bootstrap.PagingToolbar = function(config)
22 {
23     // old args format still supported... - xtype is prefered..
24         // created from xtype...
25     
26     this.ds = config.dataSource;
27     
28     if (config.store && !this.ds) {
29         this.store= Roo.factory(config.store, Roo.data);
30         this.ds = this.store;
31         this.ds.xmodule = this.xmodule || false;
32     }
33     
34     this.toolbarItems = [];
35     if (config.items) {
36         this.toolbarItems = config.items;
37     }
38     
39     Roo.bootstrap.PagingToolbar.superclass.constructor.call(this, config);
40     
41     this.cursor = 0;
42     
43     if (this.ds) { 
44         this.bind(this.ds);
45     }
46     
47     this.navgroup = new Roo.bootstrap.NavGroup({ cls: 'pagination' });
48     
49 };
50
51 Roo.extend(Roo.bootstrap.PagingToolbar, Roo.bootstrap.NavSimplebar, {
52     /**
53      * @cfg {Roo.data.Store} dataSource
54      * The underlying data store providing the paged data
55      */
56     /**
57      * @cfg {String/HTMLElement/Element} container
58      * container The id or element that will contain the toolbar
59      */
60     /**
61      * @cfg {Boolean} displayInfo
62      * True to display the displayMsg (defaults to false)
63      */
64     /**
65      * @cfg {Number} pageSize
66      * The number of records to display per page (defaults to 20)
67      */
68     pageSize: 20,
69     /**
70      * @cfg {String} displayMsg
71      * The paging status message to display (defaults to "Displaying {start} - {end} of {total}")
72      */
73     displayMsg : 'Displaying {0} - {1} of {2}',
74     /**
75      * @cfg {String} emptyMsg
76      * The message to display when no records are found (defaults to "No data to display")
77      */
78     emptyMsg : 'No data to display',
79     /**
80      * Customizable piece of the default paging text (defaults to "Page")
81      * @type String
82      */
83     beforePageText : "Page",
84     /**
85      * Customizable piece of the default paging text (defaults to "of %0")
86      * @type String
87      */
88     afterPageText : "of {0}",
89     /**
90      * Customizable piece of the default paging text (defaults to "First Page")
91      * @type String
92      */
93     firstText : "First Page",
94     /**
95      * Customizable piece of the default paging text (defaults to "Previous Page")
96      * @type String
97      */
98     prevText : "Previous Page",
99     /**
100      * Customizable piece of the default paging text (defaults to "Next Page")
101      * @type String
102      */
103     nextText : "Next Page",
104     /**
105      * Customizable piece of the default paging text (defaults to "Last Page")
106      * @type String
107      */
108     lastText : "Last Page",
109     /**
110      * Customizable piece of the default paging text (defaults to "Refresh")
111      * @type String
112      */
113     refreshText : "Refresh",
114
115     buttons : false,
116     // private
117     onRender : function(ct, position) 
118     {
119         Roo.bootstrap.PagingToolbar.superclass.onRender.call(this, ct, position);
120         this.navgroup.parentId = this.id;
121         this.navgroup.onRender(this.el, null);
122         // add the buttons to the navgroup
123         
124         if(this.displayInfo){
125             this.el.select('ul.navbar-nav',true).first().createChild({cls:'x-paging-info'});
126             this.displayEl = this.el.select('.x-paging-info', true).first();
127 //            var navel = this.navgroup.addItem( { tagtype : 'span', html : '', cls : 'x-paging-info', preventDefault : true } );
128 //            this.displayEl = navel.el.select('span',true).first();
129         }
130         
131         var _this = this;
132         
133         if(this.buttons){
134             Roo.each(_this.buttons, function(e){ // this might need to use render????
135                Roo.factory(e).onRender(_this.el, null);
136             });
137         }
138             
139         Roo.each(_this.toolbarItems, function(e) {
140             _this.navgroup.addItem(e);
141         });
142         
143         
144         this.first = this.navgroup.addItem({
145             tooltip: this.firstText,
146             cls: "prev",
147             icon : 'fa fa-backward',
148             disabled: true,
149             preventDefault: true,
150             listeners : { click : this.onClick.createDelegate(this, ["first"]) }
151         });
152         
153         this.prev =  this.navgroup.addItem({
154             tooltip: this.prevText,
155             cls: "prev",
156             icon : 'fa fa-step-backward',
157             disabled: true,
158             preventDefault: true,
159             listeners : { click :  this.onClick.createDelegate(this, ["prev"]) }
160         });
161     //this.addSeparator();
162         
163         
164         var field = this.navgroup.addItem( {
165             tagtype : 'span',
166             cls : 'x-paging-position',
167             
168             html : this.beforePageText  +
169                 '<input type="text" size="3" value="1" class="x-grid-page-number">' +
170                 '<span class="x-paging-after">' +  String.format(this.afterPageText, 1) + '</span>'
171          } ); //?? escaped?
172         
173         this.field = field.el.select('input', true).first();
174         this.field.on("keydown", this.onPagingKeydown, this);
175         this.field.on("focus", function(){this.dom.select();});
176     
177     
178         this.afterTextEl =  field.el.select('.x-paging-after',true).first();
179         //this.field.setHeight(18);
180         //this.addSeparator();
181         this.next = this.navgroup.addItem({
182             tooltip: this.nextText,
183             cls: "next",
184             html : ' <i class="fa fa-step-forward">',
185             disabled: true,
186             preventDefault: true,
187             listeners : { click :  this.onClick.createDelegate(this, ["next"]) }
188         });
189         this.last = this.navgroup.addItem({
190             tooltip: this.lastText,
191             icon : 'fa fa-forward',
192             cls: "next",
193             disabled: true,
194             preventDefault: true,
195             listeners : { click :  this.onClick.createDelegate(this, ["last"]) }
196         });
197     //this.addSeparator();
198         this.loading = this.navgroup.addItem({
199             tooltip: this.refreshText,
200             icon: 'fa fa-refresh',
201             preventDefault: true,
202             listeners : { click : this.onClick.createDelegate(this, ["refresh"]) }
203         });
204         
205     },
206
207     // private
208     updateInfo : function(){
209         if(this.displayEl){
210             var count = (typeof(this.getCount) == 'undefined') ? this.ds.getCount() : this.getCount();
211             var msg = count == 0 ?
212                 this.emptyMsg :
213                 String.format(
214                     this.displayMsg,
215                     this.cursor+1, this.cursor+count, this.ds.getTotalCount()    
216                 );
217             this.displayEl.update(msg);
218         }
219     },
220
221     // private
222     onLoad : function(ds, r, o)
223     {
224         this.cursor = o.params ? o.params.start : 0;
225         var d = this.getPageData(),
226             ap = d.activePage,
227             ps = d.pages;
228         
229         Roo.log(this.parent());
230         if(this.afterTextEl){
231             
232         }
233         Roo.log('run????????????????????????????????');
234         this.afterTextEl.dom.innerHTML = String.format(this.afterPageText, d.pages);
235         
236         this.field.dom.value = ap;
237         this.first.setDisabled(ap == 1);
238         this.prev.setDisabled(ap == 1);
239         this.next.setDisabled(ap == ps);
240         this.last.setDisabled(ap == ps);
241         this.loading.enable();
242         this.updateInfo();
243     },
244
245     // private
246     getPageData : function(){
247         var total = this.ds.getTotalCount();
248         return {
249             total : total,
250             activePage : Math.ceil((this.cursor+this.pageSize)/this.pageSize),
251             pages :  total < this.pageSize ? 1 : Math.ceil(total/this.pageSize)
252         };
253     },
254
255     // private
256     onLoadError : function(){
257         this.loading.enable();
258     },
259
260     // private
261     onPagingKeydown : function(e){
262         var k = e.getKey();
263         var d = this.getPageData();
264         if(k == e.RETURN){
265             var v = this.field.dom.value, pageNum;
266             if(!v || isNaN(pageNum = parseInt(v, 10))){
267                 this.field.dom.value = d.activePage;
268                 return;
269             }
270             pageNum = Math.min(Math.max(1, pageNum), d.pages) - 1;
271             this.ds.load({params:{start: pageNum * this.pageSize, limit: this.pageSize}});
272             e.stopEvent();
273         }
274         else if(k == e.HOME || (k == e.UP && e.ctrlKey) || (k == e.PAGEUP && e.ctrlKey) || (k == e.RIGHT && e.ctrlKey) || k == e.END || (k == e.DOWN && e.ctrlKey) || (k == e.LEFT && e.ctrlKey) || (k == e.PAGEDOWN && e.ctrlKey))
275         {
276           var pageNum = (k == e.HOME || (k == e.DOWN && e.ctrlKey) || (k == e.LEFT && e.ctrlKey) || (k == e.PAGEDOWN && e.ctrlKey)) ? 1 : d.pages;
277           this.field.dom.value = pageNum;
278           this.ds.load({params:{start: (pageNum - 1) * this.pageSize, limit: this.pageSize}});
279           e.stopEvent();
280         }
281         else if(k == e.UP || k == e.RIGHT || k == e.PAGEUP || k == e.DOWN || k == e.LEFT || k == e.PAGEDOWN)
282         {
283           var v = this.field.dom.value, pageNum; 
284           var increment = (e.shiftKey) ? 10 : 1;
285           if(k == e.DOWN || k == e.LEFT || k == e.PAGEDOWN) {
286                 increment *= -1;
287           }
288           if(!v || isNaN(pageNum = parseInt(v, 10))) {
289             this.field.dom.value = d.activePage;
290             return;
291           }
292           else if(parseInt(v, 10) + increment >= 1 & parseInt(v, 10) + increment <= d.pages)
293           {
294             this.field.dom.value = parseInt(v, 10) + increment;
295             pageNum = Math.min(Math.max(1, pageNum + increment), d.pages) - 1;
296             this.ds.load({params:{start: pageNum * this.pageSize, limit: this.pageSize}});
297           }
298           e.stopEvent();
299         }
300     },
301
302     // private
303     beforeLoad : function(){
304         if(this.loading){
305             this.loading.disable();
306         }
307     },
308
309     // private
310     onClick : function(which){
311         
312         var ds = this.ds;
313         if (!ds) {
314             return;
315         }
316         
317         switch(which){
318             case "first":
319                 ds.load({params:{start: 0, limit: this.pageSize}});
320             break;
321             case "prev":
322                 ds.load({params:{start: Math.max(0, this.cursor-this.pageSize), limit: this.pageSize}});
323             break;
324             case "next":
325                 ds.load({params:{start: this.cursor+this.pageSize, limit: this.pageSize}});
326             break;
327             case "last":
328                 var total = ds.getTotalCount();
329                 var extra = total % this.pageSize;
330                 var lastStart = extra ? (total - extra) : total-this.pageSize;
331                 ds.load({params:{start: lastStart, limit: this.pageSize}});
332             break;
333             case "refresh":
334                 ds.load({params:{start: this.cursor, limit: this.pageSize}});
335             break;
336         }
337     },
338
339     /**
340      * Unbinds the paging toolbar from the specified {@link Roo.data.Store}
341      * @param {Roo.data.Store} store The data store to unbind
342      */
343     unbind : function(ds){
344         ds.un("beforeload", this.beforeLoad, this);
345         ds.un("load", this.onLoad, this);
346         ds.un("loadexception", this.onLoadError, this);
347         ds.un("remove", this.updateInfo, this);
348         ds.un("add", this.updateInfo, this);
349         this.ds = undefined;
350     },
351
352     /**
353      * Binds the paging toolbar to the specified {@link Roo.data.Store}
354      * @param {Roo.data.Store} store The data store to bind
355      */
356     bind : function(ds){
357         ds.on("beforeload", this.beforeLoad, this);
358         ds.on("load", this.onLoad, this);
359         ds.on("loadexception", this.onLoadError, this);
360         ds.on("remove", this.updateInfo, this);
361         ds.on("add", this.updateInfo, this);
362         this.ds = ds;
363     }
364 });