Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.grid.feature.Summary.html
1 <!DOCTYPE html><html><head><title>Ext.grid.feature.Summary | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
2 <style type="text/css">.head-band { display: none; }
3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
4 .doc-tab .members .member a.more { background-color: #efefef; }
5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit 
7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
8
9     req = {
10         liveURL: '.',
11         standAloneMode: true,
12         origDocClass: 'Ext.grid.feature.Summary',
13         docClass: 'Ext.grid.feature.Summary',
14         docReq: 'Ext.grid.feature.Summary',
15         version: '4.0',
16         baseURL: '.',
17         baseDocURL: '.',
18         baseProdURL: '.'
19     };
20
21     clsInfo = {};
22
23
24
25 </script>
26
27 <script type="text/javascript" src="../search.js"></script>
28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
29 <script type="text/javascript" src="../class_tree.js"></script>
30 <script type="text/javascript" src="../class_doc.js"></script>
31 <script type="text/javascript">
32     req.source = 'Summary.html#Ext-grid.feature.Summary';
33     clsInfo = {"methods":["addEvents","addListener","addManagedListener","attachEvents","capture","clearListeners","clearManagedListeners","disable","enable","enableBubble","fireEvent","getAdditionalData","getColumnValue","getFireEventArgs","getMetaRowTplFragments","hasListener","mutateMetaRowTpl","observe","on","relayEvents","releaseCapture","removeListener","removeManagedListener","resumeEvents","suspendEvents","toggleSummaryRow","un"],"cfgs":["listeners","showSummaryRow"],"properties":["collectData","eventPrefix","eventSelector","grid","hasFeatureEvent","view"],"events":[],"subclasses":[]};
34     Ext.onReady(function() {
35         Ext.create('Docs.classPanel');
36     });
37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Summary.html#Ext-grid.feature.Summary" target="_blank">Ext.grid.feature.Summary</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Hierarchy</h4><div class="subclass f"><a href="Ext.util.Observable.html" rel="Ext.util.Observable" class="cls docClass">Ext.util.Observable</a><div class="subclass"><a href="Ext.grid.feature.Feature.html" rel="Ext.grid.feature.Feature" class="cls docClass">Ext.grid.feature.Feature</a><div class="subclass"><a href="Ext.grid.feature.AbstractSummary.html" rel="Ext.grid.feature.AbstractSummary" class="cls docClass">Ext.grid.feature.AbstractSummary</a><div class="subclass"><strong>Ext.grid.feature.Summary</strong></div></div></div></div></pre><p>This feature is used to place a summary row at the bottom of the grid. If using a grouping,
38 see <a href="Ext.grid.feature.GroupingSummary.html" rel="Ext.grid.feature.GroupingSummary" class="docClass">Ext.grid.feature.GroupingSummary</a>. There are 2 aspects to calculating the summaries,
39 calculation and rendering.</p>
40
41 <h2>Calculation</h2>
42
43 <p>The summary value needs to be calculated for each column in the grid. This is controlled
44 by the summaryType option specified on the column. There are several built in summary types,
45 which can be specified as a string on the column configuration. These call underlying methods
46 on the store:</p>
47
48 <ul>
49 <li><a href="Ext.data.Store.html#count" rel="Ext.data.Store#count" class="docClass">count</a></li>
50 <li><a href="Ext.data.Store.html#sum" rel="Ext.data.Store#sum" class="docClass">sum</a></li>
51 <li><a href="Ext.data.Store.html#min" rel="Ext.data.Store#min" class="docClass">min</a></li>
52 <li><a href="Ext.data.Store.html#max" rel="Ext.data.Store#max" class="docClass">max</a></li>
53 <li><a href="Ext.data.Store.html#average" rel="Ext.data.Store#average" class="docClass">average</a></li>
54 </ul>
55
56
57 <p>Alternatively, the summaryType can be a function definition. If this is the case,
58 the function is called with an array of records to calculate the summary value.</p>
59
60 <h2>Rendering</h2>
61
62 <p>Similar to a column, the summary also supports a summaryRenderer function. This
63 summaryRenderer is called before displaying a value. The function is optional, if
64 not specified the default calculated value is shown. The summaryRenderer is called with:</p>
65
66 <ul>
67 <li>value {Object} - The calculated value.</li>
68 <li>data {Object} - Contains all raw summary values for the row.</li>
69 <li>field {String} - The name of the field we are calculating</li>
70 </ul>
71
72
73 <h2>Example Usage</h2>
74
75 <pre class="prettyprint"><code>Ext.define('TestResult', {
76     extend: 'Ext.data.Model',
77     fields: ['student', {
78         name: 'mark',
79         type: 'int'
80     }]
81 });
82
83 Ext.create('Ext.grid.Panel', {
84     width: 200,
85     height: 140,
86     renderTo: document.body,
87     features: [{
88         ftype: 'summary'
89     }],
90     store: {
91         model: 'TestResult',
92         data: [{
93             student: 'Student 1',
94             mark: 84
95         },{
96             student: 'Student 2',
97             mark: 72
98         },{
99             student: 'Student 3',
100             mark: 96
101         },{
102             student: 'Student 4',
103             mark: 68
104         }]
105     },
106     columns: [{
107         dataIndex: 'student',
108         text: 'Name',
109         summaryType: 'count',
110         summaryRenderer: function(value){
111             return Ext.String.format('{0} student{1}', value, value !== 1 ? 's' : ''); 
112         }
113     }, {
114         dataIndex: 'mark',
115         text: 'Mark',
116         summaryType: 'average'
117     }]
118 });
119 </code></pre>
120 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">Other Configs</h4><div id="config-listeners" class="member f inherited"><a href="Ext.grid.feature.Summary.html#config-listeners" rel="config-listeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-cfg-listeners" class="viewSource">view source</a></div><a name="listeners"></a><a name="config-listeners"></a><a href="Ext.grid.feature.Summary.html#" rel="config-listeners" class="cls expand">listeners</a><span> : Object</span></div><div class="description"><div class="short">(optional) A config object containing one or more event handlers to be added to this
121 object during initialization.  T...</div><div class="long"><p>(optional) <p>A config object containing one or more event handlers to be added to this
122 object during initialization.  This should be a valid listeners config object as specified in the
123 <a href="Ext.grid.feature.Summary.html#addListener" rel="Ext.grid.feature.Summary#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
124
125 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
126
127
128 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
129
130
131 <p>is usually only done when extra value can be added. For example the <a href="Ext.view.View.html" rel="Ext.view.View" class="docClass">DataView</a>'s
132 <b><code><a href="Ext.view.View.html#click" rel="Ext.view.View#click" class="docClass">click</a></code></b> event passing the node clicked on. To access DOM
133 events directly from a child element of a Component, we need to specify the <code>element</code> option to
134 identify the Component property to add a DOM listener to:</p>
135
136 <pre><code>new Ext.panel.Panel({
137     width: 400,
138     height: 200,
139     dockedItems: [{
140         xtype: 'toolbar'
141     }],
142     listeners: {
143         click: {
144             element: 'el', //bind to the underlying el property on the panel
145             fn: function(){ console.log('click el'); }
146         },
147         dblclick: {
148             element: 'body', //bind to the underlying body property on the panel
149             fn: function(){ console.log('dblclick body'); }
150         }
151     }
152 });
153 </code></pre>
154
155
156 <p></p></p>
157 </div></div></div><div id="config-showSummaryRow" class="member inherited"><a href="Ext.grid.feature.Summary.html#config-showSummaryRow" rel="config-showSummaryRow" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.grid.feature.AbstractSummary.html" class="definedIn docClass">Ext.grid.feature.AbstractSummary</a><br/><a href="../source/AbstractSummary.html#Ext-grid.feature.AbstractSummary-cfg-showSummaryRow" class="viewSource">view source</a></div><a name="showSummaryRow"></a><a name="config-showSummaryRow"></a><a href="Ext.grid.feature.Summary.html#" rel="config-showSummaryRow" class="cls expand">showSummaryRow</a><span> : Boolean</span></div><div class="description"><div class="short"><p>True to show the summary row. Defaults to <tt>true</tt>.</p>
158 </div><div class="long"><p>True to show the summary row. Defaults to <tt>true</tt>.</p>
159 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-collectData" class="member f inherited"><a href="Ext.grid.feature.Summary.html#property-collectData" rel="property-collectData" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.grid.feature.Feature.html" class="definedIn docClass">Ext.grid.feature.Feature</a><br/><a href="../source/Feature.html#Ext-grid.feature.Feature-property-collectData" class="viewSource">view source</a></div><a name="collectData"></a><a name="property-collectData"></a><a href="Ext.grid.feature.Summary.html#" rel="property-collectData" class="cls expand">collectData</a><span> : Boolean</span></div><div class="description"><div class="short">Most features will not modify the data returned to the view.
160 This is limited to one feature that manipulates the data...</div><div class="long"><p>Most features will not modify the data returned to the view.
161 This is limited to one feature that manipulates the data per grid view.</p>
162 </div></div></div><div id="property-eventPrefix" class="member inherited"><a href="Ext.grid.feature.Summary.html#property-eventPrefix" rel="property-eventPrefix" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.grid.feature.Feature.html" class="definedIn docClass">Ext.grid.feature.Feature</a><br/><a href="../source/Feature.html#Ext-grid.feature.Feature-property-eventPrefix" class="viewSource">view source</a></div><a name="eventPrefix"></a><a name="property-eventPrefix"></a><a href="Ext.grid.feature.Summary.html#" rel="property-eventPrefix" class="cls expand">eventPrefix</a><span> : String</span></div><div class="description"><div class="short">Prefix to use when firing events on the view.
163 For example a prefix of group would expose "groupclick", "groupcontextm...</div><div class="long"><p>Prefix to use when firing events on the view.
164 For example a prefix of group would expose "groupclick", "groupcontextmenu", "groupdblclick".</p>
165 </div></div></div><div id="property-eventSelector" class="member inherited"><a href="Ext.grid.feature.Summary.html#property-eventSelector" rel="property-eventSelector" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.grid.feature.Feature.html" class="definedIn docClass">Ext.grid.feature.Feature</a><br/><a href="../source/Feature.html#Ext-grid.feature.Feature-property-eventSelector" class="viewSource">view source</a></div><a name="eventSelector"></a><a name="property-eventSelector"></a><a href="Ext.grid.feature.Summary.html#" rel="property-eventSelector" class="cls expand">eventSelector</a><span> : String</span></div><div class="description"><div class="short"><p>Selector used to determine when to fire the event with the eventPrefix.</p>
166 </div><div class="long"><p>Selector used to determine when to fire the event with the eventPrefix.</p>
167 </div></div></div><div id="property-grid" class="member inherited"><a href="Ext.grid.feature.Summary.html#property-grid" rel="property-grid" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.grid.feature.Feature.html" class="definedIn docClass">Ext.grid.feature.Feature</a><br/><a href="../source/Feature.html#Ext-grid.feature.Feature-property-grid" class="viewSource">view source</a></div><a name="grid"></a><a name="property-grid"></a><a href="Ext.grid.feature.Summary.html#" rel="property-grid" class="cls expand">grid</a><span> : Ext.grid.Panel</span></div><div class="description"><div class="short"><p>Reference to the grid panel</p>
168 </div><div class="long"><p>Reference to the grid panel</p>
169 </div></div></div><div id="property-hasFeatureEvent" class="member inherited"><a href="Ext.grid.feature.Summary.html#property-hasFeatureEvent" rel="property-hasFeatureEvent" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.grid.feature.Feature.html" class="definedIn docClass">Ext.grid.feature.Feature</a><br/><a href="../source/Feature.html#Ext-grid.feature.Feature-property-hasFeatureEvent" class="viewSource">view source</a></div><a name="hasFeatureEvent"></a><a name="property-hasFeatureEvent"></a><a href="Ext.grid.feature.Summary.html#" rel="property-hasFeatureEvent" class="cls expand">hasFeatureEvent</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Most features will expose additional events, some may not and will
170 need to change this to false.</p>
171 </div><div class="long"><p>Most features will expose additional events, some may not and will
172 need to change this to false.</p>
173 </div></div></div><div id="property-view" class="member inherited"><a href="Ext.grid.feature.Summary.html#property-view" rel="property-view" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.grid.feature.Feature.html" class="definedIn docClass">Ext.grid.feature.Feature</a><br/><a href="../source/Feature.html#Ext-grid.feature.Feature-property-view" class="viewSource">view source</a></div><a name="view"></a><a name="property-view"></a><a href="Ext.grid.feature.Summary.html#" rel="property-view" class="cls expand">view</a><span> : Ext.view.Table</span></div><div class="description"><div class="short"><p>Reference to the TableView.</p>
174 </div><div class="long"><p>Reference to the TableView.</p>
175 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-addEvents" class="member f inherited"><a href="Ext.grid.feature.Summary.html#method-addEvents" rel="method-addEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addEvents" class="viewSource">view source</a></div><a name="addEvents"></a><a name="method-addEvents"></a><a href="Ext.grid.feature.Summary.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
176 <span class="pre">Object/String o, String </span>)
177  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
178 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
179 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object/String<div class="sub-desc"><p>Either an object with event names as properties with a value of <code>true</code>
180 or the first event name string if multiple event names are being passed as separate parameters.</p>
181 </div></li><li><span class="pre"></span> : String<div class="sub-desc"><p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.
182 Usage:</p>
183
184 <pre><code>this.addEvents('storeloaded', 'storecleared');
185 </code></pre>
186
187 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
188 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-addListener" rel="method-addListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addListener" class="viewSource">view source</a></div><a name="addListener"></a><a name="method-addListener"></a><a href="Ext.grid.feature.Summary.html#" rel="method-addListener" class="cls expand">addListener</a>(
189 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
190  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
191 </div><div class="long"><p>Appends an event handler to this object.</p>
192 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to listen for. May also be an object who's property names are event names. See</p>
193 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
194 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
195 <b>If omitted, defaults to the object which fired the event.</b></p>
196 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
197 properties. This may contain any of the following properties:<ul>
198 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
199 <b>If omitted, defaults to the object which fired the event.</b></div></li>
200 <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>
201 <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>
202 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html" rel="Ext.util.DelayedTask" class="docClass">Ext.util.DelayedTask</a> delayed
203 by the specified number of milliseconds. If the event fires again within that time, the original
204 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
205 <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>
206 if the event was bubbled up from a child Observable.</div></li>
207 <li><b>element</b> : String<div class="sub-desc"><b>This option is only valid for listeners bound to <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a>.</b>
208 The name of a Component property which references an element to add a listener to.</p>
209
210 <p>This option is useful during Component construction to add DOM event listeners to elements of <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a> which
211 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
212 <pre><code>new Ext.panel.Panel({
213     title: 'The title',
214     listeners: {
215         click: this.handlePanelClick,
216         element: 'body'
217     }
218 });
219 </code></pre></p>
220
221
222 <p>When added in this way, the options available are the options applicable to <a href="Ext.core.Element.html#addListener" rel="Ext.core.Element#addListener" class="docClass">Ext.core.Element.addListener</a></p>
223
224
225 <p></div></li>
226 </ul><br></p>
227
228 <p>
229 <b>Combining Options</b><br>
230 Using the options argument, it is possible to combine different types of listeners:<br>
231 <br>
232 A delayed, one-time listener.
233 <pre><code>myPanel.on('hide', this.handleClick, this, {
234 single: true,
235 delay: 100
236 });</code></pre>
237 <p>
238 <b>Attaching multiple handlers in 1 call</b><br>
239 The method also allows for a single argument to be passed which is a config object containing properties
240 which specify multiple events. For example:
241 <pre><code>myGridPanel.on({
242     cellClick: this.onCellClick,
243     mouseover: this.onMouseOver,
244     mouseout: this.onMouseOut,
245     scope: this // Important. Ensure "this" is correct during handler execution
246 });
247 </code></pre>.
248 <p>
249
250 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
251 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-addManagedListener" rel="method-addManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addManagedListener" class="viewSource">view source</a></div><a name="addManagedListener"></a><a name="method-addManagedListener"></a><a href="Ext.grid.feature.Summary.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
252 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
253  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
254 is destroyed.
255
256 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
257 is destroyed.
258
259 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable/Element<div class="sub-desc"><p>The item to which to add a listener/listeners.</p>
260 </div></li><li><span class="pre">ename</span> : Object/String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
261 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
262 is the handler function.</p>
263 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
264 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
265 </div></li><li><span class="pre">opt</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
266 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
267 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
268 </li></ul></div></div></div><div id="method-attachEvents" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-attachEvents" rel="method-attachEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.grid.feature.Feature.html" class="definedIn docClass">Ext.grid.feature.Feature</a><br/><a href="../source/Feature.html#Ext-grid.feature.Feature-method-attachEvents" class="viewSource">view source</a></div><a name="attachEvents"></a><a name="method-attachEvents"></a><a href="Ext.grid.feature.Summary.html#" rel="method-attachEvents" class="cls expand">attachEvents</a> : void</div><div class="description"><div class="short"><p>Approriate place to attach events to the view, selectionmodel, headerCt, etc</p>
269 </div><div class="long"><p>Approriate place to attach events to the view, selectionmodel, headerCt, etc</p>
270 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
271 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-capture" rel="method-capture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-capture" class="viewSource">view source</a></div><a name="capture"></a><a name="method-capture"></a><a href="Ext.grid.feature.Summary.html#" rel="method-capture" class="cls expand">capture</a>(
272 <span class="pre">Observable o, Function fn, [Object scope]</span>)
273  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
274 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
275 to the supplied function with the event name + standard signature of the event
276 <b>before</b> the event is fired. If the supplied function returns false,
277 the event will not fire.</p>
278 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to capture events from.</p>
279 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
280 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>
281 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
282 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-clearListeners" rel="method-clearListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearListeners" class="viewSource">view source</a></div><a name="clearListeners"></a><a name="method-clearListeners"></a><a href="Ext.grid.feature.Summary.html#" rel="method-clearListeners" class="cls expand">clearListeners</a> : void</div><div class="description"><div class="short"><p>Removes all listeners for this object including the managed listeners</p>
283 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
284 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
285 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-clearManagedListeners" rel="method-clearManagedListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearManagedListeners" class="viewSource">view source</a></div><a name="clearManagedListeners"></a><a name="method-clearManagedListeners"></a><a href="Ext.grid.feature.Summary.html#" rel="method-clearManagedListeners" class="cls expand">clearManagedListeners</a> : void</div><div class="description"><div class="short"><p>Removes all managed listeners for this object.</p>
286 </div><div class="long"><p>Removes all managed listeners for this object.</p>
287 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
288 </li></ul></div></div></div><div id="method-disable" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-disable" rel="method-disable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.grid.feature.Feature.html" class="definedIn docClass">Ext.grid.feature.Feature</a><br/><a href="../source/Feature.html#Ext-grid.feature.Feature-method-disable" class="viewSource">view source</a></div><a name="disable"></a><a name="method-disable"></a><a href="Ext.grid.feature.Summary.html#" rel="method-disable" class="cls expand">disable</a> : void</div><div class="description"><div class="short"><p>Disable a feature</p>
289 </div><div class="long"><p>Disable a feature</p>
290 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
291 </li></ul></div></div></div><div id="method-enable" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-enable" rel="method-enable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.grid.feature.Feature.html" class="definedIn docClass">Ext.grid.feature.Feature</a><br/><a href="../source/Feature.html#Ext-grid.feature.Feature-method-enable" class="viewSource">view source</a></div><a name="enable"></a><a name="method-enable"></a><a href="Ext.grid.feature.Summary.html#" rel="method-enable" class="cls expand">enable</a> : void</div><div class="description"><div class="short"><p>Enable a feature</p>
292 </div><div class="long"><p>Enable a feature</p>
293 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
294 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-enableBubble" rel="method-enableBubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-enableBubble" class="viewSource">view source</a></div><a name="enableBubble"></a><a name="method-enableBubble"></a><a href="Ext.grid.feature.Summary.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
295 <span class="pre">String/Array events</span>)
296  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
297 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
298 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
299
300
301 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>. The default
302 implementation in <a href="Ext.Component.html" 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
303 access the required target more quickly.</p>
304
305
306 <p>Example:</p>
307
308
309 <pre><code>Ext.override(Ext.form.field.Base, {
310 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
311 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
312     this.enableBubble('change');
313 }),
314
315 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
316 getBubbleTarget : function() {
317     if (!this.formPanel) {
318         this.formPanel = this.findParentByType('form');
319     }
320     return this.formPanel;
321 }
322 });
323
324 var myForm = new Ext.formPanel({
325 title: 'User Details',
326 items: [{
327     ...
328 }],
329 listeners: {
330     change: function() {
331         // Title goes red if form has been modified.
332         myForm.header.setStyle('color', 'red');
333     }
334 }
335 });
336 </code></pre>
337
338 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name to bubble, or an Array of event names.</p>
339 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
340 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-fireEvent" rel="method-fireEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-fireEvent" class="viewSource">view source</a></div><a name="fireEvent"></a><a name="method-fireEvent"></a><a href="Ext.grid.feature.Summary.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
341 <span class="pre">String eventName, Object... args</span>)
342  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
343
344
345 An event may be set to bubble up an Ob...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
346
347
348 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>)
349 by calling <a href="Ext.grid.feature.Summary.html#enableBubble" rel="Ext.grid.feature.Summary#enableBubble" class="docClass">enableBubble</a>.</p>
350
351 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to fire.</p>
352 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
353 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>returns false if any of the handlers return false otherwise it returns true.</p>
354 </li></ul></div></div></div><div id="method-getAdditionalData" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-getAdditionalData" rel="method-getAdditionalData" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.grid.feature.Feature.html" class="definedIn docClass">Ext.grid.feature.Feature</a><br/><a href="../source/Feature.html#Ext-grid.feature.Feature-method-getAdditionalData" class="viewSource">view source</a></div><a name="getAdditionalData"></a><a name="method-getAdditionalData"></a><a href="Ext.grid.feature.Summary.html#" rel="method-getAdditionalData" class="cls expand">getAdditionalData</a>(
355 <span class="pre">Object data, Number idx, Ext.data.Model record, Object orig</span>)
356  : void</div><div class="description"><div class="short"><p>Provide additional data to the prepareData call within the grid view.</p>
357 </div><div class="long"><p>Provide additional data to the prepareData call within the grid view.</p>
358 <h3 class="pa">Parameters</h3><ul><li><span class="pre">data</span> : Object<div class="sub-desc"><p>The data for this particular record.</p>
359 </div></li><li><span class="pre">idx</span> : Number<div class="sub-desc"><p>The row index for this record.</p>
360 </div></li><li><span class="pre">record</span> : Ext.data.Model<div class="sub-desc"><p>The record instance</p>
361 </div></li><li><span class="pre">orig</span> : Object<div class="sub-desc"><p>The original result from the prepareData call to massage.</p>
362 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
363 </li></ul></div></div></div><div id="method-getColumnValue" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-getColumnValue" rel="method-getColumnValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.grid.feature.AbstractSummary.html" class="definedIn docClass">Ext.grid.feature.AbstractSummary</a><br/><a href="../source/AbstractSummary.html#Ext-grid.feature.AbstractSummary-method-getColumnValue" class="viewSource">view source</a></div><a name="getColumnValue"></a><a name="method-getColumnValue"></a><a href="Ext.grid.feature.Summary.html#" rel="method-getColumnValue" class="cls expand">getColumnValue</a>(
364 <span class="pre">Ext.grid.column.Column column, Object data</span>)
365  : String</div><div class="description"><div class="short"><p>Gets the value for the column from the attached data.</p>
366 </div><div class="long"><p>Gets the value for the column from the attached data.</p>
367 <h3 class="pa">Parameters</h3><ul><li><span class="pre">column</span> : Ext.grid.column.Column<div class="sub-desc"><p>The header</p>
368 </div></li><li><span class="pre">data</span> : Object<div class="sub-desc"><p>The current data</p>
369 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The value to be rendered</p>
370 </li></ul></div></div></div><div id="method-getFireEventArgs" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-getFireEventArgs" rel="method-getFireEventArgs" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.grid.feature.Feature.html" class="definedIn docClass">Ext.grid.feature.Feature</a><br/><a href="../source/Feature.html#Ext-grid.feature.Feature-method-getFireEventArgs" class="viewSource">view source</a></div><a name="getFireEventArgs"></a><a name="method-getFireEventArgs"></a><a href="Ext.grid.feature.Summary.html#" rel="method-getFireEventArgs" class="cls expand">getFireEventArgs</a>(
371 <span class="pre">Object eventName, Object view, Object featureTarget</span>)
372  : void</div><div class="description"><div class="short">Abstract method to be overriden when a feature should add additional
373 arguments to its event signature. By default the...</div><div class="long"><p>Abstract method to be overriden when a feature should add additional
374 arguments to its event signature. By default the event will fire:
375 - view - The underlying <a href="Ext.view.Table.html" rel="Ext.view.Table" class="docClass">Ext.view.Table</a>
376 - featureTarget - The matched element by the defined <a href="eventSelector.html" rel="eventSelector" class="docClass">eventSelector</a></p>
377
378 <p>The method must also return the eventName as the first index of the array
379 to be passed to fireEvent.</p>
380 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : Object<div class="sub-desc">
381 </div></li><li><span class="pre">view</span> : Object<div class="sub-desc">
382 </div></li><li><span class="pre">featureTarget</span> : Object<div class="sub-desc">
383 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
384 </li></ul></div></div></div><div id="method-getMetaRowTplFragments" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-getMetaRowTplFragments" rel="method-getMetaRowTplFragments" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.grid.feature.Feature.html" class="definedIn docClass">Ext.grid.feature.Feature</a><br/><a href="../source/Feature.html#Ext-grid.feature.Feature-method-getMetaRowTplFragments" class="viewSource">view source</a></div><a name="getMetaRowTplFragments"></a><a name="method-getMetaRowTplFragments"></a><a href="Ext.grid.feature.Summary.html#" rel="method-getMetaRowTplFragments" class="cls expand">getMetaRowTplFragments</a> : void</div><div class="description"><div class="short">Allows a feature to inject member methods into the metaRowTpl. This is
385 important for embedding functionality which wi...</div><div class="long"><p>Allows a feature to inject member methods into the metaRowTpl. This is
386 important for embedding functionality which will become part of the proper
387 row tpl.</p>
388 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
389 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-hasListener" rel="method-hasListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-hasListener" class="viewSource">view source</a></div><a name="hasListener"></a><a name="method-hasListener"></a><a href="Ext.grid.feature.Summary.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
390 <span class="pre">String eventName</span>)
391  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
392 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
393 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to check for</p>
394 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the event is being listened for, else false</p>
395 </li></ul></div></div></div><div id="method-mutateMetaRowTpl" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-mutateMetaRowTpl" rel="method-mutateMetaRowTpl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.grid.feature.Feature.html" class="definedIn docClass">Ext.grid.feature.Feature</a><br/><a href="../source/Feature.html#Ext-grid.feature.Feature-method-mutateMetaRowTpl" class="viewSource">view source</a></div><a name="mutateMetaRowTpl"></a><a name="method-mutateMetaRowTpl"></a><a href="Ext.grid.feature.Summary.html#" rel="method-mutateMetaRowTpl" class="cls expand">mutateMetaRowTpl</a>(
396 <span class="pre">Object metaRowTplArray</span>)
397  : void</div><div class="description"><div class="short">Allows a feature to mutate the metaRowTpl.
398 The array received as a single argument can be manipulated to add things
399 o...</div><div class="long"><p>Allows a feature to mutate the metaRowTpl.
400 The array received as a single argument can be manipulated to add things
401 on the end/begining of a particular row.</p>
402 <h3 class="pa">Parameters</h3><ul><li><span class="pre">metaRowTplArray</span> : Object<div class="sub-desc">
403 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
404 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-observe" rel="method-observe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-observe" class="viewSource">view source</a></div><a name="observe"></a><a name="method-observe"></a><a href="Ext.grid.feature.Summary.html#" rel="method-observe" class="cls expand">observe</a>(
405 <span class="pre">Function c, Object listeners</span>)
406  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
407
408 This makes any event fired on any instance of the passed class a...</div><div class="long"><p>Sets observability on the passed class constructor.</p>
409
410 <p>This makes any event fired on any instance of the passed class also fire a single event through
411 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
412
413 <p>Usage:</p>
414
415 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
416 Ext.data.Connection.on('beforerequest', function(con, options) {
417     console.log('Ajax request made to ' + options.url);
418 });
419 </code></pre>
420 <h3 class="pa">Parameters</h3><ul><li><span class="pre">c</span> : Function<div class="sub-desc"><p>The class constructor to make observable.</p>
421 </div></li><li><span class="pre">listeners</span> : Object<div class="sub-desc"><p>An object containing a series of listeners to add. See <a href="Ext.grid.feature.Summary.html#addListener" rel="Ext.grid.feature.Summary#addListener" class="docClass">addListener</a>.</p>
422 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
423 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-on" rel="method-on" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-on" class="viewSource">view source</a></div><a name="on"></a><a name="method-on"></a><a href="Ext.grid.feature.Summary.html#" rel="method-on" class="cls expand">on</a>(
424 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
425  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.grid.feature.Summary.html#addListener" rel="Ext.grid.feature.Summary#addListener" class="docClass">addListener</a>.)</p>
426 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.grid.feature.Summary.html#addListener" rel="Ext.grid.feature.Summary#addListener" class="docClass">addListener</a>.)</p>
427 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event to listen for</p>
428 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
429 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
430 <b>If omitted, defaults to the object which fired the event.</b></p>
431 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
432 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
433 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-relayEvents" rel="method-relayEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-relayEvents" class="viewSource">view source</a></div><a name="relayEvents"></a><a name="method-relayEvents"></a><a href="Ext.grid.feature.Summary.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
434 <span class="pre">Object origin, Array events, Object prefix</span>)
435  : void</div><div class="description"><div class="short"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
436 </div><div class="long"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
437 <h3 class="pa">Parameters</h3><ul><li><span class="pre">origin</span> : Object<div class="sub-desc"><p>The Observable whose events this object is to relay.</p>
438 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
439 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
440 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
441 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-releaseCapture" rel="method-releaseCapture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-releaseCapture" class="viewSource">view source</a></div><a name="releaseCapture"></a><a name="method-releaseCapture"></a><a href="Ext.grid.feature.Summary.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
442 <span class="pre">Observable o</span>)
443  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
444 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
445 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
446 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
447 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-removeListener" rel="method-removeListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeListener" class="viewSource">view source</a></div><a name="removeListener"></a><a name="method-removeListener"></a><a href="Ext.grid.feature.Summary.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
448 <span class="pre">String eventName, Function handler, [Object scope]</span>)
449  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
450 </div><div class="long"><p>Removes an event handler.</p>
451 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
452 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.grid.feature.Summary.html#addListener" rel="Ext.grid.feature.Summary#addListener" class="docClass">addListener</a> call.</b></p>
453 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
454 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
455 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-removeManagedListener" rel="method-removeManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeManagedListener" class="viewSource">view source</a></div><a name="removeManagedListener"></a><a name="method-removeManagedListener"></a><a href="Ext.grid.feature.Summary.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
456 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
457  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.grid.feature.Summary.html#mon" rel="Ext.grid.feature.Summary#mon" class="docClass">mon</a> method.</p>
458 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.grid.feature.Summary.html#mon" rel="Ext.grid.feature.Summary#mon" class="docClass">mon</a> method.</p>
459 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable|Element<div class="sub-desc"><p>The item from which to remove a listener/listeners.</p>
460 </div></li><li><span class="pre">ename</span> : Object|String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
461 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
462 is the handler function.</p>
463 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
464 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
465 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
466 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-resumeEvents" rel="method-resumeEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-resumeEvents" class="viewSource">view source</a></div><a name="resumeEvents"></a><a name="method-resumeEvents"></a><a href="Ext.grid.feature.Summary.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
467 If events were suspended using the queueSuspended parameter, then all
468 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.grid.feature.Summary.html#suspendEvents" rel="Ext.grid.feature.Summary#suspendEvents" class="docClass">suspendEvents</a>)
469 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
470 events fired during event suspension will be sent to any listeners now.</p>
471 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
472 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-suspendEvents" rel="method-suspendEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-suspendEvents" class="viewSource">view source</a></div><a name="suspendEvents"></a><a name="method-suspendEvents"></a><a href="Ext.grid.feature.Summary.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
473 <span class="pre">Boolean queueSuspended</span>)
474  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.grid.feature.Summary.html#resumeEvents" rel="Ext.grid.feature.Summary#resumeEvents" class="docClass">resumeEvents</a>)</p>
475 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.grid.feature.Summary.html#resumeEvents" rel="Ext.grid.feature.Summary#resumeEvents" class="docClass">resumeEvents</a>)</p>
476 <h3 class="pa">Parameters</h3><ul><li><span class="pre">queueSuspended</span> : Boolean<div class="sub-desc"><p>Pass as true to queue up suspended events to be fired
477 after the <a href="Ext.grid.feature.Summary.html#resumeEvents" rel="Ext.grid.feature.Summary#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
478 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
479 </li></ul></div></div></div><div id="method-toggleSummaryRow" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-toggleSummaryRow" rel="method-toggleSummaryRow" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.grid.feature.AbstractSummary.html" class="definedIn docClass">Ext.grid.feature.AbstractSummary</a><br/><a href="../source/AbstractSummary.html#Ext-grid.feature.AbstractSummary-method-toggleSummaryRow" class="viewSource">view source</a></div><a name="toggleSummaryRow"></a><a name="method-toggleSummaryRow"></a><a href="Ext.grid.feature.Summary.html#" rel="method-toggleSummaryRow" class="cls expand">toggleSummaryRow</a>(
480 <span class="pre">Boolan visible</span>)
481  : void</div><div class="description"><div class="short"><p>Toggle whether or not to show the summary row.</p>
482 </div><div class="long"><p>Toggle whether or not to show the summary row.</p>
483 <h3 class="pa">Parameters</h3><ul><li><span class="pre">visible</span> : Boolan<div class="sub-desc"><p>True to show the summary row</p>
484 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
485 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.grid.feature.Summary.html#method-un" rel="method-un" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-un" class="viewSource">view source</a></div><a name="un"></a><a name="method-un"></a><a href="Ext.grid.feature.Summary.html#" rel="method-un" class="cls expand">un</a>(
486 <span class="pre">String eventName, Function handler, [Object scope]</span>)
487  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.grid.feature.Summary.html#removeListener" rel="Ext.grid.feature.Summary#removeListener" class="docClass">removeListener</a>.)</p>
488 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.grid.feature.Summary.html#removeListener" rel="Ext.grid.feature.Summary#removeListener" class="docClass">removeListener</a>.)</p>
489 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
490 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.grid.feature.Summary.html#addListener" rel="Ext.grid.feature.Summary#addListener" class="docClass">addListener</a> call.</b></p>
491 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
492 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
493 </li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>