1 Ext.data.JsonP.Ext_grid_feature_Grouping({
3 "name": "Ext.grid.feature.Grouping",
4 "doc": "<p>This feature allows to display the grid rows aggregated into groups as specified by the <a href=\"#/api/Ext.data.Store-property-groupers\" rel=\"Ext.data.Store-property-groupers\" class=\"docClass\">Ext.data.Store.groupers</a>\nspecified on the Store. The group will show the title for the group name and then the appropriate records for the group\nunderneath. The groups can also be expanded and collapsed.</p>\n\n<h2>Extra Events</h2>\n\n<p>This feature adds several extra events that will be fired on the grid to interact with the groups:</p>\n\n<ul>\n<li><a href=\"#/api/Ext.grid.feature.Grouping-event-groupclick\" rel=\"Ext.grid.feature.Grouping-event-groupclick\" class=\"docClass\">groupclick</a></li>\n<li><a href=\"#/api/Ext.grid.feature.Grouping-event-groupdblclick\" rel=\"Ext.grid.feature.Grouping-event-groupdblclick\" class=\"docClass\">groupdblclick</a></li>\n<li><a href=\"#/api/Ext.grid.feature.Grouping-event-groupcontextmenu\" rel=\"Ext.grid.feature.Grouping-event-groupcontextmenu\" class=\"docClass\">groupcontextmenu</a></li>\n<li><a href=\"#/api/Ext.grid.feature.Grouping-event-groupexpand\" rel=\"Ext.grid.feature.Grouping-event-groupexpand\" class=\"docClass\">groupexpand</a></li>\n<li><a href=\"#/api/Ext.grid.feature.Grouping-event-groupcollapse\" rel=\"Ext.grid.feature.Grouping-event-groupcollapse\" class=\"docClass\">groupcollapse</a></li>\n</ul>\n\n\n<h2>Menu Augmentation</h2>\n\n<p>This feature adds extra options to the grid column menu to provide the user with functionality to modify the grouping.\nThis can be disabled by setting the <a href=\"#/api/Ext.grid.feature.Grouping-cfg-enableGroupingMenu\" rel=\"Ext.grid.feature.Grouping-cfg-enableGroupingMenu\" class=\"docClass\">enableGroupingMenu</a> option. The option to disallow grouping from being turned off\nby thew user is <a href=\"#/api/Ext.grid.feature.Grouping-cfg-enableNoGroups\" rel=\"Ext.grid.feature.Grouping-cfg-enableNoGroups\" class=\"docClass\">enableNoGroups</a>.</p>\n\n<h2>Controlling Group Text</h2>\n\n<p>The <a href=\"#/api/Ext.grid.feature.Grouping-cfg-groupHeaderTpl\" rel=\"Ext.grid.feature.Grouping-cfg-groupHeaderTpl\" class=\"docClass\">groupHeaderTpl</a> is used to control the rendered title for each group. It can modified to customized\nthe default display.</p>\n\n<h2>Example Usage</h2>\n\n<pre><code>var groupingFeature = Ext.create('Ext.grid.feature.Grouping', {\n groupHeaderTpl: 'Group: {name} ({rows.length})', //print the number of items in the group\n startCollapsed: true // start all groups collapsed\n});\n</code></pre>\n",
5 "extends": "Ext.grid.feature.Feature",
9 "alternateClassNames": [
13 "author": "Nicolas Ferrero",
20 "name": "depthToIndent",
21 "member": "Ext.grid.feature.Grouping",
23 "doc": "<p>Number of pixels to indent per grouping level</p>\n",
25 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
27 "html_filename": "Grouping.html",
28 "href": "Grouping.html#Ext-grid-feature-Grouping-cfg-depthToIndent"
32 "name": "enableGroupingMenu",
33 "member": "Ext.grid.feature.Grouping",
35 "doc": "<p><tt>true</tt> to enable the grouping control in the header menu (defaults to <tt>true</tt>)</p>\n",
37 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
39 "html_filename": "Grouping.html",
40 "href": "Grouping.html#Ext-grid-feature-Grouping-cfg-enableGroupingMenu"
44 "name": "enableNoGroups",
45 "member": "Ext.grid.feature.Grouping",
47 "doc": "<p><tt>true</tt> to allow the user to turn off grouping (defaults to <tt>true</tt>)</p>\n",
49 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
51 "html_filename": "Grouping.html",
52 "href": "Grouping.html#Ext-grid-feature-Grouping-cfg-enableNoGroups"
56 "name": "groupByText",
57 "member": "Ext.grid.feature.Grouping",
59 "doc": "<p>Text displayed in the grid header menu for grouping by header\n(defaults to 'Group By This Field').</p>\n",
61 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
63 "html_filename": "Grouping.html",
64 "href": "Grouping.html#Ext-grid-feature-Grouping-cfg-groupByText"
68 "name": "groupHeaderTpl",
69 "member": "Ext.grid.feature.Grouping",
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",
73 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
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..."
81 "name": "hideGroupedHeader",
82 "member": "Ext.grid.feature.Grouping",
84 "doc": "<p><tt>true</tt> to hide the header that is currently grouped (defaults to <tt>false</tt>)</p>\n",
86 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
88 "html_filename": "Grouping.html",
89 "href": "Grouping.html#Ext-grid-feature-Grouping-cfg-hideGroupedHeader"
94 "member": "Ext.util.Observable",
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.Grouping-method-addListener\" rel=\"Ext.grid.feature.Grouping-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",
98 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
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..."
106 "name": "showGroupsText",
107 "member": "Ext.grid.feature.Grouping",
109 "doc": "<p>Text displayed in the grid header for enabling/disabling grouping\n(defaults to 'Show in Groups').</p>\n",
111 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
113 "html_filename": "Grouping.html",
114 "href": "Grouping.html#Ext-grid-feature-Grouping-cfg-showGroupsText"
118 "name": "startCollapsed",
119 "member": "Ext.grid.feature.Grouping",
121 "doc": "<p><tt>true</tt> to start all groups collapsed (defaults to <tt>false</tt>)</p>\n",
123 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
125 "html_filename": "Grouping.html",
126 "href": "Grouping.html#Ext-grid-feature-Grouping-cfg-startCollapsed"
133 "member": "Ext.util.Observable",
134 "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
137 "type": "Object/String",
139 "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",
145 "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",
155 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
157 "html_filename": "Observable.html",
158 "href": "Observable.html#Ext-util-Observable-method-addEvents",
159 "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
163 "name": "addListener",
164 "member": "Ext.util.Observable",
165 "doc": "<p>Appends an event handler to this object.</p>\n",
170 "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",
176 "doc": "<p>The method the event invokes.</p>\n",
182 "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",
188 "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",
198 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
200 "html_filename": "Observable.html",
201 "href": "Observable.html#Ext-util-Observable-method-addListener",
202 "shortDoc": "<p>Appends an event handler to this object.</p>\n"
206 "name": "addManagedListener",
207 "member": "Ext.util.Observable",
208 "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
211 "type": "Observable/Element",
213 "doc": "<p>The item to which to add a listener/listeners.</p>\n",
217 "type": "Object/String",
219 "doc": "<p>The event name, or an object containing event name properties.</p>\n",
225 "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
231 "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",
237 "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",
247 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
249 "html_filename": "Observable.html",
250 "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
251 "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
255 "name": "attachEvents",
256 "member": "Ext.grid.feature.Feature",
257 "doc": "<p>Approriate place to attach events to the view, selectionmodel, headerCt, etc</p>\n",
267 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
269 "html_filename": "Feature.html",
270 "href": "Feature.html#Ext-grid-feature-Feature-method-attachEvents",
271 "shortDoc": "<p>Approriate place to attach events to the view, selectionmodel, headerCt, etc</p>\n"
276 "member": "Ext.util.Observable",
277 "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",
280 "type": "Observable",
282 "doc": "<p>The Observable to capture events from.</p>\n",
288 "doc": "<p>The function to call when an event is fired.</p>\n",
294 "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
304 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
306 "html_filename": "Observable.html",
307 "href": "Observable.html#Ext-util-Observable-method-capture",
308 "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
312 "name": "clearListeners",
313 "member": "Ext.util.Observable",
314 "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
324 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
326 "html_filename": "Observable.html",
327 "href": "Observable.html#Ext-util-Observable-method-clearListeners",
328 "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
332 "name": "clearManagedListeners",
333 "member": "Ext.util.Observable",
334 "doc": "<p>Removes all managed listeners for this object.</p>\n",
344 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
346 "html_filename": "Observable.html",
347 "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
348 "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
353 "member": "Ext.grid.feature.Feature",
354 "doc": "<p>Disable a feature</p>\n",
364 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
366 "html_filename": "Feature.html",
367 "href": "Feature.html#Ext-grid-feature-Feature-method-disable",
368 "shortDoc": "<p>Disable a feature</p>\n"
373 "member": "Ext.grid.feature.Feature",
374 "doc": "<p>Enable a feature</p>\n",
384 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
386 "html_filename": "Feature.html",
387 "href": "Feature.html#Ext-grid-feature-Feature-method-enable",
388 "shortDoc": "<p>Enable a feature</p>\n"
392 "name": "enableBubble",
393 "member": "Ext.util.Observable",
394 "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'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'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",
397 "type": "String/Array",
399 "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
409 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
411 "html_filename": "Observable.html",
412 "href": "Observable.html#Ext-util-Observable-method-enableBubble",
413 "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
418 "member": "Ext.util.Observable",
419 "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.Grouping-method-enableBubble\" rel=\"Ext.grid.feature.Grouping-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
424 "doc": "<p>The name of the event to fire.</p>\n",
430 "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
436 "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
440 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
442 "html_filename": "Observable.html",
443 "href": "Observable.html#Ext-util-Observable-method-fireEvent",
444 "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..."
448 "name": "getAdditionalData",
449 "member": "Ext.grid.feature.Feature",
450 "doc": "<p>Provide additional data to the prepareData call within the grid view.</p>\n",
455 "doc": "<p>The data for this particular record.</p>\n",
461 "doc": "<p>The row index for this record.</p>\n",
465 "type": "Ext.data.Model",
467 "doc": "<p>The record instance</p>\n",
473 "doc": "<p>The original result from the prepareData call to massage.</p>\n",
483 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
485 "html_filename": "Feature.html",
486 "href": "Feature.html#Ext-grid-feature-Feature-method-getAdditionalData",
487 "shortDoc": "<p>Provide additional data to the prepareData call within the grid view.</p>\n"
491 "name": "getFireEventArgs",
492 "member": "Ext.grid.feature.Feature",
493 "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",
509 "name": "featureTarget",
526 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
528 "html_filename": "Feature.html",
529 "href": "Feature.html#Ext-grid-feature-Feature-method-getFireEventArgs",
530 "shortDoc": "Abstract method to be overriden when a feature should add additional\narguments to its event signature. By default the..."
534 "name": "getMetaRowTplFragments",
535 "member": "Ext.grid.feature.Feature",
536 "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",
546 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
548 "html_filename": "Feature.html",
549 "href": "Feature.html#Ext-grid-feature-Feature-method-getMetaRowTplFragments",
550 "shortDoc": "Allows a feature to inject member methods into the metaRowTpl. This is\nimportant for embedding functionality which wi..."
554 "name": "hasListener",
555 "member": "Ext.util.Observable",
556 "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
561 "doc": "<p>The name of the event to check for</p>\n",
567 "doc": "<p>True if the event is being listened for, else false</p>\n"
571 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
573 "html_filename": "Observable.html",
574 "href": "Observable.html#Ext-util-Observable-method-hasListener",
575 "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
579 "name": "mutateMetaRowTpl",
580 "member": "Ext.grid.feature.Feature",
581 "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",
585 "name": "metaRowTplArray",
596 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
598 "html_filename": "Feature.html",
599 "href": "Feature.html#Ext-grid-feature-Feature-method-mutateMetaRowTpl",
600 "shortDoc": "Allows a feature to mutate the metaRowTpl.\nThe array received as a single argument can be manipulated to add things\no..."
605 "member": "Ext.util.Observable",
606 "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",
611 "doc": "<p>The class constructor to make observable.</p>\n",
617 "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.grid.feature.Grouping-method-addListener\" rel=\"Ext.grid.feature.Grouping-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
627 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
629 "html_filename": "Observable.html",
630 "href": "Observable.html#Ext-util-Observable-method-observe",
631 "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
636 "member": "Ext.util.Observable",
637 "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.grid.feature.Grouping-method-addListener\" rel=\"Ext.grid.feature.Grouping-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
642 "doc": "<p>The type of event to listen for</p>\n",
648 "doc": "<p>The method the event invokes</p>\n",
654 "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",
660 "doc": "<p>(optional) An object containing handler configuration.</p>\n",
670 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
672 "html_filename": "Observable.html",
673 "href": "Observable.html#Ext-util-Observable-method-on",
674 "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.grid.feature.Grouping-method-addListener\" rel=\"Ext.grid.feature.Grouping-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
678 "name": "relayEvents",
679 "member": "Ext.util.Observable",
680 "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
685 "doc": "<p>The Observable whose events this object is to relay.</p>\n",
691 "doc": "<p>Array of event names to relay.</p>\n",
707 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
709 "html_filename": "Observable.html",
710 "href": "Observable.html#Ext-util-Observable-method-relayEvents",
711 "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
715 "name": "releaseCapture",
716 "member": "Ext.util.Observable",
717 "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
720 "type": "Observable",
722 "doc": "<p>The Observable to release</p>\n",
732 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
734 "html_filename": "Observable.html",
735 "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
736 "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
740 "name": "removeListener",
741 "member": "Ext.util.Observable",
742 "doc": "<p>Removes an event handler.</p>\n",
747 "doc": "<p>The type of event the handler was associated with.</p>\n",
753 "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.grid.feature.Grouping-method-addListener\" rel=\"Ext.grid.feature.Grouping-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
759 "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
769 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
771 "html_filename": "Observable.html",
772 "href": "Observable.html#Ext-util-Observable-method-removeListener",
773 "shortDoc": "<p>Removes an event handler.</p>\n"
777 "name": "removeManagedListener",
778 "member": "Ext.util.Observable",
779 "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.grid.feature.Grouping--mon\" rel=\"Ext.grid.feature.Grouping--mon\" class=\"docClass\">mon</a> method.</p>\n",
782 "type": "Observable|Element",
784 "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
788 "type": "Object|String",
790 "doc": "<p>The event name, or an object containing event name properties.</p>\n",
796 "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
802 "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",
812 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
814 "html_filename": "Observable.html",
815 "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
816 "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.grid.feature.Grouping--mon\" rel=\"Ext.grid.feature.Grouping--mon\" class=\"docClass\">mon</a> method.</p>\n"
820 "name": "resumeEvents",
821 "member": "Ext.util.Observable",
822 "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.grid.feature.Grouping-method-suspendEvents\" rel=\"Ext.grid.feature.Grouping-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",
832 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
834 "html_filename": "Observable.html",
835 "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
836 "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
840 "name": "suspendEvents",
841 "member": "Ext.util.Observable",
842 "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.grid.feature.Grouping-method-resumeEvents\" rel=\"Ext.grid.feature.Grouping-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
846 "name": "queueSuspended",
847 "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.grid.feature.Grouping-method-resumeEvents\" rel=\"Ext.grid.feature.Grouping-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
857 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
859 "html_filename": "Observable.html",
860 "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
861 "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.grid.feature.Grouping-method-resumeEvents\" rel=\"Ext.grid.feature.Grouping-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
866 "member": "Ext.util.Observable",
867 "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.grid.feature.Grouping-method-removeListener\" rel=\"Ext.grid.feature.Grouping-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
872 "doc": "<p>The type of event the handler was associated with.</p>\n",
878 "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.grid.feature.Grouping-method-addListener\" rel=\"Ext.grid.feature.Grouping-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
884 "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
894 "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
896 "html_filename": "Observable.html",
897 "href": "Observable.html#Ext-util-Observable-method-un",
898 "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.grid.feature.Grouping-method-removeListener\" rel=\"Ext.grid.feature.Grouping-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
903 "tagname": "property",
904 "name": "collectData",
905 "member": "Ext.grid.feature.Feature",
907 "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",
910 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
912 "html_filename": "Feature.html",
913 "href": "Feature.html#Ext-grid-feature-Feature-property-collectData",
914 "shortDoc": "Most features will not modify the data returned to the view.\nThis is limited to one feature that manipulates the data..."
917 "tagname": "property",
918 "name": "eventPrefix",
919 "member": "Ext.grid.feature.Feature",
921 "doc": "<p>Prefix to use when firing events on the view.\nFor example a prefix of group would expose \"groupclick\", \"groupcontextmenu\", \"groupdblclick\".</p>\n",
924 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
926 "html_filename": "Feature.html",
927 "href": "Feature.html#Ext-grid-feature-Feature-property-eventPrefix",
928 "shortDoc": "Prefix to use when firing events on the view.\nFor example a prefix of group would expose \"groupclick\", \"groupcontextm..."
931 "tagname": "property",
932 "name": "eventSelector",
933 "member": "Ext.grid.feature.Feature",
935 "doc": "<p>Selector used to determine when to fire the event with the eventPrefix.</p>\n",
938 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
940 "html_filename": "Feature.html",
941 "href": "Feature.html#Ext-grid-feature-Feature-property-eventSelector"
944 "tagname": "property",
946 "member": "Ext.grid.feature.Feature",
947 "type": "Ext.grid.Panel",
948 "doc": "<p>Reference to the grid panel</p>\n",
951 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
953 "html_filename": "Feature.html",
954 "href": "Feature.html#Ext-grid-feature-Feature-property-grid"
957 "tagname": "property",
958 "name": "hasFeatureEvent",
959 "member": "Ext.grid.feature.Feature",
961 "doc": "<p>Most features will expose additional events, some may not and will\nneed to change this to false.</p>\n",
964 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
966 "html_filename": "Feature.html",
967 "href": "Feature.html#Ext-grid-feature-Feature-property-hasFeatureEvent"
970 "tagname": "property",
972 "member": "Ext.grid.feature.Feature",
973 "type": "Ext.view.Table",
974 "doc": "<p>Reference to the TableView.</p>\n",
977 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Feature.js",
979 "html_filename": "Feature.html",
980 "href": "Feature.html#Ext-grid-feature-Feature-property-view"
986 "name": "groupclick",
987 "member": "Ext.grid.feature.Grouping",
991 "type": "Ext.view.Table",
997 "type": "HTMLElement",
1005 "doc": "<p>The name of the group</p>\n",
1009 "type": "Ext.EventObject",
1016 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
1018 "html_filename": "Grouping.html",
1019 "href": "Grouping.html#Ext-grid-feature-Grouping-event-groupclick",
1024 "name": "groupcollapse",
1025 "member": "Ext.grid.feature.Grouping",
1029 "type": "Ext.view.Table",
1035 "type": "HTMLElement",
1043 "doc": "<p>The name of the group</p>\n",
1047 "type": "Ext.EventObject",
1054 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
1056 "html_filename": "Grouping.html",
1057 "href": "Grouping.html#Ext-grid-feature-Grouping-event-groupcollapse",
1062 "name": "groupcontextmenu",
1063 "member": "Ext.grid.feature.Grouping",
1067 "type": "Ext.view.Table",
1073 "type": "HTMLElement",
1081 "doc": "<p>The name of the group</p>\n",
1085 "type": "Ext.EventObject",
1092 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
1094 "html_filename": "Grouping.html",
1095 "href": "Grouping.html#Ext-grid-feature-Grouping-event-groupcontextmenu",
1100 "name": "groupdblclick",
1101 "member": "Ext.grid.feature.Grouping",
1105 "type": "Ext.view.Table",
1111 "type": "HTMLElement",
1119 "doc": "<p>The name of the group</p>\n",
1123 "type": "Ext.EventObject",
1130 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
1132 "html_filename": "Grouping.html",
1133 "href": "Grouping.html#Ext-grid-feature-Grouping-event-groupdblclick",
1138 "name": "groupexpand",
1139 "member": "Ext.grid.feature.Grouping",
1143 "type": "Ext.view.Table",
1149 "type": "HTMLElement",
1157 "doc": "<p>The name of the group</p>\n",
1161 "type": "Ext.EventObject",
1168 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
1170 "html_filename": "Grouping.html",
1171 "href": "Grouping.html#Ext-grid-feature-Grouping-event-groupexpand",
1175 "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/feature/Grouping.js",
1177 "html_filename": "Grouping.html",
1178 "href": "Grouping.html#Ext-grid-feature-Grouping",
1187 "Ext.util.Observable",
1188 "Ext.grid.feature.Feature"
1191 "Ext.grid.feature.GroupingSummary"