3 * Copyright(c) 2006-2009 Ext JS, LLC
5 * http://www.extjs.com/license
8 * @class Ext.grid.GroupingView
\r
9 * @extends Ext.grid.GridView
\r
10 * Adds the ability for single level grouping to the grid. A {@link Ext.data.GroupingStore GroupingStore}
\r
11 * must be used to enable grouping. Some grouping characteristics may also be configured at the
\r
12 * {@link Ext.grid.Column Column level}<div class="mdetail-params"><ul>
\r
13 * <li><code>{@link Ext.grid.Column#emptyGroupText emptyGroupText}</li>
\r
14 * <li><code>{@link Ext.grid.Column#groupable groupable}</li>
\r
15 * <li><code>{@link Ext.grid.Column#groupName groupName}</li>
\r
16 * <li><code>{@link Ext.grid.Column#groupRender groupRender}</li>
\r
18 * <p>Sample usage:</p>
\r
20 var grid = new Ext.grid.GridPanel({
\r
21 // A groupingStore is required for a GroupingView
\r
22 store: new {@link Ext.data.GroupingStore}({
\r
26 sortInfo: {field: 'company', direction: 'ASC'},
\r
27 {@link Ext.data.GroupingStore#groupOnSort groupOnSort}: true,
\r
28 {@link Ext.data.GroupingStore#remoteGroup remoteGroup}: true,
\r
29 {@link Ext.data.GroupingStore#groupField groupField}: 'industry'
\r
31 colModel: new {@link Ext.grid.ColumnModel}({
\r
33 {id:'company',header: 'Company', width: 60, dataIndex: 'company'},
\r
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
\r
35 {header: 'Price', renderer: Ext.util.Format.usMoney, dataIndex: 'price', {@link Ext.grid.Column#groupable groupable}: false},
\r
36 {header: 'Change', dataIndex: 'change', renderer: Ext.util.Format.usMoney},
\r
37 {header: 'Industry', dataIndex: 'industry'},
\r
38 {header: 'Last Updated', renderer: Ext.util.Format.dateRenderer('m/d/Y'), dataIndex: 'lastChange'}
\r
42 menuDisabled: false,
\r
47 view: new Ext.grid.GroupingView({
\r
48 {@link Ext.grid.GridView#forceFit forceFit}: true,
\r
49 // custom grouping text template to display the number of items per group
\r
50 {@link #groupTextTpl}: '{text} ({[values.rs.length]} {[values.rs.length > 1 ? "Items" : "Item"]})'
\r
57 animCollapse: false,
\r
58 title: 'Grouping Example',
\r
59 iconCls: 'icon-grid',
\r
60 renderTo: document.body
\r
64 * @param {Object} config
\r
66 Ext.grid.GroupingView = Ext.extend(Ext.grid.GridView, {
\r
69 * @cfg {String} groupByText Text displayed in the grid header menu for grouping by a column
\r
70 * (defaults to 'Group By This Field').
\r
72 groupByText : 'Group By This Field',
\r
74 * @cfg {String} showGroupsText Text displayed in the grid header for enabling/disabling grouping
\r
75 * (defaults to 'Show in Groups').
\r
77 showGroupsText : 'Show in Groups',
\r
79 * @cfg {Boolean} hideGroupedColumn <tt>true</tt> to hide the column that is currently grouped (defaults to <tt>false</tt>)
\r
81 hideGroupedColumn : false,
\r
83 * @cfg {Boolean} showGroupName If <tt>true</tt> will display a prefix plus a ': ' before the group field value
\r
84 * in the group header line. The prefix will consist of the <tt><b>{@link Ext.grid.Column#groupName groupName}</b></tt>
\r
85 * (or the configured <tt><b>{@link Ext.grid.Column#header header}</b></tt> if not provided) configured in the
\r
86 * {@link Ext.grid.Column} for each set of grouped rows (defaults to <tt>true</tt>).
\r
88 showGroupName : true,
\r
90 * @cfg {Boolean} startCollapsed <tt>true</tt> to start all groups collapsed (defaults to <tt>false</tt>)
\r
92 startCollapsed : false,
\r
94 * @cfg {Boolean} enableGrouping <tt>false</tt> to disable grouping functionality (defaults to <tt>true</tt>)
\r
96 enableGrouping : true,
\r
98 * @cfg {Boolean} enableGroupingMenu <tt>true</tt> to enable the grouping control in the column menu (defaults to <tt>true</tt>)
\r
100 enableGroupingMenu : true,
\r
102 * @cfg {Boolean} enableNoGroups <tt>true</tt> to allow the user to turn off grouping (defaults to <tt>true</tt>)
\r
104 enableNoGroups : true,
\r
106 * @cfg {String} emptyGroupText The text to display when there is an empty group value (defaults to <tt>'(None)'</tt>).
\r
107 * May also be specified per column, see {@link Ext.grid.Column}.{@link Ext.grid.Column#emptyGroupText emptyGroupText}.
\r
109 emptyGroupText : '(None)',
\r
111 * @cfg {Boolean} ignoreAdd <tt>true</tt> to skip refreshing the view when new rows are added (defaults to <tt>false</tt>)
\r
115 * @cfg {String} groupTextTpl The template used to render the group header (defaults to <tt>'{text}'</tt>).
\r
116 * This is used to format an object which contains the following properties:
\r
117 * <div class="mdetail-params"><ul>
\r
118 * <li><b>group</b> : String<p class="sub-desc">The <i>rendered</i> value of the group field.
\r
119 * By default this is the unchanged value of the group field. If a <tt><b>{@link Ext.grid.Column#groupRenderer groupRenderer}</b></tt>
\r
120 * is specified, it is the result of a call to that function.</p></li>
\r
121 * <li><b>gvalue</b> : Object<p class="sub-desc">The <i>raw</i> value of the group field.</p></li>
\r
122 * <li><b>text</b> : String<p class="sub-desc">The configured header (as described in <tt>{@link #showGroupName})</tt>
\r
123 * if <tt>{@link #showGroupName}</tt> is <tt>true</tt>) plus the <i>rendered</i> group field value.</p></li>
\r
124 * <li><b>groupId</b> : String<p class="sub-desc">A unique, generated ID which is applied to the
\r
125 * View Element which contains the group.</p></li>
\r
126 * <li><b>startRow</b> : Number<p class="sub-desc">The row index of the Record which caused group change.</p></li>
\r
127 * <li><b>rs</b> : Array<p class="sub-desc">Contains a single element: The Record providing the data
\r
128 * for the row which caused group change.</p></li>
\r
129 * <li><b>cls</b> : String<p class="sub-desc">The generated class name string to apply to the group header Element.</p></li>
\r
130 * <li><b>style</b> : String<p class="sub-desc">The inline style rules to apply to the group header Element.</p></li>
\r
132 * See {@link Ext.XTemplate} for information on how to format data using a template. Possible usage:<pre><code>
\r
133 var grid = new Ext.grid.GridPanel({
\r
135 view: new Ext.grid.GroupingView({
\r
136 groupTextTpl: '{text} ({[values.rs.length]} {[values.rs.length > 1 ? "Items" : "Item"]})'
\r
141 groupTextTpl : '{text}',
\r
144 * @cfg {String} groupMode Indicates how to construct the group identifier. <tt>'value'</tt> constructs the id using
\r
145 * raw value, <tt>'display'</tt> constructs the id using the rendered value. Defaults to <tt>'value'</tt>.
\r
147 groupMode: 'value',
\r
150 * @cfg {Function} groupRenderer This property must be configured in the {@link Ext.grid.Column} for
\r
158 initTemplates : function(){
\r
159 Ext.grid.GroupingView.superclass.initTemplates.call(this);
\r
162 var sm = this.grid.getSelectionModel();
\r
163 sm.on(sm.selectRow ? 'beforerowselect' : 'beforecellselect',
\r
164 this.onBeforeRowSelect, this);
\r
166 if(!this.startGroup){
\r
167 this.startGroup = new Ext.XTemplate(
\r
168 '<div id="{groupId}" class="x-grid-group {cls}">',
\r
169 '<div id="{groupId}-hd" class="x-grid-group-hd" style="{style}"><div class="x-grid-group-title">', this.groupTextTpl ,'</div></div>',
\r
170 '<div id="{groupId}-bd" class="x-grid-group-body">'
\r
173 this.startGroup.compile();
\r
174 if(!this.endGroup){
\r
175 this.endGroup = '</div></div>';
\r
178 this.endGroup = '</div></div>';
\r
182 findGroup : function(el){
\r
183 return Ext.fly(el).up('.x-grid-group', this.mainBody.dom);
\r
187 getGroups : function(){
\r
188 return this.hasRows() ? this.mainBody.dom.childNodes : [];
\r
192 onAdd : function(){
\r
193 if(this.enableGrouping && !this.ignoreAdd){
\r
194 var ss = this.getScrollState();
\r
196 this.restoreScroll(ss);
\r
197 }else if(!this.enableGrouping){
\r
198 Ext.grid.GroupingView.superclass.onAdd.apply(this, arguments);
\r
203 onRemove : function(ds, record, index, isUpdate){
\r
204 Ext.grid.GroupingView.superclass.onRemove.apply(this, arguments);
\r
205 var g = document.getElementById(record._groupId);
\r
206 if(g && g.childNodes[1].childNodes.length < 1){
\r
209 this.applyEmptyText();
\r
213 refreshRow : function(record){
\r
214 if(this.ds.getCount()==1){
\r
217 this.isUpdating = true;
\r
218 Ext.grid.GroupingView.superclass.refreshRow.apply(this, arguments);
\r
219 this.isUpdating = false;
\r
224 beforeMenuShow : function(){
\r
225 var item, items = this.hmenu.items, disabled = this.cm.config[this.hdCtxIndex].groupable === false;
\r
226 if((item = items.get('groupBy'))){
\r
227 item.setDisabled(disabled);
\r
229 if((item = items.get('showGroups'))){
\r
230 item.setDisabled(disabled);
\r
231 item.setChecked(this.enableGrouping, true);
\r
236 renderUI : function(){
\r
237 Ext.grid.GroupingView.superclass.renderUI.call(this);
\r
238 this.mainBody.on('mousedown', this.interceptMouse, this);
\r
240 if(this.enableGroupingMenu && this.hmenu){
\r
241 this.hmenu.add('-',{
\r
243 text: this.groupByText,
\r
244 handler: this.onGroupByClick,
\r
246 iconCls:'x-group-by-icon'
\r
248 if(this.enableNoGroups){
\r
250 itemId:'showGroups',
\r
251 text: this.showGroupsText,
\r
253 checkHandler: this.onShowGroupsClick,
\r
257 this.hmenu.on('beforeshow', this.beforeMenuShow, this);
\r
261 processEvent: function(name, e){
\r
262 var hd = e.getTarget('.x-grid-group-hd', this.mainBody);
\r
264 // group value is at the end of the string
\r
265 var field = this.getGroupField(),
\r
266 prefix = this.getPrefix(field),
\r
267 groupValue = hd.id.substring(prefix.length);
\r
269 // remove trailing '-hd'
\r
270 groupValue = groupValue.substr(0, groupValue.length - 3);
\r
272 this.grid.fireEvent('group' + name, this.grid, field, groupValue, e);
\r
279 onGroupByClick : function(){
\r
280 this.enableGrouping = true;
\r
281 this.grid.store.groupBy(this.cm.getDataIndex(this.hdCtxIndex));
\r
282 this.beforeMenuShow(); // Make sure the checkboxes get properly set when changing groups
\r
287 onShowGroupsClick : function(mi, checked){
\r
288 this.enableGrouping = checked;
\r
290 this.onGroupByClick();
\r
292 this.grid.store.clearGrouping();
\r
297 * Toggle the group that contains the specific row.
\r
298 * @param {Number} rowIndex The row inside the group
\r
299 * @param {Boolean} expanded (optional)
\r
301 toggleRowIndex : function(rowIndex, expanded){
\r
302 if(!this.enableGrouping){
\r
305 var row = this.getRow(rowIndex);
\r
307 this.toggleGroup(this.findGroup(row), expanded);
\r
312 * Toggles the specified group if no value is passed, otherwise sets the expanded state of the group to the value passed.
\r
313 * @param {String} groupId The groupId assigned to the group (see getGroupId)
\r
314 * @param {Boolean} expanded (optional)
\r
316 toggleGroup : function(group, expanded){
\r
317 var gel = Ext.get(group);
\r
318 expanded = Ext.isDefined(expanded) ? expanded : gel.hasClass('x-grid-group-collapsed');
\r
319 if(this.state[gel.id] !== expanded){
\r
320 this.grid.stopEditing(true);
\r
321 this.state[gel.id] = expanded;
\r
322 gel[expanded ? 'removeClass' : 'addClass']('x-grid-group-collapsed');
\r
327 * Toggles all groups if no value is passed, otherwise sets the expanded state of all groups to the value passed.
\r
328 * @param {Boolean} expanded (optional)
\r
330 toggleAllGroups : function(expanded){
\r
331 var groups = this.getGroups();
\r
332 for(var i = 0, len = groups.length; i < len; i++){
\r
333 this.toggleGroup(groups[i], expanded);
\r
338 * Expands all grouped rows.
\r
340 expandAllGroups : function(){
\r
341 this.toggleAllGroups(true);
\r
345 * Collapses all grouped rows.
\r
347 collapseAllGroups : function(){
\r
348 this.toggleAllGroups(false);
\r
352 interceptMouse : function(e){
\r
353 var hd = e.getTarget('.x-grid-group-hd', this.mainBody);
\r
356 this.toggleGroup(hd.parentNode);
\r
361 getGroup : function(v, r, groupRenderer, rowIndex, colIndex, ds){
\r
362 var g = groupRenderer ? groupRenderer(v, {}, r, rowIndex, colIndex, ds) : String(v);
\r
363 if(g === '' || g === ' '){
\r
364 g = this.cm.config[colIndex].emptyGroupText || this.emptyGroupText;
\r
370 getGroupField : function(){
\r
371 return this.grid.store.getGroupState();
\r
375 afterRender : function(){
\r
376 Ext.grid.GroupingView.superclass.afterRender.call(this);
\r
377 if(this.grid.deferRowRender){
\r
378 this.updateGroupWidths();
\r
383 renderRows : function(){
\r
384 var groupField = this.getGroupField();
\r
385 var eg = !!groupField;
\r
386 // if they turned off grouping and the last grouped field is hidden
\r
387 if(this.hideGroupedColumn) {
\r
388 var colIndex = this.cm.findColumnIndex(groupField),
\r
389 hasLastGroupField = Ext.isDefined(this.lastGroupField);
\r
390 if(!eg && hasLastGroupField){
\r
391 this.mainBody.update('');
\r
392 this.cm.setHidden(this.cm.findColumnIndex(this.lastGroupField), false);
\r
393 delete this.lastGroupField;
\r
394 }else if (eg && !hasLastGroupField){
\r
395 this.lastGroupField = groupField;
\r
396 this.cm.setHidden(colIndex, true);
\r
397 }else if (eg && hasLastGroupField && groupField !== this.lastGroupField) {
\r
398 this.mainBody.update('');
\r
399 var oldIndex = this.cm.findColumnIndex(this.lastGroupField);
\r
400 this.cm.setHidden(oldIndex, false);
\r
401 this.lastGroupField = groupField;
\r
402 this.cm.setHidden(colIndex, true);
\r
405 return Ext.grid.GroupingView.superclass.renderRows.apply(
\r
410 doRender : function(cs, rs, ds, startRow, colCount, stripe){
\r
414 var groupField = this.getGroupField(),
\r
415 colIndex = this.cm.findColumnIndex(groupField),
\r
418 this.enableGrouping = (this.enableGrouping === false) ? false : !!groupField;
\r
420 if(!this.enableGrouping || this.isUpdating){
\r
421 return Ext.grid.GroupingView.superclass.doRender.apply(
\r
424 var gstyle = 'width:' + this.getTotalWidth() + ';',
\r
425 cfg = this.cm.config[colIndex],
\r
426 groupRenderer = cfg.groupRenderer || cfg.renderer,
\r
427 prefix = this.showGroupName ? (cfg.groupName || cfg.header)+': ' : '',
\r
429 curGroup, i, len, gid;
\r
431 for(i = 0, len = rs.length; i < len; i++){
\r
432 var rowIndex = startRow + i,
\r
434 gvalue = r.data[groupField];
\r
436 g = this.getGroup(gvalue, r, groupRenderer, rowIndex, colIndex, ds);
\r
437 if(!curGroup || curGroup.group != g){
\r
438 gid = this.constructId(gvalue, groupField, colIndex);
\r
439 // if state is defined use it, however state is in terms of expanded
\r
440 // so negate it, otherwise use the default.
\r
441 this.state[gid] = !(Ext.isDefined(this.state[gid]) ? !this.state[gid] : this.startCollapsed);
\r
447 startRow: rowIndex,
\r
449 cls: this.state[gid] ? '' : 'x-grid-group-collapsed',
\r
452 groups.push(curGroup);
\r
454 curGroup.rs.push(r);
\r
460 for(i = 0, len = groups.length; i < len; i++){
\r
462 this.doGroupStart(buf, g, cs, ds, colCount);
\r
463 buf[buf.length] = Ext.grid.GroupingView.superclass.doRender.call(
\r
464 this, cs, g.rs, ds, g.startRow, colCount, stripe);
\r
466 this.doGroupEnd(buf, g, cs, ds, colCount);
\r
468 return buf.join('');
\r
472 * Dynamically tries to determine the groupId of a specific value
\r
473 * @param {String} value
\r
474 * @return {String} The group id
\r
476 getGroupId : function(value){
\r
477 var field = this.getGroupField();
\r
478 return this.constructId(value, field, this.cm.findColumnIndex(field));
\r
482 constructId : function(value, field, idx){
\r
483 var cfg = this.cm.config[idx],
\r
484 groupRenderer = cfg.groupRenderer || cfg.renderer,
\r
485 val = (this.groupMode == 'value') ? value : this.getGroup(value, {data:{}}, groupRenderer, 0, idx, this.ds);
\r
487 return this.getPrefix(field) + Ext.util.Format.htmlEncode(val);
\r
491 getPrefix: function(field){
\r
492 return this.grid.getGridEl().id + '-gp-' + field + '-';
\r
496 doGroupStart : function(buf, g, cs, ds, colCount){
\r
497 buf[buf.length] = this.startGroup.apply(g);
\r
501 doGroupEnd : function(buf, g, cs, ds, colCount){
\r
502 buf[buf.length] = this.endGroup;
\r
506 getRows : function(){
\r
507 if(!this.enableGrouping){
\r
508 return Ext.grid.GroupingView.superclass.getRows.call(this);
\r
511 var g, gs = this.getGroups();
\r
512 for(var i = 0, len = gs.length; i < len; i++){
\r
513 g = gs[i].childNodes[1].childNodes;
\r
514 for(var j = 0, jlen = g.length; j < jlen; j++){
\r
515 r[r.length] = g[j];
\r
522 updateGroupWidths : function(){
\r
523 if(!this.enableGrouping || !this.hasRows()){
\r
526 var tw = Math.max(this.cm.getTotalWidth(), this.el.dom.offsetWidth-this.getScrollOffset()) +'px';
\r
527 var gs = this.getGroups();
\r
528 for(var i = 0, len = gs.length; i < len; i++){
\r
529 gs[i].firstChild.style.width = tw;
\r
534 onColumnWidthUpdated : function(col, w, tw){
\r
535 Ext.grid.GroupingView.superclass.onColumnWidthUpdated.call(this, col, w, tw);
\r
536 this.updateGroupWidths();
\r
540 onAllColumnWidthsUpdated : function(ws, tw){
\r
541 Ext.grid.GroupingView.superclass.onAllColumnWidthsUpdated.call(this, ws, tw);
\r
542 this.updateGroupWidths();
\r
546 onColumnHiddenUpdated : function(col, hidden, tw){
\r
547 Ext.grid.GroupingView.superclass.onColumnHiddenUpdated.call(this, col, hidden, tw);
\r
548 this.updateGroupWidths();
\r
552 onLayout : function(){
\r
553 this.updateGroupWidths();
\r
557 onBeforeRowSelect : function(sm, rowIndex){
\r
558 this.toggleRowIndex(rowIndex, true);
\r
562 Ext.grid.GroupingView.GROUP_ID = 1000;