docs/output/Ext.form.BasicForm.html

   1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.form.BasicForm-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.form.BasicForm-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.form.BasicForm-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.form.BasicForm-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.form.BasicForm"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif">BasicForm</pre></div><h1>Class <a href="source/BasicForm.html#cls-Ext.form.BasicForm">Ext.form.BasicForm</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.form</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">BasicForm.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/BasicForm.html#cls-Ext.form.BasicForm">BasicForm</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.util.Observable.html" ext:cls="Ext.util.Observable" ext:member="">Observable</a></td></tr></table><div class="description"><p>Encapsulates the DOM &lt;form> element at the heart of the <a href="output/Ext.form.FormPanel.html" ext:cls="Ext.form.FormPanel">FormPanel</a> class, and provides
   2 input field management, validation, submission, and form loading services.</p>
   3 <p>By default, Ext Forms are submitted through Ajax, using an instance of <a href="output/Ext.form.Action.Submit.html" ext:cls="Ext.form.Action.Submit">Ext.form.Action.Submit</a>.
   4 To enable normal browser submission of an Ext Form, use the <a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-standardSubmit" ext:member="standardSubmit" ext:cls="Ext.form.BasicForm">standardSubmit</a> config option.</p>
   5 <p><b><u>File Uploads</u></b></p>
   6 <p><a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-fileUpload" ext:member="fileUpload" ext:cls="Ext.form.BasicForm">File uploads</a> are not performed using Ajax submission, that
   7 is they are <b>not</b> performed using XMLHttpRequests. Instead the form is submitted in the standard
   8 manner with the DOM <tt>&lt;form></tt> element temporarily modified to have its
   9 <a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer
  10 to a dynamically generated, hidden <tt>&lt;iframe></tt> which is inserted into the document
  11 but removed after the return data has been gathered.</p>
  12 <p>The server response is parsed by the browser to create the document for the IFRAME. If the
  13 server is using JSON to send the return object, then the
  14 <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header
  15 must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>
  16 <p>Characters which are significant to an HTML parser must be sent as HTML entities, so encode
  17 "&lt;" as "&amp;lt;", "&amp;" as "&amp;amp;" etc.</p>
  18 <p>The response text is retrieved from the document, and a fake XMLHttpRequest object
  19 is created containing a <tt>responseText</tt> property in order to conform to the
  20 requirements of event handlers and callbacks.</p>
  21 <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>
  22 and some server technologies (notably JEE) may require some custom processing in order to
  23 retrieve parameter names and parameter values from the packet content.</p></div><div class="hr"></div><a id="Ext.form.BasicForm-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-api"></a><b><a href="source/BasicForm.html#cfg-Ext.form.BasicForm-api">api</a></b> : Object<div class="mdesc"><div class="short">If specified load and submit actions will be handled
  24 with Ext.form.Action.DirectLoad and Ext.form.Action.DirectSubmit...</div><div class="long">If specified load and submit actions will be handled
  25 with <a href="output/Ext.form.Action.DirectLoad.html" ext:cls="Ext.form.Action.DirectLoad">Ext.form.Action.DirectLoad</a> and <a href="output/Ext.form.Action.DirectSubmit.html" ext:cls="Ext.form.Action.DirectSubmit">Ext.form.Action.DirectSubmit</a>.
  26 Methods which have been imported by Ext.Direct can be specified here to load and submit
  27 forms.
  28 Such as the following:<pre><code>api: {
  29     load: App.ss.MyProfile.load,
  30     submit: App.ss.MyProfile.submit
  31 }</code></pre>
  32 <p>Load actions can use <code><a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-paramOrder" ext:member="paramOrder" ext:cls="Ext.form.BasicForm">paramOrder</a></code> or <code><a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-paramsAsHash" ext:member="paramsAsHash" ext:cls="Ext.form.BasicForm">paramsAsHash</a></code>
  33 to customize how the load method is invoked.
  34 Submit actions will always use a standard form submit. The formHandler configuration must
  35 be set on the associated server-side method which has been imported by Ext.Direct</p></div></div></td><td class="msource">BasicForm</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-baseParams"></a><b><a href="source/BasicForm.html#cfg-Ext.form.BasicForm-baseParams">baseParams</a></b> : Object<div class="mdesc"><div class="short">Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.
  36 Parameters are encoded as standard HT...</div><div class="long"><p>Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.</p>
  37 <p>Parameters are encoded as standard HTTP parameters using <a href="output/Ext.html#Ext-urlEncode" ext:member="urlEncode" ext:cls="Ext">Ext.urlEncode</a>.</p></div></div></td><td class="msource">BasicForm</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-errorReader"></a><b><a href="source/BasicForm.html#cfg-Ext.form.BasicForm-errorReader">errorReader</a></b> : DataReader<div class="mdesc"><div class="short">An Ext.data.DataReader (e.g. Ext.data.XmlReader) to be used to
  38 read field error messages returned from 'submit' actio...</div><div class="long"><p>An Ext.data.DataReader (e.g. <a href="output/Ext.data.XmlReader.html" ext:cls="Ext.data.XmlReader">Ext.data.XmlReader</a>) to be used to
  39 read field error messages returned from 'submit' actions. This is optional
  40 as there is built-in support for processing JSON.</p>
  41 <p>The Records which provide messages for the invalid Fields must use the
  42 Field name (or id) as the Record ID, and must contain a field called 'msg'
  43 which contains the error message.</p>
  44 <p>The errorReader does not have to be a full-blown implementation of a
  45 DataReader. It simply needs to implement a <tt>read(xhr)</tt> function
  46 which returns an Array of Records in an object with the following
  47 structure:</p><pre><code>{
  48     records: recordArray
  49 }</code></pre></div></div></td><td class="msource">BasicForm</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-fileUpload"></a><b><a href="source/BasicForm.html#cfg-Ext.form.BasicForm-fileUpload">fileUpload</a></b> : Boolean<div class="mdesc"><div class="short">Set to true if this form is a file upload.
  50 File uploads are not performed using normal 'Ajax' techniques, that is the...</div><div class="long">Set to true if this form is a file upload.
  51 <p>File uploads are not performed using normal 'Ajax' techniques, that is they are <b>not</b>
  52 performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the
  53 DOM <tt>&lt;form></tt> element temporarily modified to have its
  54 <a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer
  55 to a dynamically generated, hidden <tt>&lt;iframe></tt> which is inserted into the document
  56 but removed after the return data has been gathered.</p>
  57 <p>The server response is parsed by the browser to create the document for the IFRAME. If the
  58 server is using JSON to send the return object, then the
  59 <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header
  60 must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>
  61 <p>Characters which are significant to an HTML parser must be sent as HTML entities, so encode
  62 "&lt;" as "&amp;lt;", "&amp;" as "&amp;amp;" etc.</p>
  63 <p>The response text is retrieved from the document, and a fake XMLHttpRequest object
  64 is created containing a <tt>responseText</tt> property in order to conform to the
  65 requirements of event handlers and callbacks.</p>
  66 <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>
  67 and some server technologies (notably JEE) may require some custom processing in order to
  68 retrieve parameter names and parameter values from the packet content.</p></div></div></td><td class="msource">BasicForm</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-listeners"></a><b><a href="source/Observable.html#cfg-Ext.util.Observable-listeners">listeners</a></b> : Object<div class="mdesc"><div class="short">A config object containing one or more event handlers to be added to this
  69 object during initialization.  This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
  70 object during initialization.  This should be a valid listeners config object as specified in the
  71 <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> example for attaching multiple handlers at once.</p>
  72 <br><p><b><u>DOM events from ExtJs <a href="output/Ext.Component.html" ext:cls="Ext.Component">Components</a></u></b></p>
  73 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
  74 is usually only done when extra value can be added. For example the <a href="output/Ext.DataView.html" ext:cls="Ext.DataView">DataView</a>'s
  75 <b><code><a href="output/Ext.DataView.html#Ext.DataView-click" ext:member="click" ext:cls="Ext.DataView">click</a></code></b> event passing the node clicked on. To access DOM
  76 events directly from a Component's HTMLElement, listeners must be added to the <i><a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">Element</a></i> after the Component
  77 has been rendered. A plugin can simplify this step:<pre><code><i>// Plugin is configured <b>with</b> a listeners config object.</i>
  78 <i>// The Component is appended to the argument list of all handler functions.</i>
  79 Ext.DomObserver = Ext.extend(Object, {
  80     constructor: <b>function</b>(config) {
  81         this.listeners = config.listeners ? config.listeners : config;
  82     },
  83
  84     <i>// Component passes itself into plugin&#39;s init method</i>
  85     init: <b>function</b>(c) {
  86         <b>var</b> p, l = this.listeners;
  87         <b>for</b> (p <b>in</b> l) {
  88             <b>if</b> (Ext.isFunction(l[p])) {
  89                 l[p] = this.createHandler(l[p], c);
  90             } <b>else</b> {
  91                 l[p].fn = this.createHandler(l[p].fn, c);
  92             }
  93         }
  94
  95         <i>// Add the listeners to the Element immediately following the render call</i>
  96         c.render = c.render.<a href="output/Function.html#Function-createSequence" ext:member="createSequence" ext:cls="Function">createSequence</a>(<b>function</b>() {
  97             <b>var</b> e = c.getEl();
  98             <b>if</b> (e) {
  99                 e.on(l);
 100             }
 101         });
 102     },
 103
 104     createHandler: <b>function</b>(fn, c) {
 105         <b>return</b> <b>function</b>(e) {
 106             fn.call(this, e, c);
 107         };
 108     }
 109 });
 110
 111 <b>var</b> combo = <b>new</b> Ext.form.ComboBox({
 112
 113     <i>// Collapse combo when its element is clicked on</i>
 114     plugins: [ <b>new</b> Ext.DomObserver({
 115         click: <b>function</b>(evt, comp) {
 116             comp.collapse();
 117         }
 118     })],
 119     store: myStore,
 120     typeAhead: true,
 121     mode: <em>'local'</em>,
 122     triggerAction: <em>'all'</em>
 123 });</code></pre></p></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#listeners" ext:member="#listeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-method"></a><b><a href="source/BasicForm.html#cfg-Ext.form.BasicForm-method">method</a></b> : String<div class="mdesc">The request method to use (GET or POST) for form actions if one isn't supplied in the action options.</div></td><td class="msource">BasicForm</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-paramOrder"></a><b><a href="source/BasicForm.html#cfg-Ext.form.BasicForm-paramOrder">paramOrder</a></b> : Array/String<div class="mdesc"><div class="short">A list of params to be executed server side.
 124 Defaults to undefined. Only used for the api
 125 load configuration.
 126 Specify...</div><div class="long"><p>A list of params to be executed server side.
 127 Defaults to <tt>undefined</tt>. Only used for the <code><a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-api" ext:member="api" ext:cls="Ext.form.BasicForm">api</a></code>
 128 <code>load</code> configuration.</p>
 129 <br><p>Specify the params in the order in which they must be executed on the
 130 server-side as either (1) an Array of String values, or (2) a String of params
 131 delimited by either whitespace, comma, or pipe. For example,
 132 any of the following would be acceptable:</p><pre><code>paramOrder: [<em>'param1'</em>,<em>'param2'</em>,<em>'param3'</em>]
 133 paramOrder: <em>'param1 param2 param3'</em>
 134 paramOrder: <em>'param1,param2,param3'</em>
 135 paramOrder: <em>'param1|param2|param'</em></code></pre></div></div></td><td class="msource">BasicForm</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-paramsAsHash"></a><b><a href="source/BasicForm.html#cfg-Ext.form.BasicForm-paramsAsHash">paramsAsHash</a></b> : Boolean<div class="mdesc"><div class="short">Only used for the api
 136 load configuration. Send parameters as a collection of named
 137 arguments (defaults to false). Pro...</div><div class="long">Only used for the <code><a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-api" ext:member="api" ext:cls="Ext.form.BasicForm">api</a></code>
 138 <code>load</code> configuration. Send parameters as a collection of named
 139 arguments (defaults to <tt>false</tt>). Providing a
 140 <tt><a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-paramOrder" ext:member="paramOrder" ext:cls="Ext.form.BasicForm">paramOrder</a></tt> nullifies this configuration.</div></div></td><td class="msource">BasicForm</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-reader"></a><b><a href="source/BasicForm.html#cfg-Ext.form.BasicForm-reader">reader</a></b> : DataReader<div class="mdesc"><div class="short">An Ext.data.DataReader (e.g. Ext.data.XmlReader) to be used to read
 141 data when executing 'load' actions. This is optio...</div><div class="long">An Ext.data.DataReader (e.g. <a href="output/Ext.data.XmlReader.html" ext:cls="Ext.data.XmlReader">Ext.data.XmlReader</a>) to be used to read
 142 data when executing 'load' actions. This is optional as there is built-in
 143 support for processing JSON.  For additional information on using an XMLReader
 144 see the example provided in examples/form/xml-form.html.</div></div></td><td class="msource">BasicForm</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-standardSubmit"></a><b><a href="source/BasicForm.html#cfg-Ext.form.BasicForm-standardSubmit">standardSubmit</a></b> : Boolean<div class="mdesc"><div class="short">If set to true, standard HTML form submits are used instead of XHR (Ajax) style
 145 form submissions. (defaults to false)...</div><div class="long">If set to true, standard HTML form submits are used instead of XHR (Ajax) style
 146 form submissions. (defaults to false)<br>
 147 <p><b>Note:</b> When using standardSubmit, the options to <a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-submit" ext:member="submit" ext:cls="Ext.form.BasicForm">submit</a> are ignored because Ext's
 148 Ajax infrastracture is bypassed. To pass extra parameters (baseParams and params), you will need to
 149 create hidden fields within the form.</p>
 150 <p>The url config option is also bypassed, so set the action as well:</p>
 151 <pre><code>PANEL.getForm().getEl().dom.action = <em>'URL'</em></code></pre>
 152 An example encapsulating the above:
 153 <pre><code><b>new</b> Ext.FormPanel({
 154     standardSubmit: true,
 155     baseParams: {
 156         foo: <em>'bar'</em>
 157     },
 158     url: <em>'myProcess.php'</em>,
 159     items: [{
 160         xtype: <em>'textfield'</em>,
 161         name: <em>'userName'</em>
 162     }],
 163     buttons: [{
 164         text: <em>'Save'</em>,
 165         handler: <b>function</b>(){
 166             <b>var</b> O = this.ownerCt;
 167             <b>if</b> (O.getForm().isValid()) {
 168                 <b>if</b> (O.url)
 169                     O.getForm().getEl().dom.action = O.url;
 170                 <b>if</b> (O.baseParams) {
 171                     <b>for</b> (i <b>in</b> O.baseParams) {
 172                         O.add({
 173                             xtype: <em>'hidden'</em>,
 174                             name: i,
 175                             value: O.baseParams[i]
 176                         })
 177                     }
 178                     O.doLayout();
 179                 }
 180                 O.getForm().submit();
 181             }
 182         }
 183     }]
 184 });</code></pre></div></div></td><td class="msource">BasicForm</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-timeout"></a><b><a href="source/BasicForm.html#cfg-Ext.form.BasicForm-timeout">timeout</a></b> : Number<div class="mdesc">Timeout for form actions in seconds (default is 30 seconds).</div></td><td class="msource">BasicForm</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-trackResetOnLoad"></a><b><a href="source/BasicForm.html#cfg-Ext.form.BasicForm-trackResetOnLoad">trackResetOnLoad</a></b> : Boolean<div class="mdesc"><div class="short">If set to true, reset() resets to the last loaded
 185 or setValues() data instead of when the form was first created.  De...</div><div class="long">If set to <tt>true</tt>, <a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-reset" ext:member="reset" ext:cls="Ext.form.BasicForm">reset</a>() resets to the last loaded
 186 or <a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-setValues" ext:member="setValues" ext:cls="Ext.form.BasicForm">setValues</a>() data instead of when the form was first created.  Defaults to <tt>false</tt>.</div></div></td><td class="msource">BasicForm</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-url"></a><b><a href="source/BasicForm.html#cfg-Ext.form.BasicForm-url">url</a></b> : String<div class="mdesc">The URL to use for form actions if one isn't supplied in the
 187 <code><a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-doAction" ext:member="doAction" ext:cls="Ext.form.BasicForm">doAction</a> options</code>.</div></td><td class="msource">BasicForm</td></tr></tbody></table><a id="Ext.form.BasicForm-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-waitMsgTarget"></a><b><a href="source/BasicForm.html#prop-Ext.form.BasicForm-waitMsgTarget">waitMsgTarget</a></b> : Mixed<div class="mdesc"><div class="short">By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific
 188 element by passing it or i...</div><div class="long">By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific
 189 element by passing it or its id or mask the form itself by passing in true.</div></div></td><td class="msource">BasicForm</td></tr></tbody></table><a id="Ext.form.BasicForm-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-BasicForm"></a><b><a href="source/BasicForm.html#cls-Ext.form.BasicForm">BasicForm</a></b>(&nbsp;<code>Mixed&nbsp;el</code>,&nbsp;<code>Object&nbsp;config</code>&nbsp;)
 190     <div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>el</code> : Mixed<div class="sub-desc">The form element or its id</div></li><li><code>config</code> : Object<div class="sub-desc">Configuration options</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-add"></a><b><a href="source/BasicForm.html#method-Ext.form.BasicForm-add">add</a></b>(&nbsp;<code>Field&nbsp;field1</code>,&nbsp;<span title="Optional" class="optional">[<code>Field&nbsp;field2</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Field&nbsp;etc</code>]</span>&nbsp;)
 191     :
 192                                         BasicForm<div class="mdesc"><div class="short">Add Ext.form Components to this form's Collection. This does not result in rendering of
 193 the passed Component, it just...</div><div class="long">Add Ext.form Components to this form's Collection. This does not result in rendering of
 194 the passed Component, it just enables the form to validate Fields, and distribute values to
 195 Fields.
 196 <p><b>You will not usually call this function. In order to be rendered, a Field must be added
 197 to a <a href="output/Ext.Container.html" ext:cls="Ext.Container">Container</a>, usually an <a href="output/Ext.form.FormPanel.html" ext:cls="Ext.form.FormPanel">FormPanel</a>.
 198 The FormPanel to which the field is added takes care of adding the Field to the BasicForm's
 199 collection.</b></p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>field1</code> : Field<div class="sub-desc"></div></li><li><code>field2</code> : Field<div class="sub-desc">(optional)</div></li><li><code>etc</code> : Field<div class="sub-desc">(optional)</div></li></ul><strong>Returns:</strong><ul><li><code>BasicForm</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-addEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addEvents">addEvents</a></b>(&nbsp;<code>Object&nbsp;object</code>&nbsp;)
 200     :
 201                                         void<div class="mdesc"><div class="short">Used to define events on this Observable</div><div class="long">Used to define events on this Observable<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addEvents" ext:member="#addEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-addListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addListener">addListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)
 202     :
 203                                         void<div class="mdesc"><div class="short">Appends an event handler to this object.</div><div class="long">Appends an event handler to this object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to listen for.</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 204 <b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.
 205 properties. This may contain any of the following properties:<ul>
 206 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 207 <b>If omitted, defaults to the object which fired the event.</b></div></li>
 208 <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>
 209 <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>
 210 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="output/Ext.util.DelayedTask.html" ext:cls="Ext.util.DelayedTask">Ext.util.DelayedTask</a> delayed
 211 by the specified number of milliseconds. If the event fires again within that time, the original
 212 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
 213 <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>
 214 if the event was bubbled up from a child Observable.</div></li>
 215 </ul><br>
 216 <p>
 217 <b>Combining Options</b><br>
 218 Using the options argument, it is possible to combine different types of listeners:<br>
 219 <br>
 220 A delayed, one-time listener.
 221 <pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, {
 222     single: true,
 223     delay: 100
 224 });</code></pre>
 225 <p>
 226 <b>Attaching multiple handlers in 1 call</b><br>
 227 The method also allows for a single argument to be passed which is a config object containing properties
 228 which specify multiple handlers.
 229 <p>
 230 <pre><code>myGridPanel.on({
 231     <em>'click'</em> : {
 232         fn: this.onClick,
 233         scope: this,
 234         delay: 100
 235     },
 236     <em>'mouseover'</em> : {
 237         fn: this.onMouseOver,
 238         scope: this
 239     },
 240     <em>'mouseout'</em> : {
 241         fn: this.onMouseOut,
 242         scope: this
 243     }
 244 });</code></pre>
 245 <p>
 246 Or a shorthand syntax:<br>
 247 <pre><code>myGridPanel.on({
 248     <em>'click'</em> : this.onClick,
 249     <em>'mouseover'</em> : this.onMouseOver,
 250     <em>'mouseout'</em> : this.onMouseOut,
 251      scope: this
 252 });</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addListener" ext:member="#addListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-applyIfToFields"></a><b><a href="source/BasicForm.html#method-Ext.form.BasicForm-applyIfToFields">applyIfToFields</a></b>(&nbsp;<code>Object&nbsp;values</code>&nbsp;)
 253     :
 254                                         BasicForm<div class="mdesc"><div class="short">Calls Ext.applyIf for all field in this form with the passed object.</div><div class="long">Calls <a href="output/Ext.html#Ext-applyIf" ext:member="applyIf" ext:cls="Ext">Ext.applyIf</a> for all field in this form with the passed object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>values</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li><code>BasicForm</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-applyToFields"></a><b><a href="source/BasicForm.html#method-Ext.form.BasicForm-applyToFields">applyToFields</a></b>(&nbsp;<code>Object&nbsp;values</code>&nbsp;)
 255     :
 256                                         BasicForm<div class="mdesc"><div class="short">Calls Ext.apply for all fields in this form with the passed object.</div><div class="long">Calls <a href="output/Ext.html#Ext-apply" ext:member="apply" ext:cls="Ext">Ext.apply</a> for all fields in this form with the passed object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>values</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li><code>BasicForm</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-clearInvalid"></a><b><a href="source/BasicForm.html#method-Ext.form.BasicForm-clearInvalid">clearInvalid</a></b>()
 257     :
 258                                         BasicForm<div class="mdesc"><div class="short">Clears all invalid messages in this form.</div><div class="long">Clears all invalid messages in this form.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>BasicForm</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-doAction"></a><b><a href="source/BasicForm.html#method-Ext.form.BasicForm-doAction">doAction</a></b>(&nbsp;<code>String/Object&nbsp;actionName</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)
 259     :
 260                                         BasicForm<div class="mdesc"><div class="short">Performs a predefined action (Ext.form.Action.Submit or
 261 Ext.form.Action.Load) or a custom extension of Ext.form.Actio...</div><div class="long">Performs a predefined action (<a href="output/Ext.form.Action.Submit.html" ext:cls="Ext.form.Action.Submit">Ext.form.Action.Submit</a> or
 262 <a href="output/Ext.form.Action.Load.html" ext:cls="Ext.form.Action.Load">Ext.form.Action.Load</a>) or a custom extension of <a href="output/Ext.form.Action.html" ext:cls="Ext.form.Action">Ext.form.Action</a>
 263 to perform application-specific processing.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>actionName</code> : String/Object<div class="sub-desc">The name of the predefined action type,
 264 or instance of <a href="output/Ext.form.Action.html" ext:cls="Ext.form.Action">Ext.form.Action</a> to perform.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) The options to pass to the <a href="output/Ext.form.Action.html" ext:cls="Ext.form.Action">Ext.form.Action</a>.
 265 All of the config options listed below are supported by both the
 266 <a href="output/Ext.form.Action.Submit.html" ext:cls="Ext.form.Action.Submit">submit</a> and <a href="output/Ext.form.Action.Load.html" ext:cls="Ext.form.Action.Load">load</a>
 267 actions unless otherwise noted (custom actions could also accept
 268 other config options):<ul>
 269 <li><b>url</b> : String<div class="sub-desc">The url for the action (defaults
 270 to the form's <a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-url" ext:member="url" ext:cls="Ext.form.BasicForm">url</a>.)</div></li>
 271 <li><b>method</b> : String<div class="sub-desc">The form method to use (defaults
 272 to the form's method, or POST if not defined)</div></li>
 273 <li><b>params</b> : String/Object<div class="sub-desc"><p>The params to pass
 274 (defaults to the form's baseParams, or none if not defined)</p>
 275 <p>Parameters are encoded as standard HTTP parameters using <a href="output/Ext.html#Ext-urlEncode" ext:member="urlEncode" ext:cls="Ext">Ext.urlEncode</a>.</p></div></li>
 276 <li><b>headers</b> : Object<div class="sub-desc">Request headers to set for the action
 277 (defaults to the form's default headers)</div></li>
 278 <li><b>success</b> : Function<div class="sub-desc">The callback that will
 279 be invoked after a successful response (see top of
 280 <a href="output/Ext.form.Action.Submit.html" ext:cls="Ext.form.Action.Submit">submit</a> and <a href="output/Ext.form.Action.Load.html" ext:cls="Ext.form.Action.Load">load</a>
 281 for a description of what constitutes a successful response).
 282 The function is passed the following parameters:<ul>
 283 <li><tt>form</tt> : Ext.form.BasicForm<div class="sub-desc">The form that requested the action</div></li>
 284 <li><tt>action</tt> : The <a href="output/Ext.form.Action.html" ext:cls="Ext.form.Action">Action</a> object which performed the operation.
 285 <div class="sub-desc">The action object contains these properties of interest:<ul>
 286 <li><tt><a href="output/Ext.form.Action.html#Ext.form.Action-response" ext:member="response" ext:cls="Ext.form.Action">response</a></tt></li>
 287 <li><tt><a href="output/Ext.form.Action.html#Ext.form.Action-result" ext:member="result" ext:cls="Ext.form.Action">result</a></tt> : interrogate for custom postprocessing</li>
 288 <li><tt><a href="output/Ext.form.Action.html#Ext.form.Action-type" ext:member="type" ext:cls="Ext.form.Action">type</a></tt></li>
 289 </ul></div></li></ul></div></li>
 290 <li><b>failure</b> : Function<div class="sub-desc">The callback that will be invoked after a
 291 failed transaction attempt. The function is passed the following parameters:<ul>
 292 <li><tt>form</tt> : The <a href="output/Ext.form.BasicForm.html" ext:cls="Ext.form.BasicForm">Ext.form.BasicForm</a> that requested the action.</li>
 293 <li><tt>action</tt> : The <a href="output/Ext.form.Action.html" ext:cls="Ext.form.Action">Action</a> object which performed the operation.
 294 <div class="sub-desc">The action object contains these properties of interest:<ul>
 295 <li><tt><a href="output/Ext.form.Action.html#Ext.form.Action-failureType" ext:member="failureType" ext:cls="Ext.form.Action">failureType</a></tt></li>
 296 <li><tt><a href="output/Ext.form.Action.html#Ext.form.Action-response" ext:member="response" ext:cls="Ext.form.Action">response</a></tt></li>
 297 <li><tt><a href="output/Ext.form.Action.html#Ext.form.Action-result" ext:member="result" ext:cls="Ext.form.Action">result</a></tt> : interrogate for custom postprocessing</li>
 298 <li><tt><a href="output/Ext.form.Action.html#Ext.form.Action-type" ext:member="type" ext:cls="Ext.form.Action">type</a></tt></li>
 299 </ul></div></li></ul></div></li>
 300 <li><b>scope</b> : Object<div class="sub-desc">The scope in which to call the
 301 callback functions (The <tt>this</tt> reference for the callback functions).</div></li>
 302 <li><b>clientValidation</b> : Boolean<div class="sub-desc">Submit Action only.
 303 Determines whether a Form's fields are validated in a final call to
 304 <a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-isValid" ext:member="isValid" ext:cls="Ext.form.BasicForm">isValid</a> prior to submission. Set to <tt>false</tt>
 305 to prevent this. If undefined, pre-submission field validation is performed.</div></li></ul></div></li></ul><strong>Returns:</strong><ul><li><code>BasicForm</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>(&nbsp;<code>Object&nbsp;events</code>&nbsp;)
 306     :
 307                                         void<div class="mdesc"><div class="short">Used to enable bubbling of events</div><div class="long">Used to enable bubbling of events<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-findField"></a><b><a href="source/BasicForm.html#method-Ext.form.BasicForm-findField">findField</a></b>(&nbsp;<code>String&nbsp;id</code>&nbsp;)
 308     :
 309                                         Field<div class="mdesc"><div class="short">Find a Ext.form.Field in this form.</div><div class="long">Find a <a href="output/Ext.form.Field.html" ext:cls="Ext.form.Field">Ext.form.Field</a> in this form.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>id</code> : String<div class="sub-desc">The value to search for (specify either a <a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a>,
 310 <a href="output/Ext.grid.Column.html#Ext.grid.Column-dataIndex" ext:member="dataIndex" ext:cls="Ext.grid.Column">dataIndex</a>, <a href="output/Ext.form.Field.html#Ext.form.Field-getName" ext:member="getName" ext:cls="Ext.form.Field">name or hiddenName</a>).</div></li></ul><strong>Returns:</strong><ul><li><code>Field</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-fireEvent"></a><b><a href="source/Observable.html#method-Ext.util.Observable-fireEvent">fireEvent</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Object...&nbsp;args</code>&nbsp;)
 311     :
 312                                         Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).
 313 An event may be set to bubble up an Obse...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
 314 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="output/Ext.Component.html#Ext.Component-getBubbleTarget" ext:member="getBubbleTarget" ext:cls="Ext.Component">Ext.Component.getBubbleTarget</a>)
 315 by calling <a href="output/Ext.util.Observable.html#Ext.util.Observable-enableBubble" ext:member="enableBubble" ext:cls="Ext.util.Observable">enableBubble</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to fire.</div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#fireEvent" ext:member="#fireEvent" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-getEl"></a><b><a href="source/BasicForm.html#method-Ext.form.BasicForm-getEl">getEl</a></b>()
 316     :
 317                                         Ext.Element<div class="mdesc"><div class="short">Get the HTML form Element</div><div class="long">Get the HTML form Element<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-getValues"></a><b><a href="source/BasicForm.html#method-Ext.form.BasicForm-getValues">getValues</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;asString</code>]</span>&nbsp;)
 318     :
 319                                         String/Object<div class="mdesc"><div class="short">Returns the fields in this form as an object with key/value pairs as they would be submitted using a standard form su...</div><div class="long"><p>Returns the fields in this form as an object with key/value pairs as they would be submitted using a standard form submit.
 320 If multiple fields exist with the same name they are returned as an array.</p>
 321 <p><b>Note:</b> The values are collected from all enabled HTML input elements within the form, <u>not</u> from
 322 the Ext Field objects. This means that all returned values are Strings (or Arrays of Strings) and that the
 323 value can potentially be the emptyText of a field.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>asString</code> : Boolean<div class="sub-desc">(optional) Pass true to return the values as a string. (defaults to false, returning an Object)</div></li></ul><strong>Returns:</strong><ul><li><code>String/Object</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-hasListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-hasListener">hasListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>&nbsp;)
 324     :
 325                                         Boolean<div class="mdesc"><div class="short">Checks to see if this object has any listeners for a specified event</div><div class="long">Checks to see if this object has any listeners for a specified event<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#hasListener" ext:member="#hasListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-isDirty"></a><b><a href="source/BasicForm.html#method-Ext.form.BasicForm-isDirty">isDirty</a></b>()
 326     :
 327                                         Boolean<div class="mdesc"><div class="short">Returns true if any fields in this form have changed from their original values.
 328 Note that if this BasicForm was conf...</div><div class="long"><p>Returns true if any fields in this form have changed from their original values.</p>
 329 <p>Note that if this BasicForm was configured with <a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-trackResetOnLoad" ext:member="trackResetOnLoad" ext:cls="Ext.form.BasicForm">trackResetOnLoad</a> then the
 330 Fields' <i>original values</i> are updated when the values are loaded by <a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-setValues" ext:member="setValues" ext:cls="Ext.form.BasicForm">setValues</a>
 331 or <a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-loadRecord" ext:member="loadRecord" ext:cls="Ext.form.BasicForm">loadRecord</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-isValid"></a><b><a href="source/BasicForm.html#method-Ext.form.BasicForm-isValid">isValid</a></b>()
 332     :
 333                                         Boolean<div class="mdesc"><div class="short">Returns true if client-side validation on the form is successful.</div><div class="long">Returns true if client-side validation on the form is successful.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-load"></a><b><a href="source/BasicForm.html#method-Ext.form.BasicForm-load">load</a></b>(&nbsp;<code>Object&nbsp;options</code>&nbsp;)
 334     :
 335                                         BasicForm<div class="mdesc"><div class="short">Shortcut to do a load action.</div><div class="long">Shortcut to <a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-doAction" ext:member="doAction" ext:cls="Ext.form.BasicForm">do</a> a <a href="output/Ext.form.Action.Load.html" ext:cls="Ext.form.Action.Load">load action</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>options</code> : Object<div class="sub-desc">The options to pass to the action (see <a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-doAction" ext:member="doAction" ext:cls="Ext.form.BasicForm">doAction</a> for details)</div></li></ul><strong>Returns:</strong><ul><li><code>BasicForm</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-loadRecord"></a><b><a href="source/BasicForm.html#method-Ext.form.BasicForm-loadRecord">loadRecord</a></b>(&nbsp;<code>Record&nbsp;record</code>&nbsp;)
 336     :
 337                                         BasicForm<div class="mdesc"><div class="short">Loads an Ext.data.Record into this form by calling setValues with the
 338 record data.
 339 See also trackResetOnLoad.</div><div class="long">Loads an <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">Ext.data.Record</a> into this form by calling <a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-setValues" ext:member="setValues" ext:cls="Ext.form.BasicForm">setValues</a> with the
 340 <a href="output/Ext.data.Record.html#Ext.data.Record-data" ext:member="data" ext:cls="Ext.data.Record">record data</a>.
 341 See also <a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-trackResetOnLoad" ext:member="trackResetOnLoad" ext:cls="Ext.form.BasicForm">trackResetOnLoad</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>record</code> : Record<div class="sub-desc">The record to load</div></li></ul><strong>Returns:</strong><ul><li><code>BasicForm</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-markInvalid"></a><b><a href="source/BasicForm.html#method-Ext.form.BasicForm-markInvalid">markInvalid</a></b>(&nbsp;<code>Array/Object&nbsp;errors</code>&nbsp;)
 342     :
 343                                         BasicForm<div class="mdesc"><div class="short">Mark fields in this form invalid in bulk.</div><div class="long">Mark fields in this form invalid in bulk.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>errors</code> : Array/Object<div class="sub-desc">Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}</div></li></ul><strong>Returns:</strong><ul><li><code>BasicForm</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-on"></a><b><a href="source/Observable.html#method-Ext.util.Observable-on">on</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)
 344     :
 345                                         void<div class="mdesc"><div class="short">Appends an event handler to this object (shorthand for addListener.)</div><div class="long">Appends an event handler to this object (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 346 <b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#on" ext:member="#on" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-purgeListeners"></a><b><a href="source/Observable.html#method-Ext.util.Observable-purgeListeners">purgeListeners</a></b>()
 347     :
 348                                         void<div class="mdesc"><div class="short">Removes all listeners for this object</div><div class="long">Removes all listeners for this object<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#purgeListeners" ext:member="#purgeListeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-relayEvents"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-relayEvents">relayEvents</a></b>(&nbsp;<code>Object&nbsp;o</code>,&nbsp;<code>Array&nbsp;events</code>&nbsp;)
 349     :
 350                                         void<div class="mdesc"><div class="short">Relays selected events from the specified Observable as if the events were fired by this.</div><div class="long">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#relayEvents" ext:member="#relayEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-remove"></a><b><a href="source/BasicForm.html#method-Ext.form.BasicForm-remove">remove</a></b>(&nbsp;<code>Field&nbsp;field</code>&nbsp;)
 351     :
 352                                         BasicForm<div class="mdesc"><div class="short">Removes a field from the items collection (does NOT remove its markup).</div><div class="long">Removes a field from the items collection (does NOT remove its markup).<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>field</code> : Field<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li><code>BasicForm</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-removeListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-removeListener">removeListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)
 353     :
 354                                         void<div class="mdesc"><div class="short">Removes an event handler.</div><div class="long">Removes an event handler.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#removeListener" ext:member="#removeListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-render"></a><b><a href="source/BasicForm.html#method-Ext.form.BasicForm-render">render</a></b>()
 355     :
 356                                         BasicForm<div class="mdesc"><div class="short">Iterates through the Fields which have been added to this BasicForm,
 357 checks them for an id attribute, and calls Ext.f...</div><div class="long">Iterates through the <a href="output/Ext.form.Field.html" ext:cls="Ext.form.Field">Field</a>s which have been <a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-add" ext:member="add" ext:cls="Ext.form.BasicForm">add</a>ed to this BasicForm,
 358 checks them for an id attribute, and calls <a href="output/Ext.form.Field.html#Ext.form.Field-applyToMarkup" ext:member="applyToMarkup" ext:cls="Ext.form.Field">Ext.form.Field.applyToMarkup</a> on the existing dom element with that id.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>BasicForm</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-reset"></a><b><a href="source/BasicForm.html#method-Ext.form.BasicForm-reset">reset</a></b>()
 359     :
 360                                         BasicForm<div class="mdesc"><div class="short">Resets this form.</div><div class="long">Resets this form.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>BasicForm</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-resumeEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-resumeEvents">resumeEvents</a></b>()
 361     :
 362                                         void<div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)
 363 If events were suspended using the queueSuspended parameter, then all
 364 event...</div><div class="long">Resume firing events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-suspendEvents" ext:member="suspendEvents" ext:cls="Ext.util.Observable">suspendEvents</a>)
 365 If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
 366 events fired during event suspension will be sent to any listeners now.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#resumeEvents" ext:member="#resumeEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-setValues"></a><b><a href="source/BasicForm.html#method-Ext.form.BasicForm-setValues">setValues</a></b>(&nbsp;<code>Array/Object&nbsp;values</code>&nbsp;)
 367     :
 368                                         BasicForm<div class="mdesc"><div class="short">Set values for fields in this form in bulk.</div><div class="long">Set values for fields in this form in bulk.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>values</code> : Array/Object<div class="sub-desc">Either an array in the form:<pre><code>[{id:<em>'clientName'</em>, value:<em>'Fred. Olsen Lines'</em>},
 369  {id:<em>'portOfLoading'</em>, value:<em>'FXT'</em>},
 370  {id:<em>'portOfDischarge'</em>, value:<em>'OSL'</em>} ]</code></pre>
 371 or an object hash of the form:<pre><code>{
 372     clientName: <em>'Fred. Olsen Lines'</em>,
 373     portOfLoading: <em>'FXT'</em>,
 374     portOfDischarge: <em>'OSL'</em>
 375 }</code></pre></div></li></ul><strong>Returns:</strong><ul><li><code>BasicForm</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-submit"></a><b><a href="source/BasicForm.html#method-Ext.form.BasicForm-submit">submit</a></b>(&nbsp;<code>Object&nbsp;options</code>&nbsp;)
 376     :
 377                                         BasicForm<div class="mdesc"><div class="short">Shortcut to do a submit action.</div><div class="long">Shortcut to <a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-doAction" ext:member="doAction" ext:cls="Ext.form.BasicForm">do</a> a <a href="output/Ext.form.Action.Submit.html" ext:cls="Ext.form.Action.Submit">submit action</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>options</code> : Object<div class="sub-desc">The options to pass to the action (see <a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-doAction" ext:member="doAction" ext:cls="Ext.form.BasicForm">doAction</a> for details).<br>
 378 <p><b>Note:</b> this is ignored when using the <a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-standardSubmit" ext:member="standardSubmit" ext:cls="Ext.form.BasicForm">standardSubmit</a> option.</p>
 379 <p>The following code:</p><pre><code>myFormPanel.getForm().submit({
 380     clientValidation: true,
 381     url: <em>'updateConsignment.php'</em>,
 382     params: {
 383         newStatus: <em>'delivered'</em>
 384     },
 385     success: <b>function</b>(form, action) {
 386        Ext.Msg.alert(<em>'Success'</em>, action.result.msg);
 387     },
 388     failure: <b>function</b>(form, action) {
 389         <b>switch</b> (action.failureType) {
 390             <b>case</b> Ext.form.Action.CLIENT_INVALID:
 391                 Ext.Msg.alert(<em>'Failure'</em>, <em>'Form fields may not be submitted <b>with</b> invalid values'</em>);
 392                 <b>break</b>;
 393             <b>case</b> Ext.form.Action.CONNECT_FAILURE:
 394                 Ext.Msg.alert(<em>'Failure'</em>, <em>'Ajax communication failed'</em>);
 395                 <b>break</b>;
 396             <b>case</b> Ext.form.Action.SERVER_INVALID:
 397                Ext.Msg.alert(<em>'Failure'</em>, action.result.msg);
 398        }
 399     }
 400 });</code></pre>
 401 would process the following server response for a successful submission:<pre><code>{
 402     <em>"success"</em>:true, <i>// note this is Boolean, not string</i>
 403     <em>"msg"</em>:<em>"Consignment updated"</em>
 404 }</code></pre>
 405 and the following server response for a failed submission:<pre><code>{
 406     <em>"success"</em>:false, <i>// note this is Boolean, not string</i>
 407     <em>"msg"</em>:<em>"You <b>do</b> not have permission to perform this operation"</em>
 408 }</code></pre></div></li></ul><strong>Returns:</strong><ul><li><code>BasicForm</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-suspendEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-suspendEvents">suspendEvents</a></b>(&nbsp;<code>Boolean&nbsp;queueSuspended</code>&nbsp;)
 409     :
 410                                         void<div class="mdesc"><div class="short">Suspend the firing of all events. (see resumeEvents)</div><div class="long">Suspend the firing of all events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a>)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>queueSuspended</code> : Boolean<div class="sub-desc">Pass as true to queue up suspended events to be fired
 411 after the <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a> call instead of discarding all suspended events;</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#suspendEvents" ext:member="#suspendEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-un"></a><b><a href="source/Observable.html#method-Ext.util.Observable-un">un</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)
 412     :
 413                                         void<div class="mdesc"><div class="short">Removes an event handler (shorthand for removeListener.)</div><div class="long">Removes an event handler (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-removeListener" ext:member="removeListener" ext:cls="Ext.util.Observable">removeListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#un" ext:member="#un" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-updateRecord"></a><b><a href="source/BasicForm.html#method-Ext.form.BasicForm-updateRecord">updateRecord</a></b>(&nbsp;<code>Record&nbsp;record</code>&nbsp;)
 414     :
 415                                         BasicForm<div class="mdesc"><div class="short">Persists the values in this form into the passed Ext.data.Record object in a beginEdit/endEdit block.</div><div class="long">Persists the values in this form into the passed <a href="output/Ext.data.Record.html" ext:cls="Ext.data.Record">Ext.data.Record</a> object in a beginEdit/endEdit block.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>record</code> : Record<div class="sub-desc">The record to edit</div></li></ul><strong>Returns:</strong><ul><li><code>BasicForm</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr></tbody></table><a id="Ext.form.BasicForm-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-actioncomplete"></a><b><a href="source/BasicForm.html#event-Ext.form.BasicForm-actioncomplete">actioncomplete</a></b> :
 416                                       (&nbsp;<code>Form&nbsp;this</code>,&nbsp;<code>Action&nbsp;action</code>&nbsp;)
 417     <div class="mdesc"><div class="short">Fires when an action is completed.</div><div class="long">Fires when an action is completed.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Form<div class="sub-desc"></div></li><li><code>action</code> : Action<div class="sub-desc">The <a href="output/Ext.form.Action.html" ext:cls="Ext.form.Action">Ext.form.Action</a> that completed</div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-actionfailed"></a><b><a href="source/BasicForm.html#event-Ext.form.BasicForm-actionfailed">actionfailed</a></b> :
 418                                       (&nbsp;<code>Form&nbsp;this</code>,&nbsp;<code>Action&nbsp;action</code>&nbsp;)
 419     <div class="mdesc"><div class="short">Fires when an action fails.</div><div class="long">Fires when an action fails.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Form<div class="sub-desc"></div></li><li><code>action</code> : Action<div class="sub-desc">The <a href="output/Ext.form.Action.html" ext:cls="Ext.form.Action">Ext.form.Action</a> that failed</div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.BasicForm-beforeaction"></a><b><a href="source/BasicForm.html#event-Ext.form.BasicForm-beforeaction">beforeaction</a></b> :
 420                                       (&nbsp;<code>Form&nbsp;this</code>,&nbsp;<code>Action&nbsp;action</code>&nbsp;)
 421     <div class="mdesc"><div class="short">Fires before any action is performed. Return false to cancel the action.</div><div class="long">Fires before any action is performed. Return false to cancel the action.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Form<div class="sub-desc"></div></li><li><code>action</code> : Action<div class="sub-desc">The <a href="output/Ext.form.Action.html" ext:cls="Ext.form.Action">Ext.form.Action</a> to be performed</div></li></ul></div></div></div></td><td class="msource">BasicForm</td></tr></tbody></table></div>