Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / output / Ext.grid.plugin.CellEditing.js
1 Ext.data.JsonP.Ext_grid_plugin_CellEditing({
2   "allMixins": [
3     "Ext.util.Observable"
4   ],
5   "deprecated": null,
6   "docauthor": null,
7   "members": {
8     "cfg": [
9       {
10         "type": "Number",
11         "deprecated": null,
12         "alias": null,
13         "protected": false,
14         "tagname": "cfg",
15         "href": "Editing.html#Ext-grid-plugin-Editing-cfg-clicksToEdit",
16         "static": false,
17         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/Editing.js",
18         "private": false,
19         "name": "clicksToEdit",
20         "owner": "Ext.grid.plugin.Editing",
21         "doc": "<p>The number of clicks on a grid required to display the editor (defaults to 2).</p>\n",
22         "linenr": 26,
23         "html_filename": "Editing.html"
24       },
25       {
26         "type": "Object",
27         "deprecated": null,
28         "alias": null,
29         "protected": false,
30         "tagname": "cfg",
31         "href": "Observable.html#Ext-util-Observable-cfg-listeners",
32         "shortDoc": "A config object containing one or more event handlers to be added to this object during initialization. ...",
33         "static": false,
34         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
35         "private": false,
36         "name": "listeners",
37         "owner": "Ext.util.Observable",
38         "doc": "<p>A config object containing one or more event handlers to be added to this object during initialization. This\nshould be a valid listeners config object as specified in the <a href=\"#/api/Ext.grid.plugin.CellEditing-method-addListener\" rel=\"Ext.grid.plugin.CellEditing-method-addListener\" class=\"docClass\">addListener</a> example for attaching multiple\nhandlers at once.</p>\n\n<p><strong>DOM events from ExtJS <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a></strong></p>\n\n<p>While <em>some</em> ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly 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 <strong><code><a href=\"#/api/Ext.view.View-event-itemclick\" rel=\"Ext.view.View-event-itemclick\" class=\"docClass\">itemclick</a></code></strong> event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the <code>element</code> option to identify the Component property to add a\nDOM 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",
39         "linenr": 102,
40         "html_filename": "Observable.html"
41       }
42     ],
43     "method": [
44       {
45         "deprecated": null,
46         "alias": null,
47         "protected": false,
48         "tagname": "method",
49         "href": "Observable.html#Ext-util-Observable-method-addEvents",
50         "shortDoc": "Adds the specified events to the list of events which this Observable may fire. ...",
51         "static": false,
52         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
53         "private": false,
54         "params": [
55           {
56             "type": "Object/String",
57             "optional": false,
58             "doc": "<p>Either an object with event names as properties with a value of <code>true</code> or the first\nevent name string if multiple event names are being passed as separate parameters. Usage:</p>\n\n<pre><code>this.addEvents({\n    storeloaded: true,\n    storecleared: true\n});\n</code></pre>\n",
59             "name": "o"
60           },
61           {
62             "type": "String...",
63             "optional": false,
64             "doc": "<p>Optional additional event names if multiple event names are being passed as separate\nparameters. Usage:</p>\n\n<pre><code>this.addEvents('storeloaded', 'storecleared');\n</code></pre>\n",
65             "name": "more"
66           }
67         ],
68         "name": "addEvents",
69         "owner": "Ext.util.Observable",
70         "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
71         "linenr": 494,
72         "return": {
73           "type": "void",
74           "doc": "\n"
75         },
76         "html_filename": "Observable.html"
77       },
78       {
79         "deprecated": null,
80         "alias": null,
81         "protected": false,
82         "tagname": "method",
83         "href": "Observable.html#Ext-util-Observable-method-addListener",
84         "shortDoc": "Appends an event handler to this object. ...",
85         "static": false,
86         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
87         "private": false,
88         "params": [
89           {
90             "type": "String",
91             "optional": false,
92             "doc": "<p>The name of the event to listen for. May also be an object who's property names are\nevent names.</p>\n",
93             "name": "eventName"
94           },
95           {
96             "type": "Function",
97             "optional": false,
98             "doc": "<p>The method the event invokes.  Will be called with arguments given to\n<a href=\"#/api/Ext.grid.plugin.CellEditing-method-fireEvent\" rel=\"Ext.grid.plugin.CellEditing-method-fireEvent\" class=\"docClass\">fireEvent</a> plus the <code>options</code> parameter described below.</p>\n",
99             "name": "handler"
100           },
101           {
102             "type": "Object",
103             "optional": true,
104             "doc": "<p>(optional) The scope (<code>this</code> reference) in which the handler function is executed. <strong>If\nomitted, defaults to the object which fired the event.</strong></p>\n",
105             "name": "scope"
106           },
107           {
108             "type": "Object",
109             "optional": true,
110             "doc": "<p>(optional) An object containing handler configuration.</p>\n\n<p><strong>Note:</strong> Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.</p>\n\n<p>This object may contain any of the following properties:</p>\n\n<ul>\n<li><p><strong>scope</strong> : Object</p>\n\n<p>The scope (<code>this</code> reference) in which the handler function is executed. <strong>If omitted, defaults to the object\nwhich fired the event.</strong></p></li>\n<li><p><strong>delay</strong> : Number</p>\n\n<p>The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>\n<li><p><strong>single</strong> : Boolean</p>\n\n<p>True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>\n<li><p><strong>buffer</strong> : Number</p>\n\n<p>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 by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is <em>not</em> invoked, but the new\nhandler is scheduled in its place.</p></li>\n<li><p><strong>target</strong> : Observable</p>\n\n<p>Only call the handler if the event was fired on the target Observable, <em>not</em> if the event was bubbled up from a\nchild Observable.</p></li>\n<li><p><strong>element</strong> : String</p>\n\n<p><strong>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</strong> The name of a Component\nproperty 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\n<a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:</p>\n\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></li>\n</ul>\n\n\n<p><strong>Combining Options</strong></p>\n\n<p>Using the options argument, it is possible to combine different types of listeners:</p>\n\n<p>A delayed, one-time listener.</p>\n\n<pre><code>myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n</code></pre>\n\n<p><strong>Attaching multiple handlers in 1 call</strong></p>\n\n<p>The method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:</p>\n\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\n<p>One can also specify options for each event handler separately:</p>\n\n<pre><code>myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n</code></pre>\n",
111             "name": "options"
112           }
113         ],
114         "name": "addListener",
115         "owner": "Ext.util.Observable",
116         "doc": "<p>Appends an event handler to this object.</p>\n",
117         "linenr": 278,
118         "return": {
119           "type": "void",
120           "doc": "\n"
121         },
122         "html_filename": "Observable.html"
123       },
124       {
125         "deprecated": null,
126         "alias": null,
127         "protected": false,
128         "tagname": "method",
129         "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
130         "shortDoc": "Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed. ...",
131         "static": false,
132         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
133         "private": false,
134         "params": [
135           {
136             "type": "Observable/Element",
137             "optional": false,
138             "doc": "<p>The item to which to add a listener/listeners.</p>\n",
139             "name": "item"
140           },
141           {
142             "type": "Object/String",
143             "optional": false,
144             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
145             "name": "ename"
146           },
147           {
148             "type": "Function",
149             "optional": true,
150             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
151             "name": "fn"
152           },
153           {
154             "type": "Object",
155             "optional": true,
156             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
157             "name": "scope"
158           },
159           {
160             "type": "Object",
161             "optional": true,
162             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the\n<a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
163             "name": "opt"
164           }
165         ],
166         "name": "addManagedListener",
167         "owner": "Ext.util.Observable",
168         "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.</p>\n",
169         "linenr": 156,
170         "return": {
171           "type": "void",
172           "doc": "\n"
173         },
174         "html_filename": "Observable.html"
175       },
176       {
177         "deprecated": null,
178         "alias": null,
179         "protected": false,
180         "tagname": "method",
181         "href": "Base3.html#Ext-Base-method-addStatics",
182         "shortDoc": "Add / override static properties of this class. ...",
183         "static": true,
184         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
185         "private": false,
186         "params": [
187           {
188             "type": "Object",
189             "optional": false,
190             "doc": "\n",
191             "name": "members"
192           }
193         ],
194         "name": "addStatics",
195         "owner": "Ext.Base",
196         "doc": "<p>Add / override static properties of this class.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.addStatics({\n    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'\n    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };\n    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };\n});\n</code></pre>\n",
197         "linenr": 388,
198         "return": {
199           "type": "Ext.Base",
200           "doc": "<p>this</p>\n"
201         },
202         "html_filename": "Base3.html"
203       },
204       {
205         "deprecated": null,
206         "alias": null,
207         "protected": false,
208         "tagname": "method",
209         "href": "Base3.html#Ext-Base-method-callOverridden",
210         "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n    constructo...",
211         "static": false,
212         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
213         "private": false,
214         "params": [
215           {
216             "type": "Array/Arguments",
217             "optional": false,
218             "doc": "<p>The arguments, either an array or the <code>arguments</code> object</p>\n",
219             "name": "args"
220           }
221         ],
222         "name": "callOverridden",
223         "owner": "Ext.Base",
224         "doc": "<p>Call the original method that was previously overridden with <a href=\"#/api/Ext.Base-method-override\" rel=\"Ext.Base-method-override\" class=\"docClass\">Ext.Base.override</a></p>\n\n<pre><code>Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n</code></pre>\n",
225         "linenr": 269,
226         "return": {
227           "type": "Mixed",
228           "doc": "<p>Returns the result after calling the overridden method</p>\n"
229         },
230         "html_filename": "Base3.html"
231       },
232       {
233         "deprecated": null,
234         "alias": null,
235         "protected": true,
236         "tagname": "method",
237         "href": "Base3.html#Ext-Base-method-callParent",
238         "shortDoc": "Call the parent's overridden method. ...",
239         "static": false,
240         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
241         "private": false,
242         "params": [
243           {
244             "type": "Array/Arguments",
245             "optional": false,
246             "doc": "<p>The arguments, either an array or the <code>arguments</code> object\nfrom the current method, for example: <code>this.callParent(arguments)</code></p>\n",
247             "name": "args"
248           }
249         ],
250         "name": "callParent",
251         "owner": "Ext.Base",
252         "doc": "<p>Call the parent's overridden method. For example:</p>\n\n<pre><code>Ext.define('My.own.A', {\n    constructor: function(test) {\n        alert(test);\n    }\n});\n\nExt.define('My.own.B', {\n    extend: 'My.own.A',\n\n    constructor: function(test) {\n        alert(test);\n\n        this.callParent([test + 1]);\n    }\n});\n\nExt.define('My.own.C', {\n    extend: 'My.own.B',\n\n    constructor: function() {\n        alert(\"Going to call parent's overriden constructor...\");\n\n        this.callParent(arguments);\n    }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n                         // alerts '2', then alerts '3'\n</code></pre>\n",
253         "linenr": 124,
254         "return": {
255           "type": "Mixed",
256           "doc": "<p>Returns the result from the superclass' method</p>\n"
257         },
258         "html_filename": "Base3.html"
259       },
260       {
261         "deprecated": null,
262         "alias": null,
263         "protected": false,
264         "tagname": "method",
265         "href": "CellEditing.html#Ext-grid-plugin-CellEditing-method-cancelEdit",
266         "shortDoc": "Cancel any active editing. ...",
267         "static": false,
268         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/CellEditing.js",
269         "private": false,
270         "params": [
271
272         ],
273         "name": "cancelEdit",
274         "owner": "Ext.grid.plugin.CellEditing",
275         "doc": "<p>Cancel any active editing.</p>\n",
276         "linenr": 362,
277         "return": {
278           "type": "void",
279           "doc": "\n"
280         },
281         "html_filename": "CellEditing.html"
282       },
283       {
284         "deprecated": null,
285         "alias": null,
286         "protected": false,
287         "tagname": "method",
288         "href": "Observable.html#Ext-util-Observable-method-capture",
289         "shortDoc": "Starts capture on the specified Observable. ...",
290         "static": true,
291         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
292         "private": false,
293         "params": [
294           {
295             "type": "Observable",
296             "optional": false,
297             "doc": "<p>The Observable to capture events from.</p>\n",
298             "name": "o"
299           },
300           {
301             "type": "Function",
302             "optional": false,
303             "doc": "<p>The function to call when an event is fired.</p>\n",
304             "name": "fn"
305           },
306           {
307             "type": "Object",
308             "optional": true,
309             "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to\nthe Observable firing the event.</p>\n",
310             "name": "scope"
311           }
312         ],
313         "name": "capture",
314         "owner": "Ext.util.Observable",
315         "doc": "<p>Starts capture on the specified Observable. All events will be passed to the supplied function with the event\nname + standard signature of the event <strong>before</strong> the event is fired. If the supplied function returns false,\nthe event will not fire.</p>\n",
316         "linenr": 54,
317         "return": {
318           "type": "void",
319           "doc": "\n"
320         },
321         "html_filename": "Observable.html"
322       },
323       {
324         "deprecated": null,
325         "alias": null,
326         "protected": false,
327         "tagname": "method",
328         "href": "Observable.html#Ext-util-Observable-method-clearListeners",
329         "shortDoc": "Removes all listeners for this object including the managed listeners ...",
330         "static": false,
331         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
332         "private": false,
333         "params": [
334
335         ],
336         "name": "clearListeners",
337         "owner": "Ext.util.Observable",
338         "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
339         "linenr": 425,
340         "return": {
341           "type": "void",
342           "doc": "\n"
343         },
344         "html_filename": "Observable.html"
345       },
346       {
347         "deprecated": null,
348         "alias": null,
349         "protected": false,
350         "tagname": "method",
351         "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
352         "shortDoc": "Removes all managed listeners for this object. ...",
353         "static": false,
354         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
355         "private": false,
356         "params": [
357
358         ],
359         "name": "clearManagedListeners",
360         "owner": "Ext.util.Observable",
361         "doc": "<p>Removes all managed listeners for this object.</p>\n",
362         "linenr": 454,
363         "return": {
364           "type": "void",
365           "doc": "\n"
366         },
367         "html_filename": "Observable.html"
368       },
369       {
370         "deprecated": null,
371         "alias": null,
372         "protected": false,
373         "tagname": "method",
374         "href": "Editing.html#Ext-grid-plugin-Editing-method-completeEdit",
375         "shortDoc": "Complete the edit if there is an active edit in progress. ...",
376         "static": false,
377         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/Editing.js",
378         "private": false,
379         "params": [
380
381         ],
382         "name": "completeEdit",
383         "owner": "Ext.grid.plugin.Editing",
384         "doc": "<p>Complete the edit if there is an active edit in progress.</p>\n",
385         "linenr": 319,
386         "return": {
387           "type": "void",
388           "doc": "\n"
389         },
390         "html_filename": "Editing.html"
391       },
392       {
393         "deprecated": null,
394         "alias": null,
395         "protected": false,
396         "tagname": "method",
397         "href": "Base3.html#Ext-Base-method-create",
398         "shortDoc": "Create a new instance of this Class. ...",
399         "static": true,
400         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
401         "private": false,
402         "params": [
403
404         ],
405         "name": "create",
406         "owner": "Ext.Base",
407         "doc": "<p>Create a new instance of this Class.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n</code></pre>\n\n<p>All parameters are passed to the constructor of the class.</p>\n",
408         "linenr": 329,
409         "return": {
410           "type": "Object",
411           "doc": "<p>the created instance.</p>\n"
412         },
413         "html_filename": "Base3.html"
414       },
415       {
416         "deprecated": null,
417         "alias": null,
418         "protected": false,
419         "tagname": "method",
420         "href": "Base3.html#Ext-Base-method-createAlias",
421         "shortDoc": "Create aliases for existing prototype methods. ...",
422         "static": true,
423         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
424         "private": false,
425         "params": [
426           {
427             "type": "String/Object",
428             "optional": false,
429             "doc": "<p>The new method name, or an object to set multiple aliases. See\n<a href=\"#/api/Ext.Function-method-flexSetter\" rel=\"Ext.Function-method-flexSetter\" class=\"docClass\">flexSetter</a></p>\n",
430             "name": "alias"
431           },
432           {
433             "type": "String/Object",
434             "optional": false,
435             "doc": "<p>The original method name</p>\n",
436             "name": "origin"
437           }
438         ],
439         "name": "createAlias",
440         "owner": "Ext.Base",
441         "doc": "<p>Create aliases for existing prototype methods. Example:</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -&gt; test.method1()\n</code></pre>\n",
442         "linenr": 648,
443         "return": {
444           "type": "void",
445           "doc": "\n"
446         },
447         "html_filename": "Base3.html"
448       },
449       {
450         "deprecated": null,
451         "alias": null,
452         "protected": false,
453         "tagname": "method",
454         "href": "Observable.html#Ext-util-Observable-method-enableBubble",
455         "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...",
456         "static": false,
457         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
458         "private": false,
459         "params": [
460           {
461             "type": "String/[String]",
462             "optional": false,
463             "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
464             "name": "events"
465           }
466         ],
467         "name": "enableBubble",
468         "owner": "Ext.util.Observable",
469         "doc": "<p>Enables events fired by this Observable to bubble up an owner hierarchy by calling <code>this.getBubbleTarget()</code> if\npresent. There is no implementation in the Observable base class.</p>\n\n<p>This is commonly used by Ext.Components to bubble events to owner Containers.\nSee <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>. The default implementation in <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a> returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.</p>\n\n<p>Example:</p>\n\n<pre><code>Ext.override(Ext.form.field.Base, {\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n        this.enableBubble('change');\n    }),\n\n    //  We know that we want Field's events to bubble directly to the FormPanel.\n    getBubbleTarget : function() {\n        if (!this.formPanel) {\n            this.formPanel = this.findParentByType('form');\n        }\n        return this.formPanel;\n    }\n});\n\nvar myForm = new Ext.formPanel({\n    title: 'User Details',\n    items: [{\n        ...\n    }],\n    listeners: {\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",
470         "linenr": 609,
471         "return": {
472           "type": "void",
473           "doc": "\n"
474         },
475         "html_filename": "Observable.html"
476       },
477       {
478         "deprecated": null,
479         "alias": null,
480         "protected": false,
481         "tagname": "method",
482         "href": "Observable.html#Ext-util-Observable-method-fireEvent",
483         "shortDoc": "Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...",
484         "static": false,
485         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
486         "private": false,
487         "params": [
488           {
489             "type": "String",
490             "optional": false,
491             "doc": "<p>The name of the event to fire.</p>\n",
492             "name": "eventName"
493           },
494           {
495             "type": "Object...",
496             "optional": false,
497             "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
498             "name": "args"
499           }
500         ],
501         "name": "fireEvent",
502         "owner": "Ext.util.Observable",
503         "doc": "<p>Fires the specified event with the passed parameters (minus the event name, plus the <code>options</code> object passed\nto <a href=\"#/api/Ext.grid.plugin.CellEditing-method-addListener\" rel=\"Ext.grid.plugin.CellEditing-method-addListener\" class=\"docClass\">addListener</a>).</p>\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>) by\ncalling <a href=\"#/api/Ext.grid.plugin.CellEditing-method-enableBubble\" rel=\"Ext.grid.plugin.CellEditing-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n",
504         "linenr": 233,
505         "return": {
506           "type": "Boolean",
507           "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
508         },
509         "html_filename": "Observable.html"
510       },
511       {
512         "deprecated": null,
513         "alias": null,
514         "protected": false,
515         "tagname": "method",
516         "href": "Base3.html#Ext-Base-method-getName",
517         "shortDoc": "Get the current class' name in string format. ...",
518         "static": false,
519         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
520         "private": false,
521         "params": [
522
523         ],
524         "name": "getName",
525         "owner": "Ext.Base",
526         "doc": "<p>Get the current class' name in string format.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n</code></pre>\n",
527         "linenr": 631,
528         "return": {
529           "type": "String",
530           "doc": "<p>className</p>\n"
531         },
532         "html_filename": "Base3.html"
533       },
534       {
535         "deprecated": null,
536         "alias": null,
537         "protected": false,
538         "tagname": "method",
539         "href": "Observable.html#Ext-util-Observable-method-hasListener",
540         "shortDoc": "Checks to see if this object has any listeners for a specified event ...",
541         "static": false,
542         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
543         "private": false,
544         "params": [
545           {
546             "type": "String",
547             "optional": false,
548             "doc": "<p>The name of the event to check for</p>\n",
549             "name": "eventName"
550           }
551         ],
552         "name": "hasListener",
553         "owner": "Ext.util.Observable",
554         "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
555         "linenr": 530,
556         "return": {
557           "type": "Boolean",
558           "doc": "<p>True if the event is being listened for, else false</p>\n"
559         },
560         "html_filename": "Observable.html"
561       },
562       {
563         "deprecated": null,
564         "alias": null,
565         "protected": false,
566         "tagname": "method",
567         "href": "Base3.html#Ext-Base-method-implement",
568         "shortDoc": "Add methods / properties to the prototype of this class. ...",
569         "static": true,
570         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
571         "private": false,
572         "params": [
573           {
574             "type": "Object",
575             "optional": false,
576             "doc": "\n",
577             "name": "members"
578           }
579         ],
580         "name": "implement",
581         "owner": "Ext.Base",
582         "doc": "<p>Add methods / properties to the prototype of this class.</p>\n\n<pre><code>Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.implement({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n</code></pre>\n",
583         "linenr": 415,
584         "return": {
585           "type": "void",
586           "doc": "\n"
587         },
588         "html_filename": "Base3.html"
589       },
590       {
591         "deprecated": null,
592         "alias": null,
593         "protected": true,
594         "tagname": "method",
595         "href": "Base3.html#Ext-Base-method-initConfig",
596         "shortDoc": "Initialize configuration for this class. ...",
597         "static": false,
598         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
599         "private": false,
600         "params": [
601           {
602             "type": "Object",
603             "optional": false,
604             "doc": "\n",
605             "name": "config"
606           }
607         ],
608         "name": "initConfig",
609         "owner": "Ext.Base",
610         "doc": "<p>Initialize configuration for this class. a typical example:</p>\n\n<pre><code>Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n\n        return this;\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n</code></pre>\n",
611         "linenr": 63,
612         "return": {
613           "type": "Object",
614           "doc": "<p>mixins The mixin prototypes as key - value pairs</p>\n"
615         },
616         "html_filename": "Base3.html"
617       },
618       {
619         "deprecated": null,
620         "alias": {
621           "tagname": "alias",
622           "cls": "Ext.util.Observable",
623           "doc": null,
624           "owner": "addManagedListener"
625         },
626         "protected": false,
627         "tagname": "method",
628         "href": "Observable.html#Ext-util-Observable-method-mon",
629         "shortDoc": "Shorthand for addManagedListener. ...",
630         "static": false,
631         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
632         "private": false,
633         "params": [
634           {
635             "type": "Observable/Element",
636             "optional": false,
637             "doc": "<p>The item to which to add a listener/listeners.</p>\n",
638             "name": "item"
639           },
640           {
641             "type": "Object/String",
642             "optional": false,
643             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
644             "name": "ename"
645           },
646           {
647             "type": "Function",
648             "optional": true,
649             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
650             "name": "fn"
651           },
652           {
653             "type": "Object",
654             "optional": true,
655             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
656             "name": "scope"
657           },
658           {
659             "type": "Object",
660             "optional": true,
661             "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the\n<a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
662             "name": "opt"
663           }
664         ],
665         "name": "mon",
666         "owner": "Ext.util.Observable",
667         "doc": "<p>Shorthand for <a href=\"#/api/Ext.grid.plugin.CellEditing-method-addManagedListener\" rel=\"Ext.grid.plugin.CellEditing-method-addManagedListener\" class=\"docClass\">addManagedListener</a>.</p>\n\n<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.</p>\n",
668         "linenr": 681,
669         "return": {
670           "type": "void",
671           "doc": "\n"
672         },
673         "html_filename": "Observable.html"
674       },
675       {
676         "deprecated": null,
677         "alias": {
678           "tagname": "alias",
679           "cls": "Ext.util.Observable",
680           "doc": null,
681           "owner": "removeManagedListener"
682         },
683         "protected": false,
684         "tagname": "method",
685         "href": "Observable.html#Ext-util-Observable-method-mun",
686         "shortDoc": "Shorthand for removeManagedListener. ...",
687         "static": false,
688         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
689         "private": false,
690         "params": [
691           {
692             "type": "Observable|Element",
693             "optional": false,
694             "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
695             "name": "item"
696           },
697           {
698             "type": "Object|String",
699             "optional": false,
700             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
701             "name": "ename"
702           },
703           {
704             "type": "Function",
705             "optional": false,
706             "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
707             "name": "fn"
708           },
709           {
710             "type": "Object",
711             "optional": false,
712             "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
713             "name": "scope"
714           }
715         ],
716         "name": "mun",
717         "owner": "Ext.util.Observable",
718         "doc": "<p>Shorthand for <a href=\"#/api/Ext.grid.plugin.CellEditing-method-removeManagedListener\" rel=\"Ext.grid.plugin.CellEditing-method-removeManagedListener\" class=\"docClass\">removeManagedListener</a>.</p>\n\n<p>Removes listeners that were added by the <a href=\"#/api/Ext.grid.plugin.CellEditing-method-mon\" rel=\"Ext.grid.plugin.CellEditing-method-mon\" class=\"docClass\">mon</a> method.</p>\n",
719         "linenr": 687,
720         "return": {
721           "type": "void",
722           "doc": "\n"
723         },
724         "html_filename": "Observable.html"
725       },
726       {
727         "deprecated": null,
728         "alias": null,
729         "protected": false,
730         "tagname": "method",
731         "href": "Observable.html#Ext-util-Observable-method-observe",
732         "shortDoc": "Sets observability on the passed class constructor. ...",
733         "static": true,
734         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
735         "private": false,
736         "params": [
737           {
738             "type": "Function",
739             "optional": false,
740             "doc": "<p>The class constructor to make observable.</p>\n",
741             "name": "c"
742           },
743           {
744             "type": "Object",
745             "optional": false,
746             "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.grid.plugin.CellEditing-method-addListener\" rel=\"Ext.grid.plugin.CellEditing-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
747             "name": "listeners"
748           }
749         ],
750         "name": "observe",
751         "owner": "Ext.util.Observable",
752         "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",
753         "linenr": 69,
754         "return": {
755           "type": "void",
756           "doc": "\n"
757         },
758         "html_filename": "Observable.html"
759       },
760       {
761         "deprecated": null,
762         "alias": {
763           "tagname": "alias",
764           "cls": "Ext.util.Observable",
765           "doc": null,
766           "owner": "addListener"
767         },
768         "protected": false,
769         "tagname": "method",
770         "href": "Observable.html#Ext-util-Observable-method-on",
771         "shortDoc": "Shorthand for addListener. ...",
772         "static": false,
773         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
774         "private": false,
775         "params": [
776           {
777             "type": "String",
778             "optional": false,
779             "doc": "<p>The name of the event to listen for. May also be an object who's property names are\nevent names.</p>\n",
780             "name": "eventName"
781           },
782           {
783             "type": "Function",
784             "optional": false,
785             "doc": "<p>The method the event invokes.  Will be called with arguments given to\n<a href=\"#/api/Ext.grid.plugin.CellEditing-method-fireEvent\" rel=\"Ext.grid.plugin.CellEditing-method-fireEvent\" class=\"docClass\">fireEvent</a> plus the <code>options</code> parameter described below.</p>\n",
786             "name": "handler"
787           },
788           {
789             "type": "Object",
790             "optional": true,
791             "doc": "<p>(optional) The scope (<code>this</code> reference) in which the handler function is executed. <strong>If\nomitted, defaults to the object which fired the event.</strong></p>\n",
792             "name": "scope"
793           },
794           {
795             "type": "Object",
796             "optional": true,
797             "doc": "<p>(optional) An object containing handler configuration.</p>\n\n<p><strong>Note:</strong> Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.</p>\n\n<p>This object may contain any of the following properties:</p>\n\n<ul>\n<li><p><strong>scope</strong> : Object</p>\n\n<p>The scope (<code>this</code> reference) in which the handler function is executed. <strong>If omitted, defaults to the object\nwhich fired the event.</strong></p></li>\n<li><p><strong>delay</strong> : Number</p>\n\n<p>The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>\n<li><p><strong>single</strong> : Boolean</p>\n\n<p>True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>\n<li><p><strong>buffer</strong> : Number</p>\n\n<p>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 by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is <em>not</em> invoked, but the new\nhandler is scheduled in its place.</p></li>\n<li><p><strong>target</strong> : Observable</p>\n\n<p>Only call the handler if the event was fired on the target Observable, <em>not</em> if the event was bubbled up from a\nchild Observable.</p></li>\n<li><p><strong>element</strong> : String</p>\n\n<p><strong>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</strong> The name of a Component\nproperty 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\n<a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:</p>\n\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></li>\n</ul>\n\n\n<p><strong>Combining Options</strong></p>\n\n<p>Using the options argument, it is possible to combine different types of listeners:</p>\n\n<p>A delayed, one-time listener.</p>\n\n<pre><code>myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n</code></pre>\n\n<p><strong>Attaching multiple handlers in 1 call</strong></p>\n\n<p>The method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:</p>\n\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\n<p>One can also specify options for each event handler separately:</p>\n\n<pre><code>myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n</code></pre>\n",
798             "name": "options"
799           }
800         ],
801         "name": "on",
802         "owner": "Ext.util.Observable",
803         "doc": "<p>Shorthand for <a href=\"#/api/Ext.grid.plugin.CellEditing-method-addListener\" rel=\"Ext.grid.plugin.CellEditing-method-addListener\" class=\"docClass\">addListener</a>.</p>\n\n<p>Appends an event handler to this object.</p>\n",
804         "linenr": 669,
805         "return": {
806           "type": "void",
807           "doc": "\n"
808         },
809         "html_filename": "Observable.html"
810       },
811       {
812         "deprecated": null,
813         "alias": null,
814         "protected": false,
815         "tagname": "method",
816         "href": "Base3.html#Ext-Base-method-override",
817         "shortDoc": "Override prototype members of this class. ...",
818         "static": true,
819         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
820         "private": false,
821         "params": [
822           {
823             "type": "Object",
824             "optional": false,
825             "doc": "\n",
826             "name": "members"
827           }
828         ],
829         "name": "override",
830         "owner": "Ext.Base",
831         "doc": "<p>Override prototype members of this class. Overridden methods can be invoked via\n<a href=\"#/api/Ext.Base-method-callOverridden\" rel=\"Ext.Base-method-callOverridden\" class=\"docClass\">Ext.Base.callOverridden</a></p>\n\n<pre><code>Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n</code></pre>\n",
832         "linenr": 518,
833         "return": {
834           "type": "Ext.Base",
835           "doc": "<p>this</p>\n"
836         },
837         "html_filename": "Base3.html"
838       },
839       {
840         "deprecated": null,
841         "alias": null,
842         "protected": false,
843         "tagname": "method",
844         "href": "Observable.html#Ext-util-Observable-method-relayEvents",
845         "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this. ...",
846         "static": false,
847         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
848         "private": false,
849         "params": [
850           {
851             "type": "Object",
852             "optional": false,
853             "doc": "<p>The Observable whose events this object is to relay.</p>\n",
854             "name": "origin"
855           },
856           {
857             "type": "[String]",
858             "optional": false,
859             "doc": "<p>Array of event names to relay.</p>\n",
860             "name": "events"
861           },
862           {
863             "type": "Object",
864             "optional": false,
865             "doc": "\n",
866             "name": "prefix"
867           }
868         ],
869         "name": "relayEvents",
870         "owner": "Ext.util.Observable",
871         "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code>this</code>.</p>\n",
872         "linenr": 573,
873         "return": {
874           "type": "void",
875           "doc": "\n"
876         },
877         "html_filename": "Observable.html"
878       },
879       {
880         "deprecated": null,
881         "alias": null,
882         "protected": false,
883         "tagname": "method",
884         "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
885         "shortDoc": "Removes all added captures from the Observable. ...",
886         "static": true,
887         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
888         "private": false,
889         "params": [
890           {
891             "type": "Observable",
892             "optional": false,
893             "doc": "<p>The Observable to release</p>\n",
894             "name": "o"
895           }
896         ],
897         "name": "releaseCapture",
898         "owner": "Ext.util.Observable",
899         "doc": "<p>Removes <strong>all</strong> added captures from the Observable.</p>\n",
900         "linenr": 44,
901         "return": {
902           "type": "void",
903           "doc": "\n"
904         },
905         "html_filename": "Observable.html"
906       },
907       {
908         "deprecated": null,
909         "alias": null,
910         "protected": false,
911         "tagname": "method",
912         "href": "Observable.html#Ext-util-Observable-method-removeListener",
913         "shortDoc": "Removes an event handler. ...",
914         "static": false,
915         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
916         "private": false,
917         "params": [
918           {
919             "type": "String",
920             "optional": false,
921             "doc": "<p>The type of event the handler was associated with.</p>\n",
922             "name": "eventName"
923           },
924           {
925             "type": "Function",
926             "optional": false,
927             "doc": "<p>The handler to remove. <strong>This must be a reference to the function passed into the\n<a href=\"#/api/Ext.grid.plugin.CellEditing-method-addListener\" rel=\"Ext.grid.plugin.CellEditing-method-addListener\" class=\"docClass\">addListener</a> call.</strong></p>\n",
928             "name": "handler"
929           },
930           {
931             "type": "Object",
932             "optional": true,
933             "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
934             "name": "scope"
935           }
936         ],
937         "name": "removeListener",
938         "owner": "Ext.util.Observable",
939         "doc": "<p>Removes an event handler.</p>\n",
940         "linenr": 392,
941         "return": {
942           "type": "void",
943           "doc": "\n"
944         },
945         "html_filename": "Observable.html"
946       },
947       {
948         "deprecated": null,
949         "alias": null,
950         "protected": false,
951         "tagname": "method",
952         "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
953         "shortDoc": "Removes listeners that were added by the mon method. ...",
954         "static": false,
955         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
956         "private": false,
957         "params": [
958           {
959             "type": "Observable|Element",
960             "optional": false,
961             "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
962             "name": "item"
963           },
964           {
965             "type": "Object|String",
966             "optional": false,
967             "doc": "<p>The event name, or an object containing event name properties.</p>\n",
968             "name": "ename"
969           },
970           {
971             "type": "Function",
972             "optional": false,
973             "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
974             "name": "fn"
975           },
976           {
977             "type": "Object",
978             "optional": false,
979             "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
980             "name": "scope"
981           }
982         ],
983         "name": "removeManagedListener",
984         "owner": "Ext.util.Observable",
985         "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.grid.plugin.CellEditing-method-mon\" rel=\"Ext.grid.plugin.CellEditing-method-mon\" class=\"docClass\">mon</a> method.</p>\n",
986         "linenr": 197,
987         "return": {
988           "type": "void",
989           "doc": "\n"
990         },
991         "html_filename": "Observable.html"
992       },
993       {
994         "deprecated": null,
995         "alias": null,
996         "protected": false,
997         "tagname": "method",
998         "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
999         "shortDoc": "Resumes firing events (see suspendEvents). ...",
1000         "static": false,
1001         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1002         "private": false,
1003         "params": [
1004
1005         ],
1006         "name": "resumeEvents",
1007         "owner": "Ext.util.Observable",
1008         "doc": "<p>Resumes firing events (see <a href=\"#/api/Ext.grid.plugin.CellEditing-method-suspendEvents\" rel=\"Ext.grid.plugin.CellEditing-method-suspendEvents\" class=\"docClass\">suspendEvents</a>).</p>\n\n<p>If events were suspended using the <code>**queueSuspended**</code> parameter, then all events fired\nduring event suspension will be sent to any listeners now.</p>\n",
1009         "linenr": 554,
1010         "return": {
1011           "type": "void",
1012           "doc": "\n"
1013         },
1014         "html_filename": "Observable.html"
1015       },
1016       {
1017         "deprecated": null,
1018         "alias": null,
1019         "protected": false,
1020         "tagname": "method",
1021         "href": "CellEditing.html#Ext-grid-plugin-CellEditing-method-startEdit",
1022         "shortDoc": "Start editing the specified record, using the specified Column definition to define which field is being edited. ...",
1023         "static": false,
1024         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/CellEditing.js",
1025         "private": false,
1026         "params": [
1027           {
1028             "type": "Model",
1029             "optional": false,
1030             "doc": "<p>The Store data record which backs the row to be edited.</p>\n",
1031             "name": "record"
1032           },
1033           {
1034             "type": "Model",
1035             "optional": false,
1036             "doc": "<p>The Column object defining the column to be edited.\n@override</p>\n",
1037             "name": "columnHeader"
1038           }
1039         ],
1040         "name": "startEdit",
1041         "owner": "Ext.grid.plugin.CellEditing",
1042         "doc": "<p>Start editing the specified record, using the specified Column definition to define which field is being edited.</p>\n",
1043         "linenr": 195,
1044         "return": {
1045           "type": "void",
1046           "doc": "\n"
1047         },
1048         "html_filename": "CellEditing.html"
1049       },
1050       {
1051         "deprecated": null,
1052         "alias": null,
1053         "protected": false,
1054         "tagname": "method",
1055         "href": "CellEditing.html#Ext-grid-plugin-CellEditing-method-startEditByPosition",
1056         "shortDoc": "Starts editing by position (row/column) ...",
1057         "static": false,
1058         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/CellEditing.js",
1059         "private": false,
1060         "params": [
1061           {
1062             "type": "Object",
1063             "optional": false,
1064             "doc": "<p>A position with keys of row and column.</p>\n",
1065             "name": "position"
1066           }
1067         ],
1068         "name": "startEditByPosition",
1069         "owner": "Ext.grid.plugin.CellEditing",
1070         "doc": "<p>Starts editing by position (row/column)</p>\n",
1071         "linenr": 379,
1072         "return": {
1073           "type": "void",
1074           "doc": "\n"
1075         },
1076         "html_filename": "CellEditing.html"
1077       },
1078       {
1079         "deprecated": null,
1080         "alias": null,
1081         "protected": true,
1082         "tagname": "method",
1083         "href": "Base3.html#Ext-Base-method-statics",
1084         "shortDoc": "Get the reference to the class from which this object was instantiated. ...",
1085         "static": false,
1086         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
1087         "private": false,
1088         "params": [
1089
1090         ],
1091         "name": "statics",
1092         "owner": "Ext.Base",
1093         "doc": "<p>Get the reference to the class from which this object was instantiated. Note that unlike <a href=\"#/api/Ext.Base-property-self\" rel=\"Ext.Base-property-self\" class=\"docClass\">Ext.Base.self</a>,\n<code>this.statics()</code> is scope-independent and it always returns the class from which it was called, regardless of what\n<code>this</code> points to during run-time</p>\n\n<pre><code>Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n\n        return this;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n</code></pre>\n",
1094         "linenr": 199,
1095         "return": {
1096           "type": "Class",
1097           "doc": "\n"
1098         },
1099         "html_filename": "Base3.html"
1100       },
1101       {
1102         "deprecated": null,
1103         "alias": null,
1104         "protected": false,
1105         "tagname": "method",
1106         "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
1107         "shortDoc": "Suspends the firing of all events. ...",
1108         "static": false,
1109         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1110         "private": false,
1111         "params": [
1112           {
1113             "type": "Boolean",
1114             "optional": false,
1115             "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.grid.plugin.CellEditing-method-resumeEvents\" rel=\"Ext.grid.plugin.CellEditing-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events.</p>\n",
1116             "name": "queueSuspended"
1117           }
1118         ],
1119         "name": "suspendEvents",
1120         "owner": "Ext.util.Observable",
1121         "doc": "<p>Suspends the firing of all events. (see <a href=\"#/api/Ext.grid.plugin.CellEditing-method-resumeEvents\" rel=\"Ext.grid.plugin.CellEditing-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
1122         "linenr": 541,
1123         "return": {
1124           "type": "void",
1125           "doc": "\n"
1126         },
1127         "html_filename": "Observable.html"
1128       },
1129       {
1130         "deprecated": null,
1131         "alias": {
1132           "tagname": "alias",
1133           "cls": "Ext.util.Observable",
1134           "doc": null,
1135           "owner": "removeListener"
1136         },
1137         "protected": false,
1138         "tagname": "method",
1139         "href": "Observable.html#Ext-util-Observable-method-un",
1140         "shortDoc": "Shorthand for removeListener. ...",
1141         "static": false,
1142         "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
1143         "private": false,
1144         "params": [
1145           {
1146             "type": "String",
1147             "optional": false,
1148             "doc": "<p>The type of event the handler was associated with.</p>\n",
1149             "name": "eventName"
1150           },
1151           {
1152             "type": "Function",
1153             "optional": false,
1154             "doc": "<p>The handler to remove. <strong>This must be a reference to the function passed into the\n<a href=\"#/api/Ext.grid.plugin.CellEditing-method-addListener\" rel=\"Ext.grid.plugin.CellEditing-method-addListener\" class=\"docClass\">addListener</a> call.</strong></p>\n",
1155             "name": "handler"
1156           },
1157           {
1158             "type": "Object",
1159             "optional": true,
1160             "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
1161             "name": "scope"
1162           }
1163         ],
1164         "name": "un",
1165         "owner": "Ext.util.Observable",
1166         "doc": "<p>Shorthand for <a href=\"#/api/Ext.grid.plugin.CellEditing-method-removeListener\" rel=\"Ext.grid.plugin.CellEditing-method-removeListener\" class=\"docClass\">removeListener</a>.</p>\n\n<p>Removes an event handler.</p>\n",
1167         "linenr": 675,
1168         "return": {
1169           "type": "void",
1170           "doc": "\n"
1171         },
1172         "html_filename": "Observable.html"
1173       }
1174     ],
1175     "property": [
1176       {
1177         "type": "Class",
1178         "deprecated": null,
1179         "alias": null,
1180         "protected": true,
1181         "tagname": "property",
1182         "href": "Base3.html#Ext-Base-property-self",
1183         "shortDoc": "Get the reference to the current class from which this object was instantiated. ...",
1184         "static": false,
1185         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
1186         "private": false,
1187         "name": "self",
1188         "owner": "Ext.Base",
1189         "doc": "<p>Get the reference to the current class from which this object was instantiated. Unlike <a href=\"#/api/Ext.Base-method-statics\" rel=\"Ext.Base-method-statics\" class=\"docClass\">Ext.Base.statics</a>,\n<code>this.self</code> is scope-dependent and it's meant to be used for dynamic inheritance. See <a href=\"#/api/Ext.Base-method-statics\" rel=\"Ext.Base-method-statics\" class=\"docClass\">Ext.Base.statics</a>\nfor a detailed comparison</p>\n\n<pre><code>Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); / dependent on 'this'\n\n        return this;\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n</code></pre>\n",
1190         "linenr": 18,
1191         "html_filename": "Base3.html"
1192       }
1193     ],
1194     "cssVar": [
1195
1196     ],
1197     "cssMixin": [
1198
1199     ],
1200     "event": [
1201       {
1202         "deprecated": null,
1203         "alias": null,
1204         "protected": false,
1205         "tagname": "event",
1206         "href": "CellEditing.html#Ext-grid-plugin-CellEditing-event-beforeedit",
1207         "shortDoc": "Fires before cell editing is triggered. ...",
1208         "static": false,
1209         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/CellEditing.js",
1210         "private": false,
1211         "params": [
1212           {
1213             "type": "Ext.grid.plugin.Editing",
1214             "optional": false,
1215             "doc": "\n",
1216             "name": "editor"
1217           },
1218           {
1219             "type": "Object",
1220             "optional": false,
1221             "doc": "<p>An edit event (see above for description)</p>\n",
1222             "name": "e"
1223           },
1224           {
1225             "type": "Object",
1226             "tagname": "param",
1227             "name": "options",
1228             "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
1229           }
1230         ],
1231         "name": "beforeedit",
1232         "owner": "Ext.grid.plugin.CellEditing",
1233         "doc": "<p>Fires before cell editing is triggered. The edit event object has the following properties <br /></p>\n\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - The grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value for the field being edited.</li>\n<li>row - The grid table row</li>\n<li>column - The grid <a href=\"#/api/Ext.grid.column.Column\" rel=\"Ext.grid.column.Column\" class=\"docClass\">Column</a> defining the column that is being edited.</li>\n<li>rowIdx - The row index that is being edited</li>\n<li>colIdx - The column index that is being edited</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>\n\n",
1234         "linenr": 68,
1235         "html_filename": "CellEditing.html"
1236       },
1237       {
1238         "deprecated": null,
1239         "alias": null,
1240         "protected": false,
1241         "tagname": "event",
1242         "href": "CellEditing.html#Ext-grid-plugin-CellEditing-event-edit",
1243         "shortDoc": "Fires after a cell is edited. ...",
1244         "static": false,
1245         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/CellEditing.js",
1246         "private": false,
1247         "params": [
1248           {
1249             "type": "Ext.grid.plugin.Editing",
1250             "optional": false,
1251             "doc": "\n",
1252             "name": "editor"
1253           },
1254           {
1255             "type": "Object",
1256             "optional": false,
1257             "doc": "<p>An edit event (see above for description)</p>\n",
1258             "name": "e"
1259           },
1260           {
1261             "type": "Object",
1262             "tagname": "param",
1263             "name": "options",
1264             "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
1265           }
1266         ],
1267         "name": "edit",
1268         "owner": "Ext.grid.plugin.CellEditing",
1269         "doc": "<p>Fires after a cell is edited. The edit event object has the following properties <br /></p>\n\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - The grid</li>\n<li>record - The record that was edited</li>\n<li>field - The field name that was edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid table row</li>\n<li>column - The grid <a href=\"#/api/Ext.grid.column.Column\" rel=\"Ext.grid.column.Column\" class=\"docClass\">Column</a> defining the column that was edited.</li>\n<li>rowIdx - The row index that was edited</li>\n<li>colIdx - The column index that was edited</li>\n</ul>\n\n\n\n\n<pre><code>grid.on('edit', onEdit, this);\n\nfunction onEdit(e) {\n    // execute an XHR to send/commit data to the server, in callback do (if successful):\n    e.record.commit();\n};\n</code></pre>\n\n",
1270         "linenr": 85,
1271         "html_filename": "CellEditing.html"
1272       },
1273       {
1274         "deprecated": null,
1275         "alias": null,
1276         "protected": false,
1277         "tagname": "event",
1278         "href": "CellEditing.html#Ext-grid-plugin-CellEditing-event-validateedit",
1279         "shortDoc": "Fires after a cell is edited, but before the value is set in the record. ...",
1280         "static": false,
1281         "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/CellEditing.js",
1282         "private": false,
1283         "params": [
1284           {
1285             "type": "Ext.grid.plugin.Editing",
1286             "optional": false,
1287             "doc": "\n",
1288             "name": "editor"
1289           },
1290           {
1291             "type": "Object",
1292             "optional": false,
1293             "doc": "<p>An edit event (see above for description)</p>\n",
1294             "name": "e"
1295           },
1296           {
1297             "type": "Object",
1298             "tagname": "param",
1299             "name": "options",
1300             "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
1301           }
1302         ],
1303         "name": "validateedit",
1304         "owner": "Ext.grid.plugin.CellEditing",
1305         "doc": "<p>Fires after a cell is edited, but before the value is set in the record. Return false\nto cancel the change. The edit event object has the following properties <br /></p>\n\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - The grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid table row</li>\n<li>column - The grid <a href=\"#/api/Ext.grid.column.Column\" rel=\"Ext.grid.column.Column\" class=\"docClass\">Column</a> defining the column that is being edited.</li>\n<li>rowIdx - The row index that is being edited</li>\n<li>colIdx - The column index that is being edited</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>\n\n\n<p>Usage example showing how to remove the red triangle (dirty record indicator) from some\nrecords (not all).  By observing the grid's validateedit event, it can be cancelled if\nthe edit occurs on a targeted row (for example) and then setting the field's new value\nin the Record directly:</p>\n\n<pre><code>grid.on('validateedit', function(e) {\n  var myTargetRow = 6;\n\n  if (e.row == myTargetRow) {\n    e.cancel = true;\n    e.record.data[e.field] = e.value;\n  }\n});\n</code></pre>\n\n",
1306         "linenr": 111,
1307         "html_filename": "CellEditing.html"
1308       }
1309     ]
1310   },
1311   "singleton": false,
1312   "alias": null,
1313   "superclasses": [
1314     "Ext.Base",
1315     "Ext.grid.plugin.Editing"
1316   ],
1317   "protected": false,
1318   "tagname": "class",
1319   "mixins": [
1320
1321   ],
1322   "href": "CellEditing.html#Ext-grid-plugin-CellEditing",
1323   "subclasses": [
1324
1325   ],
1326   "static": false,
1327   "author": null,
1328   "component": false,
1329   "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/grid/plugin/CellEditing.js",
1330   "private": false,
1331   "alternateClassNames": [
1332
1333   ],
1334   "name": "Ext.grid.plugin.CellEditing",
1335   "doc": "<p>The <a href=\"#/api/Ext.grid.plugin.CellEditing\" rel=\"Ext.grid.plugin.CellEditing\" class=\"docClass\">Ext.grid.plugin.CellEditing</a> plugin injects editing at a cell level for a Grid. Only a single\ncell will be editable at a time. The field that will be used for the editor is defined at the\nfield. The editor can be a field instance or a field configuration.</p>\n\n<p>If an editor is not specified for a particular column then that cell will not be editable and it will\nbe skipped when activated via the mouse or the keyboard.</p>\n\n<p>The editor may be shared for each column in the grid, or a different one may be specified for each column.\nAn appropriate field type should be chosen to match the data structure that it will be editing. For example,\nto edit a date, it would be useful to specify <a href=\"#/api/Ext.form.field.Date\" rel=\"Ext.form.field.Date\" class=\"docClass\">Ext.form.field.Date</a> as the editor.</p>\n\n<p><p><img src=\"doc-resources/Ext.grid.plugin.CellEditing/Ext.grid.plugin.CellEditing.png\" alt=\"Ext.grid.plugin.CellEditing plugin\"></p></p>\n\n<h2>Example Usage</h2>\n\n<pre><code>Ext.create('Ext.data.Store', {\n    storeId:'simpsonsStore',\n    fields:['name', 'email', 'phone'],\n    data:{'items':[\n        {\"name\":\"Lisa\", \"email\":\"lisa@simpsons.com\", \"phone\":\"555-111-1224\"},\n        {\"name\":\"Bart\", \"email\":\"bart@simpsons.com\", \"phone\":\"555--222-1234\"},\n        {\"name\":\"Homer\", \"email\":\"home@simpsons.com\", \"phone\":\"555-222-1244\"},\n        {\"name\":\"Marge\", \"email\":\"marge@simpsons.com\", \"phone\":\"555-222-1254\"}\n    ]},\n    proxy: {\n        type: 'memory',\n        reader: {\n            type: 'json',\n            root: 'items'\n        }\n    }\n});\n\nExt.create('Ext.grid.Panel', {\n    title: 'Simpsons',\n    store: Ext.data.StoreManager.lookup('simpsonsStore'),\n    columns: [\n        {header: 'Name',  dataIndex: 'name', field: 'textfield'},\n        {header: 'Email', dataIndex: 'email', flex:1,\n            editor: {\n                xtype:'textfield',\n                allowBlank:false\n            }\n        },\n        {header: 'Phone', dataIndex: 'phone'}\n    ],\n    selType: 'cellmodel',\n    plugins: [\n        Ext.create('Ext.grid.plugin.CellEditing', {\n            clicksToEdit: 1\n        })\n    ],\n    height: 200,\n    width: 400,\n    renderTo: Ext.getBody()\n});\n</code></pre>\n",
1336   "mixedInto": [
1337
1338   ],
1339   "linenr": 1,
1340   "xtypes": [
1341
1342   ],
1343   "html_filename": "CellEditing.html",
1344   "extends": "Ext.grid.plugin.Editing"
1345 });