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

JavaScript

开发平台:

JavaScript

  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.grid.GroupingView
  3.  * @extends Ext.grid.GridView
  4.  * Adds the ability for single level grouping to the grid. A {@link Ext.data.GroupingStore GroupingStore}
  5.  * must be used to enable grouping.  Some grouping characteristics may also be configured at the
  6.  * {@link Ext.grid.Column Column level}<div class="mdetail-params"><ul>
  7.  * <li><code>{@link Ext.grid.Column#emptyGroupText emptyGroupText}</li>
  8.  * <li><code>{@link Ext.grid.Column#groupable groupable}</li>
  9.  * <li><code>{@link Ext.grid.Column#groupName groupName}</li>
  10.  * <li><code>{@link Ext.grid.Column#groupRender groupRender}</li>
  11.  * </ul></div>
  12.  * <p>Sample usage:</p>
  13.  * <pre><code>
  14. var grid = new Ext.grid.GridPanel({
  15.     // A groupingStore is required for a GroupingView
  16.     store: new {@link Ext.data.GroupingStore}({
  17.         autoDestroy: true,
  18.         reader: reader,
  19.         data: xg.dummyData,
  20.         sortInfo: {field: 'company', direction: 'ASC'},
  21.         {@link Ext.data.GroupingStore#groupOnSort groupOnSort}: true,
  22.         {@link Ext.data.GroupingStore#remoteGroup remoteGroup}: true,
  23.         {@link Ext.data.GroupingStore#groupField groupField}: 'industry'
  24.     }),
  25.     colModel: new {@link Ext.grid.ColumnModel}({
  26.         columns:[
  27.             {id:'company',header: 'Company', width: 60, dataIndex: 'company'},
  28.             // {@link Ext.grid.Column#groupable groupable}, {@link Ext.grid.Column#groupName groupName}, {@link Ext.grid.Column#groupRender groupRender} are also configurable at column level
  29.             {header: 'Price', renderer: Ext.util.Format.usMoney, dataIndex: 'price', {@link Ext.grid.Column#groupable groupable}: false},
  30.             {header: 'Change', dataIndex: 'change', renderer: Ext.util.Format.usMoney},
  31.             {header: 'Industry', dataIndex: 'industry'},
  32.             {header: 'Last Updated', renderer: Ext.util.Format.dateRenderer('m/d/Y'), dataIndex: 'lastChange'}
  33.         ],
  34.         defaults: {
  35.             sortable: true,
  36.             menuDisabled: false,
  37.             width: 20
  38.         }
  39.     }),
  40.     view: new Ext.grid.GroupingView({
  41.         {@link Ext.grid.GridView#forceFit forceFit}: true,
  42.         // custom grouping text template to display the number of items per group
  43.         {@link #groupTextTpl}: '{text} ({[values.rs.length]} {[values.rs.length > 1 ? "Items" : "Item"]})'
  44.     }),
  45.     frame:true,
  46.     width: 700,
  47.     height: 450,
  48.     collapsible: true,
  49.     animCollapse: false,
  50.     title: 'Grouping Example',
  51.     iconCls: 'icon-grid',
  52.     renderTo: document.body
  53. });
  54.  * </code></pre>
  55.  * @constructor
  56.  * @param {Object} config
  57.  */
  58. Ext.grid.GroupingView = Ext.extend(Ext.grid.GridView, {
  59.     /**
  60.      * @cfg {String} groupByText Text displayed in the grid header menu for grouping by a column
  61.      * (defaults to 'Group By This Field').
  62.      */
  63.     groupByText : 'Group By This Field',
  64.     /**
  65.      * @cfg {String} showGroupsText Text displayed in the grid header for enabling/disabling grouping
  66.      * (defaults to 'Show in Groups').
  67.      */
  68.     showGroupsText : 'Show in Groups',
  69.     /**
  70.      * @cfg {Boolean} hideGroupedColumn <tt>true</tt> to hide the column that is currently grouped (defaults to <tt>false</tt>)
  71.      */
  72.     hideGroupedColumn : false,
  73.     /**
  74.      * @cfg {Boolean} showGroupName If <tt>true</tt> will display a prefix plus a ': ' before the group field value
  75.      * in the group header line.  The prefix will consist of the <tt><b>{@link Ext.grid.Column#groupName groupName}</b></tt>
  76.      * (or the configured <tt><b>{@link Ext.grid.Column#header header}</b></tt> if not provided) configured in the
  77.      * {@link Ext.grid.Column} for each set of grouped rows (defaults to <tt>true</tt>).
  78.      */
  79.     showGroupName : true,
  80.     /**
  81.      * @cfg {Boolean} startCollapsed <tt>true</tt> to start all groups collapsed (defaults to <tt>false</tt>)
  82.      */
  83.     startCollapsed : false,
  84.     /**
  85.      * @cfg {Boolean} enableGrouping <tt>false</tt> to disable grouping functionality (defaults to <tt>true</tt>)
  86.      */
  87.     enableGrouping : true,
  88.     /**
  89.      * @cfg {Boolean} enableGroupingMenu <tt>true</tt> to enable the grouping control in the column menu (defaults to <tt>true</tt>)
  90.      */
  91.     enableGroupingMenu : true,
  92.     /**
  93.      * @cfg {Boolean} enableNoGroups <tt>true</tt> to allow the user to turn off grouping (defaults to <tt>true</tt>)
  94.      */
  95.     enableNoGroups : true,
  96.     /**
  97.      * @cfg {String} emptyGroupText The text to display when there is an empty group value (defaults to <tt>'(None)'</tt>).
  98.      * May also be specified per column, see {@link Ext.grid.Column}.{@link Ext.grid.Column#emptyGroupText emptyGroupText}.
  99.      */
  100.     emptyGroupText : '(None)',
  101.     /**
  102.      * @cfg {Boolean} ignoreAdd <tt>true</tt> to skip refreshing the view when new rows are added (defaults to <tt>false</tt>)
  103.      */
  104.     ignoreAdd : false,
  105.     /**
  106.      * @cfg {String} groupTextTpl The template used to render the group header (defaults to <tt>'{text}'</tt>).
  107.      * This is used to format an object which contains the following properties:
  108.      * <div class="mdetail-params"><ul>
  109.      * <li><b>group</b> : String<p class="sub-desc">The <i>rendered</i> value of the group field.
  110.      * By default this is the unchanged value of the group field. If a <tt><b>{@link Ext.grid.Column#groupRenderer groupRenderer}</b></tt>
  111.      * is specified, it is the result of a call to that function.</p></li>
  112.      * <li><b>gvalue</b> : Object<p class="sub-desc">The <i>raw</i> value of the group field.</p></li>
  113.      * <li><b>text</b> : String<p class="sub-desc">The configured header (as described in <tt>{@link #showGroupName})</tt>
  114.      * if <tt>{@link #showGroupName}</tt> is <tt>true</tt>) plus the <i>rendered</i> group field value.</p></li>
  115.      * <li><b>groupId</b> : String<p class="sub-desc">A unique, generated ID which is applied to the
  116.      * View Element which contains the group.</p></li>
  117.      * <li><b>startRow</b> : Number<p class="sub-desc">The row index of the Record which caused group change.</p></li>
  118.      * <li><b>rs</b> : Array<p class="sub-desc">Contains a single element: The Record providing the data
  119.      * for the row which caused group change.</p></li>
  120.      * <li><b>cls</b> : String<p class="sub-desc">The generated class name string to apply to the group header Element.</p></li>
  121.      * <li><b>style</b> : String<p class="sub-desc">The inline style rules to apply to the group header Element.</p></li>
  122.      * </ul></div></p>
  123.      * See {@link Ext.XTemplate} for information on how to format data using a template. Possible usage:<pre><code>
  124. var grid = new Ext.grid.GridPanel({
  125.     ...
  126.     view: new Ext.grid.GroupingView({
  127.         groupTextTpl: '{text} ({[values.rs.length]} {[values.rs.length > 1 ? "Items" : "Item"]})'
  128.     }),
  129. });
  130.      * </code></pre>
  131.      */
  132.     groupTextTpl : '{text}',
  133.     /**
  134.      * @cfg {String} groupMode Indicates how to construct the group identifier. <tt>'value'</tt> constructs the id using
  135.      * raw value, <tt>'display'</tt> constructs the id using the rendered value. Defaults to <tt>'value'</tt>.
  136.      */
  137.     groupMode: 'value',
  138.     /**
  139.      * @cfg {Function} groupRenderer This property must be configured in the {@link Ext.grid.Column} for
  140.      * each column.
  141.      */
  142.     // private
  143.     gidSeed : 1000,
  144.     // private
  145.     initTemplates : function(){
  146.         Ext.grid.GroupingView.superclass.initTemplates.call(this);
  147.         this.state = {};
  148.         var sm = this.grid.getSelectionModel();
  149.         sm.on(sm.selectRow ? 'beforerowselect' : 'beforecellselect',
  150.                 this.onBeforeRowSelect, this);
  151.         if(!this.startGroup){
  152.             this.startGroup = new Ext.XTemplate(
  153.                 '<div id="{groupId}" class="x-grid-group {cls}">',
  154.                     '<div id="{groupId}-hd" class="x-grid-group-hd" style="{style}"><div class="x-grid-group-title">', this.groupTextTpl ,'</div></div>',
  155.                     '<div id="{groupId}-bd" class="x-grid-group-body">'
  156.             );
  157.         }
  158.         this.startGroup.compile();
  159.         if(!this.endGroup){
  160.             this.endGroup = '</div></div>';
  161.         }
  162.         this.endGroup = '</div></div>';
  163.     },
  164.     // private
  165.     findGroup : function(el){
  166.         return Ext.fly(el).up('.x-grid-group', this.mainBody.dom);
  167.     },
  168.     // private
  169.     getGroups : function(){
  170.         return this.hasRows() ? this.mainBody.dom.childNodes : [];
  171.     },
  172.     // private
  173.     onAdd : function(){
  174.         if(this.enableGrouping && !this.ignoreAdd){
  175.             var ss = this.getScrollState();
  176.             this.refresh();
  177.             this.restoreScroll(ss);
  178.         }else if(!this.enableGrouping){
  179.             Ext.grid.GroupingView.superclass.onAdd.apply(this, arguments);
  180.         }
  181.     },
  182.     // private
  183.     onRemove : function(ds, record, index, isUpdate){
  184.         Ext.grid.GroupingView.superclass.onRemove.apply(this, arguments);
  185.         var g = document.getElementById(record._groupId);
  186.         if(g && g.childNodes[1].childNodes.length < 1){
  187.             Ext.removeNode(g);
  188.         }
  189.         this.applyEmptyText();
  190.     },
  191.     // private
  192.     refreshRow : function(record){
  193.         if(this.ds.getCount()==1){
  194.             this.refresh();
  195.         }else{
  196.             this.isUpdating = true;
  197.             Ext.grid.GroupingView.superclass.refreshRow.apply(this, arguments);
  198.             this.isUpdating = false;
  199.         }
  200.     },
  201.     // private
  202.     beforeMenuShow : function(){
  203.         var item, items = this.hmenu.items, disabled = this.cm.config[this.hdCtxIndex].groupable === false;
  204.         if((item = items.get('groupBy'))){
  205.             item.setDisabled(disabled);
  206.         }
  207.         if((item = items.get('showGroups'))){
  208.             item.setDisabled(disabled);
  209.         item.setChecked(this.enableGrouping, true);
  210.         }
  211.     },
  212.     // private
  213.     renderUI : function(){
  214.         Ext.grid.GroupingView.superclass.renderUI.call(this);
  215.         this.mainBody.on('mousedown', this.interceptMouse, this);
  216.         if(this.enableGroupingMenu && this.hmenu){
  217.             this.hmenu.add('-',{
  218.                 itemId:'groupBy',
  219.                 text: this.groupByText,
  220.                 handler: this.onGroupByClick,
  221.                 scope: this,
  222.                 iconCls:'x-group-by-icon'
  223.             });
  224.             if(this.enableNoGroups){
  225.                 this.hmenu.add({
  226.                     itemId:'showGroups',
  227.                     text: this.showGroupsText,
  228.             checked: true,
  229.                     checkHandler: this.onShowGroupsClick,
  230.                     scope: this
  231.                 });
  232.             }
  233.             this.hmenu.on('beforeshow', this.beforeMenuShow, this);
  234.         }
  235.     },
  236.     processEvent: function(name, e){
  237.         var hd = e.getTarget('.x-grid-group-hd', this.mainBody);
  238.         if(hd){
  239.             // group value is at the end of the string
  240.             var field = this.getGroupField(),
  241.                 prefix = this.getPrefix(field),
  242.                 groupValue = hd.id.substring(prefix.length);
  243.             // remove trailing '-hd'
  244.             groupValue = groupValue.substr(0, groupValue.length - 3);
  245.             if(groupValue){
  246.                 this.grid.fireEvent('group' + name, this.grid, field, groupValue, e);
  247.             }
  248.         }
  249.     },
  250.     // private
  251.     onGroupByClick : function(){
  252.     this.enableGrouping = true;
  253.         this.grid.store.groupBy(this.cm.getDataIndex(this.hdCtxIndex));
  254.         this.beforeMenuShow(); // Make sure the checkboxes get properly set when changing groups
  255.     this.refresh();
  256.     },
  257.     // private
  258.     onShowGroupsClick : function(mi, checked){
  259.     this.enableGrouping = checked;
  260.         if(checked){
  261.             this.onGroupByClick();
  262.         }else{
  263.             this.grid.store.clearGrouping();
  264.         }
  265.     },
  266.     /**
  267.      * Toggle the group that contains the specific row.
  268.      * @param {Number} rowIndex The row inside the group
  269.      * @param {Boolean} expanded (optional)
  270.      */
  271.     toggleRowIndex : function(rowIndex, expanded){
  272.         if(!this.enableGrouping){
  273.             return;
  274.         }
  275.         var row = this.getRow(rowIndex);
  276.         if(row){
  277.             this.toggleGroup(this.findGroup(row), expanded);
  278.         }
  279.     },
  280.     /**
  281.      * Toggles the specified group if no value is passed, otherwise sets the expanded state of the group to the value passed.
  282.      * @param {String} groupId The groupId assigned to the group (see getGroupId)
  283.      * @param {Boolean} expanded (optional)
  284.      */
  285.     toggleGroup : function(group, expanded){
  286.         var gel = Ext.get(group);
  287.         expanded = Ext.isDefined(expanded) ? expanded : gel.hasClass('x-grid-group-collapsed');
  288.         if(this.state[gel.id] !== expanded){
  289.             this.grid.stopEditing(true);
  290.             this.state[gel.id] = expanded;
  291.             gel[expanded ? 'removeClass' : 'addClass']('x-grid-group-collapsed');
  292.         }
  293.     },
  294.     /**
  295.      * Toggles all groups if no value is passed, otherwise sets the expanded state of all groups to the value passed.
  296.      * @param {Boolean} expanded (optional)
  297.      */
  298.     toggleAllGroups : function(expanded){
  299.         var groups = this.getGroups();
  300.         for(var i = 0, len = groups.length; i < len; i++){
  301.             this.toggleGroup(groups[i], expanded);
  302.         }
  303.     },
  304.     /**
  305.      * Expands all grouped rows.
  306.      */
  307.     expandAllGroups : function(){
  308.         this.toggleAllGroups(true);
  309.     },
  310.     /**
  311.      * Collapses all grouped rows.
  312.      */
  313.     collapseAllGroups : function(){
  314.         this.toggleAllGroups(false);
  315.     },
  316.     // private
  317.     interceptMouse : function(e){
  318.         var hd = e.getTarget('.x-grid-group-hd', this.mainBody);
  319.         if(hd){
  320.             e.stopEvent();
  321.             this.toggleGroup(hd.parentNode);
  322.         }
  323.     },
  324.     // private
  325.     getGroup : function(v, r, groupRenderer, rowIndex, colIndex, ds){
  326.         var g = groupRenderer ? groupRenderer(v, {}, r, rowIndex, colIndex, ds) : String(v);
  327.         if(g === '' || g === '&#160;'){
  328.             g = this.cm.config[colIndex].emptyGroupText || this.emptyGroupText;
  329.         }
  330.         return g;
  331.     },
  332.     // private
  333.     getGroupField : function(){
  334.         return this.grid.store.getGroupState();
  335.     },
  336.     // private
  337.     afterRender : function(){
  338.         Ext.grid.GroupingView.superclass.afterRender.call(this);
  339.         if(this.grid.deferRowRender){
  340.             this.updateGroupWidths();
  341.         }
  342.     },
  343.     // private
  344.     renderRows : function(){
  345.         var groupField = this.getGroupField();
  346.         var eg = !!groupField;
  347.         // if they turned off grouping and the last grouped field is hidden
  348.         if(this.hideGroupedColumn) {
  349.             var colIndex = this.cm.findColumnIndex(groupField),
  350.                 hasLastGroupField = Ext.isDefined(this.lastGroupField);
  351.             if(!eg && hasLastGroupField){
  352.                 this.mainBody.update('');
  353.                 this.cm.setHidden(this.cm.findColumnIndex(this.lastGroupField), false);
  354.                 delete this.lastGroupField;
  355.             }else if (eg && !hasLastGroupField){
  356.                 this.lastGroupField = groupField;
  357.                 this.cm.setHidden(colIndex, true);
  358.             }else if (eg && hasLastGroupField && groupField !== this.lastGroupField) {
  359.                 this.mainBody.update('');
  360.                 var oldIndex = this.cm.findColumnIndex(this.lastGroupField);
  361.                 this.cm.setHidden(oldIndex, false);
  362.                 this.lastGroupField = groupField;
  363.                 this.cm.setHidden(colIndex, true);
  364.             }
  365.         }
  366.         return Ext.grid.GroupingView.superclass.renderRows.apply(
  367.                     this, arguments);
  368.     },
  369.     // private
  370.     doRender : function(cs, rs, ds, startRow, colCount, stripe){
  371.         if(rs.length < 1){
  372.             return '';
  373.         }
  374.         var groupField = this.getGroupField(),
  375.             colIndex = this.cm.findColumnIndex(groupField),
  376.             g;
  377.         this.enableGrouping = (this.enableGrouping === false) ? false : !!groupField;
  378.         if(!this.enableGrouping || this.isUpdating){
  379.             return Ext.grid.GroupingView.superclass.doRender.apply(
  380.                     this, arguments);
  381.         }
  382.         var gstyle = 'width:' + this.getTotalWidth() + ';',
  383.             cfg = this.cm.config[colIndex],
  384.             groupRenderer = cfg.groupRenderer || cfg.renderer,
  385.             prefix = this.showGroupName ? (cfg.groupName || cfg.header)+': ' : '',
  386.             groups = [],
  387.             curGroup, i, len, gid;
  388.         for(i = 0, len = rs.length; i < len; i++){
  389.             var rowIndex = startRow + i,
  390.                 r = rs[i],
  391.                 gvalue = r.data[groupField];
  392.                 g = this.getGroup(gvalue, r, groupRenderer, rowIndex, colIndex, ds);
  393.             if(!curGroup || curGroup.group != g){
  394.                 gid = this.constructId(gvalue, groupField, colIndex);
  395.                 // if state is defined use it, however state is in terms of expanded
  396.                 // so negate it, otherwise use the default.
  397.                 this.state[gid] = !(Ext.isDefined(this.state[gid]) ? !this.state[gid] : this.startCollapsed);
  398.                 curGroup = {
  399.                     group: g,
  400.                     gvalue: gvalue,
  401.                     text: prefix + g,
  402.                     groupId: gid,
  403.                     startRow: rowIndex,
  404.                     rs: [r],
  405.                     cls: this.state[gid] ? '' : 'x-grid-group-collapsed',
  406.                     style: gstyle
  407.                 };
  408.                 groups.push(curGroup);
  409.             }else{
  410.                 curGroup.rs.push(r);
  411.             }
  412.             r._groupId = gid;
  413.         }
  414.         var buf = [];
  415.         for(i = 0, len = groups.length; i < len; i++){
  416.             g = groups[i];
  417.             this.doGroupStart(buf, g, cs, ds, colCount);
  418.             buf[buf.length] = Ext.grid.GroupingView.superclass.doRender.call(
  419.                     this, cs, g.rs, ds, g.startRow, colCount, stripe);
  420.             this.doGroupEnd(buf, g, cs, ds, colCount);
  421.         }
  422.         return buf.join('');
  423.     },
  424.     /**
  425.      * Dynamically tries to determine the groupId of a specific value
  426.      * @param {String} value
  427.      * @return {String} The group id
  428.      */
  429.     getGroupId : function(value){
  430.         var field = this.getGroupField();
  431.         return this.constructId(value, field, this.cm.findColumnIndex(field));
  432.     },
  433.     // private
  434.     constructId : function(value, field, idx){
  435.         var cfg = this.cm.config[idx],
  436.             groupRenderer = cfg.groupRenderer || cfg.renderer,
  437.             val = (this.groupMode == 'value') ? value : this.getGroup(value, {data:{}}, groupRenderer, 0, idx, this.ds);
  438.         return this.getPrefix(field) + Ext.util.Format.htmlEncode(val);
  439.     },
  440.     // private
  441.     getPrefix: function(field){
  442.         return this.grid.getGridEl().id + '-gp-' + field + '-';
  443.     },
  444.     // private
  445.     doGroupStart : function(buf, g, cs, ds, colCount){
  446.         buf[buf.length] = this.startGroup.apply(g);
  447.     },
  448.     // private
  449.     doGroupEnd : function(buf, g, cs, ds, colCount){
  450.         buf[buf.length] = this.endGroup;
  451.     },
  452.     // private
  453.     getRows : function(){
  454.         if(!this.enableGrouping){
  455.             return Ext.grid.GroupingView.superclass.getRows.call(this);
  456.         }
  457.         var r = [];
  458.         var g, gs = this.getGroups();
  459.         for(var i = 0, len = gs.length; i < len; i++){
  460.             g = gs[i].childNodes[1].childNodes;
  461.             for(var j = 0, jlen = g.length; j < jlen; j++){
  462.                 r[r.length] = g[j];
  463.             }
  464.         }
  465.         return r;
  466.     },
  467.     // private
  468.     updateGroupWidths : function(){
  469.         if(!this.enableGrouping || !this.hasRows()){
  470.             return;
  471.         }
  472.         var tw = Math.max(this.cm.getTotalWidth(), this.el.dom.offsetWidth-this.getScrollOffset()) +'px';
  473.         var gs = this.getGroups();
  474.         for(var i = 0, len = gs.length; i < len; i++){
  475.             gs[i].firstChild.style.width = tw;
  476.         }
  477.     },
  478.     // private
  479.     onColumnWidthUpdated : function(col, w, tw){
  480.         Ext.grid.GroupingView.superclass.onColumnWidthUpdated.call(this, col, w, tw);
  481.         this.updateGroupWidths();
  482.     },
  483.     // private
  484.     onAllColumnWidthsUpdated : function(ws, tw){
  485.         Ext.grid.GroupingView.superclass.onAllColumnWidthsUpdated.call(this, ws, tw);
  486.         this.updateGroupWidths();
  487.     },
  488.     // private
  489.     onColumnHiddenUpdated : function(col, hidden, tw){
  490.         Ext.grid.GroupingView.superclass.onColumnHiddenUpdated.call(this, col, hidden, tw);
  491.         this.updateGroupWidths();
  492.     },
  493.     // private
  494.     onLayout : function(){
  495.         this.updateGroupWidths();
  496.     },
  497.     // private
  498.     onBeforeRowSelect : function(sm, rowIndex){
  499.         this.toggleRowIndex(rowIndex, true);
  500.     }
  501. });
  502. // private
  503. Ext.grid.GroupingView.GROUP_ID = 1000;