Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.grid.feature.Feature.html
1 <!DOCTYPE html><html><head><title>Ext.grid.feature.Feature | 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.Feature',
13         docClass: 'Ext.grid.feature.Feature',
14         docReq: 'Ext.grid.feature.Feature',
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 = 'Feature.html#Ext-grid.feature.Feature';
33     clsInfo = {"methods":["addEvents","addListener","addManagedListener","attachEvents","capture","clearListeners","clearManagedListeners","disable","enable","enableBubble","fireEvent","getAdditionalData","getFireEventArgs","getMetaRowTplFragments","hasListener","mutateMetaRowTpl","observe","on","relayEvents","releaseCapture","removeListener","removeManagedListener","resumeEvents","suspendEvents","un"],"cfgs":["listeners"],"properties":["collectData","eventPrefix","eventSelector","grid","hasFeatureEvent","view"],"events":[],"subclasses":["Ext.grid.feature.AbstractSummary","Ext.grid.feature.Chunking","Ext.grid.feature.Grouping","Ext.grid.feature.RowBody","Ext.grid.feature.RowWrap"]};
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/Feature.html#Ext-grid.feature.Feature" target="_blank">Ext.grid.feature.Feature</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"><strong>Ext.grid.feature.Feature</strong></div></div></pre><p>A feature is a type of plugin that is specific to the <a href="Ext.grid.Panel.html" rel="Ext.grid.Panel" class="docClass">Ext.grid.Panel</a>. It provides several
38 hooks that allows the developer to inject additional functionality at certain points throughout the
39 grid creation cycle. This class provides the base template methods that are available to the developer,
40 it should be extended.</p>
41
42 <p>There are several built in features that extend this class, for example:</p>
43
44 <ul>
45 <li><a href="Ext.grid.feature.Grouping.html" rel="Ext.grid.feature.Grouping" class="docClass">Ext.grid.feature.Grouping</a> - Shows grid rows in groups as specified by the <a href="Ext.data.Store.html" rel="Ext.data.Store" class="docClass">Ext.data.Store</a></li>
46 <li><a href="Ext.grid.feature.RowBody.html" rel="Ext.grid.feature.RowBody" class="docClass">Ext.grid.feature.RowBody</a> - Adds a body section for each grid row that can contain markup.</li>
47 <li><a href="Ext.grid.feature.Summary.html" rel="Ext.grid.feature.Summary" class="docClass">Ext.grid.feature.Summary</a> - Adds a summary row at the bottom of the grid with aggregate totals for a column.</li>
48 </ul>
49
50
51 <h2>Using Features</h2>
52
53 <p>A feature is added to the grid by specifying it an array of features in the configuration:</p>
54
55 <pre class="prettyprint"><code>var groupingFeature = Ext.create('Ext.grid.feature.Grouping');
56 Ext.create('Ext.grid.Panel', {
57     // other options
58     features: [groupingFeature]
59 });
60 </code></pre>
61 <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.Feature.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.Feature.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
62 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
63 object during initialization.  This should be a valid listeners config object as specified in the
64 <a href="Ext.grid.feature.Feature.html#addListener" rel="Ext.grid.feature.Feature#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
65
66 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
67
68
69 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
70
71
72 <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
73 <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
74 events directly from a child element of a Component, we need to specify the <code>element</code> option to
75 identify the Component property to add a DOM listener to:</p>
76
77 <pre><code>new Ext.panel.Panel({
78     width: 400,
79     height: 200,
80     dockedItems: [{
81         xtype: 'toolbar'
82     }],
83     listeners: {
84         click: {
85             element: 'el', //bind to the underlying el property on the panel
86             fn: function(){ console.log('click el'); }
87         },
88         dblclick: {
89             element: 'body', //bind to the underlying body property on the panel
90             fn: function(){ console.log('dblclick body'); }
91         }
92     }
93 });
94 </code></pre>
95
96
97 <p></p></p>
98 </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 ni"><a href="Ext.grid.feature.Feature.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.Feature.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.
99 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.
100 This is limited to one feature that manipulates the data per grid view.</p>
101 </div></div></div><div id="property-eventPrefix" class="member ni"><a href="Ext.grid.feature.Feature.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.Feature.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.
102 For example a prefix of group would expose "groupclick", "groupcontextm...</div><div class="long"><p>Prefix to use when firing events on the view.
103 For example a prefix of group would expose "groupclick", "groupcontextmenu", "groupdblclick".</p>
104 </div></div></div><div id="property-eventSelector" class="member ni"><a href="Ext.grid.feature.Feature.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.Feature.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>
105 </div><div class="long"><p>Selector used to determine when to fire the event with the eventPrefix.</p>
106 </div></div></div><div id="property-grid" class="member ni"><a href="Ext.grid.feature.Feature.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.Feature.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>
107 </div><div class="long"><p>Reference to the grid panel</p>
108 </div></div></div><div id="property-hasFeatureEvent" class="member ni"><a href="Ext.grid.feature.Feature.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.Feature.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
109 need to change this to false.</p>
110 </div><div class="long"><p>Most features will expose additional events, some may not and will
111 need to change this to false.</p>
112 </div></div></div><div id="property-view" class="member ni"><a href="Ext.grid.feature.Feature.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.Feature.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>
113 </div><div class="long"><p>Reference to the TableView.</p>
114 </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.Feature.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.Feature.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
115 <span class="pre">Object/String o, String </span>)
116  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
117 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
118 <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>
119 or the first event name string if multiple event names are being passed as separate parameters.</p>
120 </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.
121 Usage:</p>
122
123 <pre><code>this.addEvents('storeloaded', 'storecleared');
124 </code></pre>
125
126 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
127 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-addListener" class="cls expand">addListener</a>(
128 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
129  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
130 </div><div class="long"><p>Appends an event handler to this object.</p>
131 <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>
132 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
133 </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.
134 <b>If omitted, defaults to the object which fired the event.</b></p>
135 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
136 properties. This may contain any of the following properties:<ul>
137 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
138 <b>If omitted, defaults to the object which fired the event.</b></div></li>
139 <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>
140 <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>
141 <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
142 by the specified number of milliseconds. If the event fires again within that time, the original
143 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
144 <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>
145 if the event was bubbled up from a child Observable.</div></li>
146 <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>
147 The name of a Component property which references an element to add a listener to.</p>
148
149 <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
150 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
151 <pre><code>new Ext.panel.Panel({
152     title: 'The title',
153     listeners: {
154         click: this.handlePanelClick,
155         element: 'body'
156     }
157 });
158 </code></pre></p>
159
160
161 <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>
162
163
164 <p></div></li>
165 </ul><br></p>
166
167 <p>
168 <b>Combining Options</b><br>
169 Using the options argument, it is possible to combine different types of listeners:<br>
170 <br>
171 A delayed, one-time listener.
172 <pre><code>myPanel.on('hide', this.handleClick, this, {
173 single: true,
174 delay: 100
175 });</code></pre>
176 <p>
177 <b>Attaching multiple handlers in 1 call</b><br>
178 The method also allows for a single argument to be passed which is a config object containing properties
179 which specify multiple events. For example:
180 <pre><code>myGridPanel.on({
181     cellClick: this.onCellClick,
182     mouseover: this.onMouseOver,
183     mouseout: this.onMouseOut,
184     scope: this // Important. Ensure "this" is correct during handler execution
185 });
186 </code></pre>.
187 <p>
188
189 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
190 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
191 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
192  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
193 is destroyed.
194
195 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
196 is destroyed.
197
198 <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>
199 </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>
200 </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
201 is the handler function.</p>
202 </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
203 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
204 </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
205 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
206 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
207 </li></ul></div></div></div><div id="method-attachEvents" class="member ni"><a href="Ext.grid.feature.Feature.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.Feature.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>
208 </div><div class="long"><p>Approriate place to attach events to the view, selectionmodel, headerCt, etc</p>
209 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
210 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-capture" class="cls expand">capture</a>(
211 <span class="pre">Observable o, Function fn, [Object scope]</span>)
212  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
213 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
214 to the supplied function with the event name + standard signature of the event
215 <b>before</b> the event is fired. If the supplied function returns false,
216 the event will not fire.</p>
217 <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>
218 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
219 </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>
220 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
221 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.grid.feature.Feature.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.Feature.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>
222 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
223 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
224 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.grid.feature.Feature.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.Feature.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>
225 </div><div class="long"><p>Removes all managed listeners for this object.</p>
226 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
227 </li></ul></div></div></div><div id="method-disable" class="member ni"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-disable" class="cls expand">disable</a> : void</div><div class="description"><div class="short"><p>Disable a feature</p>
228 </div><div class="long"><p>Disable a feature</p>
229 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
230 </li></ul></div></div></div><div id="method-enable" class="member ni"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-enable" class="cls expand">enable</a> : void</div><div class="description"><div class="short"><p>Enable a feature</p>
231 </div><div class="long"><p>Enable a feature</p>
232 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
233 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
234 <span class="pre">String/Array events</span>)
235  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
236 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
237 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
238
239
240 <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
241 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
242 access the required target more quickly.</p>
243
244
245 <p>Example:</p>
246
247
248 <pre><code>Ext.override(Ext.form.field.Base, {
249 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
250 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
251     this.enableBubble('change');
252 }),
253
254 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
255 getBubbleTarget : function() {
256     if (!this.formPanel) {
257         this.formPanel = this.findParentByType('form');
258     }
259     return this.formPanel;
260 }
261 });
262
263 var myForm = new Ext.formPanel({
264 title: 'User Details',
265 items: [{
266     ...
267 }],
268 listeners: {
269     change: function() {
270         // Title goes red if form has been modified.
271         myForm.header.setStyle('color', 'red');
272     }
273 }
274 });
275 </code></pre>
276
277 <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>
278 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
279 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
280 <span class="pre">String eventName, Object... args</span>)
281  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
282
283
284 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>
285
286
287 <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>)
288 by calling <a href="Ext.grid.feature.Feature.html#enableBubble" rel="Ext.grid.feature.Feature#enableBubble" class="docClass">enableBubble</a>.</p>
289
290 <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>
291 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
292 </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>
293 </li></ul></div></div></div><div id="method-getAdditionalData" class="member ni"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-getAdditionalData" class="cls expand">getAdditionalData</a>(
294 <span class="pre">Object data, Number idx, Ext.data.Model record, Object orig</span>)
295  : void</div><div class="description"><div class="short"><p>Provide additional data to the prepareData call within the grid view.</p>
296 </div><div class="long"><p>Provide additional data to the prepareData call within the grid view.</p>
297 <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>
298 </div></li><li><span class="pre">idx</span> : Number<div class="sub-desc"><p>The row index for this record.</p>
299 </div></li><li><span class="pre">record</span> : Ext.data.Model<div class="sub-desc"><p>The record instance</p>
300 </div></li><li><span class="pre">orig</span> : Object<div class="sub-desc"><p>The original result from the prepareData call to massage.</p>
301 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
302 </li></ul></div></div></div><div id="method-getFireEventArgs" class="member ni"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-getFireEventArgs" class="cls expand">getFireEventArgs</a>(
303 <span class="pre">Object eventName, Object view, Object featureTarget</span>)
304  : void</div><div class="description"><div class="short">Abstract method to be overriden when a feature should add additional
305 arguments to its event signature. By default the...</div><div class="long"><p>Abstract method to be overriden when a feature should add additional
306 arguments to its event signature. By default the event will fire:
307 - view - The underlying <a href="Ext.view.Table.html" rel="Ext.view.Table" class="docClass">Ext.view.Table</a>
308 - featureTarget - The matched element by the defined <a href="eventSelector.html" rel="eventSelector" class="docClass">eventSelector</a></p>
309
310 <p>The method must also return the eventName as the first index of the array
311 to be passed to fireEvent.</p>
312 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : Object<div class="sub-desc">
313 </div></li><li><span class="pre">view</span> : Object<div class="sub-desc">
314 </div></li><li><span class="pre">featureTarget</span> : Object<div class="sub-desc">
315 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
316 </li></ul></div></div></div><div id="method-getMetaRowTplFragments" class="member ni"><a href="Ext.grid.feature.Feature.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.Feature.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
317 important for embedding functionality which wi...</div><div class="long"><p>Allows a feature to inject member methods into the metaRowTpl. This is
318 important for embedding functionality which will become part of the proper
319 row tpl.</p>
320 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
321 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
322 <span class="pre">String eventName</span>)
323  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
324 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
325 <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>
326 </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>
327 </li></ul></div></div></div><div id="method-mutateMetaRowTpl" class="member ni"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-mutateMetaRowTpl" class="cls expand">mutateMetaRowTpl</a>(
328 <span class="pre">Object metaRowTplArray</span>)
329  : void</div><div class="description"><div class="short">Allows a feature to mutate the metaRowTpl.
330 The array received as a single argument can be manipulated to add things
331 o...</div><div class="long"><p>Allows a feature to mutate the metaRowTpl.
332 The array received as a single argument can be manipulated to add things
333 on the end/begining of a particular row.</p>
334 <h3 class="pa">Parameters</h3><ul><li><span class="pre">metaRowTplArray</span> : Object<div class="sub-desc">
335 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
336 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-observe" class="cls expand">observe</a>(
337 <span class="pre">Function c, Object listeners</span>)
338  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
339
340 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>
341
342 <p>This makes any event fired on any instance of the passed class also fire a single event through
343 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
344
345 <p>Usage:</p>
346
347 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
348 Ext.data.Connection.on('beforerequest', function(con, options) {
349     console.log('Ajax request made to ' + options.url);
350 });
351 </code></pre>
352 <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>
353 </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.Feature.html#addListener" rel="Ext.grid.feature.Feature#addListener" class="docClass">addListener</a>.</p>
354 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
355 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-on" class="cls expand">on</a>(
356 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
357  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.grid.feature.Feature.html#addListener" rel="Ext.grid.feature.Feature#addListener" class="docClass">addListener</a>.)</p>
358 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.grid.feature.Feature.html#addListener" rel="Ext.grid.feature.Feature#addListener" class="docClass">addListener</a>.)</p>
359 <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>
360 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
361 </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.
362 <b>If omitted, defaults to the object which fired the event.</b></p>
363 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
364 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
365 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
366 <span class="pre">Object origin, Array events, Object prefix</span>)
367  : 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>
368 </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>
369 <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>
370 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
371 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
372 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
373 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
374 <span class="pre">Observable o</span>)
375  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
376 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
377 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
378 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
379 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
380 <span class="pre">String eventName, Function handler, [Object scope]</span>)
381  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
382 </div><div class="long"><p>Removes an event handler.</p>
383 <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>
384 </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.Feature.html#addListener" rel="Ext.grid.feature.Feature#addListener" class="docClass">addListener</a> call.</b></p>
385 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
386 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
387 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
388 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
389  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.grid.feature.Feature.html#mon" rel="Ext.grid.feature.Feature#mon" class="docClass">mon</a> method.</p>
390 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.grid.feature.Feature.html#mon" rel="Ext.grid.feature.Feature#mon" class="docClass">mon</a> method.</p>
391 <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>
392 </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>
393 </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
394 is the handler function.</p>
395 </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
396 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
397 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
398 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
399 If events were suspended using the queueSuspended parameter, then all
400 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.grid.feature.Feature.html#suspendEvents" rel="Ext.grid.feature.Feature#suspendEvents" class="docClass">suspendEvents</a>)
401 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
402 events fired during event suspension will be sent to any listeners now.</p>
403 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
404 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
405 <span class="pre">Boolean queueSuspended</span>)
406  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.grid.feature.Feature.html#resumeEvents" rel="Ext.grid.feature.Feature#resumeEvents" class="docClass">resumeEvents</a>)</p>
407 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.grid.feature.Feature.html#resumeEvents" rel="Ext.grid.feature.Feature#resumeEvents" class="docClass">resumeEvents</a>)</p>
408 <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
409 after the <a href="Ext.grid.feature.Feature.html#resumeEvents" rel="Ext.grid.feature.Feature#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
410 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
411 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.grid.feature.Feature.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.Feature.html#" rel="method-un" class="cls expand">un</a>(
412 <span class="pre">String eventName, Function handler, [Object scope]</span>)
413  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.grid.feature.Feature.html#removeListener" rel="Ext.grid.feature.Feature#removeListener" class="docClass">removeListener</a>.)</p>
414 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.grid.feature.Feature.html#removeListener" rel="Ext.grid.feature.Feature#removeListener" class="docClass">removeListener</a>.)</p>
415 <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>
416 </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.Feature.html#addListener" rel="Ext.grid.feature.Feature#addListener" class="docClass">addListener</a> call.</b></p>
417 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
418 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
419 </li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>