PagingToolbar.js
上传用户:dawnssy
上传日期:2022-08-06
资源大小:9345k
文件大小:18k
源码类别:

JavaScript

开发平台:

JavaScript

  1. /*!
  2.  * Ext JS Library 3.1.0
  3.  * Copyright(c) 2006-2009 Ext JS, LLC
  4.  * licensing@extjs.com
  5.  * http://www.extjs.com/license
  6.  */
  7. /**
  8.  * @class Ext.PagingToolbar
  9.  * @extends Ext.Toolbar
  10.  * <p>As the amount of records increases, the time required for the browser to render
  11.  * them increases. Paging is used to reduce the amount of data exchanged with the client.
  12.  * Note: if there are more records/rows than can be viewed in the available screen area, vertical
  13.  * scrollbars will be added.</p>
  14.  * <p>Paging is typically handled on the server side (see exception below). The client sends
  15.  * parameters to the server side, which the server needs to interpret and then respond with the
  16.  * approprate data.</p>
  17.  * <p><b>Ext.PagingToolbar</b> is a specialized toolbar that is bound to a {@link Ext.data.Store}
  18.  * and provides automatic paging control. This Component {@link Ext.data.Store#load load}s blocks
  19.  * of data into the <tt>{@link #store}</tt> by passing {@link Ext.data.Store#paramNames paramNames} used for
  20.  * paging criteria.</p>
  21.  * <p>PagingToolbar is typically used as one of the Grid's toolbars:</p>
  22.  * <pre><code>
  23. Ext.QuickTips.init(); // to display button quicktips
  24. var myStore = new Ext.data.Store({
  25.     reader: new Ext.data.JsonReader({
  26.         {@link Ext.data.JsonReader#totalProperty totalProperty}: 'results', 
  27.         ...
  28.     }),
  29.     ...
  30. });
  31. var myPageSize = 25;  // server script should only send back 25 items at a time
  32. var grid = new Ext.grid.GridPanel({
  33.     ...
  34.     store: myStore,
  35.     bbar: new Ext.PagingToolbar({
  36.         {@link #store}: myStore,       // grid and PagingToolbar using same store
  37.         {@link #displayInfo}: true,
  38.         {@link #pageSize}: myPageSize,
  39.         {@link #prependButtons}: true,
  40.         items: [
  41.             'text 1'
  42.         ]
  43.     })
  44. });
  45.  * </code></pre>
  46.  *
  47.  * <p>To use paging, pass the paging requirements to the server when the store is first loaded.</p>
  48.  * <pre><code>
  49. store.load({
  50.     params: {
  51.         // specify params for the first page load if using paging
  52.         start: 0,          
  53.         limit: myPageSize,
  54.         // other params
  55.         foo:   'bar'
  56.     }
  57. });
  58.  * </code></pre>
  59.  * 
  60.  * <p>If using {@link Ext.data.Store#autoLoad store's autoLoad} configuration:</p>
  61.  * <pre><code>
  62. var myStore = new Ext.data.Store({
  63.     {@link Ext.data.Store#autoLoad autoLoad}: {params:{start: 0, limit: 25}},
  64.     ...
  65. });
  66.  * </code></pre>
  67.  * 
  68.  * <p>The packet sent back from the server would have this form:</p>
  69.  * <pre><code>
  70. {
  71.     "success": true,
  72.     "results": 2000, 
  73.     "rows": [ // <b>*Note:</b> this must be an Array 
  74.         { "id":  1, "name": "Bill", "occupation": "Gardener" },
  75.         { "id":  2, "name":  "Ben", "occupation": "Horticulturalist" },
  76.         ...
  77.         { "id": 25, "name":  "Sue", "occupation": "Botanist" }
  78.     ]
  79. }
  80.  * </code></pre>
  81.  * <p><u>Paging with Local Data</u></p>
  82.  * <p>Paging can also be accomplished with local data using extensions:</p>
  83.  * <div class="mdetail-params"><ul>
  84.  * <li><a href="http://extjs.com/forum/showthread.php?t=71532">Ext.ux.data.PagingStore</a></li>
  85.  * <li>Paging Memory Proxy (examples/ux/PagingMemoryProxy.js)</li>
  86.  * </ul></div>
  87.  * @constructor Create a new PagingToolbar
  88.  * @param {Object} config The config object
  89.  * @xtype paging
  90.  */
  91. (function() {
  92. var T = Ext.Toolbar;
  93. Ext.PagingToolbar = Ext.extend(Ext.Toolbar, {
  94.     /**
  95.      * @cfg {Ext.data.Store} store
  96.      * The {@link Ext.data.Store} the paging toolbar should use as its data source (required).
  97.      */
  98.     /**
  99.      * @cfg {Boolean} displayInfo
  100.      * <tt>true</tt> to display the displayMsg (defaults to <tt>false</tt>)
  101.      */
  102.     /**
  103.      * @cfg {Number} pageSize
  104.      * The number of records to display per page (defaults to <tt>20</tt>)
  105.      */
  106.     pageSize : 20,
  107.     /**
  108.      * @cfg {Boolean} prependButtons
  109.      * <tt>true</tt> to insert any configured <tt>items</tt> <i>before</i> the paging buttons.
  110.      * Defaults to <tt>false</tt>.
  111.      */
  112.     /**
  113.      * @cfg {String} displayMsg
  114.      * The paging status message to display (defaults to <tt>'Displaying {0} - {1} of {2}'</tt>).
  115.      * Note that this string is formatted using the braced numbers <tt>{0}-{2}</tt> as tokens
  116.      * that are replaced by the values for start, end and total respectively. These tokens should
  117.      * be preserved when overriding this string if showing those values is desired.
  118.      */
  119.     displayMsg : 'Displaying {0} - {1} of {2}',
  120.     /**
  121.      * @cfg {String} emptyMsg
  122.      * The message to display when no records are found (defaults to 'No data to display')
  123.      */
  124.     emptyMsg : 'No data to display',
  125.     /**
  126.      * @cfg {String} beforePageText
  127.      * The text displayed before the input item (defaults to <tt>'Page'</tt>).
  128.      */
  129.     beforePageText : 'Page',
  130.     /**
  131.      * @cfg {String} afterPageText
  132.      * Customizable piece of the default paging text (defaults to <tt>'of {0}'</tt>). Note that
  133.      * this string is formatted using <tt>{0}</tt> as a token that is replaced by the number of
  134.      * total pages. This token should be preserved when overriding this string if showing the
  135.      * total page count is desired.
  136.      */
  137.     afterPageText : 'of {0}',
  138.     /**
  139.      * @cfg {String} firstText
  140.      * The quicktip text displayed for the first page button (defaults to <tt>'First Page'</tt>).
  141.      * <b>Note</b>: quick tips must be initialized for the quicktip to show.
  142.      */
  143.     firstText : 'First Page',
  144.     /**
  145.      * @cfg {String} prevText
  146.      * The quicktip text displayed for the previous page button (defaults to <tt>'Previous Page'</tt>).
  147.      * <b>Note</b>: quick tips must be initialized for the quicktip to show.
  148.      */
  149.     prevText : 'Previous Page',
  150.     /**
  151.      * @cfg {String} nextText
  152.      * The quicktip text displayed for the next page button (defaults to <tt>'Next Page'</tt>).
  153.      * <b>Note</b>: quick tips must be initialized for the quicktip to show.
  154.      */
  155.     nextText : 'Next Page',
  156.     /**
  157.      * @cfg {String} lastText
  158.      * The quicktip text displayed for the last page button (defaults to <tt>'Last Page'</tt>).
  159.      * <b>Note</b>: quick tips must be initialized for the quicktip to show.
  160.      */
  161.     lastText : 'Last Page',
  162.     /**
  163.      * @cfg {String} refreshText
  164.      * The quicktip text displayed for the Refresh button (defaults to <tt>'Refresh'</tt>).
  165.      * <b>Note</b>: quick tips must be initialized for the quicktip to show.
  166.      */
  167.     refreshText : 'Refresh',
  168.     /**
  169.      * <p><b>Deprecated</b>. <code>paramNames</code> should be set in the <b>data store</b>
  170.      * (see {@link Ext.data.Store#paramNames}).</p>
  171.      * <br><p>Object mapping of parameter names used for load calls, initially set to:</p>
  172.      * <pre>{start: 'start', limit: 'limit'}</pre>
  173.      * @type Object
  174.      * @property paramNames
  175.      * @deprecated
  176.      */
  177.     /**
  178.      * The number of records to display per page.  See also <tt>{@link #cursor}</tt>.
  179.      * @type Number
  180.      * @property pageSize
  181.      */
  182.     /**
  183.      * Indicator for the record position.  This property might be used to get the active page
  184.      * number for example:<pre><code>
  185.      * // t is reference to the paging toolbar instance
  186.      * var activePage = Math.ceil((t.cursor + t.pageSize) / t.pageSize);
  187.      * </code></pre>
  188.      * @type Number
  189.      * @property cursor
  190.      */
  191.     initComponent : function(){
  192.         var pagingItems = [this.first = new T.Button({
  193.             tooltip: this.firstText,
  194.             overflowText: this.firstText,
  195.             iconCls: 'x-tbar-page-first',
  196.             disabled: true,
  197.             handler: this.moveFirst,
  198.             scope: this
  199.         }), this.prev = new T.Button({
  200.             tooltip: this.prevText,
  201.             overflowText: this.prevText,
  202.             iconCls: 'x-tbar-page-prev',
  203.             disabled: true,
  204.             handler: this.movePrevious,
  205.             scope: this
  206.         }), '-', this.beforePageText,
  207.         this.inputItem = new Ext.form.NumberField({
  208.             cls: 'x-tbar-page-number',
  209.             allowDecimals: false,
  210.             allowNegative: false,
  211.             enableKeyEvents: true,
  212.             selectOnFocus: true,
  213.             submitValue: false,
  214.             listeners: {
  215.                 scope: this,
  216.                 keydown: this.onPagingKeyDown,
  217.                 blur: this.onPagingBlur
  218.             }
  219.         }), this.afterTextItem = new T.TextItem({
  220.             text: String.format(this.afterPageText, 1)
  221.         }), '-', this.next = new T.Button({
  222.             tooltip: this.nextText,
  223.             overflowText: this.nextText,
  224.             iconCls: 'x-tbar-page-next',
  225.             disabled: true,
  226.             handler: this.moveNext,
  227.             scope: this
  228.         }), this.last = new T.Button({
  229.             tooltip: this.lastText,
  230.             overflowText: this.lastText,
  231.             iconCls: 'x-tbar-page-last',
  232.             disabled: true,
  233.             handler: this.moveLast,
  234.             scope: this
  235.         }), '-', this.refresh = new T.Button({
  236.             tooltip: this.refreshText,
  237.             overflowText: this.refreshText,
  238.             iconCls: 'x-tbar-loading',
  239.             handler: this.doRefresh,
  240.             scope: this
  241.         })];
  242.         var userItems = this.items || this.buttons || [];
  243.         if (this.prependButtons) {
  244.             this.items = userItems.concat(pagingItems);
  245.         }else{
  246.             this.items = pagingItems.concat(userItems);
  247.         }
  248.         delete this.buttons;
  249.         if(this.displayInfo){
  250.             this.items.push('->');
  251.             this.items.push(this.displayItem = new T.TextItem({}));
  252.         }
  253.         Ext.PagingToolbar.superclass.initComponent.call(this);
  254.         this.addEvents(
  255.             /**
  256.              * @event change
  257.              * Fires after the active page has been changed.
  258.              * @param {Ext.PagingToolbar} this
  259.              * @param {Object} pageData An object that has these properties:<ul>
  260.              * <li><code>total</code> : Number <div class="sub-desc">The total number of records in the dataset as
  261.              * returned by the server</div></li>
  262.              * <li><code>activePage</code> : Number <div class="sub-desc">The current page number</div></li>
  263.              * <li><code>pages</code> : Number <div class="sub-desc">The total number of pages (calculated from
  264.              * the total number of records in the dataset as returned by the server and the current {@link #pageSize})</div></li>
  265.              * </ul>
  266.              */
  267.             'change',
  268.             /**
  269.              * @event beforechange
  270.              * Fires just before the active page is changed.
  271.              * Return false to prevent the active page from being changed.
  272.              * @param {Ext.PagingToolbar} this
  273.              * @param {Object} params An object hash of the parameters which the PagingToolbar will send when
  274.              * loading the required page. This will contain:<ul>
  275.              * <li><code>start</code> : Number <div class="sub-desc">The starting row number for the next page of records to
  276.              * be retrieved from the server</div></li>
  277.              * <li><code>limit</code> : Number <div class="sub-desc">The number of records to be retrieved from the server</div></li>
  278.              * </ul>
  279.              * <p>(note: the names of the <b>start</b> and <b>limit</b> properties are determined
  280.              * by the store's {@link Ext.data.Store#paramNames paramNames} property.)</p>
  281.              * <p>Parameters may be added as required in the event handler.</p>
  282.              */
  283.             'beforechange'
  284.         );
  285.         this.on('afterlayout', this.onFirstLayout, this, {single: true});
  286.         this.cursor = 0;
  287.         this.bindStore(this.store, true);
  288.     },
  289.     // private
  290.     onFirstLayout : function(){
  291.         if(this.dsLoaded){
  292.             this.onLoad.apply(this, this.dsLoaded);
  293.         }
  294.     },
  295.     // private
  296.     updateInfo : function(){
  297.         if(this.displayItem){
  298.             var count = this.store.getCount();
  299.             var msg = count == 0 ?
  300.                 this.emptyMsg :
  301.                 String.format(
  302.                     this.displayMsg,
  303.                     this.cursor+1, this.cursor+count, this.store.getTotalCount()
  304.                 );
  305.             this.displayItem.setText(msg);
  306.         }
  307.     },
  308.     // private
  309.     onLoad : function(store, r, o){
  310.         if(!this.rendered){
  311.             this.dsLoaded = [store, r, o];
  312.             return;
  313.         }
  314.         var p = this.getParams();
  315.         this.cursor = (o.params && o.params[p.start]) ? o.params[p.start] : 0;
  316.         var d = this.getPageData(), ap = d.activePage, ps = d.pages;
  317.         this.afterTextItem.setText(String.format(this.afterPageText, d.pages));
  318.         this.inputItem.setValue(ap);
  319.         this.first.setDisabled(ap == 1);
  320.         this.prev.setDisabled(ap == 1);
  321.         this.next.setDisabled(ap == ps);
  322.         this.last.setDisabled(ap == ps);
  323.         this.refresh.enable();
  324.         this.updateInfo();
  325.         this.fireEvent('change', this, d);
  326.     },
  327.     // private
  328.     getPageData : function(){
  329.         var total = this.store.getTotalCount();
  330.         return {
  331.             total : total,
  332.             activePage : Math.ceil((this.cursor+this.pageSize)/this.pageSize),
  333.             pages :  total < this.pageSize ? 1 : Math.ceil(total/this.pageSize)
  334.         };
  335.     },
  336.     /**
  337.      * Change the active page
  338.      * @param {Integer} page The page to display
  339.      */
  340.     changePage : function(page){
  341.         this.doLoad(((page-1) * this.pageSize).constrain(0, this.store.getTotalCount()));
  342.     },
  343.     // private
  344.     onLoadError : function(){
  345.         if(!this.rendered){
  346.             return;
  347.         }
  348.         this.refresh.enable();
  349.     },
  350.     // private
  351.     readPage : function(d){
  352.         var v = this.inputItem.getValue(), pageNum;
  353.         if (!v || isNaN(pageNum = parseInt(v, 10))) {
  354.             this.inputItem.setValue(d.activePage);
  355.             return false;
  356.         }
  357.         return pageNum;
  358.     },
  359.     onPagingFocus : function(){
  360.         this.inputItem.select();
  361.     },
  362.     //private
  363.     onPagingBlur : function(e){
  364.         this.inputItem.setValue(this.getPageData().activePage);
  365.     },
  366.     // private
  367.     onPagingKeyDown : function(field, e){
  368.         var k = e.getKey(), d = this.getPageData(), pageNum;
  369.         if (k == e.RETURN) {
  370.             e.stopEvent();
  371.             pageNum = this.readPage(d);
  372.             if(pageNum !== false){
  373.                 pageNum = Math.min(Math.max(1, pageNum), d.pages) - 1;
  374.                 this.doLoad(pageNum * this.pageSize);
  375.             }
  376.         }else if (k == e.HOME || k == e.END){
  377.             e.stopEvent();
  378.             pageNum = k == e.HOME ? 1 : d.pages;
  379.             field.setValue(pageNum);
  380.         }else if (k == e.UP || k == e.PAGEUP || k == e.DOWN || k == e.PAGEDOWN){
  381.             e.stopEvent();
  382.             if((pageNum = this.readPage(d))){
  383.                 var increment = e.shiftKey ? 10 : 1;
  384.                 if(k == e.DOWN || k == e.PAGEDOWN){
  385.                     increment *= -1;
  386.                 }
  387.                 pageNum += increment;
  388.                 if(pageNum >= 1 & pageNum <= d.pages){
  389.                     field.setValue(pageNum);
  390.                 }
  391.             }
  392.         }
  393.     },
  394.     // private
  395.     getParams : function(){
  396.         //retain backwards compat, allow params on the toolbar itself, if they exist.
  397.         return this.paramNames || this.store.paramNames;
  398.     },
  399.     // private
  400.     beforeLoad : function(){
  401.         if(this.rendered && this.refresh){
  402.             this.refresh.disable();
  403.         }
  404.     },
  405.     // private
  406.     doLoad : function(start){
  407.         var o = {}, pn = this.getParams();
  408.         o[pn.start] = start;
  409.         o[pn.limit] = this.pageSize;
  410.         if(this.fireEvent('beforechange', this, o) !== false){
  411.             this.store.load({params:o});
  412.         }
  413.     },
  414.     /**
  415.      * Move to the first page, has the same effect as clicking the 'first' button.
  416.      */
  417.     moveFirst : function(){
  418.         this.doLoad(0);
  419.     },
  420.     /**
  421.      * Move to the previous page, has the same effect as clicking the 'previous' button.
  422.      */
  423.     movePrevious : function(){
  424.         this.doLoad(Math.max(0, this.cursor-this.pageSize));
  425.     },
  426.     /**
  427.      * Move to the next page, has the same effect as clicking the 'next' button.
  428.      */
  429.     moveNext : function(){
  430.         this.doLoad(this.cursor+this.pageSize);
  431.     },
  432.     /**
  433.      * Move to the last page, has the same effect as clicking the 'last' button.
  434.      */
  435.     moveLast : function(){
  436.         var total = this.store.getTotalCount(),
  437.             extra = total % this.pageSize;
  438.         this.doLoad(extra ? (total - extra) : total - this.pageSize);
  439.     },
  440.     /**
  441.      * Refresh the current page, has the same effect as clicking the 'refresh' button.
  442.      */
  443.     doRefresh : function(){
  444.         this.doLoad(this.cursor);
  445.     },
  446.     /**
  447.      * Binds the paging toolbar to the specified {@link Ext.data.Store}
  448.      * @param {Store} store The store to bind to this toolbar
  449.      * @param {Boolean} initial (Optional) true to not remove listeners
  450.      */
  451.     bindStore : function(store, initial){
  452.         var doLoad;
  453.         if(!initial && this.store){
  454.             if(store !== this.store && this.store.autoDestroy){
  455.                 this.store.destroy();
  456.             }else{
  457.                 this.store.un('beforeload', this.beforeLoad, this);
  458.                 this.store.un('load', this.onLoad, this);
  459.                 this.store.un('exception', this.onLoadError, this);
  460.             }
  461.             if(!store){
  462.                 this.store = null;
  463.             }
  464.         }
  465.         if(store){
  466.             store = Ext.StoreMgr.lookup(store);
  467.             store.on({
  468.                 scope: this,
  469.                 beforeload: this.beforeLoad,
  470.                 load: this.onLoad,
  471.                 exception: this.onLoadError
  472.             });
  473.             doLoad = true;
  474.         }
  475.         this.store = store;
  476.         if(doLoad){
  477.             this.onLoad(store, null, {});
  478.         }
  479.     },
  480.     /**
  481.      * Unbinds the paging toolbar from the specified {@link Ext.data.Store} <b>(deprecated)</b>
  482.      * @param {Ext.data.Store} store The data store to unbind
  483.      */
  484.     unbind : function(store){
  485.         this.bindStore(null);
  486.     },
  487.     /**
  488.      * Binds the paging toolbar to the specified {@link Ext.data.Store} <b>(deprecated)</b>
  489.      * @param {Ext.data.Store} store The data store to bind
  490.      */
  491.     bind : function(store){
  492.         this.bindStore(store);
  493.     },
  494.     // private
  495.     onDestroy : function(){
  496.         this.bindStore(null);
  497.         Ext.PagingToolbar.superclass.onDestroy.call(this);
  498.     }
  499. });
  500. })();
  501. Ext.reg('paging', Ext.PagingToolbar);