Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.grid.property.Property.js
1 Ext.data.JsonP.Ext_grid_property_Property({
2   "tagname": "class",
3   "name": "Ext.grid.property.Property",
4   "doc": "<p>A specific <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> type that represents a name/value pair and is made to work with the\n<a href=\"#/api/Ext.grid.property.Grid\" rel=\"Ext.grid.property.Grid\" class=\"docClass\">Ext.grid.property.Grid</a>.  Typically, Properties do not need to be created directly as they can be\ncreated implicitly by simply using the appropriate data configs either via the <a href=\"#/api/Ext.grid.property.Grid-cfg-source\" rel=\"Ext.grid.property.Grid-cfg-source\" class=\"docClass\">Ext.grid.property.Grid.source</a>\nconfig property or by calling <a href=\"#/api/Ext.grid.property.Grid-method-setSource\" rel=\"Ext.grid.property.Grid-method-setSource\" class=\"docClass\">Ext.grid.property.Grid.setSource</a>.  However, if the need arises, these records\ncan also be created explicitly as shown below.  Example usage:</p>\n\n<pre><code>var rec = new Ext.grid.property.Property({\n    name: 'birthday',\n    value: Ext.Date.parse('17/06/1962', 'd/m/Y')\n});\n// Add record to an already populated grid\ngrid.store.addSorted(rec);\n</code></pre>\n\n",
5   "extends": "Ext.data.Model",
6   "mixins": [
7
8   ],
9   "alternateClassNames": [
10     "Ext.PropGridProperty"
11   ],
12   "xtype": null,
13   "author": null,
14   "docauthor": null,
15   "singleton": false,
16   "private": false,
17   "cfg": [
18     {
19       "tagname": "cfg",
20       "name": "idProperty",
21       "member": "Ext.data.Model",
22       "type": "String",
23       "doc": "<p>The name of the field treated as this Model's unique id (defaults to 'id').</p>\n",
24       "private": false,
25       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
26       "linenr": 521,
27       "html_filename": "Model.html",
28       "href": "Model.html#Ext-data-Model-cfg-idProperty"
29     },
30     {
31       "tagname": "cfg",
32       "name": "listeners",
33       "member": "Ext.util.Observable",
34       "type": "Object",
35       "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.property.Property-method-addListener\" rel=\"Ext.grid.property.Property-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",
36       "private": false,
37       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
38       "linenr": 103,
39       "html_filename": "Observable.html",
40       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
41       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
42     },
43     {
44       "tagname": "cfg",
45       "name": "persistanceProperty",
46       "member": "Ext.data.Model",
47       "type": "String",
48       "doc": "<p>The property on this Persistable object that its data is saved to.\nDefaults to 'data' (e.g. all persistable data resides in this.data.)</p>\n",
49       "private": false,
50       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
51       "linenr": 503,
52       "html_filename": "Model.html",
53       "href": "Model.html#Ext-data-Model-cfg-persistanceProperty",
54       "shortDoc": "The property on this Persistable object that its data is saved to.\nDefaults to 'data' (e.g. all persistable data resi..."
55     }
56   ],
57   "method": [
58     {
59       "tagname": "method",
60       "name": "Property",
61       "member": "Ext.grid.property.Property",
62       "doc": "\n",
63       "params": [
64         {
65           "type": "Object",
66           "name": "config",
67           "doc": "<p>A data object in the format:</p>\n\n<pre><code>{\n    name: [name],\n    value: [value]\n}</code></pre>\n\n\n<p>The specified value's type\nwill be read automatically by the grid to determine the type of editor to use when displaying it.</p>\n",
68           "optional": false
69         }
70       ],
71       "return": {
72         "type": "void",
73         "doc": "\n"
74       },
75       "private": false,
76       "static": false,
77       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/property/Property.js",
78       "linenr": 1,
79       "html_filename": "Property.html",
80       "href": "Property.html#Ext-grid-property-Property-method-constructor",
81       "shortDoc": "\n"
82     },
83     {
84       "tagname": "method",
85       "name": "addEvents",
86       "member": "Ext.util.Observable",
87       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
88       "params": [
89         {
90           "type": "Object/String",
91           "name": "o",
92           "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",
93           "optional": false
94         },
95         {
96           "type": "String",
97           "name": "",
98           "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",
99           "optional": false
100         }
101       ],
102       "return": {
103         "type": "void",
104         "doc": "\n"
105       },
106       "private": false,
107       "static": false,
108       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
109       "linenr": 452,
110       "html_filename": "Observable.html",
111       "href": "Observable.html#Ext-util-Observable-method-addEvents",
112       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
113     },
114     {
115       "tagname": "method",
116       "name": "addListener",
117       "member": "Ext.util.Observable",
118       "doc": "<p>Appends an event handler to this object.</p>\n",
119       "params": [
120         {
121           "type": "String",
122           "name": "eventName",
123           "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",
124           "optional": false
125         },
126         {
127           "type": "Function",
128           "name": "handler",
129           "doc": "<p>The method the event invokes.</p>\n",
130           "optional": false
131         },
132         {
133           "type": "Object",
134           "name": "scope",
135           "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",
136           "optional": true
137         },
138         {
139           "type": "Object",
140           "name": "options",
141           "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",
142           "optional": true
143         }
144       ],
145       "return": {
146         "type": "void",
147         "doc": "\n"
148       },
149       "private": false,
150       "static": false,
151       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
152       "linenr": 271,
153       "html_filename": "Observable.html",
154       "href": "Observable.html#Ext-util-Observable-method-addListener",
155       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
156     },
157     {
158       "tagname": "method",
159       "name": "addManagedListener",
160       "member": "Ext.util.Observable",
161       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
162       "params": [
163         {
164           "type": "Observable/Element",
165           "name": "item",
166           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
167           "optional": false
168         },
169         {
170           "type": "Object/String",
171           "name": "ename",
172           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
173           "optional": false
174         },
175         {
176           "type": "Function",
177           "name": "fn",
178           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
179           "optional": false
180         },
181         {
182           "type": "Object",
183           "name": "scope",
184           "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",
185           "optional": false
186         },
187         {
188           "type": "Object",
189           "name": "opt",
190           "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",
191           "optional": false
192         }
193       ],
194       "return": {
195         "type": "void",
196         "doc": "\n"
197       },
198       "private": false,
199       "static": false,
200       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
201       "linenr": 155,
202       "html_filename": "Observable.html",
203       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
204       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
205     },
206     {
207       "tagname": "method",
208       "name": "beginEdit",
209       "member": "Ext.data.Model",
210       "doc": "<p>Begin an edit. While in edit mode, no events (e.g.. the <code>update</code> event)\nare relayed to the containing store. When an edit has begun, it must be followed\nby either <a href=\"#/api/Ext.grid.property.Property-method-endEdit\" rel=\"Ext.grid.property.Property-method-endEdit\" class=\"docClass\">endEdit</a> or <a href=\"#/api/Ext.grid.property.Property-method-cancelEdit\" rel=\"Ext.grid.property.Property-method-cancelEdit\" class=\"docClass\">cancelEdit</a>.</p>\n",
211       "params": [
212
213       ],
214       "return": {
215         "type": "void",
216         "doc": "\n"
217       },
218       "private": false,
219       "static": false,
220       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
221       "linenr": 701,
222       "html_filename": "Model.html",
223       "href": "Model.html#Ext-data-Model-method-beginEdit",
224       "shortDoc": "Begin an edit. While in edit mode, no events (e.g.. the update event)\nare relayed to the containing store. When an ed..."
225     },
226     {
227       "tagname": "method",
228       "name": "cancelEdit",
229       "member": "Ext.data.Model",
230       "doc": "<p>Cancels all changes made in the current edit operation.</p>\n",
231       "params": [
232
233       ],
234       "return": {
235         "type": "void",
236         "doc": "\n"
237       },
238       "private": false,
239       "static": false,
240       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
241       "linenr": 716,
242       "html_filename": "Model.html",
243       "href": "Model.html#Ext-data-Model-method-cancelEdit",
244       "shortDoc": "<p>Cancels all changes made in the current edit operation.</p>\n"
245     },
246     {
247       "tagname": "method",
248       "name": "capture",
249       "member": "Ext.util.Observable",
250       "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",
251       "params": [
252         {
253           "type": "Observable",
254           "name": "o",
255           "doc": "<p>The Observable to capture events from.</p>\n",
256           "optional": false
257         },
258         {
259           "type": "Function",
260           "name": "fn",
261           "doc": "<p>The function to call when an event is fired.</p>\n",
262           "optional": false
263         },
264         {
265           "type": "Object",
266           "name": "scope",
267           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
268           "optional": true
269         }
270       ],
271       "return": {
272         "type": "void",
273         "doc": "\n"
274       },
275       "private": false,
276       "static": true,
277       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
278       "linenr": 55,
279       "html_filename": "Observable.html",
280       "href": "Observable.html#Ext-util-Observable-method-capture",
281       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
282     },
283     {
284       "tagname": "method",
285       "name": "clearListeners",
286       "member": "Ext.util.Observable",
287       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
288       "params": [
289
290       ],
291       "return": {
292         "type": "void",
293         "doc": "\n"
294       },
295       "private": false,
296       "static": false,
297       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
298       "linenr": 383,
299       "html_filename": "Observable.html",
300       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
301       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
302     },
303     {
304       "tagname": "method",
305       "name": "clearManagedListeners",
306       "member": "Ext.util.Observable",
307       "doc": "<p>Removes all managed listeners for this object.</p>\n",
308       "params": [
309
310       ],
311       "return": {
312         "type": "void",
313         "doc": "\n"
314       },
315       "private": false,
316       "static": false,
317       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
318       "linenr": 412,
319       "html_filename": "Observable.html",
320       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
321       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
322     },
323     {
324       "tagname": "method",
325       "name": "commit",
326       "member": "Ext.data.Model",
327       "doc": "<p>Usually called by the <a href=\"#/api/Ext.data.Store\" rel=\"Ext.data.Store\" class=\"docClass\">Ext.data.Store</a> which owns the model instance.\nCommits all changes made to the instance since either creation or the last commit operation.</p>\n\n<p>Developers should subscribe to the <a href=\"#/api/Ext.data.Store-event-update\" rel=\"Ext.data.Store-event-update\" class=\"docClass\">Ext.data.Store.update</a> event\nto have their code notified of commit operations.</p>\n\n",
328       "params": [
329         {
330           "type": "Boolean",
331           "name": "silent",
332           "doc": "<p>(optional) True to skip notification of the owning\nstore of the change (defaults to false)</p>\n",
333           "optional": true
334         }
335       ],
336       "return": {
337         "type": "void",
338         "doc": "\n"
339       },
340       "private": false,
341       "static": false,
342       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
343       "linenr": 842,
344       "html_filename": "Model.html",
345       "href": "Model.html#Ext-data-Model-method-commit",
346       "shortDoc": "Usually called by the Ext.data.Store which owns the model instance.\nCommits all changes made to the instance since ei..."
347     },
348     {
349       "tagname": "method",
350       "name": "copy",
351       "member": "Ext.data.Model",
352       "doc": "<p>Creates a copy (clone) of this Model instance.</p>\n",
353       "params": [
354         {
355           "type": "String",
356           "name": "id",
357           "doc": "<p>(optional) A new id, defaults to the id\nof the instance being copied. See <code><a href=\"#/api/Ext.grid.property.Property-method-id\" rel=\"Ext.grid.property.Property-method-id\" class=\"docClass\">id</a></code>.\nTo generate a phantom instance with a new id use:</p>\n\n<pre><code>var rec = record.copy(); // clone the record\nExt.data.Model.id(rec); // automatically generate a unique sequential id\n</code></pre>\n\n",
358           "optional": true
359         }
360       ],
361       "return": {
362         "type": "Record",
363         "doc": "\n"
364       },
365       "private": false,
366       "static": false,
367       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
368       "linenr": 863,
369       "html_filename": "Model.html",
370       "href": "Model.html#Ext-data-Model-method-copy",
371       "shortDoc": "<p>Creates a copy (clone) of this Model instance.</p>\n"
372     },
373     {
374       "tagname": "method",
375       "name": "destroy",
376       "member": "Ext.data.Model",
377       "doc": "<p>Destroys the model using the configured proxy</p>\n",
378       "params": [
379         {
380           "type": "Object",
381           "name": "options",
382           "doc": "<p>Options to pass to the proxy</p>\n",
383           "optional": false
384         }
385       ],
386       "return": {
387         "type": "Ext.data.Model",
388         "doc": "<p>The Model instance</p>\n"
389       },
390       "private": false,
391       "static": false,
392       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
393       "linenr": 991,
394       "html_filename": "Model.html",
395       "href": "Model.html#Ext-data-Model-method-destroy",
396       "shortDoc": "<p>Destroys the model using the configured proxy</p>\n"
397     },
398     {
399       "tagname": "method",
400       "name": "enableBubble",
401       "member": "Ext.util.Observable",
402       "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",
403       "params": [
404         {
405           "type": "String/Array",
406           "name": "events",
407           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
408           "optional": false
409         }
410       ],
411       "return": {
412         "type": "void",
413         "doc": "\n"
414       },
415       "private": false,
416       "static": false,
417       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
418       "linenr": 554,
419       "html_filename": "Observable.html",
420       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
421       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
422     },
423     {
424       "tagname": "method",
425       "name": "endEdit",
426       "member": "Ext.data.Model",
427       "doc": "<p>End an edit. If any data was modified, the containing store is notified\n(ie, the store's <code>update</code> event will fire).</p>\n",
428       "params": [
429         {
430           "type": "Boolean",
431           "name": "silent",
432           "doc": "<p>True to not notify the store of the change</p>\n",
433           "optional": false
434         }
435       ],
436       "return": {
437         "type": "void",
438         "doc": "\n"
439       },
440       "private": false,
441       "static": false,
442       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
443       "linenr": 733,
444       "html_filename": "Model.html",
445       "href": "Model.html#Ext-data-Model-method-endEdit",
446       "shortDoc": "<p>End an edit. If any data was modified, the containing store is notified\n(ie, the store's <code>update</code> event will fire).</p>\n"
447     },
448     {
449       "tagname": "method",
450       "name": "fireEvent",
451       "member": "Ext.util.Observable",
452       "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.property.Property-method-enableBubble\" rel=\"Ext.grid.property.Property-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
453       "params": [
454         {
455           "type": "String",
456           "name": "eventName",
457           "doc": "<p>The name of the event to fire.</p>\n",
458           "optional": false
459         },
460         {
461           "type": "Object...",
462           "name": "args",
463           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
464           "optional": false
465         }
466       ],
467       "return": {
468         "type": "Boolean",
469         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
470       },
471       "private": false,
472       "static": false,
473       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
474       "linenr": 232,
475       "html_filename": "Observable.html",
476       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
477       "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..."
478     },
479     {
480       "tagname": "method",
481       "name": "get",
482       "member": "Ext.data.Model",
483       "doc": "<p>Returns the value of the given field</p>\n",
484       "params": [
485         {
486           "type": "String",
487           "name": "fieldName",
488           "doc": "<p>The field to fetch the value for</p>\n",
489           "optional": false
490         }
491       ],
492       "return": {
493         "type": "Mixed",
494         "doc": "<p>The value</p>\n"
495       },
496       "private": false,
497       "static": false,
498       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
499       "linenr": 618,
500       "html_filename": "Model.html",
501       "href": "Model.html#Ext-data-Model-method-get",
502       "shortDoc": "<p>Returns the value of the given field</p>\n"
503     },
504     {
505       "tagname": "method",
506       "name": "getAssociatedData",
507       "member": "Ext.data.Model",
508       "doc": "<p>Gets all of the data from this Models <em>loaded</em> associations.\nIt does this recursively - for example if we have a User which\nhasMany Orders, and each Order hasMany OrderItems, it will return an object like this:\n{</p>\n\n<pre><code>orders: [\n    {\n        id: 123,\n        status: 'shipped',\n        orderItems: [\n            ...\n        ]\n    }\n]\n</code></pre>\n\n<p>}</p>\n",
509       "params": [
510
511       ],
512       "return": {
513         "type": "Object",
514         "doc": "<p>The nested data set for the Model's loaded associations</p>\n"
515       },
516       "private": false,
517       "static": false,
518       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
519       "linenr": 1102,
520       "html_filename": "Model.html",
521       "href": "Model.html#Ext-data-Model-method-getAssociatedData",
522       "shortDoc": "Gets all of the data from this Models loaded associations.\nIt does this recursively - for example if we have a User w..."
523     },
524     {
525       "tagname": "method",
526       "name": "getChanges",
527       "member": "Ext.data.Model",
528       "doc": "<p>Gets a hash of only the fields that have been modified since this Model was created or commited.</p>\n",
529       "params": [
530
531       ],
532       "return": {
533         "type": "void",
534         "doc": "<p>Object</p>\n"
535       },
536       "private": false,
537       "static": false,
538       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
539       "linenr": 751,
540       "html_filename": "Model.html",
541       "href": "Model.html#Ext-data-Model-method-getChanges",
542       "shortDoc": "<p>Gets a hash of only the fields that have been modified since this Model was created or commited.</p>\n"
543     },
544     {
545       "tagname": "method",
546       "name": "getId",
547       "member": "Ext.data.Model",
548       "doc": "<p>Returns the unique ID allocated to this model instance as defined by <a href=\"#/api/Ext.grid.property.Property-cfg-idProperty\" rel=\"Ext.grid.property.Property-cfg-idProperty\" class=\"docClass\">idProperty</a></p>\n",
549       "params": [
550
551       ],
552       "return": {
553         "type": "Number",
554         "doc": "<p>The id</p>\n"
555       },
556       "private": false,
557       "static": false,
558       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
559       "linenr": 1024,
560       "html_filename": "Model.html",
561       "href": "Model.html#Ext-data-Model-method-getId",
562       "shortDoc": "<p>Returns the unique ID allocated to this model instance as defined by <a href=\"#/api/Ext.grid.property.Property-cfg-idProperty\" rel=\"Ext.grid.property.Property-cfg-idProperty\" class=\"docClass\">idProperty</a></p>\n"
563     },
564     {
565       "tagname": "method",
566       "name": "getProxy",
567       "member": "Ext.data.Model",
568       "doc": "<p>Returns the configured Proxy for this Model</p>\n",
569       "params": [
570
571       ],
572       "return": {
573         "type": "Ext.data.proxy.Proxy",
574         "doc": "<p>The proxy</p>\n"
575       },
576       "private": false,
577       "static": false,
578       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
579       "linenr": 900,
580       "html_filename": "Model.html",
581       "href": "Model.html#Ext-data-Model-method-getProxy",
582       "shortDoc": "<p>Returns the configured Proxy for this Model</p>\n"
583     },
584     {
585       "tagname": "method",
586       "name": "hasListener",
587       "member": "Ext.util.Observable",
588       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
589       "params": [
590         {
591           "type": "String",
592           "name": "eventName",
593           "doc": "<p>The name of the event to check for</p>\n",
594           "optional": false
595         }
596       ],
597       "return": {
598         "type": "Boolean",
599         "doc": "<p>True if the event is being listened for, else false</p>\n"
600       },
601       "private": false,
602       "static": false,
603       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
604       "linenr": 480,
605       "html_filename": "Observable.html",
606       "href": "Observable.html#Ext-util-Observable-method-hasListener",
607       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
608     },
609     {
610       "tagname": "method",
611       "name": "id",
612       "member": "Ext.data.Model",
613       "doc": "<p>Generates a sequential id. This method is typically called when a record is <a href=\"#/api/Ext.grid.property.Property--create\" rel=\"Ext.grid.property.Property--create\" class=\"docClass\">create</a>d\nand <a href=\"#/api/Ext.grid.property.Property--Record\" rel=\"Ext.grid.property.Property--Record\" class=\"docClass\">no id has been specified</a>. The id will automatically be assigned\nto the record. The returned id takes the form:\n<tt>&#123;PREFIX}-&#123;AUTO_ID}</tt>.<div class=\"mdetail-params\"><ul>\n<li><b><tt>PREFIX</tt></b> : String<p class=\"sub-desc\"><tt>Ext.data.Model.PREFIX</tt>\n(defaults to <tt>'ext-record'</tt>)</p></li>\n<li><b><tt>AUTO_ID</tt></b> : String<p class=\"sub-desc\"><tt>Ext.data.Model.AUTO_ID</tt>\n(defaults to <tt>1</tt> initially)</p></li>\n</ul></div></p>\n",
614       "params": [
615         {
616           "type": "Ext.data.Model",
617           "name": "rec",
618           "doc": "<p>The record being created.  The record does not exist, it's a <a href=\"#/api/Ext.grid.property.Property-property-phantom\" rel=\"Ext.grid.property.Property-property-phantom\" class=\"docClass\">phantom</a>.</p>\n",
619           "optional": false
620         }
621       ],
622       "return": {
623         "type": "String",
624         "doc": "<p>auto-generated string id, <tt>\"ext-record-i++'</tt>;</p>\n"
625       },
626       "private": false,
627       "static": true,
628       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
629       "linenr": 468,
630       "html_filename": "Model.html",
631       "href": "Model.html#Ext-data-Model-method-id",
632       "shortDoc": "Generates a sequential id. This method is typically called when a record is created\nand no id has been specified. The..."
633     },
634     {
635       "tagname": "method",
636       "name": "isModified",
637       "member": "Ext.data.Model",
638       "doc": "<p>Returns <tt>true</tt> if the passed field name has been <code><a href=\"#/api/Ext.grid.property.Property-property-modified\" rel=\"Ext.grid.property.Property-property-modified\" class=\"docClass\">modified</a></code>\nsince the load or last commit.</p>\n",
639       "params": [
640         {
641           "type": "String",
642           "name": "fieldName",
643           "doc": "<p><a href=\"#/api/Ext.data.Field-cfg-name\" rel=\"Ext.data.Field-cfg-name\" class=\"docClass\">Ext.data.Field.name</a></p>\n",
644           "optional": false
645         }
646       ],
647       "return": {
648         "type": "Boolean",
649         "doc": "\n"
650       },
651       "private": false,
652       "static": false,
653       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
654       "linenr": 769,
655       "html_filename": "Model.html",
656       "href": "Model.html#Ext-data-Model-method-isModified",
657       "shortDoc": "<p>Returns <tt>true</tt> if the passed field name has been <code><a href=\"#/api/Ext.grid.property.Property-property-modified\" rel=\"Ext.grid.property.Property-property-modified\" class=\"docClass\">modified</a></code>\nsince the load or last commit.</p>\n"
658     },
659     {
660       "tagname": "method",
661       "name": "isValid",
662       "member": "Ext.data.Model",
663       "doc": "<p>Checks if the model is valid. See <a href=\"#/api/Ext.grid.property.Property-method-validate\" rel=\"Ext.grid.property.Property-method-validate\" class=\"docClass\">validate</a>.</p>\n",
664       "params": [
665
666       ],
667       "return": {
668         "type": "Boolean",
669         "doc": "<p>True if the model is valid.</p>\n"
670       },
671       "private": false,
672       "static": false,
673       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
674       "linenr": 940,
675       "html_filename": "Model.html",
676       "href": "Model.html#Ext-data-Model-method-isValid",
677       "shortDoc": "<p>Checks if the model is valid. See <a href=\"#/api/Ext.grid.property.Property-method-validate\" rel=\"Ext.grid.property.Property-method-validate\" class=\"docClass\">validate</a>.</p>\n"
678     },
679     {
680       "tagname": "method",
681       "name": "join",
682       "member": "Ext.data.Model",
683       "doc": "<p>Tells this model instance that it has been added to a store</p>\n",
684       "params": [
685         {
686           "type": "Ext.data.Store",
687           "name": "store",
688           "doc": "<p>The store that the model has been added to</p>\n",
689           "optional": false
690         }
691       ],
692       "return": {
693         "type": "void",
694         "doc": "\n"
695       },
696       "private": false,
697       "static": false,
698       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
699       "linenr": 1040,
700       "html_filename": "Model.html",
701       "href": "Model.html#Ext-data-Model-method-join",
702       "shortDoc": "<p>Tells this model instance that it has been added to a store</p>\n"
703     },
704     {
705       "tagname": "method",
706       "name": "load",
707       "member": "Ext.data.Model",
708       "doc": "<p><b>Static</b>. Asynchronously loads a model instance by id. Sample usage:</p>\n\n<pre><code>    MyApp.User = Ext.define('User', {\n        extend: 'Ext.data.Model',\n        fields: [\n            {name: 'id', type: 'int'},\n            {name: 'name', type: 'string'}\n        ]\n    });\n\n    MyApp.User.load(10, {\n        scope: this,\n        failure: function(record, operation) {\n            //do something if the load failed\n        },\n        success: function(record, operation) {\n            //do something if the load succeeded\n        },\n        callback: function(record, operation) {\n            //do something whether the load succeeded or failed\n        }\n    });\n    </code></pre>\n\n",
709       "params": [
710         {
711           "type": "Number",
712           "name": "id",
713           "doc": "<p>The id of the model to load</p>\n",
714           "optional": false
715         },
716         {
717           "type": "Object",
718           "name": "config",
719           "doc": "<p>Optional config object containing success, failure and callback functions, plus optional scope</p>\n",
720           "optional": false
721         }
722       ],
723       "return": {
724         "type": "void",
725         "doc": "\n"
726       },
727       "private": false,
728       "static": true,
729       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
730       "linenr": 405,
731       "html_filename": "Model.html",
732       "href": "Model.html#Ext-data-Model-method-load",
733       "shortDoc": "Static. Asynchronously loads a model instance by id. Sample usage:\n\n    MyApp.User = Ext.define('User', {\n        ext..."
734     },
735     {
736       "tagname": "method",
737       "name": "observe",
738       "member": "Ext.util.Observable",
739       "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",
740       "params": [
741         {
742           "type": "Function",
743           "name": "c",
744           "doc": "<p>The class constructor to make observable.</p>\n",
745           "optional": false
746         },
747         {
748           "type": "Object",
749           "name": "listeners",
750           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.grid.property.Property-method-addListener\" rel=\"Ext.grid.property.Property-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
751           "optional": false
752         }
753       ],
754       "return": {
755         "type": "void",
756         "doc": "\n"
757       },
758       "private": false,
759       "static": true,
760       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
761       "linenr": 69,
762       "html_filename": "Observable.html",
763       "href": "Observable.html#Ext-util-Observable-method-observe",
764       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
765     },
766     {
767       "tagname": "method",
768       "name": "on",
769       "member": "Ext.util.Observable",
770       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.grid.property.Property-method-addListener\" rel=\"Ext.grid.property.Property-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
771       "params": [
772         {
773           "type": "String",
774           "name": "eventName",
775           "doc": "<p>The type of event to listen for</p>\n",
776           "optional": false
777         },
778         {
779           "type": "Function",
780           "name": "handler",
781           "doc": "<p>The method the event invokes</p>\n",
782           "optional": false
783         },
784         {
785           "type": "Object",
786           "name": "scope",
787           "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",
788           "optional": true
789         },
790         {
791           "type": "Object",
792           "name": "options",
793           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
794           "optional": true
795         }
796       ],
797       "return": {
798         "type": "void",
799         "doc": "\n"
800       },
801       "private": false,
802       "static": false,
803       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
804       "linenr": 616,
805       "html_filename": "Observable.html",
806       "href": "Observable.html#Ext-util-Observable-method-on",
807       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.grid.property.Property-method-addListener\" rel=\"Ext.grid.property.Property-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
808     },
809     {
810       "tagname": "method",
811       "name": "reject",
812       "member": "Ext.data.Model",
813       "doc": "<p>Usually called by the <a href=\"#/api/Ext.data.Store\" rel=\"Ext.data.Store\" class=\"docClass\">Ext.data.Store</a> to which this model instance has been <a href=\"#/api/Ext.grid.property.Property-method-join\" rel=\"Ext.grid.property.Property-method-join\" class=\"docClass\">joined</a>.\nRejects all changes made to the model instance since either creation, or the last commit operation.\nModified fields are reverted to their original values.</p>\n\n<p>Developers should subscribe to the <a href=\"#/api/Ext.data.Store-event-update\" rel=\"Ext.data.Store-event-update\" class=\"docClass\">Ext.data.Store.update</a> event\nto have their code notified of reject operations.</p>\n\n",
814       "params": [
815         {
816           "type": "Boolean",
817           "name": "silent",
818           "doc": "<p>(optional) True to skip notification of the owning\nstore of the change (defaults to false)</p>\n",
819           "optional": true
820         }
821       ],
822       "return": {
823         "type": "void",
824         "doc": "\n"
825       },
826       "private": false,
827       "static": false,
828       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
829       "linenr": 811,
830       "html_filename": "Model.html",
831       "href": "Model.html#Ext-data-Model-method-reject",
832       "shortDoc": "Usually called by the Ext.data.Store to which this model instance has been joined.\nRejects all changes made to the mo..."
833     },
834     {
835       "tagname": "method",
836       "name": "relayEvents",
837       "member": "Ext.util.Observable",
838       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
839       "params": [
840         {
841           "type": "Object",
842           "name": "origin",
843           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
844           "optional": false
845         },
846         {
847           "type": "Array",
848           "name": "events",
849           "doc": "<p>Array of event names to relay.</p>\n",
850           "optional": false
851         },
852         {
853           "type": "Object",
854           "name": "prefix",
855           "doc": "\n",
856           "optional": false
857         }
858       ],
859       "return": {
860         "type": "void",
861         "doc": "\n"
862       },
863       "private": false,
864       "static": false,
865       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
866       "linenr": 520,
867       "html_filename": "Observable.html",
868       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
869       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
870     },
871     {
872       "tagname": "method",
873       "name": "releaseCapture",
874       "member": "Ext.util.Observable",
875       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
876       "params": [
877         {
878           "type": "Observable",
879           "name": "o",
880           "doc": "<p>The Observable to release</p>\n",
881           "optional": false
882         }
883       ],
884       "return": {
885         "type": "void",
886         "doc": "\n"
887       },
888       "private": false,
889       "static": true,
890       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
891       "linenr": 46,
892       "html_filename": "Observable.html",
893       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
894       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
895     },
896     {
897       "tagname": "method",
898       "name": "removeListener",
899       "member": "Ext.util.Observable",
900       "doc": "<p>Removes an event handler.</p>\n",
901       "params": [
902         {
903           "type": "String",
904           "name": "eventName",
905           "doc": "<p>The type of event the handler was associated with.</p>\n",
906           "optional": false
907         },
908         {
909           "type": "Function",
910           "name": "handler",
911           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.grid.property.Property-method-addListener\" rel=\"Ext.grid.property.Property-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
912           "optional": false
913         },
914         {
915           "type": "Object",
916           "name": "scope",
917           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
918           "optional": true
919         }
920       ],
921       "return": {
922         "type": "void",
923         "doc": "\n"
924       },
925       "private": false,
926       "static": false,
927       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
928       "linenr": 352,
929       "html_filename": "Observable.html",
930       "href": "Observable.html#Ext-util-Observable-method-removeListener",
931       "shortDoc": "<p>Removes an event handler.</p>\n"
932     },
933     {
934       "tagname": "method",
935       "name": "removeManagedListener",
936       "member": "Ext.util.Observable",
937       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.grid.property.Property--mon\" rel=\"Ext.grid.property.Property--mon\" class=\"docClass\">mon</a> method.</p>\n",
938       "params": [
939         {
940           "type": "Observable|Element",
941           "name": "item",
942           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
943           "optional": false
944         },
945         {
946           "type": "Object|String",
947           "name": "ename",
948           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
949           "optional": false
950         },
951         {
952           "type": "Function",
953           "name": "fn",
954           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
955           "optional": false
956         },
957         {
958           "type": "Object",
959           "name": "scope",
960           "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",
961           "optional": false
962         }
963       ],
964       "return": {
965         "type": "void",
966         "doc": "\n"
967       },
968       "private": false,
969       "static": false,
970       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
971       "linenr": 196,
972       "html_filename": "Observable.html",
973       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
974       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.grid.property.Property--mon\" rel=\"Ext.grid.property.Property--mon\" class=\"docClass\">mon</a> method.</p>\n"
975     },
976     {
977       "tagname": "method",
978       "name": "resumeEvents",
979       "member": "Ext.util.Observable",
980       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.grid.property.Property-method-suspendEvents\" rel=\"Ext.grid.property.Property-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",
981       "params": [
982
983       ],
984       "return": {
985         "type": "void",
986         "doc": "\n"
987       },
988       "private": false,
989       "static": false,
990       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
991       "linenr": 502,
992       "html_filename": "Observable.html",
993       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
994       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
995     },
996     {
997       "tagname": "method",
998       "name": "save",
999       "member": "Ext.data.Model",
1000       "doc": "<p>Saves the model instance using the configured proxy</p>\n",
1001       "params": [
1002         {
1003           "type": "Object",
1004           "name": "options",
1005           "doc": "<p>Options to pass to the proxy</p>\n",
1006           "optional": false
1007         }
1008       ],
1009       "return": {
1010         "type": "Ext.data.Model",
1011         "doc": "<p>The Model instance</p>\n"
1012       },
1013       "private": false,
1014       "static": false,
1015       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
1016       "linenr": 948,
1017       "html_filename": "Model.html",
1018       "href": "Model.html#Ext-data-Model-method-save",
1019       "shortDoc": "<p>Saves the model instance using the configured proxy</p>\n"
1020     },
1021     {
1022       "tagname": "method",
1023       "name": "set",
1024       "member": "Ext.data.Model",
1025       "doc": "<p>Sets the given field to the given value, marks the instance as dirty</p>\n",
1026       "params": [
1027         {
1028           "type": "String|Object",
1029           "name": "fieldName",
1030           "doc": "<p>The field to set, or an object containing key/value pairs</p>\n",
1031           "optional": false
1032         },
1033         {
1034           "type": "Mixed",
1035           "name": "value",
1036           "doc": "<p>The value to set</p>\n",
1037           "optional": false
1038         }
1039       ],
1040       "return": {
1041         "type": "void",
1042         "doc": "\n"
1043       },
1044       "private": false,
1045       "static": false,
1046       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
1047       "linenr": 627,
1048       "html_filename": "Model.html",
1049       "href": "Model.html#Ext-data-Model-method-set",
1050       "shortDoc": "<p>Sets the given field to the given value, marks the instance as dirty</p>\n"
1051     },
1052     {
1053       "tagname": "method",
1054       "name": "setDirty",
1055       "member": "Ext.data.Model",
1056       "doc": "<p>Marks this <b>Record</b> as <code><a href=\"#/api/Ext.grid.property.Property-property-dirty\" rel=\"Ext.grid.property.Property-property-dirty\" class=\"docClass\">dirty</a></code>.  This method\nis used interally when adding <code><a href=\"#/api/Ext.grid.property.Property-property-phantom\" rel=\"Ext.grid.property.Property-property-phantom\" class=\"docClass\">phantom</a></code> records to a\n<a href=\"#/api/Ext.data.Store--writer\" rel=\"Ext.data.Store--writer\" class=\"docClass\">writer enabled store</a>.</p>\n\n\n<br><p>Marking a record <code><a href=\"#/api/Ext.grid.property.Property-property-dirty\" rel=\"Ext.grid.property.Property-property-dirty\" class=\"docClass\">dirty</a></code> causes the phantom to\n\n\n<p>be returned by <a href=\"#/api/Ext.data.Store--getModifiedRecords\" rel=\"Ext.data.Store--getModifiedRecords\" class=\"docClass\">Ext.data.Store.getModifiedRecords</a> where it will\nhave a create action composed for it during <a href=\"#/api/Ext.data.Store--save\" rel=\"Ext.data.Store--save\" class=\"docClass\">store save</a>\noperations.</p></p>\n",
1057       "params": [
1058
1059       ],
1060       "return": {
1061         "type": "void",
1062         "doc": "\n"
1063       },
1064       "private": false,
1065       "static": false,
1066       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
1067       "linenr": 779,
1068       "html_filename": "Model.html",
1069       "href": "Model.html#Ext-data-Model-method-setDirty",
1070       "shortDoc": "Marks this Record as dirty.  This method\nis used interally when adding phantom records to a\nwriter enabled store.\n\n\nM..."
1071     },
1072     {
1073       "tagname": "method",
1074       "name": "setId",
1075       "member": "Ext.data.Model",
1076       "doc": "<p>Sets the model instance's id field to the given id</p>\n",
1077       "params": [
1078         {
1079           "type": "Number",
1080           "name": "id",
1081           "doc": "<p>The new id</p>\n",
1082           "optional": false
1083         }
1084       ],
1085       "return": {
1086         "type": "void",
1087         "doc": "\n"
1088       },
1089       "private": false,
1090       "static": false,
1091       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
1092       "linenr": 1032,
1093       "html_filename": "Model.html",
1094       "href": "Model.html#Ext-data-Model-method-setId",
1095       "shortDoc": "<p>Sets the model instance's id field to the given id</p>\n"
1096     },
1097     {
1098       "tagname": "method",
1099       "name": "setProxy",
1100       "member": "Ext.data.Model",
1101       "doc": "<p>Sets the Proxy to use for this model. Accepts any options that can be accepted by <a href=\"#/api/Ext-method-createByAlias\" rel=\"Ext-method-createByAlias\" class=\"docClass\">Ext.createByAlias</a></p>\n",
1102       "params": [
1103         {
1104           "type": "String/Object/Ext.data.proxy.Proxy",
1105           "name": "proxy",
1106           "doc": "<p>The proxy</p>\n",
1107           "optional": false
1108         }
1109       ],
1110       "return": {
1111         "type": "void",
1112         "doc": "\n"
1113       },
1114       "private": false,
1115       "static": true,
1116       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
1117       "linenr": 879,
1118       "html_filename": "Model.html",
1119       "href": "Model.html#Ext-data-Model-method-setProxy",
1120       "shortDoc": "<p>Sets the Proxy to use for this model. Accepts any options that can be accepted by <a href=\"#/api/Ext-method-createByAlias\" rel=\"Ext-method-createByAlias\" class=\"docClass\">Ext.createByAlias</a></p>\n"
1121     },
1122     {
1123       "tagname": "method",
1124       "name": "suspendEvents",
1125       "member": "Ext.util.Observable",
1126       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.grid.property.Property-method-resumeEvents\" rel=\"Ext.grid.property.Property-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
1127       "params": [
1128         {
1129           "type": "Boolean",
1130           "name": "queueSuspended",
1131           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.grid.property.Property-method-resumeEvents\" rel=\"Ext.grid.property.Property-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
1132           "optional": false
1133         }
1134       ],
1135       "return": {
1136         "type": "void",
1137         "doc": "\n"
1138       },
1139       "private": false,
1140       "static": false,
1141       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1142       "linenr": 490,
1143       "html_filename": "Observable.html",
1144       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
1145       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.grid.property.Property-method-resumeEvents\" rel=\"Ext.grid.property.Property-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
1146     },
1147     {
1148       "tagname": "method",
1149       "name": "un",
1150       "member": "Ext.util.Observable",
1151       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.grid.property.Property-method-removeListener\" rel=\"Ext.grid.property.Property-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
1152       "params": [
1153         {
1154           "type": "String",
1155           "name": "eventName",
1156           "doc": "<p>The type of event the handler was associated with.</p>\n",
1157           "optional": false
1158         },
1159         {
1160           "type": "Function",
1161           "name": "handler",
1162           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.grid.property.Property-method-addListener\" rel=\"Ext.grid.property.Property-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
1163           "optional": false
1164         },
1165         {
1166           "type": "Object",
1167           "name": "scope",
1168           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
1169           "optional": true
1170         }
1171       ],
1172       "return": {
1173         "type": "void",
1174         "doc": "\n"
1175       },
1176       "private": false,
1177       "static": false,
1178       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1179       "linenr": 608,
1180       "html_filename": "Observable.html",
1181       "href": "Observable.html#Ext-util-Observable-method-un",
1182       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.grid.property.Property-method-removeListener\" rel=\"Ext.grid.property.Property-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
1183     },
1184     {
1185       "tagname": "method",
1186       "name": "unjoin",
1187       "member": "Ext.data.Model",
1188       "doc": "<p>Tells this model instance that it has been removed from the store</p>\n",
1189       "params": [
1190
1191       ],
1192       "return": {
1193         "type": "void",
1194         "doc": "\n"
1195       },
1196       "private": false,
1197       "static": false,
1198       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
1199       "linenr": 1053,
1200       "html_filename": "Model.html",
1201       "href": "Model.html#Ext-data-Model-method-unjoin",
1202       "shortDoc": "<p>Tells this model instance that it has been removed from the store</p>\n"
1203     },
1204     {
1205       "tagname": "method",
1206       "name": "validate",
1207       "member": "Ext.data.Model",
1208       "doc": "<p>Validates the current data against all of its configured <a href=\"#/api/Ext.grid.property.Property--validations\" rel=\"Ext.grid.property.Property--validations\" class=\"docClass\">validations</a> and returns an\n<a href=\"#/api/Ext.data.Errors\" rel=\"Ext.data.Errors\" class=\"docClass\">Errors</a> object</p>\n",
1209       "params": [
1210
1211       ],
1212       "return": {
1213         "type": "Ext.data.Errors",
1214         "doc": "<p>The errors object</p>\n"
1215       },
1216       "private": false,
1217       "static": false,
1218       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
1219       "linenr": 908,
1220       "html_filename": "Model.html",
1221       "href": "Model.html#Ext-data-Model-method-validate",
1222       "shortDoc": "<p>Validates the current data against all of its configured <a href=\"#/api/Ext.grid.property.Property--validations\" rel=\"Ext.grid.property.Property--validations\" class=\"docClass\">validations</a> and returns an\n<a href=\"#/api/Ext.data.Errors\" rel=\"Ext.data.Errors\" class=\"docClass\">Errors</a> object</p>\n"
1223     }
1224   ],
1225   "property": [
1226     {
1227       "tagname": "property",
1228       "name": "defaultProxyType",
1229       "member": "Ext.data.Model",
1230       "type": "String",
1231       "doc": "<p>The string type of the default Model Proxy. Defaults to 'ajax'</p>\n",
1232       "private": false,
1233       "static": false,
1234       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
1235       "linenr": 526,
1236       "html_filename": "Model.html",
1237       "href": "Model.html#Ext-data-Model-property-defaultProxyType"
1238     },
1239     {
1240       "tagname": "property",
1241       "name": "dirty",
1242       "member": "Ext.data.Model",
1243       "type": "Boolean",
1244       "doc": "<p>Readonly flag - true if this Record has been modified.</p>\n",
1245       "private": false,
1246       "static": false,
1247       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
1248       "linenr": 497,
1249       "html_filename": "Model.html",
1250       "href": "Model.html#Ext-data-Model-property-dirty"
1251     },
1252     {
1253       "tagname": "property",
1254       "name": "editing",
1255       "member": "Ext.data.Model",
1256       "type": "Boolean",
1257       "doc": "<p>Internal flag used to track whether or not the model instance is currently being edited. Read-only</p>\n",
1258       "private": false,
1259       "static": false,
1260       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
1261       "linenr": 490,
1262       "html_filename": "Model.html",
1263       "href": "Model.html#Ext-data-Model-property-editing"
1264     },
1265     {
1266       "tagname": "property",
1267       "name": "fields",
1268       "member": "Ext.data.Model",
1269       "type": "Array",
1270       "doc": "<p>An array of the fields defined on this model</p>\n",
1271       "private": false,
1272       "static": false,
1273       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
1274       "linenr": 533,
1275       "html_filename": "Model.html",
1276       "href": "Model.html#Ext-data-Model-property-fields"
1277     },
1278     {
1279       "tagname": "property",
1280       "name": "modified",
1281       "member": "Ext.data.Model",
1282       "type": "Object",
1283       "doc": "<p>Key: value pairs of all fields whose values have changed</p>\n",
1284       "private": false,
1285       "static": false,
1286       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
1287       "linenr": 571,
1288       "html_filename": "Model.html",
1289       "href": "Model.html#Ext-data-Model-property-modified"
1290     },
1291     {
1292       "tagname": "property",
1293       "name": "phantom",
1294       "member": "Ext.data.Model",
1295       "type": "Boolean",
1296       "doc": "<p><tt>true</tt> when the record does not yet exist in a server-side database (see\n<a href=\"#/api/Ext.grid.property.Property-method-setDirty\" rel=\"Ext.grid.property.Property-method-setDirty\" class=\"docClass\">setDirty</a>).  Any record which has a real database pk set as its id property\nis NOT a phantom -- it's real.</p>\n",
1297       "private": false,
1298       "static": false,
1299       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
1300       "linenr": 512,
1301       "html_filename": "Model.html",
1302       "href": "Model.html#Ext-data-Model-property-phantom",
1303       "shortDoc": "true when the record does not yet exist in a server-side database (see\nsetDirty).  Any record which has a real databa..."
1304     },
1305     {
1306       "tagname": "property",
1307       "name": "raw",
1308       "member": "Ext.data.Model",
1309       "type": "Object",
1310       "doc": "<p>The raw data used to create this model if created via a reader.</p>\n",
1311       "private": false,
1312       "static": false,
1313       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
1314       "linenr": 560,
1315       "html_filename": "Model.html",
1316       "href": "Model.html#Ext-data-Model-property-raw"
1317     },
1318     {
1319       "tagname": "property",
1320       "name": "store",
1321       "member": "Ext.data.Model",
1322       "type": "Ext.data.Store",
1323       "doc": "<p>The <a href=\"#/api/Ext.data.Store\" rel=\"Ext.data.Store\" class=\"docClass\">Ext.data.Store</a> to which this Record belongs.</p>\n",
1324       "private": false,
1325       "static": false,
1326       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/Model.js",
1327       "linenr": 1045,
1328       "html_filename": "Model.html",
1329       "href": "Model.html#Ext-data-Model-property-store"
1330     }
1331   ],
1332   "event": [
1333
1334   ],
1335   "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/property/Property.js",
1336   "linenr": 1,
1337   "html_filename": "Property.html",
1338   "href": "Property.html#Ext-grid-property-Property",
1339   "cssVar": [
1340
1341   ],
1342   "cssMixin": [
1343
1344   ],
1345   "component": false,
1346   "superclasses": [
1347     "Ext.data.Model"
1348   ],
1349   "subclasses": [
1350
1351   ],
1352   "mixedInto": [
1353
1354   ],
1355   "allMixins": [
1356     "Ext.util.Observable"
1357   ]
1358 });