Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.form.Basic.js
1 Ext.data.JsonP.Ext_form_Basic({
2   "tagname": "class",
3   "name": "Ext.form.Basic",
4   "doc": "<p>Provides input field management, validation, submission, and form loading services for the collection\nof <a href=\"#/api/Ext.form.field.Field\" rel=\"Ext.form.field.Field\" class=\"docClass\">Field</a> instances within a <a href=\"#/api/Ext.container.Container\" rel=\"Ext.container.Container\" class=\"docClass\">Ext.container.Container</a>. It is recommended\nthat you use a <a href=\"#/api/Ext.form.Panel\" rel=\"Ext.form.Panel\" class=\"docClass\">Ext.form.Panel</a> as the form container, as that has logic to automatically\nhook up an instance of <a href=\"#/api/Ext.form.Basic\" rel=\"Ext.form.Basic\" class=\"docClass\">Ext.form.Basic</a> (plus other conveniences related to field configuration.)</p>\n\n<h1>Form Actions</h1>\n\n<p>The Basic class delegates the handling of form loads and submits to instances of <a href=\"#/api/Ext.form.action.Action\" rel=\"Ext.form.action.Action\" class=\"docClass\">Ext.form.action.Action</a>.\nSee the various Action implementations for specific details of each one's functionality, as well as the\ndocumentation for <a href=\"#/api/Ext.form.Basic-method-doAction\" rel=\"Ext.form.Basic-method-doAction\" class=\"docClass\">doAction</a> which details the configuration options that can be specified in\neach action call.</p>\n\n<p>The default submit Action is <a href=\"#/api/Ext.form.action.Submit\" rel=\"Ext.form.action.Submit\" class=\"docClass\">Ext.form.action.Submit</a>, which uses an Ajax request to submit the\nform's values to a configured URL. To enable normal browser submission of an <a href=\"#/api/Ext\" rel=\"Ext\" class=\"docClass\">Ext</a> form, use the\n<a href=\"#/api/Ext.form.Basic-cfg-standardSubmit\" rel=\"Ext.form.Basic-cfg-standardSubmit\" class=\"docClass\">standardSubmit</a> config option.</p>\n\n<p>Note: File uploads are not performed using normal 'Ajax' techniques; see the description for\n<a href=\"#/api/Ext.form.Basic-method-hasUpload\" rel=\"Ext.form.Basic-method-hasUpload\" class=\"docClass\">hasUpload</a> for details.</p>\n\n<h1>Example usage:</h1>\n\n<pre><code>Ext.create('Ext.form.Panel', {\n    title: 'Basic Form',\n    renderTo: Ext.getBody(),\n    bodyPadding: 5,\n    width: 350,\n\n    // Any configuration items here will be automatically passed along to\n    // the <a href=\"#/api/Ext.form.Basic\" rel=\"Ext.form.Basic\" class=\"docClass\">Ext.form.Basic</a> instance when it gets created.\n\n    // The form will submit an AJAX request to this URL when submitted\n    url: 'save-form.php',\n\n    items: [{\n        fieldLabel: 'Field',\n        name: 'theField'\n    }],\n\n    buttons: [{\n        text: 'Submit',\n        handler: function() {\n            // The getForm() method returns the <a href=\"#/api/Ext.form.Basic\" rel=\"Ext.form.Basic\" class=\"docClass\">Ext.form.Basic</a> instance:\n            var form = this.up('form').getForm();\n            if (form.isValid()) {\n                // Submit the Ajax request and handle the response\n                form.submit({\n                    success: function(form, action) {\n                       Ext.Msg.alert('Success', action.result.msg);\n                    },\n                    failure: function(form, action) {\n                        Ext.Msg.alert('Failed', action.result.msg);\n                    }\n                });\n            }\n        }\n    }]\n});\n</code></pre>\n",
5   "extends": "Ext.util.Observable",
6   "mixins": [
7
8   ],
9   "alternateClassNames": [
10     "Ext.form.BasicForm"
11   ],
12   "xtype": null,
13   "author": null,
14   "docauthor": null,
15   "singleton": false,
16   "private": false,
17   "cfg": [
18     {
19       "tagname": "cfg",
20       "name": "api",
21       "member": "Ext.form.Basic",
22       "type": "Object",
23       "doc": "<p>(Optional) If specified, load and submit actions will be handled\nwith <a href=\"#/api/Ext.form.action.DirectLoad\" rel=\"Ext.form.action.DirectLoad\" class=\"docClass\">Ext.form.action.DirectLoad</a> and <a href=\"#/api/Ext.form.action.DirectLoad\" rel=\"Ext.form.action.DirectLoad\" class=\"docClass\">Ext.form.action.DirectLoad</a>.\nMethods which have been imported by <a href=\"#/api/Ext.direct.Manager\" rel=\"Ext.direct.Manager\" class=\"docClass\">Ext.direct.Manager</a> can be specified here to load and submit\nforms.\nSuch as the following:</p>\n\n<pre><code>api: {\n    load: App.ss.MyProfile.load,\n    submit: App.ss.MyProfile.submit\n}\n</code></pre>\n\n\n<p>Load actions can use <code><a href=\"#/api/Ext.form.Basic-cfg-paramOrder\" rel=\"Ext.form.Basic-cfg-paramOrder\" class=\"docClass\">paramOrder</a></code> or <code><a href=\"#/api/Ext.form.Basic-cfg-paramsAsHash\" rel=\"Ext.form.Basic-cfg-paramsAsHash\" class=\"docClass\">paramsAsHash</a></code>\nto customize how the load method is invoked.\nSubmit actions will always use a standard form submit. The <tt>formHandler</tt> configuration must\nbe set on the associated server-side method which has been imported by <a href=\"#/api/Ext.direct.Manager\" rel=\"Ext.direct.Manager\" class=\"docClass\">Ext.direct.Manager</a>.</p>\n\n",
24       "private": false,
25       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
26       "linenr": 201,
27       "html_filename": "Basic.html",
28       "href": "Basic.html#Ext-form-Basic-cfg-api",
29       "shortDoc": "(Optional) If specified, load and submit actions will be handled\nwith Ext.form.action.DirectLoad and Ext.form.action...."
30     },
31     {
32       "tagname": "cfg",
33       "name": "baseParams",
34       "member": "Ext.form.Basic",
35       "type": "Object",
36       "doc": "<p>Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.</p>\n\n\n<p>Parameters are encoded as standard HTTP parameters using <a href=\"#/api/Ext-method-urlEncode\" rel=\"Ext-method-urlEncode\" class=\"docClass\">Ext.Object.toQueryString</a>.</p>\n\n",
37       "private": false,
38       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
39       "linenr": 190,
40       "html_filename": "Basic.html",
41       "href": "Basic.html#Ext-form-Basic-cfg-baseParams",
42       "shortDoc": "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.\n\n\nParameters are encoded as standard ..."
43     },
44     {
45       "tagname": "cfg",
46       "name": "errorReader",
47       "member": "Ext.form.Basic",
48       "type": "Ext.data.reader.Reader",
49       "doc": "<p>An Ext.data.DataReader (e.g. <a href=\"#/api/Ext.data.reader.Xml\" rel=\"Ext.data.reader.Xml\" class=\"docClass\">Ext.data.reader.Xml</a>) to be used to\nread field error messages returned from 'submit' actions. This is optional\nas there is built-in support for processing JSON responses.</p>\n\n\n<p>The Records which provide messages for the invalid Fields must use the\nField name (or id) as the Record ID, and must contain a field called 'msg'\nwhich contains the error message.</p>\n\n\n<p>The errorReader does not have to be a full-blown implementation of a\nReader. It simply needs to implement a <tt>read(xhr)</tt> function\nwhich returns an Array of Records in an object with the following\nstructure:</p>\n\n\n<pre><code>{\n    records: recordArray\n}\n</code></pre>\n\n",
50       "private": false,
51       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
52       "linenr": 166,
53       "html_filename": "Basic.html",
54       "href": "Basic.html#Ext-form-Basic-cfg-errorReader",
55       "shortDoc": "An Ext.data.DataReader (e.g. Ext.data.reader.Xml) to be used to\nread field error messages returned from 'submit' acti..."
56     },
57     {
58       "tagname": "cfg",
59       "name": "listeners",
60       "member": "Ext.util.Observable",
61       "type": "Object",
62       "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.form.Basic-method-addListener\" rel=\"Ext.form.Basic-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",
63       "private": false,
64       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
65       "linenr": 103,
66       "html_filename": "Observable.html",
67       "href": "Observable.html#Ext-util-Observable-cfg-listeners",
68       "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization.  T..."
69     },
70     {
71       "tagname": "cfg",
72       "name": "method",
73       "member": "Ext.form.Basic",
74       "type": "String",
75       "doc": "<p>The request method to use (GET or POST) for form actions if one isn't supplied in the action options.</p>\n",
76       "private": false,
77       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
78       "linenr": 156,
79       "html_filename": "Basic.html",
80       "href": "Basic.html#Ext-form-Basic-cfg-method"
81     },
82     {
83       "tagname": "cfg",
84       "name": "paramOrder",
85       "member": "Ext.form.Basic",
86       "type": "Array/String",
87       "doc": "<p>A list of params to be executed server side.\nDefaults to <tt>undefined</tt>. Only used for the <code><a href=\"#/api/Ext.form.Basic-cfg-api\" rel=\"Ext.form.Basic-cfg-api\" class=\"docClass\">api</a></code>\n<code>load</code> configuration.</p>\n\n\n<p>Specify the params in the order in which they must be executed on the\nserver-side as either (1) an Array of String values, or (2) a String of params\ndelimited by either whitespace, comma, or pipe. For example,\nany of the following would be acceptable:</p>\n\n\n<pre><code>paramOrder: ['param1','param2','param3']\nparamOrder: 'param1 param2 param3'\nparamOrder: 'param1,param2,param3'\nparamOrder: 'param1|param2|param'\n     </code></pre>\n\n",
88       "private": false,
89       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
90       "linenr": 218,
91       "html_filename": "Basic.html",
92       "href": "Basic.html#Ext-form-Basic-cfg-paramOrder",
93       "shortDoc": "A list of params to be executed server side.\nDefaults to undefined. Only used for the api\nload configuration.\n\n\nSpeci..."
94     },
95     {
96       "tagname": "cfg",
97       "name": "paramsAsHash",
98       "member": "Ext.form.Basic",
99       "type": "Boolean",
100       "doc": "<p>Only used for the <code><a href=\"#/api/Ext.form.Basic-cfg-api\" rel=\"Ext.form.Basic-cfg-api\" class=\"docClass\">api</a></code>\n<code>load</code> configuration. If <tt>true</tt>, parameters will be sent as a\nsingle hash collection of named arguments (defaults to <tt>false</tt>). Providing a\n<tt><a href=\"#/api/Ext.form.Basic-cfg-paramOrder\" rel=\"Ext.form.Basic-cfg-paramOrder\" class=\"docClass\">paramOrder</a></tt> nullifies this configuration.</p>\n",
101       "private": false,
102       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
103       "linenr": 233,
104       "html_filename": "Basic.html",
105       "href": "Basic.html#Ext-form-Basic-cfg-paramsAsHash",
106       "shortDoc": "Only used for the api\nload configuration. If true, parameters will be sent as a\nsingle hash collection of named argum..."
107     },
108     {
109       "tagname": "cfg",
110       "name": "reader",
111       "member": "Ext.form.Basic",
112       "type": "Ext.data.reader.Reader",
113       "doc": "<p>An Ext.data.DataReader (e.g. <a href=\"#/api/Ext.data.reader.Xml\" rel=\"Ext.data.reader.Xml\" class=\"docClass\">Ext.data.reader.Xml</a>) to be used to read\ndata when executing 'load' actions. This is optional as there is built-in\nsupport for processing JSON responses.</p>\n",
114       "private": false,
115       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
116       "linenr": 160,
117       "html_filename": "Basic.html",
118       "href": "Basic.html#Ext-form-Basic-cfg-reader",
119       "shortDoc": "An Ext.data.DataReader (e.g. Ext.data.reader.Xml) to be used to read\ndata when executing 'load' actions. This is opti..."
120     },
121     {
122       "tagname": "cfg",
123       "name": "standardSubmit",
124       "member": "Ext.form.Basic",
125       "type": "Boolean",
126       "doc": "<p>If set to <tt>true</tt>, a standard HTML form submit is used instead\nof a XHR (Ajax) style form submission. Defaults to <tt>false</tt>. All of\nthe field values, plus any additional params configured via <a href=\"#/api/Ext.form.Basic-cfg-baseParams\" rel=\"Ext.form.Basic-cfg-baseParams\" class=\"docClass\">baseParams</a>\nand/or the <code>options</code> to <a href=\"#/api/Ext.form.Basic-method-submit\" rel=\"Ext.form.Basic-method-submit\" class=\"docClass\">submit</a>, will be included in the\nvalues submitted in the form.</p>\n\n",
127       "private": false,
128       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
129       "linenr": 253,
130       "html_filename": "Basic.html",
131       "href": "Basic.html#Ext-form-Basic-cfg-standardSubmit",
132       "shortDoc": "If set to true, a standard HTML form submit is used instead\nof a XHR (Ajax) style form submission. Defaults to false...."
133     },
134     {
135       "tagname": "cfg",
136       "name": "timeout",
137       "member": "Ext.form.Basic",
138       "type": "Number",
139       "doc": "<p>Timeout for form actions in seconds (default is 30 seconds).</p>\n",
140       "private": false,
141       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
142       "linenr": 196,
143       "html_filename": "Basic.html",
144       "href": "Basic.html#Ext-form-Basic-cfg-timeout"
145     },
146     {
147       "tagname": "cfg",
148       "name": "trackResetOnLoad",
149       "member": "Ext.form.Basic",
150       "type": "Boolean",
151       "doc": "<p>If set to <tt>true</tt>, <a href=\"#/api/Ext.form.Basic-method-reset\" rel=\"Ext.form.Basic-method-reset\" class=\"docClass\">reset</a>() resets to the last loaded\nor <a href=\"#/api/Ext.form.Basic-method-setValues\" rel=\"Ext.form.Basic-method-setValues\" class=\"docClass\">setValues</a>() data instead of when the form was first created.  Defaults to <tt>false</tt>.</p>\n",
152       "private": false,
153       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
154       "linenr": 247,
155       "html_filename": "Basic.html",
156       "href": "Basic.html#Ext-form-Basic-cfg-trackResetOnLoad",
157       "shortDoc": "If set to true, reset() resets to the last loaded\nor setValues() data instead of when the form was first created.  De..."
158     },
159     {
160       "tagname": "cfg",
161       "name": "url",
162       "member": "Ext.form.Basic",
163       "type": "String",
164       "doc": "<p>The URL to use for form actions if one isn't supplied in the\n<a href=\"#/api/Ext.form.Basic-method-doAction\" rel=\"Ext.form.Basic-method-doAction\" class=\"docClass\">doAction</a> options.</p>\n",
165       "private": false,
166       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
167       "linenr": 184,
168       "html_filename": "Basic.html",
169       "href": "Basic.html#Ext-form-Basic-cfg-url"
170     },
171     {
172       "tagname": "cfg",
173       "name": "waitMsgTarget",
174       "member": "Ext.form.Basic",
175       "type": "Mixed",
176       "doc": "<p>By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific\nelement by passing it or its id or mask the form itself by passing in true. Defaults to <tt>undefined</tt>.</p>\n",
177       "private": false,
178       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
179       "linenr": 262,
180       "html_filename": "Basic.html",
181       "href": "Basic.html#Ext-form-Basic-cfg-waitMsgTarget",
182       "shortDoc": "By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific\nelement by passing it or i..."
183     },
184     {
185       "tagname": "cfg",
186       "name": "waitTitle",
187       "member": "Ext.form.Basic",
188       "type": "String",
189       "doc": "<p>The default title to show for the waiting message box (defaults to <tt>'Please Wait...'</tt>)</p>\n",
190       "private": false,
191       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
192       "linenr": 241,
193       "html_filename": "Basic.html",
194       "href": "Basic.html#Ext-form-Basic-cfg-waitTitle"
195     }
196   ],
197   "method": [
198     {
199       "tagname": "method",
200       "name": "Basic",
201       "member": "Ext.form.Basic",
202       "doc": "\n",
203       "params": [
204         {
205           "type": "Ext.container.Container",
206           "name": "owner",
207           "doc": "<p>The component that is the container for the form, usually a <a href=\"#/api/Ext.form.Panel\" rel=\"Ext.form.Panel\" class=\"docClass\">Ext.form.Panel</a></p>\n",
208           "optional": false
209         },
210         {
211           "type": "Object",
212           "name": "config",
213           "doc": "<p>Configuration options. These are normally specified in the config to the\n<a href=\"#/api/Ext.form.Panel\" rel=\"Ext.form.Panel\" class=\"docClass\">Ext.form.Panel</a> constructor, which passes them along to the BasicForm automatically.</p>\n",
214           "optional": false
215         }
216       ],
217       "return": {
218         "type": "void",
219         "doc": "\n"
220       },
221       "private": false,
222       "static": false,
223       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
224       "linenr": 1,
225       "html_filename": "Basic.html",
226       "href": "Basic.html#Ext-form-Basic-method-constructor",
227       "shortDoc": "\n"
228     },
229     {
230       "tagname": "method",
231       "name": "addEvents",
232       "member": "Ext.util.Observable",
233       "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
234       "params": [
235         {
236           "type": "Object/String",
237           "name": "o",
238           "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",
239           "optional": false
240         },
241         {
242           "type": "String",
243           "name": "",
244           "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",
245           "optional": false
246         }
247       ],
248       "return": {
249         "type": "void",
250         "doc": "\n"
251       },
252       "private": false,
253       "static": false,
254       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
255       "linenr": 452,
256       "html_filename": "Observable.html",
257       "href": "Observable.html#Ext-util-Observable-method-addEvents",
258       "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
259     },
260     {
261       "tagname": "method",
262       "name": "addListener",
263       "member": "Ext.util.Observable",
264       "doc": "<p>Appends an event handler to this object.</p>\n",
265       "params": [
266         {
267           "type": "String",
268           "name": "eventName",
269           "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",
270           "optional": false
271         },
272         {
273           "type": "Function",
274           "name": "handler",
275           "doc": "<p>The method the event invokes.</p>\n",
276           "optional": false
277         },
278         {
279           "type": "Object",
280           "name": "scope",
281           "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",
282           "optional": true
283         },
284         {
285           "type": "Object",
286           "name": "options",
287           "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",
288           "optional": true
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": 271,
299       "html_filename": "Observable.html",
300       "href": "Observable.html#Ext-util-Observable-method-addListener",
301       "shortDoc": "<p>Appends an event handler to this object.</p>\n"
302     },
303     {
304       "tagname": "method",
305       "name": "addManagedListener",
306       "member": "Ext.util.Observable",
307       "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
308       "params": [
309         {
310           "type": "Observable/Element",
311           "name": "item",
312           "doc": "<p>The item to which to add a listener/listeners.</p>\n",
313           "optional": false
314         },
315         {
316           "type": "Object/String",
317           "name": "ename",
318           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
319           "optional": false
320         },
321         {
322           "type": "Function",
323           "name": "fn",
324           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
325           "optional": false
326         },
327         {
328           "type": "Object",
329           "name": "scope",
330           "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",
331           "optional": false
332         },
333         {
334           "type": "Object",
335           "name": "opt",
336           "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",
337           "optional": false
338         }
339       ],
340       "return": {
341         "type": "void",
342         "doc": "\n"
343       },
344       "private": false,
345       "static": false,
346       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
347       "linenr": 155,
348       "html_filename": "Observable.html",
349       "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
350       "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
351     },
352     {
353       "tagname": "method",
354       "name": "applyIfToFields",
355       "member": "Ext.form.Basic",
356       "doc": "<p>Calls <a href=\"#/api/Ext-method-applyIf\" rel=\"Ext-method-applyIf\" class=\"docClass\">Ext.applyIf</a> for all field in this form with the passed object.</p>\n",
357       "params": [
358         {
359           "type": "Object",
360           "name": "obj",
361           "doc": "<p>The object to be applied</p>\n",
362           "optional": false
363         }
364       ],
365       "return": {
366         "type": "Ext.form.Basic",
367         "doc": "<p>this</p>\n"
368       },
369       "private": false,
370       "static": false,
371       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
372       "linenr": 883,
373       "html_filename": "Basic.html",
374       "href": "Basic.html#Ext-form-Basic-method-applyIfToFields",
375       "shortDoc": "<p>Calls <a href=\"#/api/Ext-method-applyIf\" rel=\"Ext-method-applyIf\" class=\"docClass\">Ext.applyIf</a> for all field in this form with the passed object.</p>\n"
376     },
377     {
378       "tagname": "method",
379       "name": "applyToFields",
380       "member": "Ext.form.Basic",
381       "doc": "<p>Calls <a href=\"#/api/Ext-method-apply\" rel=\"Ext-method-apply\" class=\"docClass\">Ext.apply</a> for all fields in this form with the passed object.</p>\n",
382       "params": [
383         {
384           "type": "Object",
385           "name": "obj",
386           "doc": "<p>The object to be applied</p>\n",
387           "optional": false
388         }
389       ],
390       "return": {
391         "type": "Ext.form.Basic",
392         "doc": "<p>this</p>\n"
393       },
394       "private": false,
395       "static": false,
396       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
397       "linenr": 871,
398       "html_filename": "Basic.html",
399       "href": "Basic.html#Ext-form-Basic-method-applyToFields",
400       "shortDoc": "<p>Calls <a href=\"#/api/Ext-method-apply\" rel=\"Ext-method-apply\" class=\"docClass\">Ext.apply</a> for all fields in this form with the passed object.</p>\n"
401     },
402     {
403       "tagname": "method",
404       "name": "capture",
405       "member": "Ext.util.Observable",
406       "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",
407       "params": [
408         {
409           "type": "Observable",
410           "name": "o",
411           "doc": "<p>The Observable to capture events from.</p>\n",
412           "optional": false
413         },
414         {
415           "type": "Function",
416           "name": "fn",
417           "doc": "<p>The function to call when an event is fired.</p>\n",
418           "optional": false
419         },
420         {
421           "type": "Object",
422           "name": "scope",
423           "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
424           "optional": true
425         }
426       ],
427       "return": {
428         "type": "void",
429         "doc": "\n"
430       },
431       "private": false,
432       "static": true,
433       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
434       "linenr": 55,
435       "html_filename": "Observable.html",
436       "href": "Observable.html#Ext-util-Observable-method-capture",
437       "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
438     },
439     {
440       "tagname": "method",
441       "name": "checkDirty",
442       "member": "Ext.form.Basic",
443       "doc": "<p>Check whether the dirty state of the entire form has changed since it was last checked, and\nif so fire the <a href=\"#/api/Ext.form.Basic-event-dirtychange\" rel=\"Ext.form.Basic-event-dirtychange\" class=\"docClass\">dirtychange</a> event. This is automatically invoked\nwhen an individual field's dirty state changes.</p>\n",
444       "params": [
445
446       ],
447       "return": {
448         "type": "void",
449         "doc": "\n"
450       },
451       "private": false,
452       "static": false,
453       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
454       "linenr": 421,
455       "html_filename": "Basic.html",
456       "href": "Basic.html#Ext-form-Basic-method-checkDirty",
457       "shortDoc": "Check whether the dirty state of the entire form has changed since it was last checked, and\nif so fire the dirtychang..."
458     },
459     {
460       "tagname": "method",
461       "name": "checkValidity",
462       "member": "Ext.form.Basic",
463       "doc": "<p>Check whether the validity of the entire form has changed since it was last checked, and\nif so fire the <a href=\"#/api/Ext.form.Basic-event-validitychange\" rel=\"Ext.form.Basic-event-validitychange\" class=\"docClass\">validitychange</a> event. This is automatically invoked\nwhen an individual field's validity changes.</p>\n",
464       "params": [
465
466       ],
467       "return": {
468         "type": "void",
469         "doc": "\n"
470       },
471       "private": false,
472       "static": false,
473       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
474       "linenr": 376,
475       "html_filename": "Basic.html",
476       "href": "Basic.html#Ext-form-Basic-method-checkValidity",
477       "shortDoc": "Check whether the validity of the entire form has changed since it was last checked, and\nif so fire the validitychang..."
478     },
479     {
480       "tagname": "method",
481       "name": "clearInvalid",
482       "member": "Ext.form.Basic",
483       "doc": "<p>Clears all invalid field messages in this form.</p>\n",
484       "params": [
485
486       ],
487       "return": {
488         "type": "Ext.form.Basic",
489         "doc": "<p>this</p>\n"
490       },
491       "private": false,
492       "static": false,
493       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
494       "linenr": 843,
495       "html_filename": "Basic.html",
496       "href": "Basic.html#Ext-form-Basic-method-clearInvalid",
497       "shortDoc": "<p>Clears all invalid field messages in this form.</p>\n"
498     },
499     {
500       "tagname": "method",
501       "name": "clearListeners",
502       "member": "Ext.util.Observable",
503       "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
504       "params": [
505
506       ],
507       "return": {
508         "type": "void",
509         "doc": "\n"
510       },
511       "private": false,
512       "static": false,
513       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
514       "linenr": 383,
515       "html_filename": "Observable.html",
516       "href": "Observable.html#Ext-util-Observable-method-clearListeners",
517       "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
518     },
519     {
520       "tagname": "method",
521       "name": "clearManagedListeners",
522       "member": "Ext.util.Observable",
523       "doc": "<p>Removes all managed listeners for this object.</p>\n",
524       "params": [
525
526       ],
527       "return": {
528         "type": "void",
529         "doc": "\n"
530       },
531       "private": false,
532       "static": false,
533       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
534       "linenr": 412,
535       "html_filename": "Observable.html",
536       "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
537       "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
538     },
539     {
540       "tagname": "method",
541       "name": "destroy",
542       "member": "Ext.form.Basic",
543       "doc": "<p>Destroys this object.</p>\n",
544       "params": [
545
546       ],
547       "return": {
548         "type": "void",
549         "doc": "\n"
550       },
551       "private": false,
552       "static": false,
553       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
554       "linenr": 273,
555       "html_filename": "Basic.html",
556       "href": "Basic.html#Ext-form-Basic-method-destroy",
557       "shortDoc": "<p>Destroys this object.</p>\n"
558     },
559     {
560       "tagname": "method",
561       "name": "doAction",
562       "member": "Ext.form.Basic",
563       "doc": "<p>Performs a predefined action (an implementation of <a href=\"#/api/Ext.form.action.Action\" rel=\"Ext.form.action.Action\" class=\"docClass\">Ext.form.action.Action</a>)\nto perform application-specific processing.</p>\n",
564       "params": [
565         {
566           "type": "String/Ext.form.action.Action",
567           "name": "action",
568           "doc": "<p>The name of the predefined action type,\nor instance of <a href=\"#/api/Ext.form.action.Action\" rel=\"Ext.form.action.Action\" class=\"docClass\">Ext.form.action.Action</a> to perform.</p>\n",
569           "optional": false
570         },
571         {
572           "type": "Object",
573           "name": "options",
574           "doc": "<p>(optional) The options to pass to the <a href=\"#/api/Ext.form.action.Action\" rel=\"Ext.form.action.Action\" class=\"docClass\">Ext.form.action.Action</a>\nthat will get created, if the <tt>action</tt> argument is a String.</p>\n\n<p>All of the config options listed below are supported by both the\n<a href=\"#/api/Ext.form.action.Submit\" rel=\"Ext.form.action.Submit\" class=\"docClass\">submit</a> and <a href=\"#/api/Ext.form.action.Load\" rel=\"Ext.form.action.Load\" class=\"docClass\">load</a>\nactions unless otherwise noted (custom actions could also accept\nother config options):</p>\n\n\n<ul>\n\n<li><b>url</b> : String<div class=\"sub-desc\">The url for the action (defaults\nto the form's <a href=\"#/api/Ext.form.Basic-cfg-url\" rel=\"Ext.form.Basic-cfg-url\" class=\"docClass\">url</a>.)</div></li>\n\n<li><b>method</b> : String<div class=\"sub-desc\">The form method to use (defaults\nto the form's method, or POST if not defined)</div></li>\n\n<li><b>params</b> : String/Object<div class=\"sub-desc\"><p>The params to pass\n(defaults to the form's baseParams, or none if not defined)</p>\n<p>Parameters are encoded as standard HTTP parameters using <a href=\"#/api/Ext-method-urlEncode\" rel=\"Ext-method-urlEncode\" class=\"docClass\">Ext.Object.toQueryString</a>.</p></div></li>\n\n<li><b>headers</b> : Object<div class=\"sub-desc\">Request headers to set for the action.</div></li>\n\n<li><b>success</b> : Function<div class=\"sub-desc\">The callback that will\nbe invoked after a successful response (see top of\n<a href=\"#/api/Ext.form.action.Submit\" rel=\"Ext.form.action.Submit\" class=\"docClass\">submit</a> and <a href=\"#/api/Ext.form.action.Load\" rel=\"Ext.form.action.Load\" class=\"docClass\">load</a>\nfor a description of what constitutes a successful response).\nThe function is passed the following parameters:<ul>\n<li><tt>form</tt> : The <a href=\"#/api/Ext.form.Basic\" rel=\"Ext.form.Basic\" class=\"docClass\">Ext.form.Basic</a> that requested the action.</li>\n<li><tt>action</tt> : The <a href=\"#/api/Ext.form.action.Action\" rel=\"Ext.form.action.Action\" class=\"docClass\">Action</a> object which performed the operation.\n<div class=\"sub-desc\">The action object contains these properties of interest:<ul>\n<li><tt><a href=\"#/api/Ext.form.action.Action-property-response\" rel=\"Ext.form.action.Action-property-response\" class=\"docClass\">response</a></tt></li>\n<li><tt><a href=\"#/api/Ext.form.action.Action-property-result\" rel=\"Ext.form.action.Action-property-result\" class=\"docClass\">result</a></tt> : interrogate for custom postprocessing</li>\n<li><tt><a href=\"#/api/Ext.form.action.Action-property-type\" rel=\"Ext.form.action.Action-property-type\" class=\"docClass\">type</a></tt></li>\n</ul></div></li></ul></div></li>\n\n<li><b>failure</b> : Function<div class=\"sub-desc\">The callback that will be invoked after a\nfailed transaction attempt. The function is passed the following parameters:<ul>\n<li><tt>form</tt> : The <a href=\"#/api/Ext.form.Basic\" rel=\"Ext.form.Basic\" class=\"docClass\">Ext.form.Basic</a> that requested the action.</li>\n<li><tt>action</tt> : The <a href=\"#/api/Ext.form.action.Action\" rel=\"Ext.form.action.Action\" class=\"docClass\">Action</a> object which performed the operation.\n<div class=\"sub-desc\">The action object contains these properties of interest:<ul>\n<li><tt><a href=\"#/api/Ext.form.action.Action-property-failureType\" rel=\"Ext.form.action.Action-property-failureType\" class=\"docClass\">failureType</a></tt></li>\n<li><tt><a href=\"#/api/Ext.form.action.Action-property-response\" rel=\"Ext.form.action.Action-property-response\" class=\"docClass\">response</a></tt></li>\n<li><tt><a href=\"#/api/Ext.form.action.Action-property-result\" rel=\"Ext.form.action.Action-property-result\" class=\"docClass\">result</a></tt> : interrogate for custom postprocessing</li>\n<li><tt><a href=\"#/api/Ext.form.action.Action-property-type\" rel=\"Ext.form.action.Action-property-type\" class=\"docClass\">type</a></tt></li>\n</ul></div></li></ul></div></li>\n\n<li><b>scope</b> : Object<div class=\"sub-desc\">The scope in which to call the\ncallback functions (The <tt>this</tt> reference for the callback functions).</div></li>\n\n<li><b>clientValidation</b> : Boolean<div class=\"sub-desc\">Submit Action only.\nDetermines whether a Form's fields are validated in a final call to\n<a href=\"#/api/Ext.form.Basic-method-isValid\" rel=\"Ext.form.Basic-method-isValid\" class=\"docClass\">isValid</a> prior to submission. Set to <tt>false</tt>\nto prevent this. If undefined, pre-submission field validation is performed.</div></li></ul>\n\n",
575           "optional": true
576         }
577       ],
578       "return": {
579         "type": "Ext.form.Basic",
580         "doc": "<p>this</p>\n"
581       },
582       "private": false,
583       "static": false,
584       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
585       "linenr": 462,
586       "html_filename": "Basic.html",
587       "href": "Basic.html#Ext-form-Basic-method-doAction",
588       "shortDoc": "<p>Performs a predefined action (an implementation of <a href=\"#/api/Ext.form.action.Action\" rel=\"Ext.form.action.Action\" class=\"docClass\">Ext.form.action.Action</a>)\nto perform application-specific processing.</p>\n"
589     },
590     {
591       "tagname": "method",
592       "name": "enableBubble",
593       "member": "Ext.util.Observable",
594       "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",
595       "params": [
596         {
597           "type": "String/Array",
598           "name": "events",
599           "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
600           "optional": false
601         }
602       ],
603       "return": {
604         "type": "void",
605         "doc": "\n"
606       },
607       "private": false,
608       "static": false,
609       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
610       "linenr": 554,
611       "html_filename": "Observable.html",
612       "href": "Observable.html#Ext-util-Observable-method-enableBubble",
613       "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
614     },
615     {
616       "tagname": "method",
617       "name": "findField",
618       "member": "Ext.form.Basic",
619       "doc": "<p>Find a specific <a href=\"#/api/Ext.form.field.Field\" rel=\"Ext.form.field.Field\" class=\"docClass\">Ext.form.field.Field</a> in this form by id or name.</p>\n",
620       "params": [
621         {
622           "type": "String",
623           "name": "id",
624           "doc": "<p>The value to search for (specify either a <a href=\"#/api/Ext.Component-cfg-id\" rel=\"Ext.Component-cfg-id\" class=\"docClass\">id</a> or\n<a href=\"#/api/Ext.form.field.Field-method-getName\" rel=\"Ext.form.field.Field-method-getName\" class=\"docClass\">name or hiddenName</a>).</p>\n",
625           "optional": false
626         }
627       ],
628       "return": {
629         "type": "void",
630         "doc": "<p>Ext.form.field.Field The first matching field, or <tt>null</tt> if none was found.</p>\n"
631       },
632       "private": false,
633       "static": false,
634       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
635       "linenr": 695,
636       "html_filename": "Basic.html",
637       "href": "Basic.html#Ext-form-Basic-method-findField",
638       "shortDoc": "<p>Find a specific <a href=\"#/api/Ext.form.field.Field\" rel=\"Ext.form.field.Field\" class=\"docClass\">Ext.form.field.Field</a> in this form by id or name.</p>\n"
639     },
640     {
641       "tagname": "method",
642       "name": "fireEvent",
643       "member": "Ext.util.Observable",
644       "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.form.Basic-method-enableBubble\" rel=\"Ext.form.Basic-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
645       "params": [
646         {
647           "type": "String",
648           "name": "eventName",
649           "doc": "<p>The name of the event to fire.</p>\n",
650           "optional": false
651         },
652         {
653           "type": "Object...",
654           "name": "args",
655           "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
656           "optional": false
657         }
658       ],
659       "return": {
660         "type": "Boolean",
661         "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
662       },
663       "private": false,
664       "static": false,
665       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
666       "linenr": 232,
667       "html_filename": "Observable.html",
668       "href": "Observable.html#Ext-util-Observable-method-fireEvent",
669       "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..."
670     },
671     {
672       "tagname": "method",
673       "name": "getFieldValues",
674       "member": "Ext.form.Basic",
675       "doc": "<p>Retrieves the fields in the form as a set of key/value pairs, using their\n<a href=\"#/api/Ext.form.field.Field-method-getModelData\" rel=\"Ext.form.field.Field-method-getModelData\" class=\"docClass\">getModelData()</a> method to collect the values.\nIf multiple fields return values under the same name those values will be combined into an Array.\nThis is similar to <a href=\"#/api/Ext.form.Basic-method-getValues\" rel=\"Ext.form.Basic-method-getValues\" class=\"docClass\">getValues</a> except that this method collects type-specific data values\n(e.g. Date objects for date fields) while getValues returns only String values for submission.</p>\n",
676       "params": [
677         {
678           "type": "Boolean",
679           "name": "dirtyOnly",
680           "doc": "<p>(optional) If true, only fields that are dirty will be included in the result.\nDefaults to false.</p>\n",
681           "optional": true
682         }
683       ],
684       "return": {
685         "type": "Object",
686         "doc": "\n"
687       },
688       "private": false,
689       "static": false,
690       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
691       "linenr": 829,
692       "html_filename": "Basic.html",
693       "href": "Basic.html#Ext-form-Basic-method-getFieldValues",
694       "shortDoc": "Retrieves the fields in the form as a set of key/value pairs, using their\ngetModelData() method to collect the values..."
695     },
696     {
697       "tagname": "method",
698       "name": "getFields",
699       "member": "Ext.form.Basic",
700       "doc": "<p>Return all the <a href=\"#/api/Ext.form.field.Field\" rel=\"Ext.form.field.Field\" class=\"docClass\">Ext.form.field.Field</a> components in the owner container.</p>\n",
701       "params": [
702
703       ],
704       "return": {
705         "type": "Ext.util.MixedCollection",
706         "doc": "<p>Collection of the Field objects</p>\n"
707       },
708       "private": false,
709       "static": false,
710       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
711       "linenr": 322,
712       "html_filename": "Basic.html",
713       "href": "Basic.html#Ext-form-Basic-method-getFields",
714       "shortDoc": "<p>Return all the <a href=\"#/api/Ext.form.field.Field\" rel=\"Ext.form.field.Field\" class=\"docClass\">Ext.form.field.Field</a> components in the owner container.</p>\n"
715     },
716     {
717       "tagname": "method",
718       "name": "getRecord",
719       "member": "Ext.form.Basic",
720       "doc": "<p>Returns the last <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> instance that was loaded via <a href=\"#/api/Ext.form.Basic-method-loadRecord\" rel=\"Ext.form.Basic-method-loadRecord\" class=\"docClass\">loadRecord</a></p>\n",
721       "params": [
722
723       ],
724       "return": {
725         "type": "Ext.data.Model",
726         "doc": "<p>The record</p>\n"
727       },
728       "private": false,
729       "static": false,
730       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
731       "linenr": 625,
732       "html_filename": "Basic.html",
733       "href": "Basic.html#Ext-form-Basic-method-getRecord",
734       "shortDoc": "<p>Returns the last <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> instance that was loaded via <a href=\"#/api/Ext.form.Basic-method-loadRecord\" rel=\"Ext.form.Basic-method-loadRecord\" class=\"docClass\">loadRecord</a></p>\n"
735     },
736     {
737       "tagname": "method",
738       "name": "getValues",
739       "member": "Ext.form.Basic",
740       "doc": "<p>Retrieves the fields in the form as a set of key/value pairs, using their\n<a href=\"#/api/Ext.form.field.Field-method-getSubmitData\" rel=\"Ext.form.field.Field-method-getSubmitData\" class=\"docClass\">getSubmitData()</a> method to collect the values.\nIf multiple fields return values under the same name those values will be combined into an Array.\nThis is similar to <a href=\"#/api/Ext.form.Basic-method-getFieldValues\" rel=\"Ext.form.Basic-method-getFieldValues\" class=\"docClass\">getFieldValues</a> except that this method collects only String values for\nsubmission, while getFieldValues collects type-specific data values (e.g. Date objects for date fields.)</p>\n",
741       "params": [
742         {
743           "type": "Boolean",
744           "name": "asString",
745           "doc": "<p>(optional) If true, will return the key/value collection as a single\nURL-encoded param string. Defaults to false.</p>\n",
746           "optional": true
747         },
748         {
749           "type": "Boolean",
750           "name": "dirtyOnly",
751           "doc": "<p>(optional) If true, only fields that are dirty will be included in the result.\nDefaults to false.</p>\n",
752           "optional": true
753         },
754         {
755           "type": "Boolean",
756           "name": "includeEmptyText",
757           "doc": "<p>(optional) If true, the configured emptyText of empty fields will be used.\nDefaults to false.</p>\n",
758           "optional": true
759         },
760         {
761           "type": "Object",
762           "name": "useDataValues",
763           "doc": "\n",
764           "optional": false
765         }
766       ],
767       "return": {
768         "type": "String/Object",
769         "doc": "\n"
770       },
771       "private": false,
772       "static": false,
773       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
774       "linenr": 779,
775       "html_filename": "Basic.html",
776       "href": "Basic.html#Ext-form-Basic-method-getValues",
777       "shortDoc": "Retrieves the fields in the form as a set of key/value pairs, using their\ngetSubmitData() method to collect the value..."
778     },
779     {
780       "tagname": "method",
781       "name": "hasInvalidField",
782       "member": "Ext.form.Basic",
783       "doc": "<p>Returns true if the form contains any invalid fields. No fields will be marked as invalid\nas a result of calling this; to trigger marking of fields use <a href=\"#/api/Ext.form.Basic-method-isValid\" rel=\"Ext.form.Basic-method-isValid\" class=\"docClass\">isValid</a> instead.</p>\n",
784       "params": [
785
786       ],
787       "return": {
788         "type": "void",
789         "doc": "\n"
790       },
791       "private": false,
792       "static": false,
793       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
794       "linenr": 344,
795       "html_filename": "Basic.html",
796       "href": "Basic.html#Ext-form-Basic-method-hasInvalidField",
797       "shortDoc": "Returns true if the form contains any invalid fields. No fields will be marked as invalid\nas a result of calling this..."
798     },
799     {
800       "tagname": "method",
801       "name": "hasListener",
802       "member": "Ext.util.Observable",
803       "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
804       "params": [
805         {
806           "type": "String",
807           "name": "eventName",
808           "doc": "<p>The name of the event to check for</p>\n",
809           "optional": false
810         }
811       ],
812       "return": {
813         "type": "Boolean",
814         "doc": "<p>True if the event is being listened for, else false</p>\n"
815       },
816       "private": false,
817       "static": false,
818       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
819       "linenr": 480,
820       "html_filename": "Observable.html",
821       "href": "Observable.html#Ext-util-Observable-method-hasListener",
822       "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
823     },
824     {
825       "tagname": "method",
826       "name": "hasUpload",
827       "member": "Ext.form.Basic",
828       "doc": "<p>Returns true if the form contains a file upload field. This is used to determine the\nmethod for submitting the form: File uploads are not performed using normal 'Ajax' techniques,\nthat is they are <b>not</b> performed using XMLHttpRequests. Instead a hidden <tt>&lt;form></tt>\nelement containing all the fields is created temporarily and submitted with its\n<a href=\"http://www.w3.org/TR/REC-html40/present/frames.html#adef-target\">target</a> set to refer\nto a dynamically generated, hidden <tt>&lt;iframe></tt> which is inserted into the document\nbut removed after the return data has been gathered.</p>\n\n\n<p>The server response is parsed by the browser to create the document for the IFRAME. If the\nserver is using JSON to send the return object, then the\n<a href=\"http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17\">Content-Type</a> header\nmust be set to \"text/html\" in order to tell the browser to insert the text unchanged into the document body.</p>\n\n\n<p>Characters which are significant to an HTML parser must be sent as HTML entities, so encode\n\"&lt;\" as \"&amp;lt;\", \"&amp;\" as \"&amp;amp;\" etc.</p>\n\n\n<p>The response text is retrieved from the document, and a fake XMLHttpRequest object\nis created containing a <tt>responseText</tt> property in order to conform to the\nrequirements of event handlers and callbacks.</p>\n\n\n<p>Be aware that file upload packets are sent with the content type <a href=\"http://www.faqs.org/rfcs/rfc2388.html\">multipart/form</a>\nand some server technologies (notably JEE) may require some custom processing in order to\nretrieve parameter names and parameter values from the packet content.</p>\n\n",
829       "params": [
830
831       ],
832       "return": {
833         "type": "void",
834         "doc": "<p>Boolean</p>\n"
835       },
836       "private": false,
837       "static": false,
838       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
839       "linenr": 434,
840       "html_filename": "Basic.html",
841       "href": "Basic.html#Ext-form-Basic-method-hasUpload",
842       "shortDoc": "Returns true if the form contains a file upload field. This is used to determine the\nmethod for submitting the form: ..."
843     },
844     {
845       "tagname": "method",
846       "name": "isDirty",
847       "member": "Ext.form.Basic",
848       "doc": "<p>Returns true if any fields in this form have changed from their original values.</p>\n\n\n<p>Note that if this BasicForm was configured with <a href=\"#/api/Ext.form.Basic-cfg-trackResetOnLoad\" rel=\"Ext.form.Basic-cfg-trackResetOnLoad\" class=\"docClass\">trackResetOnLoad</a> then the\nFields' <em>original values</em> are updated when the values are loaded by <a href=\"#/api/Ext.form.Basic-method-setValues\" rel=\"Ext.form.Basic-method-setValues\" class=\"docClass\">setValues</a>\nor <a href=\"#/api/Ext.form.Basic-method-loadRecord\" rel=\"Ext.form.Basic-method-loadRecord\" class=\"docClass\">loadRecord</a>.</p>\n\n",
849       "params": [
850
851       ],
852       "return": {
853         "type": "void",
854         "doc": "<p>Boolean</p>\n"
855       },
856       "private": false,
857       "static": false,
858       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
859       "linenr": 408,
860       "html_filename": "Basic.html",
861       "href": "Basic.html#Ext-form-Basic-method-isDirty",
862       "shortDoc": "Returns true if any fields in this form have changed from their original values.\n\n\nNote that if this BasicForm was co..."
863     },
864     {
865       "tagname": "method",
866       "name": "isValid",
867       "member": "Ext.form.Basic",
868       "doc": "<p>Returns true if client-side validation on the form is successful. Any invalid fields will be\nmarked as invalid. If you only want to determine overall form validity without marking anything,\nuse <a href=\"#/api/Ext.form.Basic-method-hasInvalidField\" rel=\"Ext.form.Basic-method-hasInvalidField\" class=\"docClass\">hasInvalidField</a> instead.</p>\n",
869       "params": [
870
871       ],
872       "return": {
873         "type": "void",
874         "doc": "<p>Boolean</p>\n"
875       },
876       "private": false,
877       "static": false,
878       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
879       "linenr": 359,
880       "html_filename": "Basic.html",
881       "href": "Basic.html#Ext-form-Basic-method-isValid",
882       "shortDoc": "Returns true if client-side validation on the form is successful. Any invalid fields will be\nmarked as invalid. If yo..."
883     },
884     {
885       "tagname": "method",
886       "name": "load",
887       "member": "Ext.form.Basic",
888       "doc": "<p>Shortcut to <a href=\"#/api/Ext.form.Basic-method-doAction\" rel=\"Ext.form.Basic-method-doAction\" class=\"docClass\">do</a> a <a href=\"#/api/Ext.form.action.Load\" rel=\"Ext.form.action.Load\" class=\"docClass\">load action</a>.</p>\n",
889       "params": [
890         {
891           "type": "Object",
892           "name": "options",
893           "doc": "<p>The options to pass to the action (see <a href=\"#/api/Ext.form.Basic-method-doAction\" rel=\"Ext.form.Basic-method-doAction\" class=\"docClass\">doAction</a> for details)</p>\n",
894           "optional": false
895         }
896       ],
897       "return": {
898         "type": "Ext.form.Basic",
899         "doc": "<p>this</p>\n"
900       },
901       "private": false,
902       "static": false,
903       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
904       "linenr": 579,
905       "html_filename": "Basic.html",
906       "href": "Basic.html#Ext-form-Basic-method-load",
907       "shortDoc": "<p>Shortcut to <a href=\"#/api/Ext.form.Basic-method-doAction\" rel=\"Ext.form.Basic-method-doAction\" class=\"docClass\">do</a> a <a href=\"#/api/Ext.form.action.Load\" rel=\"Ext.form.action.Load\" class=\"docClass\">load action</a>.</p>\n"
908     },
909     {
910       "tagname": "method",
911       "name": "loadRecord",
912       "member": "Ext.form.Basic",
913       "doc": "<p>Loads an <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> into this form by calling <a href=\"#/api/Ext.form.Basic-method-setValues\" rel=\"Ext.form.Basic-method-setValues\" class=\"docClass\">setValues</a> with the\n<a href=\"#/api/Ext.data.Model--data\" rel=\"Ext.data.Model--data\" class=\"docClass\">record data</a>.\nSee also <a href=\"#/api/Ext.form.Basic-cfg-trackResetOnLoad\" rel=\"Ext.form.Basic-cfg-trackResetOnLoad\" class=\"docClass\">trackResetOnLoad</a>.</p>\n",
914       "params": [
915         {
916           "type": "Ext.data.Model",
917           "name": "record",
918           "doc": "<p>The record to load</p>\n",
919           "optional": false
920         }
921       ],
922       "return": {
923         "type": "Ext.form.Basic",
924         "doc": "<p>this</p>\n"
925       },
926       "private": false,
927       "static": false,
928       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
929       "linenr": 613,
930       "html_filename": "Basic.html",
931       "href": "Basic.html#Ext-form-Basic-method-loadRecord",
932       "shortDoc": "<p>Loads an <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> into this form by calling <a href=\"#/api/Ext.form.Basic-method-setValues\" rel=\"Ext.form.Basic-method-setValues\" class=\"docClass\">setValues</a> with the\n<a href=\"#/api/Ext.data.Model--data\" rel=\"Ext.data.Model--data\" class=\"docClass\">record data</a>.\nSee also <a href=\"#/api/Ext.form.Basic-cfg-trackResetOnLoad\" rel=\"Ext.form.Basic-cfg-trackResetOnLoad\" class=\"docClass\">trackResetOnLoad</a>.</p>\n"
933     },
934     {
935       "tagname": "method",
936       "name": "markInvalid",
937       "member": "Ext.form.Basic",
938       "doc": "<p>Mark fields in this form invalid in bulk.</p>\n",
939       "params": [
940         {
941           "type": "Array/Object",
942           "name": "errors",
943           "doc": "<p>Either an array in the form <code>[{id:'fieldId', msg:'The message'}, ...]</code>,\nan object hash of <code>{id: msg, id2: msg2}</code>, or a <a href=\"#/api/Ext.data.Errors\" rel=\"Ext.data.Errors\" class=\"docClass\">Ext.data.Errors</a> object.</p>\n",
944           "optional": false
945         }
946       ],
947       "return": {
948         "type": "Ext.form.Basic",
949         "doc": "<p>this</p>\n"
950       },
951       "private": false,
952       "static": false,
953       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
954       "linenr": 708,
955       "html_filename": "Basic.html",
956       "href": "Basic.html#Ext-form-Basic-method-markInvalid",
957       "shortDoc": "<p>Mark fields in this form invalid in bulk.</p>\n"
958     },
959     {
960       "tagname": "method",
961       "name": "observe",
962       "member": "Ext.util.Observable",
963       "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",
964       "params": [
965         {
966           "type": "Function",
967           "name": "c",
968           "doc": "<p>The class constructor to make observable.</p>\n",
969           "optional": false
970         },
971         {
972           "type": "Object",
973           "name": "listeners",
974           "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.form.Basic-method-addListener\" rel=\"Ext.form.Basic-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
975           "optional": false
976         }
977       ],
978       "return": {
979         "type": "void",
980         "doc": "\n"
981       },
982       "private": false,
983       "static": true,
984       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
985       "linenr": 69,
986       "html_filename": "Observable.html",
987       "href": "Observable.html#Ext-util-Observable-method-observe",
988       "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
989     },
990     {
991       "tagname": "method",
992       "name": "on",
993       "member": "Ext.util.Observable",
994       "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.form.Basic-method-addListener\" rel=\"Ext.form.Basic-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
995       "params": [
996         {
997           "type": "String",
998           "name": "eventName",
999           "doc": "<p>The type of event to listen for</p>\n",
1000           "optional": false
1001         },
1002         {
1003           "type": "Function",
1004           "name": "handler",
1005           "doc": "<p>The method the event invokes</p>\n",
1006           "optional": false
1007         },
1008         {
1009           "type": "Object",
1010           "name": "scope",
1011           "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",
1012           "optional": true
1013         },
1014         {
1015           "type": "Object",
1016           "name": "options",
1017           "doc": "<p>(optional) An object containing handler configuration.</p>\n",
1018           "optional": true
1019         }
1020       ],
1021       "return": {
1022         "type": "void",
1023         "doc": "\n"
1024       },
1025       "private": false,
1026       "static": false,
1027       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1028       "linenr": 616,
1029       "html_filename": "Observable.html",
1030       "href": "Observable.html#Ext-util-Observable-method-on",
1031       "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.form.Basic-method-addListener\" rel=\"Ext.form.Basic-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
1032     },
1033     {
1034       "tagname": "method",
1035       "name": "relayEvents",
1036       "member": "Ext.util.Observable",
1037       "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
1038       "params": [
1039         {
1040           "type": "Object",
1041           "name": "origin",
1042           "doc": "<p>The Observable whose events this object is to relay.</p>\n",
1043           "optional": false
1044         },
1045         {
1046           "type": "Array",
1047           "name": "events",
1048           "doc": "<p>Array of event names to relay.</p>\n",
1049           "optional": false
1050         },
1051         {
1052           "type": "Object",
1053           "name": "prefix",
1054           "doc": "\n",
1055           "optional": false
1056         }
1057       ],
1058       "return": {
1059         "type": "void",
1060         "doc": "\n"
1061       },
1062       "private": false,
1063       "static": false,
1064       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1065       "linenr": 520,
1066       "html_filename": "Observable.html",
1067       "href": "Observable.html#Ext-util-Observable-method-relayEvents",
1068       "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
1069     },
1070     {
1071       "tagname": "method",
1072       "name": "releaseCapture",
1073       "member": "Ext.util.Observable",
1074       "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
1075       "params": [
1076         {
1077           "type": "Observable",
1078           "name": "o",
1079           "doc": "<p>The Observable to release</p>\n",
1080           "optional": false
1081         }
1082       ],
1083       "return": {
1084         "type": "void",
1085         "doc": "\n"
1086       },
1087       "private": false,
1088       "static": true,
1089       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1090       "linenr": 46,
1091       "html_filename": "Observable.html",
1092       "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
1093       "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
1094     },
1095     {
1096       "tagname": "method",
1097       "name": "removeListener",
1098       "member": "Ext.util.Observable",
1099       "doc": "<p>Removes an event handler.</p>\n",
1100       "params": [
1101         {
1102           "type": "String",
1103           "name": "eventName",
1104           "doc": "<p>The type of event the handler was associated with.</p>\n",
1105           "optional": false
1106         },
1107         {
1108           "type": "Function",
1109           "name": "handler",
1110           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.form.Basic-method-addListener\" rel=\"Ext.form.Basic-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
1111           "optional": false
1112         },
1113         {
1114           "type": "Object",
1115           "name": "scope",
1116           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
1117           "optional": true
1118         }
1119       ],
1120       "return": {
1121         "type": "void",
1122         "doc": "\n"
1123       },
1124       "private": false,
1125       "static": false,
1126       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1127       "linenr": 352,
1128       "html_filename": "Observable.html",
1129       "href": "Observable.html#Ext-util-Observable-method-removeListener",
1130       "shortDoc": "<p>Removes an event handler.</p>\n"
1131     },
1132     {
1133       "tagname": "method",
1134       "name": "removeManagedListener",
1135       "member": "Ext.util.Observable",
1136       "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.form.Basic--mon\" rel=\"Ext.form.Basic--mon\" class=\"docClass\">mon</a> method.</p>\n",
1137       "params": [
1138         {
1139           "type": "Observable|Element",
1140           "name": "item",
1141           "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
1142           "optional": false
1143         },
1144         {
1145           "type": "Object|String",
1146           "name": "ename",
1147           "doc": "<p>The event name, or an object containing event name properties.</p>\n",
1148           "optional": false
1149         },
1150         {
1151           "type": "Function",
1152           "name": "fn",
1153           "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
1154           "optional": false
1155         },
1156         {
1157           "type": "Object",
1158           "name": "scope",
1159           "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",
1160           "optional": false
1161         }
1162       ],
1163       "return": {
1164         "type": "void",
1165         "doc": "\n"
1166       },
1167       "private": false,
1168       "static": false,
1169       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1170       "linenr": 196,
1171       "html_filename": "Observable.html",
1172       "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
1173       "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.form.Basic--mon\" rel=\"Ext.form.Basic--mon\" class=\"docClass\">mon</a> method.</p>\n"
1174     },
1175     {
1176       "tagname": "method",
1177       "name": "reset",
1178       "member": "Ext.form.Basic",
1179       "doc": "<p>Resets all fields in this form.</p>\n",
1180       "params": [
1181
1182       ],
1183       "return": {
1184         "type": "Ext.form.Basic",
1185         "doc": "<p>this</p>\n"
1186       },
1187       "private": false,
1188       "static": false,
1189       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
1190       "linenr": 857,
1191       "html_filename": "Basic.html",
1192       "href": "Basic.html#Ext-form-Basic-method-reset",
1193       "shortDoc": "<p>Resets all fields in this form.</p>\n"
1194     },
1195     {
1196       "tagname": "method",
1197       "name": "resumeEvents",
1198       "member": "Ext.util.Observable",
1199       "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.form.Basic-method-suspendEvents\" rel=\"Ext.form.Basic-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",
1200       "params": [
1201
1202       ],
1203       "return": {
1204         "type": "void",
1205         "doc": "\n"
1206       },
1207       "private": false,
1208       "static": false,
1209       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1210       "linenr": 502,
1211       "html_filename": "Observable.html",
1212       "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
1213       "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
1214     },
1215     {
1216       "tagname": "method",
1217       "name": "setValues",
1218       "member": "Ext.form.Basic",
1219       "doc": "<p>Set values for fields in this form in bulk.</p>\n",
1220       "params": [
1221         {
1222           "type": "Array/Object",
1223           "name": "values",
1224           "doc": "<p>Either an array in the form:</p>\n\n<pre><code>[{id:'clientName', value:'Fred. Olsen Lines'},\n {id:'portOfLoading', value:'FXT'},\n {id:'portOfDischarge', value:'OSL'} ]</code></pre>\n\n\n<p>or an object hash of the form:</p>\n\n<pre><code>{\n    clientName: 'Fred. Olsen Lines',\n    portOfLoading: 'FXT',\n    portOfDischarge: 'OSL'\n}</code></pre>\n\n",
1225           "optional": false
1226         }
1227       ],
1228       "return": {
1229         "type": "Ext.form.Basic",
1230         "doc": "<p>this</p>\n"
1231       },
1232       "private": false,
1233       "static": false,
1234       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
1235       "linenr": 740,
1236       "html_filename": "Basic.html",
1237       "href": "Basic.html#Ext-form-Basic-method-setValues",
1238       "shortDoc": "<p>Set values for fields in this form in bulk.</p>\n"
1239     },
1240     {
1241       "tagname": "method",
1242       "name": "submit",
1243       "member": "Ext.form.Basic",
1244       "doc": "<p>Shortcut to <a href=\"#/api/Ext.form.Basic-method-doAction\" rel=\"Ext.form.Basic-method-doAction\" class=\"docClass\">do</a> a <a href=\"#/api/Ext.form.action.Submit\" rel=\"Ext.form.action.Submit\" class=\"docClass\">submit action</a>. This will use the\n<a href=\"#/api/Ext.form.action.Submit\" rel=\"Ext.form.action.Submit\" class=\"docClass\">AJAX submit action</a> by default. If the <a href=\"#/api/Ext.form.Basic--standardsubmit\" rel=\"Ext.form.Basic--standardsubmit\" class=\"docClass\">standardsubmit</a> config is\nenabled it will use a standard form element to submit, or if the <a href=\"#/api/Ext.form.Basic-cfg-api\" rel=\"Ext.form.Basic-cfg-api\" class=\"docClass\">api</a> config is present it will\nuse the <a href=\"#/api/Ext.form.action.DirectLoad\" rel=\"Ext.form.action.DirectLoad\" class=\"docClass\">Ext.direct.Direct submit action</a>.</p>\n",
1245       "params": [
1246         {
1247           "type": "Object",
1248           "name": "options",
1249           "doc": "<p>The options to pass to the action (see <a href=\"#/api/Ext.form.Basic-method-doAction\" rel=\"Ext.form.Basic-method-doAction\" class=\"docClass\">doAction</a> for details).<br></p>\n\n<p>The following code:</p>\n\n\n<pre><code>myFormPanel.getForm().submit({\n    clientValidation: true,\n    url: 'updateConsignment.php',\n    params: {\n        newStatus: 'delivered'\n    },\n    success: function(form, action) {\n       Ext.Msg.alert('Success', action.result.msg);\n    },\n    failure: function(form, action) {\n        switch (action.failureType) {\n            case Ext.form.action.Action.CLIENT_INVALID:\n                Ext.Msg.alert('Failure', 'Form fields may not be submitted with invalid values');\n                break;\n            case Ext.form.action.Action.CONNECT_FAILURE:\n                Ext.Msg.alert('Failure', 'Ajax communication failed');\n                break;\n            case Ext.form.action.Action.SERVER_INVALID:\n               Ext.Msg.alert('Failure', action.result.msg);\n       }\n    }\n});\n</code></pre>\n\n\n<p>would process the following server response for a successful submission:</p>\n\n<pre><code>{\n    \"success\":true, // note this is Boolean, not string\n    \"msg\":\"Consignment updated\"\n}\n</code></pre>\n\n\n<p>and the following server response for a failed submission:</p>\n\n<pre><code>{\n    \"success\":false, // note this is Boolean, not string\n    \"msg\":\"You do not have permission to perform this operation\"\n}\n</code></pre>\n\n",
1250           "optional": false
1251         }
1252       ],
1253       "return": {
1254         "type": "Ext.form.Basic",
1255         "doc": "<p>this</p>\n"
1256       },
1257       "private": false,
1258       "static": false,
1259       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
1260       "linenr": 531,
1261       "html_filename": "Basic.html",
1262       "href": "Basic.html#Ext-form-Basic-method-submit",
1263       "shortDoc": "Shortcut to do a submit action. This will use the\nAJAX submit action by default. If the standardsubmit config is\nenab..."
1264     },
1265     {
1266       "tagname": "method",
1267       "name": "suspendEvents",
1268       "member": "Ext.util.Observable",
1269       "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.form.Basic-method-resumeEvents\" rel=\"Ext.form.Basic-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
1270       "params": [
1271         {
1272           "type": "Boolean",
1273           "name": "queueSuspended",
1274           "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.form.Basic-method-resumeEvents\" rel=\"Ext.form.Basic-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
1275           "optional": false
1276         }
1277       ],
1278       "return": {
1279         "type": "void",
1280         "doc": "\n"
1281       },
1282       "private": false,
1283       "static": false,
1284       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1285       "linenr": 490,
1286       "html_filename": "Observable.html",
1287       "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
1288       "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.form.Basic-method-resumeEvents\" rel=\"Ext.form.Basic-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
1289     },
1290     {
1291       "tagname": "method",
1292       "name": "un",
1293       "member": "Ext.util.Observable",
1294       "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.form.Basic-method-removeListener\" rel=\"Ext.form.Basic-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
1295       "params": [
1296         {
1297           "type": "String",
1298           "name": "eventName",
1299           "doc": "<p>The type of event the handler was associated with.</p>\n",
1300           "optional": false
1301         },
1302         {
1303           "type": "Function",
1304           "name": "handler",
1305           "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.form.Basic-method-addListener\" rel=\"Ext.form.Basic-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
1306           "optional": false
1307         },
1308         {
1309           "type": "Object",
1310           "name": "scope",
1311           "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
1312           "optional": true
1313         }
1314       ],
1315       "return": {
1316         "type": "void",
1317         "doc": "\n"
1318       },
1319       "private": false,
1320       "static": false,
1321       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
1322       "linenr": 608,
1323       "html_filename": "Observable.html",
1324       "href": "Observable.html#Ext-util-Observable-method-un",
1325       "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.form.Basic-method-removeListener\" rel=\"Ext.form.Basic-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
1326     },
1327     {
1328       "tagname": "method",
1329       "name": "updateRecord",
1330       "member": "Ext.form.Basic",
1331       "doc": "<p>Persists the values in this form into the passed <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> object in a beginEdit/endEdit block.</p>\n",
1332       "params": [
1333         {
1334           "type": "Ext.data.Record",
1335           "name": "record",
1336           "doc": "<p>The record to edit</p>\n",
1337           "optional": false
1338         }
1339       ],
1340       "return": {
1341         "type": "Ext.form.Basic",
1342         "doc": "<p>this</p>\n"
1343       },
1344       "private": false,
1345       "static": false,
1346       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
1347       "linenr": 588,
1348       "html_filename": "Basic.html",
1349       "href": "Basic.html#Ext-form-Basic-method-updateRecord",
1350       "shortDoc": "<p>Persists the values in this form into the passed <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> object in a beginEdit/endEdit block.</p>\n"
1351     }
1352   ],
1353   "property": [
1354     {
1355       "tagname": "property",
1356       "name": "owner",
1357       "member": "Ext.form.Basic",
1358       "type": "Ext.container.Container",
1359       "doc": "<p>The container component to which this BasicForm is attached.</p>\n",
1360       "private": false,
1361       "static": false,
1362       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
1363       "linenr": 84,
1364       "html_filename": "Basic.html",
1365       "href": "Basic.html#Ext-form-Basic-property-owner"
1366     }
1367   ],
1368   "event": [
1369     {
1370       "tagname": "event",
1371       "name": "actioncomplete",
1372       "member": "Ext.form.Basic",
1373       "doc": "<p>Fires when an action is completed.</p>\n",
1374       "params": [
1375         {
1376           "type": "Ext.form.Basic",
1377           "name": "this",
1378           "doc": "\n",
1379           "optional": false
1380         },
1381         {
1382           "type": "Ext.form.action.Action",
1383           "name": "action",
1384           "doc": "<p>The <a href=\"#/api/Ext.form.action.Action\" rel=\"Ext.form.action.Action\" class=\"docClass\">Ext.form.action.Action</a> that completed</p>\n",
1385           "optional": false
1386         }
1387       ],
1388       "private": false,
1389       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
1390       "linenr": 122,
1391       "html_filename": "Basic.html",
1392       "href": "Basic.html#Ext-form-Basic-event-actioncomplete",
1393       "shortDoc": "<p>Fires when an action is completed.</p>\n"
1394     },
1395     {
1396       "tagname": "event",
1397       "name": "actionfailed",
1398       "member": "Ext.form.Basic",
1399       "doc": "<p>Fires when an action fails.</p>\n",
1400       "params": [
1401         {
1402           "type": "Ext.form.Basic",
1403           "name": "this",
1404           "doc": "\n",
1405           "optional": false
1406         },
1407         {
1408           "type": "Ext.form.action.Action",
1409           "name": "action",
1410           "doc": "<p>The <a href=\"#/api/Ext.form.action.Action\" rel=\"Ext.form.action.Action\" class=\"docClass\">Ext.form.action.Action</a> that failed</p>\n",
1411           "optional": false
1412         }
1413       ],
1414       "private": false,
1415       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
1416       "linenr": 115,
1417       "html_filename": "Basic.html",
1418       "href": "Basic.html#Ext-form-Basic-event-actionfailed",
1419       "shortDoc": "<p>Fires when an action fails.</p>\n"
1420     },
1421     {
1422       "tagname": "event",
1423       "name": "beforeaction",
1424       "member": "Ext.form.Basic",
1425       "doc": "<p>Fires before any action is performed. Return false to cancel the action.</p>\n",
1426       "params": [
1427         {
1428           "type": "Ext.form.Basic",
1429           "name": "this",
1430           "doc": "\n",
1431           "optional": false
1432         },
1433         {
1434           "type": "Ext.form.action.Action",
1435           "name": "action",
1436           "doc": "<p>The <a href=\"#/api/Ext.form.action.Action\" rel=\"Ext.form.action.Action\" class=\"docClass\">Ext.form.action.Action</a> to be performed</p>\n",
1437           "optional": false
1438         }
1439       ],
1440       "private": false,
1441       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
1442       "linenr": 108,
1443       "html_filename": "Basic.html",
1444       "href": "Basic.html#Ext-form-Basic-event-beforeaction",
1445       "shortDoc": "<p>Fires before any action is performed. Return false to cancel the action.</p>\n"
1446     },
1447     {
1448       "tagname": "event",
1449       "name": "dirtychange",
1450       "member": "Ext.form.Basic",
1451       "doc": "<p>Fires when the dirty state of the entire form changes.</p>\n",
1452       "params": [
1453         {
1454           "type": "Ext.form.Basic",
1455           "name": "this",
1456           "doc": "\n",
1457           "optional": false
1458         },
1459         {
1460           "type": "Boolean",
1461           "name": "dirty",
1462           "doc": "<p><tt>true</tt> if the form is now dirty, <tt>false</tt> if it is no longer dirty.</p>\n",
1463           "optional": false
1464         }
1465       ],
1466       "private": false,
1467       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
1468       "linenr": 136,
1469       "html_filename": "Basic.html",
1470       "href": "Basic.html#Ext-form-Basic-event-dirtychange",
1471       "shortDoc": "<p>Fires when the dirty state of the entire form changes.</p>\n"
1472     },
1473     {
1474       "tagname": "event",
1475       "name": "validitychange",
1476       "member": "Ext.form.Basic",
1477       "doc": "<p>Fires when the validity of the entire form changes.</p>\n",
1478       "params": [
1479         {
1480           "type": "Ext.form.Basic",
1481           "name": "this",
1482           "doc": "\n",
1483           "optional": false
1484         },
1485         {
1486           "type": "Boolean",
1487           "name": "valid",
1488           "doc": "<p><tt>true</tt> if the form is now valid, <tt>false</tt> if it is now invalid.</p>\n",
1489           "optional": false
1490         }
1491       ],
1492       "private": false,
1493       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
1494       "linenr": 129,
1495       "html_filename": "Basic.html",
1496       "href": "Basic.html#Ext-form-Basic-event-validitychange",
1497       "shortDoc": "<p>Fires when the validity of the entire form changes.</p>\n"
1498     }
1499   ],
1500   "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Basic.js",
1501   "linenr": 1,
1502   "html_filename": "Basic.html",
1503   "href": "Basic.html#Ext-form-Basic",
1504   "cssVar": [
1505
1506   ],
1507   "cssMixin": [
1508
1509   ],
1510   "component": false,
1511   "superclasses": [
1512     "Ext.util.Observable"
1513   ],
1514   "subclasses": [
1515
1516   ],
1517   "mixedInto": [
1518
1519   ],
1520   "allMixins": [
1521
1522   ]
1523 });