Category

Development Platform
Home > SourceCode/Document > Java Develop > JavaScript > View Code
GroupingStore.js
Package: ext-3.1.0.zip　[view]
Upload User: dawnssy
Upload Date: 2022-08-06
Package Size: 9345k
Code Size: 5k
Category:

JavaScript

Development Platform:

JavaScript

GroupingStore.js：Code Content
  1. /*!  * Ext JS Library 3.1.0  * Copyright(c) 2006-2009 Ext JS, LLC  * licensing@extjs.com  * http://www.extjs.com/license  */ /**
  2.  * @class Ext.data.GroupingStore
  3.  * @extends Ext.data.Store
  4.  * A specialized store implementation that provides for grouping records by one of the available fields. This
  5.  * is usually used in conjunction with an {@link Ext.grid.GroupingView} to proved the data model for
  6.  * a grouped GridPanel.
  7.  * @constructor
  8.  * Creates a new GroupingStore.
  9.  * @param {Object} config A config object containing the objects needed for the Store to access data,
  10.  * and read the data into Records.
  11.  * @xtype groupingstore
  12.  */
  13. Ext.data.GroupingStore = Ext.extend(Ext.data.Store, {
  14.     
  15.     //inherit docs
  16.     constructor: function(config){
  17.         Ext.data.GroupingStore.superclass.constructor.call(this, config);
  18.         this.applyGroupField();
  19.     },
  20.     
  21.     /**
  22.      * @cfg {String} groupField
  23.      * The field name by which to sort the store's data (defaults to '').
  24.      */
  25.     /**
  26.      * @cfg {Boolean} remoteGroup
  27.      * True if the grouping should apply on the server side, false if it is local only (defaults to false).  If the
  28.      * grouping is local, it can be applied immediately to the data.  If it is remote, then it will simply act as a
  29.      * helper, automatically sending the grouping field name as the 'groupBy' param with each XHR call.
  30.      */
  31.     remoteGroup : false,
  32.     /**
  33.      * @cfg {Boolean} groupOnSort
  34.      * True to sort the data on the grouping field when a grouping operation occurs, false to sort based on the
  35.      * existing sort info (defaults to false).
  36.      */
  37.     groupOnSort:false,
  39. groupDir : 'ASC',
  41.     /**
  42.      * Clears any existing grouping and refreshes the data using the default sort.
  43.      */
  44.     clearGrouping : function(){
  45.         this.groupField = false;
  46.         if(this.remoteGroup){
  47.             if(this.baseParams){
  48.                 delete this.baseParams.groupBy;
  49.             }
  50.             var lo = this.lastOptions;
  51.             if(lo && lo.params){
  52.                 delete lo.params.groupBy;
  53.             }
  54.             this.reload();
  55.         }else{
  56.             this.applySort();
  57.             this.fireEvent('datachanged', this);
  58.         }
  59.     },
  61.     /**
  62.      * Groups the data by the specified field.
  63.      * @param {String} field The field name by which to sort the store's data
  64.      * @param {Boolean} forceRegroup (optional) True to force the group to be refreshed even if the field passed
  65.      * in is the same as the current grouping field, false to skip grouping on the same field (defaults to false)
  66.      */
  67.     groupBy : function(field, forceRegroup, direction){
  68. direction = direction ? (String(direction).toUpperCase() == 'DESC' ? 'DESC' : 'ASC') : this.groupDir;
  69.         if(this.groupField == field && this.groupDir == direction && !forceRegroup){
  70.             return; // already grouped by this field
  71.         }
  72.         this.groupField = field;
  73. this.groupDir = direction;
  74.         this.applyGroupField();
  75.         if(this.groupOnSort){
  76.             this.sort(field, direction);
  77.             return;
  78.         }
  79.         if(this.remoteGroup){
  80.             this.reload();
  81.         }else{
  82.             var si = this.sortInfo || {};
  83.             if(si.field != field || si.direction != direction){
  84.                 this.applySort();
  85.             }else{
  86.                 this.sortData(field, direction);
  87.             }
  88.             this.fireEvent('datachanged', this);
  89.         }
  90.     },
  91.     
  92.     // private
  93.     applyGroupField: function(){
  94.         if(this.remoteGroup){
  95.             if(!this.baseParams){
  96.                 this.baseParams = {};
  97.             }
  98.             this.baseParams.groupBy = this.groupField;
  99.             this.baseParams.groupDir = this.groupDir;
  100.         }
  101.     },
  103.     // private
  104.     applySort : function(){
  105.         Ext.data.GroupingStore.superclass.applySort.call(this);
  106.         if(!this.groupOnSort && !this.remoteGroup){
  107.             var gs = this.getGroupState();
  108.             if(gs && (gs != this.sortInfo.field || this.groupDir != this.sortInfo.direction)){
  109.                 this.sortData(this.groupField, this.groupDir);
  110.             }
  111.         }
  112.     },
  114.     // private
  115.     applyGrouping : function(alwaysFireChange){
  116.         if(this.groupField !== false){
  117.             this.groupBy(this.groupField, true, this.groupDir);
  118.             return true;
  119.         }else{
  120.             if(alwaysFireChange === true){
  121.                 this.fireEvent('datachanged', this);
  122.             }
  123.             return false;
  124.         }
  125.     },
  127.     // private
  128.     getGroupState : function(){
  129.         return this.groupOnSort && this.groupField !== false ?
  130.                (this.sortInfo ? this.sortInfo.field : undefined) : this.groupField;
  131.     }
  132. });
  133. Ext.reg('groupingstore', Ext.data.GroupingStore);