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