Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.grid.feature.Summary.js
1 Ext.data.JsonP.Ext_grid_feature_Summary({
2   "tagname": "class",
3   "name": "Ext.grid.feature.Summary",
4   "doc": "<p>This feature is used to place a summary row at the bottom of the grid. If using a grouping,\nsee <a href=\"#/api/Ext.grid.feature.GroupingSummary\" rel=\"Ext.grid.feature.GroupingSummary\" class=\"docClass\">Ext.grid.feature.GroupingSummary</a>. There are 2 aspects to calculating the summaries,\ncalculation and rendering.</p>\n\n<h2>Calculation</h2>\n\n<p>The summary value needs to be calculated for each column in the grid. This is controlled\nby the summaryType option specified on the column. There are several built in summary types,\nwhich can be specified as a string on the column configuration. These call underlying methods\non the store:</p>\n\n<ul>\n<li><a href=\"#/api/Ext.data.Store-method-count\" rel=\"Ext.data.Store-method-count\" class=\"docClass\">count</a></li>\n<li><a href=\"#/api/Ext.data.Store-method-sum\" rel=\"Ext.data.Store-method-sum\" class=\"docClass\">sum</a></li>\n<li><a href=\"#/api/Ext.data.Store-method-min\" rel=\"Ext.data.Store-method-min\" class=\"docClass\">min</a></li>\n<li><a href=\"#/api/Ext.data.Store-method-max\" rel=\"Ext.data.Store-method-max\" class=\"docClass\">max</a></li>\n<li><a href=\"#/api/Ext.data.Store-method-average\" rel=\"Ext.data.Store-method-average\" class=\"docClass\">average</a></li>\n</ul>\n\n\n<p>Alternatively, the summaryType can be a function definition. If this is the case,\nthe function is called with an array of records to calculate the summary value.</p>\n\n<h2>Rendering</h2>\n\n<p>Similar to a column, the summary also supports a summaryRenderer function. This\nsummaryRenderer is called before displaying a value. The function is optional, if\nnot specified the default calculated value is shown. The summaryRenderer is called with:</p>\n\n<ul>\n<li>value {Object} - The calculated value.</li>\n<li>summaryData {Object} - Contains all raw summary values for the row.</li>\n<li>field {String} - The name of the field we are calculating</li>\n</ul>\n\n\n<h2>Example Usage</h2>\n\n<pre><code>Ext.define('TestResult', {\n    extend: 'Ext.data.Model',\n    fields: ['student', {\n        name: 'mark',\n        type: 'int'\n    }]\n});\n\nExt.create('Ext.grid.Panel', {\n    width: 200,\n    height: 140,\n    renderTo: document.body,\n    features: [{\n        ftype: 'summary'\n    }],\n    store: {\n        model: 'TestResult',\n        data: [{\n            student: 'Student 1',\n            mark: 84\n        },{\n            student: 'Student 2',\n            mark: 72\n        },{\n            student: 'Student 3',\n            mark: 96\n        },{\n            student: 'Student 4',\n            mark: 68\n        }]\n    },\n    columns: [{\n        dataIndex: 'student',\n        text: 'Name',\n        summaryType: 'count',\n        summaryRenderer: function(value, summaryData, dataIndex) {\n            return Ext.String.format('{0} student{1}', value, value !== 1 ? 's' : ''); \n        }\n    }, {\n        dataIndex: 'mark',\n        text: 'Mark',\n        summaryType: 'average'\n    }]\n});\n</code></pre>\n",
5   "extends": "Ext.grid.feature.AbstractSummary",
6   "mixins": [
7
8   ],
9   "alternateClassNames": [
10
11   ],
12   "xtype": null,
13   "author": null,
14   "docauthor": null,
15   "singleton": false,
16   "private": false,
17   "cfg": [
18     {
19       "tagname": "cfg",
20       "name": "listeners",
21       "member": "Ext.util.Observable",
22       "type": "Object",
23       "doc": "<p>(optional) <p>A config object containing one or more event handlers to be added to this\nobject during initialization.  This should be a valid listeners config object as specified in the\n<a href=\"#/api/Ext.grid.feature.Summary-method-addListener\" rel=\"Ext.grid.feature.Summary-method-addListener\" class=\"docClass\">addListener</a> example for attaching multiple handlers at once.</p></p>\n\n<br><p><b><u>DOM events from ExtJs <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a></u></b></p>\n\n\n<br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n<p>is usually only done when extra value can be added. For example the <a href=\"#/api/Ext.view.View\" rel=\"Ext.view.View\" class=\"docClass\">DataView</a>'s\n<b><code><a href=\"#/api/Ext.view.View--click\" rel=\"Ext.view.View--click\" class=\"docClass\">click</a></code></b> event passing the node clicked on. To access DOM\nevents directly from a child element of a Component, we need to specify the <code>element</code> option to\nidentify the Component property to add a DOM listener to:</p>\n\n<pre><code>new Ext.panel.Panel({\n    width: 400,\n    height: 200,\n    dockedItems: [{\n        xtype: 'toolbar'\n    }],\n    listeners: {\n        click: {\n            element: 'el', //bind to the underlying el property on the panel\n            fn: function(){ console.log('click el'); }\n        },\n        dblclick: {\n            element: 'body', //bind to the underlying body property on the panel\n            fn: function(){ console.log('dblclick body'); }\n        }\n    }\n});\n</code></pre>\n\n\n<p></p></p>\n",
24       "private": false,
25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
26       "linenr": 103,
27       "html_filename": "Observable.html",
28       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
29       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
30     },
31     {
32       "tagname": "cfg",
33       "name": "showSummaryRow",
34       "member": "Ext.grid.feature.AbstractSummary",
35       "type": "Boolean",
36       "doc": "<p>True to show the summary row. Defaults to <tt>true</tt>.</p>\n",
37       "private": false,
38       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/AbstractSummary.js",
39       "linenr": 18,
40       "html_filename": "AbstractSummary.html",
41       "href": "AbstractSummary.html#Ext-grid-feature-AbstractSummary-cfg-showSummaryRow"
42     }
43   ],
44   "method": [
45     {
46       "tagname": "method",
47       "name": "addEvents",
48       "member": "Ext.util.Observable",
49       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
50       "params": [
51         {
52           "type": "Object/String",
53           "name": "o",
54           "doc": "<p>Either an object with event names as properties with a value of <code>true</code>\nor the first event name string if multiple event names are being passed as separate parameters.</p>\n",
55           "optional": false
56         },
57         {
58           "type": "String",
59           "name": "",
60           "doc": "<p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:</p>\n\n<pre><code>this.addEvents('storeloaded', 'storecleared');\n</code></pre>\n\n",
61           "optional": false
62         }
63       ],
64       "return": {
65         "type": "void",
66         "doc": "\n"
67       },
68       "private": false,
69       "static": false,
70       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
71       "linenr": 452,
72       "html_filename": "Observable.html",
73       "href": "Observable.html#Ext-util-Observable-method-addEvents",
74       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
75     },
76     {
77       "tagname": "method",
78       "name": "addListener",
79       "member": "Ext.util.Observable",
80       "doc": "<p>Appends an event handler to this object.</p>\n",
81       "params": [
82         {
83           "type": "String",
84           "name": "eventName",
85           "doc": "<p>The name of the event to listen for. May also be an object who's property names are event names. See</p>\n",
86           "optional": false
87         },
88         {
89           "type": "Function",
90           "name": "handler",
91           "doc": "<p>The method the event invokes.</p>\n",
92           "optional": false
93         },
94         {
95           "type": "Object",
96           "name": "scope",
97           "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
98           "optional": true
99         },
100         {
101           "type": "Object",
102           "name": "options",
103           "doc": "<p>(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:<ul>\n<li><b>scope</b> : Object<div class=\"sub-desc\">The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></div></li>\n<li><b>delay</b> : Number<div class=\"sub-desc\">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>\n<li><b>single</b> : Boolean<div class=\"sub-desc\">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>\n<li><b>buffer</b> : Number<div class=\"sub-desc\">Causes the handler to be scheduled to run in an <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a> delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>\n<li><b>target</b> : Observable<div class=\"sub-desc\">Only call the handler if the event was fired on the target Observable, <i>not</i>\nif the event was bubbled up from a child Observable.</div></li>\n<li><b>element</b> : String<div class=\"sub-desc\"><b>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</b>\nThe name of a Component property which references an element to add a listener to.</p>\n\n<p>This option is useful during Component construction to add DOM event listeners to elements of <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n<pre><code>new Ext.panel.Panel({\n    title: 'The title',\n    listeners: {\n        click: this.handlePanelClick,\n        element: 'body'\n    }\n});\n</code></pre></p>\n\n\n<p>When added in this way, the options available are the options applicable to <a href=\"#/api/Ext.core.Element-method-addListener\" rel=\"Ext.core.Element-method-addListener\" class=\"docClass\">Ext.core.Element.addListener</a></p>\n\n\n<p></div></li>\n</ul><br></p>\n\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA delayed, one-time listener.\n<pre><code>myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple events. For example:\n<pre><code>myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n</code></pre>.\n<p>\n\n",
104           "optional": true
105         }
106       ],
107       "return": {
108         "type": "void",
109         "doc": "\n"
110       },
111       "private": false,
112       "static": false,
113       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
114       "linenr": 271,
115       "html_filename": "Observable.html",
116       "href": "Observable.html#Ext-util-Observable-method-addListener",
117       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
118     },
119     {
120       "tagname": "method",
121       "name": "addManagedListener",
122       "member": "Ext.util.Observable",
123       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
124       "params": [
125         {
126           "type": "Observable/Element",
127           "name": "item",
128           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
129           "optional": false
130         },
131         {
132           "type": "Object/String",
133           "name": "ename",
134           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
135           "optional": false
136         },
137         {
138           "type": "Function",
139           "name": "fn",
140           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
141           "optional": false
142         },
143         {
144           "type": "Object",
145           "name": "scope",
146           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
147           "optional": false
148         },
149         {
150           "type": "Object",
151           "name": "opt",
152           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
153           "optional": false
154         }
155       ],
156       "return": {
157         "type": "void",
158         "doc": "\n"
159       },
160       "private": false,
161       "static": false,
162       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
163       "linenr": 155,
164       "html_filename": "Observable.html",
165       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
166       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
167     },
168     {
169       "tagname": "method",
170       "name": "attachEvents",
171       "member": "Ext.grid.feature.Feature",
172       "doc": "<p>Approriate place to attach events to the view, selectionmodel, headerCt, etc</p>\n",
173       "params": [
174
175       ],
176       "return": {
177         "type": "void",
178         "doc": "\n"
179       },
180       "private": false,
181       "static": false,
182       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
183       "linenr": 89,
184       "html_filename": "Feature.html",
185       "href": "Feature.html#Ext-grid-feature-Feature-method-attachEvents",
186       "shortDoc": "<p>Approriate place to attach events to the view, selectionmodel, headerCt, etc</p>\n"
187     },
188     {
189       "tagname": "method",
190       "name": "capture",
191       "member": "Ext.util.Observable",
192       "doc": "<p>Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.</p>\n",
193       "params": [
194         {
195           "type": "Observable",
196           "name": "o",
197           "doc": "<p>The Observable to capture events from.</p>\n",
198           "optional": false
199         },
200         {
201           "type": "Function",
202           "name": "fn",
203           "doc": "<p>The function to call when an event is fired.</p>\n",
204           "optional": false
205         },
206         {
207           "type": "Object",
208           "name": "scope",
209           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
210           "optional": true
211         }
212       ],
213       "return": {
214         "type": "void",
215         "doc": "\n"
216       },
217       "private": false,
218       "static": true,
219       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
220       "linenr": 55,
221       "html_filename": "Observable.html",
222       "href": "Observable.html#Ext-util-Observable-method-capture",
223       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
224     },
225     {
226       "tagname": "method",
227       "name": "clearListeners",
228       "member": "Ext.util.Observable",
229       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
230       "params": [
231
232       ],
233       "return": {
234         "type": "void",
235         "doc": "\n"
236       },
237       "private": false,
238       "static": false,
239       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
240       "linenr": 383,
241       "html_filename": "Observable.html",
242       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
243       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
244     },
245     {
246       "tagname": "method",
247       "name": "clearManagedListeners",
248       "member": "Ext.util.Observable",
249       "doc": "<p>Removes all managed listeners for this object.</p>\n",
250       "params": [
251
252       ],
253       "return": {
254         "type": "void",
255         "doc": "\n"
256       },
257       "private": false,
258       "static": false,
259       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
260       "linenr": 412,
261       "html_filename": "Observable.html",
262       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
263       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
264     },
265     {
266       "tagname": "method",
267       "name": "disable",
268       "member": "Ext.grid.feature.Feature",
269       "doc": "<p>Disable a feature</p>\n",
270       "params": [
271
272       ],
273       "return": {
274         "type": "void",
275         "doc": "\n"
276       },
277       "private": false,
278       "static": false,
279       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
280       "linenr": 140,
281       "html_filename": "Feature.html",
282       "href": "Feature.html#Ext-grid-feature-Feature-method-disable",
283       "shortDoc": "<p>Disable a feature</p>\n"
284     },
285     {
286       "tagname": "method",
287       "name": "enable",
288       "member": "Ext.grid.feature.Feature",
289       "doc": "<p>Enable a feature</p>\n",
290       "params": [
291
292       ],
293       "return": {
294         "type": "void",
295         "doc": "\n"
296       },
297       "private": false,
298       "static": false,
299       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
300       "linenr": 133,
301       "html_filename": "Feature.html",
302       "href": "Feature.html#Ext-grid-feature-Feature-method-enable",
303       "shortDoc": "<p>Enable a feature</p>\n"
304     },
305     {
306       "tagname": "method",
307       "name": "enableBubble",
308       "member": "Ext.util.Observable",
309       "doc": "<p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\n<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\n\n\n<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>. The default\nimplementation in <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.</p>\n\n\n<p>Example:</p>\n\n\n<pre><code>Ext.override(Ext.form.field.Base, {\n//  Add functionality to Field&#39;s initComponent to enable the change event to bubble\ninitComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n    this.enableBubble('change');\n}),\n\n//  We know that we want Field&#39;s events to bubble directly to the FormPanel.\ngetBubbleTarget : function() {\n    if (!this.formPanel) {\n        this.formPanel = this.findParentByType('form');\n    }\n    return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n    ...\n}],\nlisteners: {\n    change: function() {\n        // Title goes red if form has been modified.\n        myForm.header.setStyle('color', 'red');\n    }\n}\n});\n</code></pre>\n\n",
310       "params": [
311         {
312           "type": "String/Array",
313           "name": "events",
314           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
315           "optional": false
316         }
317       ],
318       "return": {
319         "type": "void",
320         "doc": "\n"
321       },
322       "private": false,
323       "static": false,
324       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
325       "linenr": 554,
326       "html_filename": "Observable.html",
327       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
328       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
329     },
330     {
331       "tagname": "method",
332       "name": "fireEvent",
333       "member": "Ext.util.Observable",
334       "doc": "<p>Fires the specified event with the passed parameters (minus the event name).</p>\n\n\n<p>An event may be set to bubble up an Observable parent hierarchy (See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>)\nby calling <a href=\"#/api/Ext.grid.feature.Summary-method-enableBubble\" rel=\"Ext.grid.feature.Summary-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
335       "params": [
336         {
337           "type": "String",
338           "name": "eventName",
339           "doc": "<p>The name of the event to fire.</p>\n",
340           "optional": false
341         },
342         {
343           "type": "Object...",
344           "name": "args",
345           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
346           "optional": false
347         }
348       ],
349       "return": {
350         "type": "Boolean",
351         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
352       },
353       "private": false,
354       "static": false,
355       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
356       "linenr": 232,
357       "html_filename": "Observable.html",
358       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
359       "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..."
360     },
361     {
362       "tagname": "method",
363       "name": "getAdditionalData",
364       "member": "Ext.grid.feature.Feature",
365       "doc": "<p>Provide additional data to the prepareData call within the grid view.</p>\n",
366       "params": [
367         {
368           "type": "Object",
369           "name": "data",
370           "doc": "<p>The data for this particular record.</p>\n",
371           "optional": false
372         },
373         {
374           "type": "Number",
375           "name": "idx",
376           "doc": "<p>The row index for this record.</p>\n",
377           "optional": false
378         },
379         {
380           "type": "Ext.data.Model",
381           "name": "record",
382           "doc": "<p>The record instance</p>\n",
383           "optional": false
384         },
385         {
386           "type": "Object",
387           "name": "orig",
388           "doc": "<p>The original result from the prepareData call to massage.</p>\n",
389           "optional": false
390         }
391       ],
392       "return": {
393         "type": "void",
394         "doc": "\n"
395       },
396       "private": false,
397       "static": false,
398       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
399       "linenr": 122,
400       "html_filename": "Feature.html",
401       "href": "Feature.html#Ext-grid-feature-Feature-method-getAdditionalData",
402       "shortDoc": "<p>Provide additional data to the prepareData call within the grid view.</p>\n"
403     },
404     {
405       "tagname": "method",
406       "name": "getColumnValue",
407       "member": "Ext.grid.feature.AbstractSummary",
408       "doc": "<p>Gets the value for the column from the attached data.</p>\n",
409       "params": [
410         {
411           "type": "Ext.grid.column.Column",
412           "name": "column",
413           "doc": "<p>The header</p>\n",
414           "optional": false
415         },
416         {
417           "type": "Object",
418           "name": "data",
419           "doc": "<p>The current data</p>\n",
420           "optional": false
421         }
422       ],
423       "return": {
424         "type": "String",
425         "doc": "<p>The value to be rendered</p>\n"
426       },
427       "private": false,
428       "static": false,
429       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/AbstractSummary.js",
430       "linenr": 72,
431       "html_filename": "AbstractSummary.html",
432       "href": "AbstractSummary.html#Ext-grid-feature-AbstractSummary-method-getColumnValue",
433       "shortDoc": "<p>Gets the value for the column from the attached data.</p>\n"
434     },
435     {
436       "tagname": "method",
437       "name": "getFireEventArgs",
438       "member": "Ext.grid.feature.Feature",
439       "doc": "<p>Abstract method to be overriden when a feature should add additional\narguments to its event signature. By default the event will fire:\n- view - The underlying <a href=\"#/api/Ext.view.Table\" rel=\"Ext.view.Table\" class=\"docClass\">Ext.view.Table</a>\n- featureTarget - The matched element by the defined <a href=\"#/api/eventSelector\" rel=\"eventSelector\" class=\"docClass\">eventSelector</a></p>\n\n<p>The method must also return the eventName as the first index of the array\nto be passed to fireEvent.</p>\n",
440       "params": [
441         {
442           "type": "Object",
443           "name": "eventName",
444           "doc": "\n",
445           "optional": false
446         },
447         {
448           "type": "Object",
449           "name": "view",
450           "doc": "\n",
451           "optional": false
452         },
453         {
454           "type": "Object",
455           "name": "featureTarget",
456           "doc": "\n",
457           "optional": false
458         },
459         {
460           "type": "Object",
461           "name": "e",
462           "doc": "\n",
463           "optional": false
464         }
465       ],
466       "return": {
467         "type": "void",
468         "doc": "\n"
469       },
470       "private": false,
471       "static": false,
472       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
473       "linenr": 76,
474       "html_filename": "Feature.html",
475       "href": "Feature.html#Ext-grid-feature-Feature-method-getFireEventArgs",
476       "shortDoc": "Abstract method to be overriden when a feature should add additional\narguments to its event signature. By default the..."
477     },
478     {
479       "tagname": "method",
480       "name": "getMetaRowTplFragments",
481       "member": "Ext.grid.feature.Feature",
482       "doc": "<p>Allows a feature to inject member methods into the metaRowTpl. This is\nimportant for embedding functionality which will become part of the proper\nrow tpl.</p>\n",
483       "params": [
484
485       ],
486       "return": {
487         "type": "void",
488         "doc": "\n"
489       },
490       "private": false,
491       "static": false,
492       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
493       "linenr": 109,
494       "html_filename": "Feature.html",
495       "href": "Feature.html#Ext-grid-feature-Feature-method-getMetaRowTplFragments",
496       "shortDoc": "Allows a feature to inject member methods into the metaRowTpl. This is\nimportant for embedding functionality which wi..."
497     },
498     {
499       "tagname": "method",
500       "name": "hasListener",
501       "member": "Ext.util.Observable",
502       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
503       "params": [
504         {
505           "type": "String",
506           "name": "eventName",
507           "doc": "<p>The name of the event to check for</p>\n",
508           "optional": false
509         }
510       ],
511       "return": {
512         "type": "Boolean",
513         "doc": "<p>True if the event is being listened for, else false</p>\n"
514       },
515       "private": false,
516       "static": false,
517       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
518       "linenr": 480,
519       "html_filename": "Observable.html",
520       "href": "Observable.html#Ext-util-Observable-method-hasListener",
521       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
522     },
523     {
524       "tagname": "method",
525       "name": "mutateMetaRowTpl",
526       "member": "Ext.grid.feature.Feature",
527       "doc": "<p>Allows a feature to mutate the metaRowTpl.\nThe array received as a single argument can be manipulated to add things\non the end/begining of a particular row.</p>\n",
528       "params": [
529         {
530           "type": "Object",
531           "name": "metaRowTplArray",
532           "doc": "\n",
533           "optional": false
534         }
535       ],
536       "return": {
537         "type": "void",
538         "doc": "\n"
539       },
540       "private": false,
541       "static": false,
542       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
543       "linenr": 100,
544       "html_filename": "Feature.html",
545       "href": "Feature.html#Ext-grid-feature-Feature-method-mutateMetaRowTpl",
546       "shortDoc": "Allows a feature to mutate the metaRowTpl.\nThe array received as a single argument can be manipulated to add things\no..."
547     },
548     {
549       "tagname": "method",
550       "name": "observe",
551       "member": "Ext.util.Observable",
552       "doc": "<p>Sets observability on the passed class constructor.</p>\n\n<p>This makes any event fired on any instance of the passed class also fire a single event through\nthe <strong>class</strong> allowing for central handling of events on many instances at once.</p>\n\n<p>Usage:</p>\n\n<pre><code>Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n    console.log('Ajax request made to ' + options.url);\n});\n</code></pre>\n",
553       "params": [
554         {
555           "type": "Function",
556           "name": "c",
557           "doc": "<p>The class constructor to make observable.</p>\n",
558           "optional": false
559         },
560         {
561           "type": "Object",
562           "name": "listeners",
563           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.grid.feature.Summary-method-addListener\" rel=\"Ext.grid.feature.Summary-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
564           "optional": false
565         }
566       ],
567       "return": {
568         "type": "void",
569         "doc": "\n"
570       },
571       "private": false,
572       "static": true,
573       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
574       "linenr": 69,
575       "html_filename": "Observable.html",
576       "href": "Observable.html#Ext-util-Observable-method-observe",
577       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
578     },
579     {
580       "tagname": "method",
581       "name": "on",
582       "member": "Ext.util.Observable",
583       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.grid.feature.Summary-method-addListener\" rel=\"Ext.grid.feature.Summary-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
584       "params": [
585         {
586           "type": "String",
587           "name": "eventName",
588           "doc": "<p>The type of event to listen for</p>\n",
589           "optional": false
590         },
591         {
592           "type": "Function",
593           "name": "handler",
594           "doc": "<p>The method the event invokes</p>\n",
595           "optional": false
596         },
597         {
598           "type": "Object",
599           "name": "scope",
600           "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
601           "optional": true
602         },
603         {
604           "type": "Object",
605           "name": "options",
606           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
607           "optional": true
608         }
609       ],
610       "return": {
611         "type": "void",
612         "doc": "\n"
613       },
614       "private": false,
615       "static": false,
616       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
617       "linenr": 616,
618       "html_filename": "Observable.html",
619       "href": "Observable.html#Ext-util-Observable-method-on",
620       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.grid.feature.Summary-method-addListener\" rel=\"Ext.grid.feature.Summary-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
621     },
622     {
623       "tagname": "method",
624       "name": "relayEvents",
625       "member": "Ext.util.Observable",
626       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
627       "params": [
628         {
629           "type": "Object",
630           "name": "origin",
631           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
632           "optional": false
633         },
634         {
635           "type": "Array",
636           "name": "events",
637           "doc": "<p>Array of event names to relay.</p>\n",
638           "optional": false
639         },
640         {
641           "type": "Object",
642           "name": "prefix",
643           "doc": "\n",
644           "optional": false
645         }
646       ],
647       "return": {
648         "type": "void",
649         "doc": "\n"
650       },
651       "private": false,
652       "static": false,
653       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
654       "linenr": 520,
655       "html_filename": "Observable.html",
656       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
657       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
658     },
659     {
660       "tagname": "method",
661       "name": "releaseCapture",
662       "member": "Ext.util.Observable",
663       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
664       "params": [
665         {
666           "type": "Observable",
667           "name": "o",
668           "doc": "<p>The Observable to release</p>\n",
669           "optional": false
670         }
671       ],
672       "return": {
673         "type": "void",
674         "doc": "\n"
675       },
676       "private": false,
677       "static": true,
678       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
679       "linenr": 46,
680       "html_filename": "Observable.html",
681       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
682       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
683     },
684     {
685       "tagname": "method",
686       "name": "removeListener",
687       "member": "Ext.util.Observable",
688       "doc": "<p>Removes an event handler.</p>\n",
689       "params": [
690         {
691           "type": "String",
692           "name": "eventName",
693           "doc": "<p>The type of event the handler was associated with.</p>\n",
694           "optional": false
695         },
696         {
697           "type": "Function",
698           "name": "handler",
699           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.grid.feature.Summary-method-addListener\" rel=\"Ext.grid.feature.Summary-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
700           "optional": false
701         },
702         {
703           "type": "Object",
704           "name": "scope",
705           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
706           "optional": true
707         }
708       ],
709       "return": {
710         "type": "void",
711         "doc": "\n"
712       },
713       "private": false,
714       "static": false,
715       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
716       "linenr": 352,
717       "html_filename": "Observable.html",
718       "href": "Observable.html#Ext-util-Observable-method-removeListener",
719       "shortDoc": "<p>Removes an event handler.</p>\n"
720     },
721     {
722       "tagname": "method",
723       "name": "removeManagedListener",
724       "member": "Ext.util.Observable",
725       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.grid.feature.Summary--mon\" rel=\"Ext.grid.feature.Summary--mon\" class=\"docClass\">mon</a> method.</p>\n",
726       "params": [
727         {
728           "type": "Observable|Element",
729           "name": "item",
730           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
731           "optional": false
732         },
733         {
734           "type": "Object|String",
735           "name": "ename",
736           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
737           "optional": false
738         },
739         {
740           "type": "Function",
741           "name": "fn",
742           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
743           "optional": false
744         },
745         {
746           "type": "Object",
747           "name": "scope",
748           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
749           "optional": false
750         }
751       ],
752       "return": {
753         "type": "void",
754         "doc": "\n"
755       },
756       "private": false,
757       "static": false,
758       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
759       "linenr": 196,
760       "html_filename": "Observable.html",
761       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
762       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.grid.feature.Summary--mon\" rel=\"Ext.grid.feature.Summary--mon\" class=\"docClass\">mon</a> method.</p>\n"
763     },
764     {
765       "tagname": "method",
766       "name": "resumeEvents",
767       "member": "Ext.util.Observable",
768       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.grid.feature.Summary-method-suspendEvents\" rel=\"Ext.grid.feature.Summary-method-suspendEvents\" class=\"docClass\">suspendEvents</a>)\nIf events were suspended using the <code><b>queueSuspended</b></code> parameter, then all\nevents fired during event suspension will be sent to any listeners now.</p>\n",
769       "params": [
770
771       ],
772       "return": {
773         "type": "void",
774         "doc": "\n"
775       },
776       "private": false,
777       "static": false,
778       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
779       "linenr": 502,
780       "html_filename": "Observable.html",
781       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
782       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
783     },
784     {
785       "tagname": "method",
786       "name": "suspendEvents",
787       "member": "Ext.util.Observable",
788       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.grid.feature.Summary-method-resumeEvents\" rel=\"Ext.grid.feature.Summary-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
789       "params": [
790         {
791           "type": "Boolean",
792           "name": "queueSuspended",
793           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.grid.feature.Summary-method-resumeEvents\" rel=\"Ext.grid.feature.Summary-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
794           "optional": false
795         }
796       ],
797       "return": {
798         "type": "void",
799         "doc": "\n"
800       },
801       "private": false,
802       "static": false,
803       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
804       "linenr": 490,
805       "html_filename": "Observable.html",
806       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
807       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.grid.feature.Summary-method-resumeEvents\" rel=\"Ext.grid.feature.Summary-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
808     },
809     {
810       "tagname": "method",
811       "name": "toggleSummaryRow",
812       "member": "Ext.grid.feature.AbstractSummary",
813       "doc": "<p>Toggle whether or not to show the summary row.</p>\n",
814       "params": [
815         {
816           "type": "Boolan",
817           "name": "visible",
818           "doc": "<p>True to show the summary row</p>\n",
819           "optional": false
820         }
821       ],
822       "return": {
823         "type": "void",
824         "doc": "\n"
825       },
826       "private": false,
827       "static": false,
828       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/AbstractSummary.js",
829       "linenr": 26,
830       "html_filename": "AbstractSummary.html",
831       "href": "AbstractSummary.html#Ext-grid-feature-AbstractSummary-method-toggleSummaryRow",
832       "shortDoc": "<p>Toggle whether or not to show the summary row.</p>\n"
833     },
834     {
835       "tagname": "method",
836       "name": "un",
837       "member": "Ext.util.Observable",
838       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.grid.feature.Summary-method-removeListener\" rel=\"Ext.grid.feature.Summary-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
839       "params": [
840         {
841           "type": "String",
842           "name": "eventName",
843           "doc": "<p>The type of event the handler was associated with.</p>\n",
844           "optional": false
845         },
846         {
847           "type": "Function",
848           "name": "handler",
849           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.grid.feature.Summary-method-addListener\" rel=\"Ext.grid.feature.Summary-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
850           "optional": false
851         },
852         {
853           "type": "Object",
854           "name": "scope",
855           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
856           "optional": true
857         }
858       ],
859       "return": {
860         "type": "void",
861         "doc": "\n"
862       },
863       "private": false,
864       "static": false,
865       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
866       "linenr": 608,
867       "html_filename": "Observable.html",
868       "href": "Observable.html#Ext-util-Observable-method-un",
869       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.grid.feature.Summary-method-removeListener\" rel=\"Ext.grid.feature.Summary-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
870     }
871   ],
872   "property": [
873     {
874       "tagname": "property",
875       "name": "collectData",
876       "member": "Ext.grid.feature.Feature",
877       "type": "Boolean",
878       "doc": "<p>Most features will not modify the data returned to the view.\nThis is limited to one feature that manipulates the data per grid view.</p>\n",
879       "private": false,
880       "static": false,
881       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
882       "linenr": 66,
883       "html_filename": "Feature.html",
884       "href": "Feature.html#Ext-grid-feature-Feature-property-collectData",
885       "shortDoc": "Most features will not modify the data returned to the view.\nThis is limited to one feature that manipulates the data..."
886     },
887     {
888       "tagname": "property",
889       "name": "eventPrefix",
890       "member": "Ext.grid.feature.Feature",
891       "type": "String",
892       "doc": "<p>Prefix to use when firing events on the view.\nFor example a prefix of group would expose \"groupclick\", \"groupcontextmenu\", \"groupdblclick\".</p>\n",
893       "private": false,
894       "static": false,
895       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
896       "linenr": 41,
897       "html_filename": "Feature.html",
898       "href": "Feature.html#Ext-grid-feature-Feature-property-eventPrefix",
899       "shortDoc": "Prefix to use when firing events on the view.\nFor example a prefix of group would expose \"groupclick\", \"groupcontextm..."
900     },
901     {
902       "tagname": "property",
903       "name": "eventSelector",
904       "member": "Ext.grid.feature.Feature",
905       "type": "String",
906       "doc": "<p>Selector used to determine when to fire the event with the eventPrefix.</p>\n",
907       "private": false,
908       "static": false,
909       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
910       "linenr": 48,
911       "html_filename": "Feature.html",
912       "href": "Feature.html#Ext-grid-feature-Feature-property-eventSelector"
913     },
914     {
915       "tagname": "property",
916       "name": "grid",
917       "member": "Ext.grid.feature.Feature",
918       "type": "Ext.grid.Panel",
919       "doc": "<p>Reference to the grid panel</p>\n",
920       "private": false,
921       "static": false,
922       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
923       "linenr": 60,
924       "html_filename": "Feature.html",
925       "href": "Feature.html#Ext-grid-feature-Feature-property-grid"
926     },
927     {
928       "tagname": "property",
929       "name": "hasFeatureEvent",
930       "member": "Ext.grid.feature.Feature",
931       "type": "Boolean",
932       "doc": "<p>Most features will expose additional events, some may not and will\nneed to change this to false.</p>\n",
933       "private": false,
934       "static": false,
935       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
936       "linenr": 34,
937       "html_filename": "Feature.html",
938       "href": "Feature.html#Ext-grid-feature-Feature-property-hasFeatureEvent"
939     },
940     {
941       "tagname": "property",
942       "name": "view",
943       "member": "Ext.grid.feature.Feature",
944       "type": "Ext.view.Table",
945       "doc": "<p>Reference to the TableView.</p>\n",
946       "private": false,
947       "static": false,
948       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
949       "linenr": 54,
950       "html_filename": "Feature.html",
951       "href": "Feature.html#Ext-grid-feature-Feature-property-view"
952     }
953   ],
954   "event": [
955
956   ],
957   "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Summary.js",
958   "linenr": 1,
959   "html_filename": "Summary.html",
960   "href": "Summary.html#Ext-grid-feature-Summary",
961   "cssVar": [
962
963   ],
964   "cssMixin": [
965
966   ],
967   "component": false,
968   "superclasses": [
969     "Ext.util.Observable",
970     "Ext.grid.feature.Feature",
971     "Ext.grid.feature.AbstractSummary"
972   ],
973   "subclasses": [
974
975   ],
976   "mixedInto": [
977
978   ],
979   "allMixins": [
980
981   ]
982 });