X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/ee06f37b0f6f6d94cd05a6ffae556660f7c4a2bc..76cb34406ceaf9681a76e13b531d7eafa483ad88:/examples/ux/GroupSummary.js

diff --git a/examples/ux/GroupSummary.js b/examples/ux/GroupSummary.js
new file mode 100644
index 00000000..18073fcd
--- /dev/null
+++ b/examples/ux/GroupSummary.js
@@ -0,0 +1,369 @@
+/*!
+ * Ext JS Library 3.0.0
+ * Copyright(c) 2006-2009 Ext JS, LLC
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+Ext.ns('Ext.ux.grid');
+
+/**
+ * @class Ext.ux.grid.GroupSummary
+ * @extends Ext.util.Observable
+ * A GridPanel plugin that enables dynamic column calculations and a dynamically
+ * updated grouped summary row.
+ */
+Ext.ux.grid.GroupSummary = Ext.extend(Ext.util.Observable, {
+    /**
+     * @cfg {Function} summaryRenderer Renderer example:<pre><code>
+summaryRenderer: function(v, params, data){
+    return ((v === 0 || v > 1) ? '(' + v +' Tasks)' : '(1 Task)');
+},
+     * </code></pre>
+     */
+    /**
+     * @cfg {String} summaryType (Optional) The type of
+     * calculation to be used for the column.  For options available see
+     * {@link #Calculations}.
+     */
+
+    constructor : function(config){
+        Ext.apply(this, config);
+        Ext.ux.grid.GroupSummary.superclass.constructor.call(this);
+    },
+    init : function(grid){
+        this.grid = grid;
+        this.cm = grid.getColumnModel();
+        this.view = grid.getView();
+
+        var v = this.view;
+        v.doGroupEnd = this.doGroupEnd.createDelegate(this);
+
+        v.afterMethod('onColumnWidthUpdated', this.doWidth, this);
+        v.afterMethod('onAllColumnWidthsUpdated', this.doAllWidths, this);
+        v.afterMethod('onColumnHiddenUpdated', this.doHidden, this);
+        v.afterMethod('onUpdate', this.doUpdate, this);
+        v.afterMethod('onRemove', this.doRemove, this);
+
+        if(!this.rowTpl){
+            this.rowTpl = new Ext.Template(
+                '<div class="x-grid3-summary-row" style="{tstyle}">',
+                '<table class="x-grid3-summary-table" border="0" cellspacing="0" cellpadding="0" style="{tstyle}">',
+                    '<tbody><tr>{cells}</tr></tbody>',
+                '</table></div>'
+            );
+            this.rowTpl.disableFormats = true;
+        }
+        this.rowTpl.compile();
+
+        if(!this.cellTpl){
+            this.cellTpl = new Ext.Template(
+                '<td class="x-grid3-col x-grid3-cell x-grid3-td-{id} {css}" style="{style}">',
+                '<div class="x-grid3-cell-inner x-grid3-col-{id}" unselectable="on">{value}</div>',
+                "</td>"
+            );
+            this.cellTpl.disableFormats = true;
+        }
+        this.cellTpl.compile();
+    },
+
+    /**
+     * Toggle the display of the summary row on/off
+     * @param {Boolean} visible <tt>true</tt> to show the summary, <tt>false</tt> to hide the summary.
+     */
+    toggleSummaries : function(visible){
+        var el = this.grid.getGridEl();
+        if(el){
+            if(visible === undefined){
+                visible = el.hasClass('x-grid-hide-summary');
+            }
+            el[visible ? 'removeClass' : 'addClass']('x-grid-hide-summary');
+        }
+    },
+
+    renderSummary : function(o, cs){
+        cs = cs || this.view.getColumnData();
+        var cfg = this.cm.config;
+
+        var buf = [], c, p = {}, cf, last = cs.length-1;
+        for(var i = 0, len = cs.length; i < len; i++){
+            c = cs[i];
+            cf = cfg[i];
+            p.id = c.id;
+            p.style = c.style;
+            p.css = i == 0 ? 'x-grid3-cell-first ' : (i == last ? 'x-grid3-cell-last ' : '');
+            if(cf.summaryType || cf.summaryRenderer){
+                p.value = (cf.summaryRenderer || c.renderer)(o.data[c.name], p, o);
+            }else{
+                p.value = '';
+            }
+            if(p.value == undefined || p.value === "") p.value = "&#160;";
+            buf[buf.length] = this.cellTpl.apply(p);
+        }
+
+        return this.rowTpl.apply({
+            tstyle: 'width:'+this.view.getTotalWidth()+';',
+            cells: buf.join('')
+        });
+    },
+
+    /**
+     * @private
+     * @param {Object} rs
+     * @param {Object} cs
+     */
+    calculate : function(rs, cs){
+        var data = {}, r, c, cfg = this.cm.config, cf;
+        for(var j = 0, jlen = rs.length; j < jlen; j++){
+            r = rs[j];
+            for(var i = 0, len = cs.length; i < len; i++){
+                c = cs[i];
+                cf = cfg[i];
+                if(cf.summaryType){
+                    data[c.name] = Ext.ux.grid.GroupSummary.Calculations[cf.summaryType](data[c.name] || 0, r, c.name, data);
+                }
+            }
+        }
+        return data;
+    },
+
+    doGroupEnd : function(buf, g, cs, ds, colCount){
+        var data = this.calculate(g.rs, cs);
+        buf.push('</div>', this.renderSummary({data: data}, cs), '</div>');
+    },
+
+    doWidth : function(col, w, tw){
+        var gs = this.view.getGroups(), s;
+        for(var i = 0, len = gs.length; i < len; i++){
+            s = gs[i].childNodes[2];
+            s.style.width = tw;
+            s.firstChild.style.width = tw;
+            s.firstChild.rows[0].childNodes[col].style.width = w;
+        }
+    },
+
+    doAllWidths : function(ws, tw){
+        var gs = this.view.getGroups(), s, cells, wlen = ws.length;
+        for(var i = 0, len = gs.length; i < len; i++){
+            s = gs[i].childNodes[2];
+            s.style.width = tw;
+            s.firstChild.style.width = tw;
+            cells = s.firstChild.rows[0].childNodes;
+            for(var j = 0; j < wlen; j++){
+                cells[j].style.width = ws[j];
+            }
+        }
+    },
+
+    doHidden : function(col, hidden, tw){
+        var gs = this.view.getGroups(), s, display = hidden ? 'none' : '';
+        for(var i = 0, len = gs.length; i < len; i++){
+            s = gs[i].childNodes[2];
+            s.style.width = tw;
+            s.firstChild.style.width = tw;
+            s.firstChild.rows[0].childNodes[col].style.display = display;
+        }
+    },
+
+    // Note: requires that all (or the first) record in the
+    // group share the same group value. Returns false if the group
+    // could not be found.
+    refreshSummary : function(groupValue){
+        return this.refreshSummaryById(this.view.getGroupId(groupValue));
+    },
+
+    getSummaryNode : function(gid){
+        var g = Ext.fly(gid, '_gsummary');
+        if(g){
+            return g.down('.x-grid3-summary-row', true);
+        }
+        return null;
+    },
+
+    refreshSummaryById : function(gid){
+        var g = document.getElementById(gid);
+        if(!g){
+            return false;
+        }
+        var rs = [];
+        this.grid.store.each(function(r){
+            if(r._groupId == gid){
+                rs[rs.length] = r;
+            }
+        });
+        var cs = this.view.getColumnData();
+        var data = this.calculate(rs, cs);
+        var markup = this.renderSummary({data: data}, cs);
+
+        var existing = this.getSummaryNode(gid);
+        if(existing){
+            g.removeChild(existing);
+        }
+        Ext.DomHelper.append(g, markup);
+        return true;
+    },
+
+    doUpdate : function(ds, record){
+        this.refreshSummaryById(record._groupId);
+    },
+
+    doRemove : function(ds, record, index, isUpdate){
+        if(!isUpdate){
+            this.refreshSummaryById(record._groupId);
+        }
+    },
+
+    /**
+     * Show a message in the summary row.
+     * <pre><code>
+grid.on('afteredit', function(){
+    var groupValue = 'Ext Forms: Field Anchoring';
+    summary.showSummaryMsg(groupValue, 'Updating Summary...');
+});
+     * </code></pre>
+     * @param {String} groupValue
+     * @param {String} msg Text to use as innerHTML for the summary row.
+     */
+    showSummaryMsg : function(groupValue, msg){
+        var gid = this.view.getGroupId(groupValue);
+        var node = this.getSummaryNode(gid);
+        if(node){
+            node.innerHTML = '<div class="x-grid3-summary-msg">' + msg + '</div>';
+        }
+    }
+});
+
+//backwards compat
+Ext.grid.GroupSummary = Ext.ux.grid.GroupSummary;
+
+
+/**
+ * Calculation types for summary row:</p><div class="mdetail-params"><ul>
+ * <li><b><tt>sum</tt></b> : <div class="sub-desc"></div></li>
+ * <li><b><tt>count</tt></b> : <div class="sub-desc"></div></li>
+ * <li><b><tt>max</tt></b> : <div class="sub-desc"></div></li>
+ * <li><b><tt>min</tt></b> : <div class="sub-desc"></div></li>
+ * <li><b><tt>average</tt></b> : <div class="sub-desc"></div></li>
+ * </ul></div>
+ * <p>Custom calculations may be implemented.  An example of
+ * custom <code>summaryType=totalCost</code>:</p><pre><code>
+// define a custom summary function
+Ext.ux.grid.GroupSummary.Calculations['totalCost'] = function(v, record, field){
+    return v + (record.data.estimate * record.data.rate);
+};
+ * </code></pre>
+ * @property Calculations
+ */
+
+Ext.ux.grid.GroupSummary.Calculations = {
+    'sum' : function(v, record, field){
+        return v + (record.data[field]||0);
+    },
+
+    'count' : function(v, record, field, data){
+        return data[field+'count'] ? ++data[field+'count'] : (data[field+'count'] = 1);
+    },
+
+    'max' : function(v, record, field, data){
+        var v = record.data[field];
+        var max = data[field+'max'] === undefined ? (data[field+'max'] = v) : data[field+'max'];
+        return v > max ? (data[field+'max'] = v) : max;
+    },
+
+    'min' : function(v, record, field, data){
+        var v = record.data[field];
+        var min = data[field+'min'] === undefined ? (data[field+'min'] = v) : data[field+'min'];
+        return v < min ? (data[field+'min'] = v) : min;
+    },
+
+    'average' : function(v, record, field, data){
+        var c = data[field+'count'] ? ++data[field+'count'] : (data[field+'count'] = 1);
+        var t = (data[field+'total'] = ((data[field+'total']||0) + (record.data[field]||0)));
+        return t === 0 ? 0 : t / c;
+    }
+};
+Ext.grid.GroupSummary.Calculations = Ext.ux.grid.GroupSummary.Calculations;
+
+/**
+ * @class Ext.ux.grid.HybridSummary
+ * @extends Ext.ux.grid.GroupSummary
+ * Adds capability to specify the summary data for the group via json as illustrated here:
+ * <pre><code>
+{
+    data: [
+        {
+            projectId: 100,     project: 'House',
+            taskId:    112, description: 'Paint',
+            estimate:    6,        rate:     150,
+            due:'06/24/2007'
+        },
+        ...
+    ],
+
+    summaryData: {
+        'House': {
+            description: 14, estimate: 9,
+                   rate: 99, due: new Date(2009, 6, 29),
+                   cost: 999
+        }
+    }
+}
+ * </code></pre>
+ *
+ */
+Ext.ux.grid.HybridSummary = Ext.extend(Ext.ux.grid.GroupSummary, {
+    /**
+     * @private
+     * @param {Object} rs
+     * @param {Object} cs
+     */
+    calculate : function(rs, cs){
+        var gcol = this.view.getGroupField();
+        var gvalue = rs[0].data[gcol];
+        var gdata = this.getSummaryData(gvalue);
+        return gdata || Ext.ux.grid.HybridSummary.superclass.calculate.call(this, rs, cs);
+    },
+
+    /**
+     * <pre><code>
+grid.on('afteredit', function(){
+    var groupValue = 'Ext Forms: Field Anchoring';
+    summary.showSummaryMsg(groupValue, 'Updating Summary...');
+    setTimeout(function(){ // simulate server call
+        // HybridSummary class implements updateSummaryData
+        summary.updateSummaryData(groupValue,
+            // create data object based on configured dataIndex
+            {description: 22, estimate: 888, rate: 888, due: new Date(), cost: 8});
+    }, 2000);
+});
+     * </code></pre>
+     * @param {String} groupValue
+     * @param {Object} data data object
+     * @param {Boolean} skipRefresh (Optional) Defaults to false
+     */
+    updateSummaryData : function(groupValue, data, skipRefresh){
+        var json = this.grid.store.reader.jsonData;
+        if(!json.summaryData){
+            json.summaryData = {};
+        }
+        json.summaryData[groupValue] = data;
+        if(!skipRefresh){
+            this.refreshSummary(groupValue);
+        }
+    },
+
+    /**
+     * Returns the summaryData for the specified groupValue or null.
+     * @param {String} groupValue
+     * @return {Object} summaryData
+     */
+    getSummaryData : function(groupValue){
+        var json = this.grid.store.reader.jsonData;
+        if(json && json.summaryData){
+            return json.summaryData[groupValue];
+        }
+        return null;
+    }
+});
+
+//backwards compat
+Ext.grid.HybridSummary = Ext.ux.grid.HybridSummary;