src/widgets/grid/GroupingView.js

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