Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.grid.feature.GroupingSummary.js
1 Ext.data.JsonP.Ext_grid_feature_GroupingSummary({
2   "tagname": "class",
3   "name": "Ext.grid.feature.GroupingSummary",
4   "doc": "<p>This feature adds an aggregate summary row at the bottom of each group that is provided\nby the <a href=\"#/api/Ext.grid.feature.Grouping\" rel=\"Ext.grid.feature.Grouping\" class=\"docClass\">Ext.grid.feature.Grouping</a> feature. There are 2 aspects to the summary:</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', 'subject', {\n        name: 'mark',\n        type: 'int'\n    }]\n});\n\nExt.create('Ext.grid.Panel', {\n    width: 200,\n    height: 240,\n    renderTo: document.body,\n    features: [{\n        groupHeaderTpl: 'Subject: {name}',\n        ftype: 'groupingsummary'\n    }],\n    store: {\n        model: 'TestResult',\n        groupField: 'subject',\n        data: [{\n            student: 'Student 1',\n            subject: 'Math',\n            mark: 84\n        },{\n            student: 'Student 1',\n            subject: 'Science',\n            mark: 72\n        },{\n            student: 'Student 2',\n            subject: 'Math',\n            mark: 96\n        },{\n            student: 'Student 2',\n            subject: 'Science',\n            mark: 68\n        }]\n    },\n    columns: [{\n        dataIndex: 'student',\n        text: 'Name',\n        summaryType: 'count',\n        summaryRenderer: function(value){\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.Grouping",
6   "mixins": [
7     "Ext.grid.feature.AbstractSummary"
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": "depthToIndent",
21       "member": "Ext.grid.feature.Grouping",
22       "type": "Number",
23       "doc": "<p>Number of pixels to indent per grouping level</p>\n",
24       "private": false,
25       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
26       "linenr": 96,
27       "html_filename": "Grouping.html",
28       "href": "Grouping.html#Ext-grid-feature-Grouping-cfg-depthToIndent"
29     },
30     {
31       "tagname": "cfg",
32       "name": "enableGroupingMenu",
33       "member": "Ext.grid.feature.Grouping",
34       "type": "Boolean",
35       "doc": "<p><tt>true</tt> to enable the grouping control in the header menu (defaults to <tt>true</tt>)</p>\n",
36       "private": false,
37       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
38       "linenr": 126,
39       "html_filename": "Grouping.html",
40       "href": "Grouping.html#Ext-grid-feature-Grouping-cfg-enableGroupingMenu"
41     },
42     {
43       "tagname": "cfg",
44       "name": "enableNoGroups",
45       "member": "Ext.grid.feature.Grouping",
46       "type": "Boolean",
47       "doc": "<p><tt>true</tt> to allow the user to turn off grouping (defaults to <tt>true</tt>)</p>\n",
48       "private": false,
49       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
50       "linenr": 131,
51       "html_filename": "Grouping.html",
52       "href": "Grouping.html#Ext-grid-feature-Grouping-cfg-enableNoGroups"
53     },
54     {
55       "tagname": "cfg",
56       "name": "groupByText",
57       "member": "Ext.grid.feature.Grouping",
58       "type": "String",
59       "doc": "<p>Text displayed in the grid header menu for grouping by header\n(defaults to 'Group By This Field').</p>\n",
60       "private": false,
61       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
62       "linenr": 105,
63       "html_filename": "Grouping.html",
64       "href": "Grouping.html#Ext-grid-feature-Grouping-cfg-groupByText"
65     },
66     {
67       "tagname": "cfg",
68       "name": "groupHeaderTpl",
69       "member": "Ext.grid.feature.Grouping",
70       "type": "String",
71       "doc": "<p>Template snippet, this cannot be an actual template. {name} will be replaced with the current group.\nDefaults to 'Group: {name}'</p>\n",
72       "private": false,
73       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
74       "linenr": 89,
75       "html_filename": "Grouping.html",
76       "href": "Grouping.html#Ext-grid-feature-Grouping-cfg-groupHeaderTpl",
77       "shortDoc": "Template snippet, this cannot be an actual template. {name} will be replaced with the current group.\nDefaults to 'Gro..."
78     },
79     {
80       "tagname": "cfg",
81       "name": "hideGroupedHeader",
82       "member": "Ext.grid.feature.Grouping",
83       "type": "Boolean",
84       "doc": "<p><tt>true</tt> to hide the header that is currently grouped (defaults to <tt>false</tt>)</p>\n",
85       "private": false,
86       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
87       "linenr": 116,
88       "html_filename": "Grouping.html",
89       "href": "Grouping.html#Ext-grid-feature-Grouping-cfg-hideGroupedHeader"
90     },
91     {
92       "tagname": "cfg",
93       "name": "listeners",
94       "member": "Ext.util.Observable",
95       "type": "Object",
96       "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.GroupingSummary-method-addListener\" rel=\"Ext.grid.feature.GroupingSummary-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",
97       "private": false,
98       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
99       "linenr": 103,
100       "html_filename": "Observable.html",
101       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
102       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
103     },
104     {
105       "tagname": "cfg",
106       "name": "remoteRoot",
107       "member": "Ext.grid.feature.GroupingSummary",
108       "type": "String",
109       "doc": "<p>.  The name of the property\nwhich contains the Array of summary objects.  Defaults to <tt>undefined</tt>.\nIt allows to use server-side calculated summaries.</p>\n",
110       "private": false,
111       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/GroupingSummary.js",
112       "linenr": 185,
113       "html_filename": "GroupingSummary.html",
114       "href": "GroupingSummary.html#Ext-grid-feature-GroupingSummary-cfg-remoteRoot",
115       "shortDoc": ".  The name of the property\nwhich contains the Array of summary objects.  Defaults to undefined.\nIt allows to use ser..."
116     },
117     {
118       "tagname": "cfg",
119       "name": "showGroupsText",
120       "member": "Ext.grid.feature.Grouping",
121       "type": "String",
122       "doc": "<p>Text displayed in the grid header for enabling/disabling grouping\n(defaults to 'Show in Groups').</p>\n",
123       "private": false,
124       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
125       "linenr": 110,
126       "html_filename": "Grouping.html",
127       "href": "Grouping.html#Ext-grid-feature-Grouping-cfg-showGroupsText"
128     },
129     {
130       "tagname": "cfg",
131       "name": "showSummaryRow",
132       "member": "Ext.grid.feature.AbstractSummary",
133       "type": "Boolean",
134       "doc": "<p>True to show the summary row. Defaults to <tt>true</tt>.</p>\n",
135       "private": false,
136       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/AbstractSummary.js",
137       "linenr": 18,
138       "html_filename": "AbstractSummary.html",
139       "href": "AbstractSummary.html#Ext-grid-feature-AbstractSummary-cfg-showSummaryRow"
140     },
141     {
142       "tagname": "cfg",
143       "name": "startCollapsed",
144       "member": "Ext.grid.feature.Grouping",
145       "type": "Boolean",
146       "doc": "<p><tt>true</tt> to start all groups collapsed (defaults to <tt>false</tt>)</p>\n",
147       "private": false,
148       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
149       "linenr": 121,
150       "html_filename": "Grouping.html",
151       "href": "Grouping.html#Ext-grid-feature-Grouping-cfg-startCollapsed"
152     }
153   ],
154   "method": [
155     {
156       "tagname": "method",
157       "name": "addEvents",
158       "member": "Ext.util.Observable",
159       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
160       "params": [
161         {
162           "type": "Object/String",
163           "name": "o",
164           "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",
165           "optional": false
166         },
167         {
168           "type": "String",
169           "name": "",
170           "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",
171           "optional": false
172         }
173       ],
174       "return": {
175         "type": "void",
176         "doc": "\n"
177       },
178       "private": false,
179       "static": false,
180       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
181       "linenr": 452,
182       "html_filename": "Observable.html",
183       "href": "Observable.html#Ext-util-Observable-method-addEvents",
184       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
185     },
186     {
187       "tagname": "method",
188       "name": "addListener",
189       "member": "Ext.util.Observable",
190       "doc": "<p>Appends an event handler to this object.</p>\n",
191       "params": [
192         {
193           "type": "String",
194           "name": "eventName",
195           "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",
196           "optional": false
197         },
198         {
199           "type": "Function",
200           "name": "handler",
201           "doc": "<p>The method the event invokes.</p>\n",
202           "optional": false
203         },
204         {
205           "type": "Object",
206           "name": "scope",
207           "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",
208           "optional": true
209         },
210         {
211           "type": "Object",
212           "name": "options",
213           "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",
214           "optional": true
215         }
216       ],
217       "return": {
218         "type": "void",
219         "doc": "\n"
220       },
221       "private": false,
222       "static": false,
223       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
224       "linenr": 271,
225       "html_filename": "Observable.html",
226       "href": "Observable.html#Ext-util-Observable-method-addListener",
227       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
228     },
229     {
230       "tagname": "method",
231       "name": "addManagedListener",
232       "member": "Ext.util.Observable",
233       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
234       "params": [
235         {
236           "type": "Observable/Element",
237           "name": "item",
238           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
239           "optional": false
240         },
241         {
242           "type": "Object/String",
243           "name": "ename",
244           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
245           "optional": false
246         },
247         {
248           "type": "Function",
249           "name": "fn",
250           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
251           "optional": false
252         },
253         {
254           "type": "Object",
255           "name": "scope",
256           "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",
257           "optional": false
258         },
259         {
260           "type": "Object",
261           "name": "opt",
262           "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",
263           "optional": false
264         }
265       ],
266       "return": {
267         "type": "void",
268         "doc": "\n"
269       },
270       "private": false,
271       "static": false,
272       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
273       "linenr": 155,
274       "html_filename": "Observable.html",
275       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
276       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
277     },
278     {
279       "tagname": "method",
280       "name": "attachEvents",
281       "member": "Ext.grid.feature.Feature",
282       "doc": "<p>Approriate place to attach events to the view, selectionmodel, headerCt, etc</p>\n",
283       "params": [
284
285       ],
286       "return": {
287         "type": "void",
288         "doc": "\n"
289       },
290       "private": false,
291       "static": false,
292       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
293       "linenr": 89,
294       "html_filename": "Feature.html",
295       "href": "Feature.html#Ext-grid-feature-Feature-method-attachEvents",
296       "shortDoc": "<p>Approriate place to attach events to the view, selectionmodel, headerCt, etc</p>\n"
297     },
298     {
299       "tagname": "method",
300       "name": "capture",
301       "member": "Ext.util.Observable",
302       "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",
303       "params": [
304         {
305           "type": "Observable",
306           "name": "o",
307           "doc": "<p>The Observable to capture events from.</p>\n",
308           "optional": false
309         },
310         {
311           "type": "Function",
312           "name": "fn",
313           "doc": "<p>The function to call when an event is fired.</p>\n",
314           "optional": false
315         },
316         {
317           "type": "Object",
318           "name": "scope",
319           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
320           "optional": true
321         }
322       ],
323       "return": {
324         "type": "void",
325         "doc": "\n"
326       },
327       "private": false,
328       "static": true,
329       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
330       "linenr": 55,
331       "html_filename": "Observable.html",
332       "href": "Observable.html#Ext-util-Observable-method-capture",
333       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
334     },
335     {
336       "tagname": "method",
337       "name": "clearListeners",
338       "member": "Ext.util.Observable",
339       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
340       "params": [
341
342       ],
343       "return": {
344         "type": "void",
345         "doc": "\n"
346       },
347       "private": false,
348       "static": false,
349       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
350       "linenr": 383,
351       "html_filename": "Observable.html",
352       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
353       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
354     },
355     {
356       "tagname": "method",
357       "name": "clearManagedListeners",
358       "member": "Ext.util.Observable",
359       "doc": "<p>Removes all managed listeners for this object.</p>\n",
360       "params": [
361
362       ],
363       "return": {
364         "type": "void",
365         "doc": "\n"
366       },
367       "private": false,
368       "static": false,
369       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
370       "linenr": 412,
371       "html_filename": "Observable.html",
372       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
373       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
374     },
375     {
376       "tagname": "method",
377       "name": "disable",
378       "member": "Ext.grid.feature.Feature",
379       "doc": "<p>Disable a feature</p>\n",
380       "params": [
381
382       ],
383       "return": {
384         "type": "void",
385         "doc": "\n"
386       },
387       "private": false,
388       "static": false,
389       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
390       "linenr": 140,
391       "html_filename": "Feature.html",
392       "href": "Feature.html#Ext-grid-feature-Feature-method-disable",
393       "shortDoc": "<p>Disable a feature</p>\n"
394     },
395     {
396       "tagname": "method",
397       "name": "enable",
398       "member": "Ext.grid.feature.Feature",
399       "doc": "<p>Enable a feature</p>\n",
400       "params": [
401
402       ],
403       "return": {
404         "type": "void",
405         "doc": "\n"
406       },
407       "private": false,
408       "static": false,
409       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
410       "linenr": 133,
411       "html_filename": "Feature.html",
412       "href": "Feature.html#Ext-grid-feature-Feature-method-enable",
413       "shortDoc": "<p>Enable a feature</p>\n"
414     },
415     {
416       "tagname": "method",
417       "name": "enableBubble",
418       "member": "Ext.util.Observable",
419       "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",
420       "params": [
421         {
422           "type": "String/Array",
423           "name": "events",
424           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
425           "optional": false
426         }
427       ],
428       "return": {
429         "type": "void",
430         "doc": "\n"
431       },
432       "private": false,
433       "static": false,
434       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
435       "linenr": 554,
436       "html_filename": "Observable.html",
437       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
438       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
439     },
440     {
441       "tagname": "method",
442       "name": "fireEvent",
443       "member": "Ext.util.Observable",
444       "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.GroupingSummary-method-enableBubble\" rel=\"Ext.grid.feature.GroupingSummary-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
445       "params": [
446         {
447           "type": "String",
448           "name": "eventName",
449           "doc": "<p>The name of the event to fire.</p>\n",
450           "optional": false
451         },
452         {
453           "type": "Object...",
454           "name": "args",
455           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
456           "optional": false
457         }
458       ],
459       "return": {
460         "type": "Boolean",
461         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
462       },
463       "private": false,
464       "static": false,
465       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
466       "linenr": 232,
467       "html_filename": "Observable.html",
468       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
469       "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..."
470     },
471     {
472       "tagname": "method",
473       "name": "getAdditionalData",
474       "member": "Ext.grid.feature.Feature",
475       "doc": "<p>Provide additional data to the prepareData call within the grid view.</p>\n",
476       "params": [
477         {
478           "type": "Object",
479           "name": "data",
480           "doc": "<p>The data for this particular record.</p>\n",
481           "optional": false
482         },
483         {
484           "type": "Number",
485           "name": "idx",
486           "doc": "<p>The row index for this record.</p>\n",
487           "optional": false
488         },
489         {
490           "type": "Ext.data.Model",
491           "name": "record",
492           "doc": "<p>The record instance</p>\n",
493           "optional": false
494         },
495         {
496           "type": "Object",
497           "name": "orig",
498           "doc": "<p>The original result from the prepareData call to massage.</p>\n",
499           "optional": false
500         }
501       ],
502       "return": {
503         "type": "void",
504         "doc": "\n"
505       },
506       "private": false,
507       "static": false,
508       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
509       "linenr": 122,
510       "html_filename": "Feature.html",
511       "href": "Feature.html#Ext-grid-feature-Feature-method-getAdditionalData",
512       "shortDoc": "<p>Provide additional data to the prepareData call within the grid view.</p>\n"
513     },
514     {
515       "tagname": "method",
516       "name": "getColumnValue",
517       "member": "Ext.grid.feature.AbstractSummary",
518       "doc": "<p>Gets the value for the column from the attached data.</p>\n",
519       "params": [
520         {
521           "type": "Ext.grid.column.Column",
522           "name": "column",
523           "doc": "<p>The header</p>\n",
524           "optional": false
525         },
526         {
527           "type": "Object",
528           "name": "data",
529           "doc": "<p>The current data</p>\n",
530           "optional": false
531         }
532       ],
533       "return": {
534         "type": "String",
535         "doc": "<p>The value to be rendered</p>\n"
536       },
537       "private": false,
538       "static": false,
539       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/AbstractSummary.js",
540       "linenr": 72,
541       "html_filename": "AbstractSummary.html",
542       "href": "AbstractSummary.html#Ext-grid-feature-AbstractSummary-method-getColumnValue",
543       "shortDoc": "<p>Gets the value for the column from the attached data.</p>\n"
544     },
545     {
546       "tagname": "method",
547       "name": "getFireEventArgs",
548       "member": "Ext.grid.feature.Feature",
549       "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",
550       "params": [
551         {
552           "type": "Object",
553           "name": "eventName",
554           "doc": "\n",
555           "optional": false
556         },
557         {
558           "type": "Object",
559           "name": "view",
560           "doc": "\n",
561           "optional": false
562         },
563         {
564           "type": "Object",
565           "name": "featureTarget",
566           "doc": "\n",
567           "optional": false
568         },
569         {
570           "type": "Object",
571           "name": "e",
572           "doc": "\n",
573           "optional": false
574         }
575       ],
576       "return": {
577         "type": "void",
578         "doc": "\n"
579       },
580       "private": false,
581       "static": false,
582       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
583       "linenr": 76,
584       "html_filename": "Feature.html",
585       "href": "Feature.html#Ext-grid-feature-Feature-method-getFireEventArgs",
586       "shortDoc": "Abstract method to be overriden when a feature should add additional\narguments to its event signature. By default the..."
587     },
588     {
589       "tagname": "method",
590       "name": "getMetaRowTplFragments",
591       "member": "Ext.grid.feature.Feature",
592       "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",
593       "params": [
594
595       ],
596       "return": {
597         "type": "void",
598         "doc": "\n"
599       },
600       "private": false,
601       "static": false,
602       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
603       "linenr": 109,
604       "html_filename": "Feature.html",
605       "href": "Feature.html#Ext-grid-feature-Feature-method-getMetaRowTplFragments",
606       "shortDoc": "Allows a feature to inject member methods into the metaRowTpl. This is\nimportant for embedding functionality which wi..."
607     },
608     {
609       "tagname": "method",
610       "name": "hasListener",
611       "member": "Ext.util.Observable",
612       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
613       "params": [
614         {
615           "type": "String",
616           "name": "eventName",
617           "doc": "<p>The name of the event to check for</p>\n",
618           "optional": false
619         }
620       ],
621       "return": {
622         "type": "Boolean",
623         "doc": "<p>True if the event is being listened for, else false</p>\n"
624       },
625       "private": false,
626       "static": false,
627       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
628       "linenr": 480,
629       "html_filename": "Observable.html",
630       "href": "Observable.html#Ext-util-Observable-method-hasListener",
631       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
632     },
633     {
634       "tagname": "method",
635       "name": "mutateMetaRowTpl",
636       "member": "Ext.grid.feature.Feature",
637       "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",
638       "params": [
639         {
640           "type": "Object",
641           "name": "metaRowTplArray",
642           "doc": "\n",
643           "optional": false
644         }
645       ],
646       "return": {
647         "type": "void",
648         "doc": "\n"
649       },
650       "private": false,
651       "static": false,
652       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
653       "linenr": 100,
654       "html_filename": "Feature.html",
655       "href": "Feature.html#Ext-grid-feature-Feature-method-mutateMetaRowTpl",
656       "shortDoc": "Allows a feature to mutate the metaRowTpl.\nThe array received as a single argument can be manipulated to add things\no..."
657     },
658     {
659       "tagname": "method",
660       "name": "observe",
661       "member": "Ext.util.Observable",
662       "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",
663       "params": [
664         {
665           "type": "Function",
666           "name": "c",
667           "doc": "<p>The class constructor to make observable.</p>\n",
668           "optional": false
669         },
670         {
671           "type": "Object",
672           "name": "listeners",
673           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.grid.feature.GroupingSummary-method-addListener\" rel=\"Ext.grid.feature.GroupingSummary-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
674           "optional": false
675         }
676       ],
677       "return": {
678         "type": "void",
679         "doc": "\n"
680       },
681       "private": false,
682       "static": true,
683       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
684       "linenr": 69,
685       "html_filename": "Observable.html",
686       "href": "Observable.html#Ext-util-Observable-method-observe",
687       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
688     },
689     {
690       "tagname": "method",
691       "name": "on",
692       "member": "Ext.util.Observable",
693       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.grid.feature.GroupingSummary-method-addListener\" rel=\"Ext.grid.feature.GroupingSummary-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
694       "params": [
695         {
696           "type": "String",
697           "name": "eventName",
698           "doc": "<p>The type of event to listen for</p>\n",
699           "optional": false
700         },
701         {
702           "type": "Function",
703           "name": "handler",
704           "doc": "<p>The method the event invokes</p>\n",
705           "optional": false
706         },
707         {
708           "type": "Object",
709           "name": "scope",
710           "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",
711           "optional": true
712         },
713         {
714           "type": "Object",
715           "name": "options",
716           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
717           "optional": true
718         }
719       ],
720       "return": {
721         "type": "void",
722         "doc": "\n"
723       },
724       "private": false,
725       "static": false,
726       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
727       "linenr": 616,
728       "html_filename": "Observable.html",
729       "href": "Observable.html#Ext-util-Observable-method-on",
730       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.grid.feature.GroupingSummary-method-addListener\" rel=\"Ext.grid.feature.GroupingSummary-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
731     },
732     {
733       "tagname": "method",
734       "name": "relayEvents",
735       "member": "Ext.util.Observable",
736       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
737       "params": [
738         {
739           "type": "Object",
740           "name": "origin",
741           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
742           "optional": false
743         },
744         {
745           "type": "Array",
746           "name": "events",
747           "doc": "<p>Array of event names to relay.</p>\n",
748           "optional": false
749         },
750         {
751           "type": "Object",
752           "name": "prefix",
753           "doc": "\n",
754           "optional": false
755         }
756       ],
757       "return": {
758         "type": "void",
759         "doc": "\n"
760       },
761       "private": false,
762       "static": false,
763       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
764       "linenr": 520,
765       "html_filename": "Observable.html",
766       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
767       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
768     },
769     {
770       "tagname": "method",
771       "name": "releaseCapture",
772       "member": "Ext.util.Observable",
773       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
774       "params": [
775         {
776           "type": "Observable",
777           "name": "o",
778           "doc": "<p>The Observable to release</p>\n",
779           "optional": false
780         }
781       ],
782       "return": {
783         "type": "void",
784         "doc": "\n"
785       },
786       "private": false,
787       "static": true,
788       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
789       "linenr": 46,
790       "html_filename": "Observable.html",
791       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
792       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
793     },
794     {
795       "tagname": "method",
796       "name": "removeListener",
797       "member": "Ext.util.Observable",
798       "doc": "<p>Removes an event handler.</p>\n",
799       "params": [
800         {
801           "type": "String",
802           "name": "eventName",
803           "doc": "<p>The type of event the handler was associated with.</p>\n",
804           "optional": false
805         },
806         {
807           "type": "Function",
808           "name": "handler",
809           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.grid.feature.GroupingSummary-method-addListener\" rel=\"Ext.grid.feature.GroupingSummary-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
810           "optional": false
811         },
812         {
813           "type": "Object",
814           "name": "scope",
815           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
816           "optional": true
817         }
818       ],
819       "return": {
820         "type": "void",
821         "doc": "\n"
822       },
823       "private": false,
824       "static": false,
825       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
826       "linenr": 352,
827       "html_filename": "Observable.html",
828       "href": "Observable.html#Ext-util-Observable-method-removeListener",
829       "shortDoc": "<p>Removes an event handler.</p>\n"
830     },
831     {
832       "tagname": "method",
833       "name": "removeManagedListener",
834       "member": "Ext.util.Observable",
835       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.grid.feature.GroupingSummary--mon\" rel=\"Ext.grid.feature.GroupingSummary--mon\" class=\"docClass\">mon</a> method.</p>\n",
836       "params": [
837         {
838           "type": "Observable|Element",
839           "name": "item",
840           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
841           "optional": false
842         },
843         {
844           "type": "Object|String",
845           "name": "ename",
846           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
847           "optional": false
848         },
849         {
850           "type": "Function",
851           "name": "fn",
852           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
853           "optional": false
854         },
855         {
856           "type": "Object",
857           "name": "scope",
858           "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",
859           "optional": false
860         }
861       ],
862       "return": {
863         "type": "void",
864         "doc": "\n"
865       },
866       "private": false,
867       "static": false,
868       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
869       "linenr": 196,
870       "html_filename": "Observable.html",
871       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
872       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.grid.feature.GroupingSummary--mon\" rel=\"Ext.grid.feature.GroupingSummary--mon\" class=\"docClass\">mon</a> method.</p>\n"
873     },
874     {
875       "tagname": "method",
876       "name": "resumeEvents",
877       "member": "Ext.util.Observable",
878       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.grid.feature.GroupingSummary-method-suspendEvents\" rel=\"Ext.grid.feature.GroupingSummary-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",
879       "params": [
880
881       ],
882       "return": {
883         "type": "void",
884         "doc": "\n"
885       },
886       "private": false,
887       "static": false,
888       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
889       "linenr": 502,
890       "html_filename": "Observable.html",
891       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
892       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
893     },
894     {
895       "tagname": "method",
896       "name": "suspendEvents",
897       "member": "Ext.util.Observable",
898       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.grid.feature.GroupingSummary-method-resumeEvents\" rel=\"Ext.grid.feature.GroupingSummary-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
899       "params": [
900         {
901           "type": "Boolean",
902           "name": "queueSuspended",
903           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.grid.feature.GroupingSummary-method-resumeEvents\" rel=\"Ext.grid.feature.GroupingSummary-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
904           "optional": false
905         }
906       ],
907       "return": {
908         "type": "void",
909         "doc": "\n"
910       },
911       "private": false,
912       "static": false,
913       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
914       "linenr": 490,
915       "html_filename": "Observable.html",
916       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
917       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.grid.feature.GroupingSummary-method-resumeEvents\" rel=\"Ext.grid.feature.GroupingSummary-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
918     },
919     {
920       "tagname": "method",
921       "name": "toggleSummaryRow",
922       "member": "Ext.grid.feature.AbstractSummary",
923       "doc": "<p>Toggle whether or not to show the summary row.</p>\n",
924       "params": [
925         {
926           "type": "Boolan",
927           "name": "visible",
928           "doc": "<p>True to show the summary row</p>\n",
929           "optional": false
930         }
931       ],
932       "return": {
933         "type": "void",
934         "doc": "\n"
935       },
936       "private": false,
937       "static": false,
938       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/AbstractSummary.js",
939       "linenr": 26,
940       "html_filename": "AbstractSummary.html",
941       "href": "AbstractSummary.html#Ext-grid-feature-AbstractSummary-method-toggleSummaryRow",
942       "shortDoc": "<p>Toggle whether or not to show the summary row.</p>\n"
943     },
944     {
945       "tagname": "method",
946       "name": "un",
947       "member": "Ext.util.Observable",
948       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.grid.feature.GroupingSummary-method-removeListener\" rel=\"Ext.grid.feature.GroupingSummary-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
949       "params": [
950         {
951           "type": "String",
952           "name": "eventName",
953           "doc": "<p>The type of event the handler was associated with.</p>\n",
954           "optional": false
955         },
956         {
957           "type": "Function",
958           "name": "handler",
959           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.grid.feature.GroupingSummary-method-addListener\" rel=\"Ext.grid.feature.GroupingSummary-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
960           "optional": false
961         },
962         {
963           "type": "Object",
964           "name": "scope",
965           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
966           "optional": true
967         }
968       ],
969       "return": {
970         "type": "void",
971         "doc": "\n"
972       },
973       "private": false,
974       "static": false,
975       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
976       "linenr": 608,
977       "html_filename": "Observable.html",
978       "href": "Observable.html#Ext-util-Observable-method-un",
979       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.grid.feature.GroupingSummary-method-removeListener\" rel=\"Ext.grid.feature.GroupingSummary-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
980     }
981   ],
982   "property": [
983     {
984       "tagname": "property",
985       "name": "collectData",
986       "member": "Ext.grid.feature.Feature",
987       "type": "Boolean",
988       "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",
989       "private": false,
990       "static": false,
991       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
992       "linenr": 66,
993       "html_filename": "Feature.html",
994       "href": "Feature.html#Ext-grid-feature-Feature-property-collectData",
995       "shortDoc": "Most features will not modify the data returned to the view.\nThis is limited to one feature that manipulates the data..."
996     },
997     {
998       "tagname": "property",
999       "name": "eventPrefix",
1000       "member": "Ext.grid.feature.Feature",
1001       "type": "String",
1002       "doc": "<p>Prefix to use when firing events on the view.\nFor example a prefix of group would expose \"groupclick\", \"groupcontextmenu\", \"groupdblclick\".</p>\n",
1003       "private": false,
1004       "static": false,
1005       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
1006       "linenr": 41,
1007       "html_filename": "Feature.html",
1008       "href": "Feature.html#Ext-grid-feature-Feature-property-eventPrefix",
1009       "shortDoc": "Prefix to use when firing events on the view.\nFor example a prefix of group would expose \"groupclick\", \"groupcontextm..."
1010     },
1011     {
1012       "tagname": "property",
1013       "name": "eventSelector",
1014       "member": "Ext.grid.feature.Feature",
1015       "type": "String",
1016       "doc": "<p>Selector used to determine when to fire the event with the eventPrefix.</p>\n",
1017       "private": false,
1018       "static": false,
1019       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
1020       "linenr": 48,
1021       "html_filename": "Feature.html",
1022       "href": "Feature.html#Ext-grid-feature-Feature-property-eventSelector"
1023     },
1024     {
1025       "tagname": "property",
1026       "name": "grid",
1027       "member": "Ext.grid.feature.Feature",
1028       "type": "Ext.grid.Panel",
1029       "doc": "<p>Reference to the grid panel</p>\n",
1030       "private": false,
1031       "static": false,
1032       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
1033       "linenr": 60,
1034       "html_filename": "Feature.html",
1035       "href": "Feature.html#Ext-grid-feature-Feature-property-grid"
1036     },
1037     {
1038       "tagname": "property",
1039       "name": "hasFeatureEvent",
1040       "member": "Ext.grid.feature.Feature",
1041       "type": "Boolean",
1042       "doc": "<p>Most features will expose additional events, some may not and will\nneed to change this to false.</p>\n",
1043       "private": false,
1044       "static": false,
1045       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
1046       "linenr": 34,
1047       "html_filename": "Feature.html",
1048       "href": "Feature.html#Ext-grid-feature-Feature-property-hasFeatureEvent"
1049     },
1050     {
1051       "tagname": "property",
1052       "name": "view",
1053       "member": "Ext.grid.feature.Feature",
1054       "type": "Ext.view.Table",
1055       "doc": "<p>Reference to the TableView.</p>\n",
1056       "private": false,
1057       "static": false,
1058       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
1059       "linenr": 54,
1060       "html_filename": "Feature.html",
1061       "href": "Feature.html#Ext-grid-feature-Feature-property-view"
1062     }
1063   ],
1064   "event": [
1065     {
1066       "tagname": "event",
1067       "name": "groupclick",
1068       "member": "Ext.grid.feature.Grouping",
1069       "doc": "\n",
1070       "params": [
1071         {
1072           "type": "Ext.view.Table",
1073           "name": "view",
1074           "doc": "\n",
1075           "optional": false
1076         },
1077         {
1078           "type": "HTMLElement",
1079           "name": "node",
1080           "doc": "\n",
1081           "optional": false
1082         },
1083         {
1084           "type": "String",
1085           "name": "group",
1086           "doc": "<p>The name of the group</p>\n",
1087           "optional": false
1088         },
1089         {
1090           "type": "Ext.EventObject",
1091           "name": "e",
1092           "doc": "\n",
1093           "optional": false
1094         }
1095       ],
1096       "private": false,
1097       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
1098       "linenr": 49,
1099       "html_filename": "Grouping.html",
1100       "href": "Grouping.html#Ext-grid-feature-Grouping-event-groupclick",
1101       "shortDoc": "\n"
1102     },
1103     {
1104       "tagname": "event",
1105       "name": "groupcollapse",
1106       "member": "Ext.grid.feature.Grouping",
1107       "doc": "\n",
1108       "params": [
1109         {
1110           "type": "Ext.view.Table",
1111           "name": "view",
1112           "doc": "\n",
1113           "optional": false
1114         },
1115         {
1116           "type": "HTMLElement",
1117           "name": "node",
1118           "doc": "\n",
1119           "optional": false
1120         },
1121         {
1122           "type": "String",
1123           "name": "group",
1124           "doc": "<p>The name of the group</p>\n",
1125           "optional": false
1126         },
1127         {
1128           "type": "Ext.EventObject",
1129           "name": "e",
1130           "doc": "\n",
1131           "optional": false
1132         }
1133       ],
1134       "private": false,
1135       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
1136       "linenr": 73,
1137       "html_filename": "Grouping.html",
1138       "href": "Grouping.html#Ext-grid-feature-Grouping-event-groupcollapse",
1139       "shortDoc": "\n"
1140     },
1141     {
1142       "tagname": "event",
1143       "name": "groupcontextmenu",
1144       "member": "Ext.grid.feature.Grouping",
1145       "doc": "\n",
1146       "params": [
1147         {
1148           "type": "Ext.view.Table",
1149           "name": "view",
1150           "doc": "\n",
1151           "optional": false
1152         },
1153         {
1154           "type": "HTMLElement",
1155           "name": "node",
1156           "doc": "\n",
1157           "optional": false
1158         },
1159         {
1160           "type": "String",
1161           "name": "group",
1162           "doc": "<p>The name of the group</p>\n",
1163           "optional": false
1164         },
1165         {
1166           "type": "Ext.EventObject",
1167           "name": "e",
1168           "doc": "\n",
1169           "optional": false
1170         }
1171       ],
1172       "private": false,
1173       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
1174       "linenr": 65,
1175       "html_filename": "Grouping.html",
1176       "href": "Grouping.html#Ext-grid-feature-Grouping-event-groupcontextmenu",
1177       "shortDoc": "\n"
1178     },
1179     {
1180       "tagname": "event",
1181       "name": "groupdblclick",
1182       "member": "Ext.grid.feature.Grouping",
1183       "doc": "\n",
1184       "params": [
1185         {
1186           "type": "Ext.view.Table",
1187           "name": "view",
1188           "doc": "\n",
1189           "optional": false
1190         },
1191         {
1192           "type": "HTMLElement",
1193           "name": "node",
1194           "doc": "\n",
1195           "optional": false
1196         },
1197         {
1198           "type": "String",
1199           "name": "group",
1200           "doc": "<p>The name of the group</p>\n",
1201           "optional": false
1202         },
1203         {
1204           "type": "Ext.EventObject",
1205           "name": "e",
1206           "doc": "\n",
1207           "optional": false
1208         }
1209       ],
1210       "private": false,
1211       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
1212       "linenr": 57,
1213       "html_filename": "Grouping.html",
1214       "href": "Grouping.html#Ext-grid-feature-Grouping-event-groupdblclick",
1215       "shortDoc": "\n"
1216     },
1217     {
1218       "tagname": "event",
1219       "name": "groupexpand",
1220       "member": "Ext.grid.feature.Grouping",
1221       "doc": "\n",
1222       "params": [
1223         {
1224           "type": "Ext.view.Table",
1225           "name": "view",
1226           "doc": "\n",
1227           "optional": false
1228         },
1229         {
1230           "type": "HTMLElement",
1231           "name": "node",
1232           "doc": "\n",
1233           "optional": false
1234         },
1235         {
1236           "type": "String",
1237           "name": "group",
1238           "doc": "<p>The name of the group</p>\n",
1239           "optional": false
1240         },
1241         {
1242           "type": "Ext.EventObject",
1243           "name": "e",
1244           "doc": "\n",
1245           "optional": false
1246         }
1247       ],
1248       "private": false,
1249       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
1250       "linenr": 81,
1251       "html_filename": "Grouping.html",
1252       "href": "Grouping.html#Ext-grid-feature-Grouping-event-groupexpand",
1253       "shortDoc": "\n"
1254     }
1255   ],
1256   "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/GroupingSummary.js",
1257   "linenr": 1,
1258   "html_filename": "GroupingSummary.html",
1259   "href": "GroupingSummary.html#Ext-grid-feature-GroupingSummary",
1260   "cssVar": [
1261
1262   ],
1263   "cssMixin": [
1264
1265   ],
1266   "component": false,
1267   "superclasses": [
1268     "Ext.util.Observable",
1269     "Ext.grid.feature.Feature",
1270     "Ext.grid.feature.Grouping"
1271   ],
1272   "subclasses": [
1273
1274   ],
1275   "mixedInto": [
1276
1277   ],
1278   "allMixins": [
1279     "Ext.grid.feature.AbstractSummary"
1280   ]
1281 });