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