+++ /dev/null
- <div class="body-wrap">
- <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>
- <a class="inner-link" href="#Ext.form.BasicForm-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Ext.form.BasicForm-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
- <a class="inner-link" href="#Ext.form.BasicForm-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
- <a class="bookmark" href="../docs/?class=Ext.form.BasicForm"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
- </div>
- <div class="inheritance res-block">
-<pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
- <img src="resources/elbow-end.gif"/>BasicForm</pre></div>
- <h1>Class Ext.form.BasicForm</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"><a href="../src/BasicForm.js" target="_blank">BasicForm.js</a></td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">BasicForm</td></tr>
- <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a></td></tr>
- </table>
- <div class="description">
- *
-<p>Encapsulates the DOM <form> element at the heart of the <a ext:cls="Ext.form.FormPanel" href="output/Ext.form.FormPanel.html">FormPanel</a> class, and provides
-input field management, validation, submission, and form loading services.</p>
-<p>By default, Ext Forms are submitted through Ajax, using an instance of <a ext:cls="Ext.form.Action.Submit" href="output/Ext.form.Action.Submit.html">Ext.form.Action.Submit</a>.
-To enable normal browser submission of an Ext Form, use the <a ext:cls="Ext.form.BasicForm" ext:member="standardSubmit" href="output/Ext.form.BasicForm.html#standardSubmit">standardSubmit</a> config option.</p>
-<p><h3>File Uploads</h3><a ext:cls="Ext.form.BasicForm" ext:member="fileUpload" href="output/Ext.form.BasicForm.html#fileUpload">File uploads</a> are not performed using Ajax submission, that
-is they are <b>not</b> performed using XMLHttpRequests. Instead the form is submitted in the standard
-manner with the DOM <tt><form></tt> element temporarily modified to have its
-<a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer
-to a dynamically generated, hidden <tt><iframe></tt> which is inserted into the document
-but removed after the return data has been gathered.</p>
-<p>The server response is parsed by the browser to create the document for the IFRAME. If the
-server is using JSON to send the return object, then the
-<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header
-must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>
-<p>Characters which are significant to an HTML parser must be sent as HTML entities, so encode
-"<" as "&lt;", "&" as "&amp;" etc.</p>
-<p>The response text is retrieved from the document, and a fake XMLHttpRequest object
-is created containing a <tt>responseText</tt> property in order to conform to the
-requirements of event handlers and callbacks.</p>
-<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>
-and some server technologies (notably JEE) may require some custom processing in order to
-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">
- <tr>
- <th class="sig-header" colspan="2">Config Options</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-baseParams"></a>\r
- <b>baseParams</b> : Object <div class="mdesc">\r
- Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}. </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="config-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-errorReader"></a>\r
- <b>errorReader</b> : DataReader <div class="mdesc">\r
- <div class="short">An Ext.data.DataReader (e.g. Ext.data.XmlReader) to be used to read field error messages returned from "submit" actio...</div>\r
- <div class="long">\r
- <p>An Ext.data.DataReader (e.g. <a ext:cls="Ext.data.XmlReader" href="output/Ext.data.XmlReader.html">Ext.data.XmlReader</a>) to be used to read field error messages returned from "submit" actions. This is completely optional as there is built-in support for processing JSON.</p> <p>The Records which provide messages for the invalid Fields must use the Field name (or id) as the Record ID, and must contain a field called "msg" which contains the error message.</p> <p>The errorReader does not have to be a full-blown implementation of a DataReader. It simply needs to implement a <tt>read(xhr)</tt> function which returns an Array of Records in an object with the following structure:<pre><code>{
- records: recordArray
-}</code></pre> </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="config-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-fileUpload"></a>\r
- <b>fileUpload</b> : Boolean <div class="mdesc">\r
- <div class="short">Set to true if this form is a file upload. File uploads are not performed using normal "Ajax" techniques, that is the...</div>\r
- <div class="long">\r
- Set to true if this form is a file upload. <p>File uploads are not performed using normal "Ajax" techniques, that is they are <b>not</b> performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the DOM <tt><form></tt> element temporarily modified to have its <a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer to a dynamically generated, hidden <tt><iframe></tt> which is inserted into the document but removed after the return data has been gathered.</p> <p>The server response is parsed by the browser to create the document for the IFRAME. If the server is using JSON to send the return object, then the <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p> <p>Characters which are significant to an HTML parser must be sent as HTML entities, so encode "<" as "&lt;", "&" as "&amp;" etc.</p> <p>The response text is retrieved from the document, and a fake XMLHttpRequest object is created containing a <tt>responseText</tt> property in order to conform to the requirements of event handlers and callbacks.</p> <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> and some server technologies (notably JEE) may require some custom processing in order to retrieve parameter names and parameter values from the packet content.</p> </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="config-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-listeners"></a>\r
- <b>listeners</b> : Object <div class="mdesc">\r
- <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>\r
- <div class="long">\r
- (optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once. </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>\r
- </tr>\r
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-method"></a>\r
- <b>method</b> : String <div class="mdesc">\r
- The request method to use (GET or POST) for form actions if one isn't supplied in the action options. </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="config-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-reader"></a>\r
- <b>reader</b> : DataReader <div class="mdesc">\r
- <div class="short">An Ext.data.DataReader (e.g. Ext.data.XmlReader) to be used to read data when executing "load" actions. This is optio...</div>\r
- <div class="long">\r
- An Ext.data.DataReader (e.g. <a ext:cls="Ext.data.XmlReader" href="output/Ext.data.XmlReader.html">Ext.data.XmlReader</a>) to be used to read data when executing "load" actions. This is optional as there is built-in support for processing JSON. </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="config-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-standardSubmit"></a>\r
- <b>standardSubmit</b> : Boolean <div class="mdesc">\r
- <div class="short">If set to true, standard HTML form submits are used instead of XHR (Ajax) style form submissions. (defaults to false)...</div>\r
- <div class="long">\r
- If set to true, standard HTML form submits are used instead of XHR (Ajax) style form submissions. (defaults to false)<br> <p><b>Note:</b> When using standardSubmit, any the options to <a ext:cls="Ext.form.BasicForm" ext:member="submit" href="output/Ext.form.BasicForm.html#submit">submit</a> are ignored because Ext's Ajax infrastracture is bypassed. To pass extra parameters, you will need to create hidden fields within the form.</p> </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-timeout"></a>\r
- <b>timeout</b> : Number <div class="mdesc">\r
- Timeout for form actions in seconds (default is 30 seconds). </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="config-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-trackResetOnLoad"></a>\r
- <b>trackResetOnLoad</b> : Boolean <div class="mdesc">\r
- If set to true, form.reset() resets to the last loaded or setValues() data instead of when the form was first created. </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="config-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-url"></a>\r
- <b>url</b> : String <div class="mdesc">\r
- The URL to use for form actions if one isn't supplied in the action options. </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- </table>
- <a id="Ext.form.BasicForm-props"></a>
- <h2>Public Properties</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Property</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="property-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-waitMsgTarget"></a>\r
- <b>waitMsgTarget</b> : Mixed <div class="mdesc">\r
- <div class="short">
-By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific
-element by passing it or ...</div>\r
- <div class="long">\r
-
-By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific
-element by passing it or its id or mask the form itself by passing in true. </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- </table>
- <a id="Ext.form.BasicForm-methods"></a>
- <h2>Public Methods</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-BasicForm"></a>\r
- <b>BasicForm</b>( <code>Mixed el</code>, <code>Object config</code> ) <div class="mdesc">\r
- <div class="short"></div>\r
- <div class="long">\r
- <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code></code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-add"></a>\r
- <b>add</b>( <code>Field field1</code>, <span class="optional" title="Optional">[<code>Field field2</code>]</span>, <span class="optional" title="Optional">[<code>Field etc</code>]</span> ) : BasicForm <div class="mdesc">\r
- <div class="short">Add Ext.form Components to this form's Collection. This does not result in rendering of
-the passed Component, it just...</div>\r
- <div class="long">\r
- Add Ext.form Components to this form's Collection. This does not result in rendering of
-the passed Component, it just enables the form to validate Fields, and distribute values to
-Fields.
-<p><b>You will not usually call this function. In order to be rendered, a Field must be added
-to a <a ext:cls="Ext.Container" href="output/Ext.Container.html">Container</a>, usually an <a ext:cls="Ext.form.FormPanel" href="output/Ext.form.FormPanel.html">FormPanel</a>.
-The FormPanel to which the field is added takes care of adding the Field to the BasicForm's
-collection.</b></p> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>BasicForm</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-addEvents"></a>\r
- <b>addEvents</b>( <code>Object object</code> ) : void <div class="mdesc">\r
- <div class="short">Used to define events on this Observable</div>\r
- <div class="long">\r
- Used to define events on this Observable <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-addListener"></a>\r
- <b>addListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Appends an event handler to this component</div>\r
- <div class="long">\r
- Appends an event handler to this component <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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 in which to execute the handler
-function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
-properties. This may contain any of the following properties:<ul>
-<li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
-<li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
-<li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
-<li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
-by the specified number of milliseconds. If the event fires again within that time, the original
-handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
-</ul><br>
-<p>
-<b>Combining Options</b><br>
-Using the options argument, it is possible to combine different types of listeners:<br>
-<br>
-A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
-<pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
- single: true,
- delay: 100,
- forumId: 4
-});</code></pre>
-<p>
-<b>Attaching multiple handlers in 1 call</b><br>
-The method also allows for a single argument to be passed which is a config object containing properties
-which specify multiple handlers.
-<p>
-<pre><code>foo.on({
- <em>'click'</em> : {
- fn: <b>this</b>.onClick,
- scope: <b>this</b>,
- delay: 100
- },
- <em>'mouseover'</em> : {
- fn: <b>this</b>.onMouseOver,
- scope: <b>this</b>
- },
- <em>'mouseout'</em> : {
- fn: <b>this</b>.onMouseOut,
- scope: <b>this</b>
- }
-});</code></pre>
-<p>
-Or a shorthand syntax:<br>
-<pre><code>foo.on({
- <em>'click'</em> : <b>this</b>.onClick,
- <em>'mouseover'</em> : <b>this</b>.onMouseOver,
- <em>'mouseout'</em> : <b>this</b>.onMouseOut,
- scope: <b>this</b>
-});</code></pre></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-applyIfToFields"></a>\r
- <b>applyIfToFields</b>( <code>Object values</code> ) : BasicForm <div class="mdesc">\r
- <div class="short">Calls <a ext:cls="Ext" ext:member="applyIf" href="output/Ext.html#applyIf">Ext.applyIf</a> for all field in this form with the passed object.</div>\r
- <div class="long">\r
- Calls <a ext:cls="Ext" ext:member="applyIf" href="output/Ext.html#applyIf">Ext.applyIf</a> for all field in this form with the passed object. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>values</code> : Object<div class="sub-desc"></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>BasicForm</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-applyToFields"></a>\r
- <b>applyToFields</b>( <code>Object values</code> ) : BasicForm <div class="mdesc">\r
- <div class="short">Calls <a ext:cls="Ext" ext:member="apply" href="output/Ext.html#apply">Ext.apply</a> for all fields in this form with the passed object.</div>\r
- <div class="long">\r
- Calls <a ext:cls="Ext" ext:member="apply" href="output/Ext.html#apply">Ext.apply</a> for all fields in this form with the passed object. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>values</code> : Object<div class="sub-desc"></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>BasicForm</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-clearInvalid"></a>\r
- <b>clearInvalid</b>() : BasicForm <div class="mdesc">\r
- <div class="short">Clears all invalid messages in this form.</div>\r
- <div class="long">\r
- Clears all invalid messages in this form. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>BasicForm</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-doAction"></a>\r
- <b>doAction</b>( <code>String/Object actionName</code>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : BasicForm <div class="mdesc">\r
- <div class="short">Performs a predefined action (Ext.form.Action.Submit or
-Ext.form.Action.Load) or a custom extension of Ext.form.Actio...</div>\r
- <div class="long">\r
- Performs a predefined action (<a ext:cls="Ext.form.Action.Submit" href="output/Ext.form.Action.Submit.html">Ext.form.Action.Submit</a> or
-<a ext:cls="Ext.form.Action.Load" href="output/Ext.form.Action.Load.html">Ext.form.Action.Load</a>) or a custom extension of <a ext:cls="Ext.form.Action" href="output/Ext.form.Action.html">Ext.form.Action</a>
-to perform application-specific processing. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>actionName</code> : String/Object<div class="sub-desc">The name of the predefined action type,
-or instance of <a ext:cls="Ext.form.Action" href="output/Ext.form.Action.html">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 ext:cls="Ext.form.Action" href="output/Ext.form.Action.html">Ext.form.Action</a>.
-All of the config options listed below are supported by both the submit
-and load actions unless otherwise noted (custom actions could also accept
-other config options):<ul>
-<li><b>url</b> : String<p style="margin-left:1em">The url for the action (defaults
-to the form's url.)</p></li>
-<li><b>method</b> : String<p style="margin-left:1em">The form method to use (defaults
-to the form's method, or POST if not defined)</p></li>
-<li><b>params</b> : String/Object<p style="margin-left:1em">The params to pass
-(defaults to the form's baseParams, or none if not defined)</p></li>
-<li><b>headers</b> : Object<p style="margin-left:1em">Request headers to set for the action
-(defaults to the form's default headers)</p></li>
-<li><b>success</b> : Function<p style="margin-left:1em">The callback that will
-be invoked after a successful response. The function is passed the following parameters:<ul>
-<li><code>form</code> : Ext.form.BasicForm<div class="sub-desc">The form that requested the action</div></li>
-<li><code>action</code> : Ext.form.Action<div class="sub-desc">The <a ext:cls="Ext.form.Action" href="output/Ext.form.Action.html">Action</a> object which performed the operation. The <a ext:cls="Ext.form.Action" ext:member="result" href="output/Ext.form.Action.html#result">result</a>
-property of this object may be examined to perform custom postprocessing.</div></li>
-</ul></p></li>
-<li><b>failure</b> : Function<p style="margin-left:1em">The callback that will
-be invoked after a failed transaction attempt. The function
-is passed the following parameters:<ul>
-<li><code>form</code> : Ext.form.BasicForm<div class="sub-desc">The form that requested the action</div></li>
-<li><code>action</code> : Ext.form.Action<div class="sub-desc">The <a ext:cls="Ext.form.Action" href="output/Ext.form.Action.html">Action</a> object which performed the operation. If an Ajax
-error ocurred, the failure type will be in <a ext:cls="Ext.form.Action" ext:member="failureType" href="output/Ext.form.Action.html#failureType">failureType</a>. The <a ext:cls="Ext.form.Action" ext:member="result" href="output/Ext.form.Action.html#result">result</a>
-property of this object may be examined to perform custom postprocessing.</div></li>
-</ul></p></li>
-<li><b>scope</b> : Object<p style="margin-left:1em">The scope in which to call the
-callback functions (The <tt>this</tt> reference for the callback functions).</p></li>
-<li><b>clientValidation</b> : Boolean<p style="margin-left:1em">Submit Action only.
-Determines whether a Form's fields are validated in a final call to
-<a ext:cls="Ext.form.BasicForm" ext:member="isValid" href="output/Ext.form.BasicForm.html#isValid">isValid</a> prior to submission. Set to <tt>false</tt>
-to prevent this. If undefined, pre-submission field validation is performed.</p></li></ul></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>BasicForm</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-findField"></a>\r
- <b>findField</b>( <code>String id</code> ) : Field <div class="mdesc">\r
- <div class="short">Find a Ext.form.Field in this form by id, dataIndex, name or hiddenName.</div>\r
- <div class="long">\r
- Find a Ext.form.Field in this form by id, dataIndex, name or hiddenName. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>id</code> : String<div class="sub-desc">The value to search for</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Field</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-fireEvent"></a>\r
- <b>fireEvent</b>( <code>String eventName</code>, <code>Object... args</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>\r
- <div class="long">\r
- Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-getEl"></a>\r
- <b>getEl</b>() : Ext.Element <div class="mdesc">\r
- <div class="short">Get the HTML form Element</div>\r
- <div class="long">\r
- Get the HTML form Element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Element</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-getValues"></a>\r
- <b>getValues</b>( <span class="optional" title="Optional">[<code>Boolean asString</code>]</span> ) : String/Object <div class="mdesc">\r
- <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>\r
- <div class="long">\r
- <p>Returns the fields in this form as an object with key/value pairs as they would be submitted using a standard form submit.
-If multiple fields exist with the same name they are returned as an array.</p>
-<p><b>Note:</b> The values are collected from all enabled HTML input elements within the form, <u>not</u> from
-the Ext Field objects. This means that all returned values are Strings (or Arrays of Strings) and that the the
-value can potentionally be the emptyText of a field.</p> <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>asString</code> : Boolean<div class="sub-desc">(optional) false to return the values as an object (defaults to returning as a string)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>String/Object</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-hasListener"></a>\r
- <b>hasListener</b>( <code>String eventName</code> ) : Boolean <div class="mdesc">\r
- <div class="short">Checks to see if this object has any listeners for a specified event</div>\r
- <div class="long">\r
- Checks to see if this object has any listeners for a specified event <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-isDirty"></a>\r
- <b>isDirty</b>() : Boolean <div class="mdesc">\r
- <div class="short">Returns true if any fields in this form have changed since their original load.</div>\r
- <div class="long">\r
- Returns true if any fields in this form have changed since their original load. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-isValid"></a>\r
- <b>isValid</b>() : Boolean <div class="mdesc">\r
- <div class="short">Returns true if client-side validation on the form is successful.</div>\r
- <div class="long">\r
- Returns true if client-side validation on the form is successful. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-load"></a>\r
- <b>load</b>( <code>Object options</code> ) : BasicForm <div class="mdesc">\r
- <div class="short">Shortcut to do a load action.</div>\r
- <div class="long">\r
- Shortcut to do a load action. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>options</code> : Object<div class="sub-desc">The options to pass to the action (see <a ext:cls="Ext.form.BasicForm" ext:member="doAction" href="output/Ext.form.BasicForm.html#doAction">doAction</a> for details)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>BasicForm</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-loadRecord"></a>\r
- <b>loadRecord</b>( <code>Record record</code> ) : BasicForm <div class="mdesc">\r
- <div class="short">Loads an Ext.data.Record into this form.</div>\r
- <div class="long">\r
- Loads an Ext.data.Record into this form. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>record</code> : Record<div class="sub-desc">The record to load</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>BasicForm</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-markInvalid"></a>\r
- <b>markInvalid</b>( <code>Array/Object errors</code> ) : BasicForm <div class="mdesc">\r
- <div class="short">Mark fields in this form invalid in bulk.</div>\r
- <div class="long">\r
- Mark fields in this form invalid in bulk. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>BasicForm</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-on"></a>\r
- <b>on</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Appends an event handler to this element (shorthand for addListener)</div>\r
- <div class="long">\r
- Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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 in which to execute the handler
-function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-purgeListeners"></a>\r
- <b>purgeListeners</b>() : void <div class="mdesc">\r
- <div class="short">Removes all listeners for this object</div>\r
- <div class="long">\r
- Removes all listeners for this object <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-relayEvents"></a>\r
- <b>relayEvents</b>( <code>Object o</code>, <code>Array events</code> ) : void <div class="mdesc">\r
- <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>\r
- <div class="long">\r
- Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-remove"></a>\r
- <b>remove</b>( <code>Field field</code> ) : BasicForm <div class="mdesc">\r
- <div class="short">Removes a field from the items collection (does NOT remove its markup).</div>\r
- <div class="long">\r
- Removes a field from the items collection (does NOT remove its markup). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>field</code> : Field<div class="sub-desc"></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>BasicForm</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-removeListener"></a>\r
- <b>removeListener</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Removes a listener</div>\r
- <div class="long">\r
- Removes a listener <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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 handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-render"></a>\r
- <b>render</b>() : BasicForm <div class="mdesc">\r
- <div class="short">Iterates through the Fields which have been added to this BasicForm,
-checks them for an id attribute, and calls Ext.f...</div>\r
- <div class="long">\r
- Iterates through the <a ext:cls="Ext.form.Field" href="output/Ext.form.Field.html">Field</a>s which have been <a ext:cls="Ext.form.BasicForm" ext:member="add" href="output/Ext.form.BasicForm.html#add">add</a>ed to this BasicForm,
-checks them for an id attribute, and calls <a ext:cls="Ext.form.Field" ext:member="applyToMarkup" href="output/Ext.form.Field.html#applyToMarkup">Ext.form.Field.applyToMarkup</a> on the existing dom element with that id. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>BasicForm</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-reset"></a>\r
- <b>reset</b>() : BasicForm <div class="mdesc">\r
- <div class="short">Resets this form.</div>\r
- <div class="long">\r
- Resets this form. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>BasicForm</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-resumeEvents"></a>\r
- <b>resumeEvents</b>() : void <div class="mdesc">\r
- <div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>\r
- <div class="long">\r
- Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-setValues"></a>\r
- <b>setValues</b>( <code>Array/Object values</code> ) : BasicForm <div class="mdesc">\r
- <div class="short">Set values for fields in this form in bulk.</div>\r
- <div class="long">\r
- Set values for fields in this form in bulk. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>values</code> : Array/Object<div class="sub-desc">Either an array in the form:<br><br><code><pre>[{id:'clientName', value:'Fred. Olsen Lines'},\r
- {id:'portOfLoading', value:'FXT'},\r
- {id:'portOfDischarge', value:'OSL'} ]</pre></code><br><br>
-or an object hash of the form:<br><br><code><pre>{\r
- clientName: 'Fred. Olsen Lines',\r
- portOfLoading: 'FXT',\r
- portOfDischarge: 'OSL'\r
-}</pre></code><br></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>BasicForm</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-submit"></a>\r
- <b>submit</b>( <code>Object options</code> ) : BasicForm <div class="mdesc">\r
- <div class="short">Shortcut to do a submit action.</div>\r
- <div class="long">\r
- Shortcut to do a submit action. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>options</code> : Object<div class="sub-desc">The options to pass to the action (see <a ext:cls="Ext.form.BasicForm" ext:member="doAction" href="output/Ext.form.BasicForm.html#doAction">doAction</a> for details).<br>
-<p><b>Note:</b> this is ignored when using the <a ext:cls="Ext.form.BasicForm" ext:member="standardSubmit" href="output/Ext.form.BasicForm.html#standardSubmit">standardSubmit</a> option.</p>
-<p>The following code:</p><pre><code>myFormPanel.getForm().submit({
- clientValidation: true,
- url: <em>'updateConsignment.php'</em>,
- params: {
- newStatus: <em>'delivered'</em>
- },
- success: <b>function</b>(form, action) {
- Ext.Msg.alert(<em>"Success"</em>, action.result.msg);
- },
- failure: <b>function</b>(form, action) {
- <b>switch</b> (action.failureType) {
- <b>case</b> Ext.form.Action.CLIENT_INVALID:
- Ext.Msg.alert(<em>"Failure"</em>, <em>"Form fields may not be submitted <b>with</b> invalid values"</em>);
- <b>break</b>;
- <b>case</b> Ext.form.Action.CONNECT_FAILURE:
- Ext.Msg.alert(<em>"Failure"</em>, <em>"Ajax communication failed"</em>);
- <b>break</b>;
- <b>case</b> Ext.form.Action.SERVER_INVALID:
- Ext.Msg.alert(<em>"Failure"</em>, action.result.msg);
- }
- }
-});</code></pre>
-would process the following server response for a successful submission:<pre><code>{
- success: true,
- msg: <em>'Consignment updated'</em>
-}</code></pre>
-and the following server response for a failed submission:<pre><code>{
- success: false,
- msg: <em>'You <b>do</b> not have permission to perform <b>this</b> operation'</em>
-}</code></pre></div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>BasicForm</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="method-row inherited expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-suspendEvents"></a>\r
- <b>suspendEvents</b>() : void <div class="mdesc">\r
- <div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>\r
- <div class="long">\r
- Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>\r
- </tr>\r
- <tr class="method-row inherited alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-un"></a>\r
- <b>un</b>( <code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : void <div class="mdesc">\r
- <div class="short">Removes a listener (shorthand for removeListener)</div>\r
- <div class="long">\r
- Removes a listener (shorthand for removeListener) <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <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 handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>void</code></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-updateRecord"></a>\r
- <b>updateRecord</b>( <code>Record record</code> ) : BasicForm <div class="mdesc">\r
- <div class="short">Persists the values in this form into the passed Ext.data.Record object in a beginEdit/endEdit block.</div>\r
- <div class="long">\r
- Persists the values in this form into the passed Ext.data.Record object in a beginEdit/endEdit block. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>record</code> : Record<div class="sub-desc">The record to edit</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>BasicForm</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- </table>
- <a id="Ext.form.BasicForm-events"></a>
- <h2>Public Events</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Event</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-actioncomplete"></a>\r
- <b>actioncomplete</b> : ( <code>Form this</code>, <code>Action action</code> ) <div class="mdesc">\r
- <div class="short">Fires when an action is completed.</div>\r
- <div class="long">\r
- Fires when an action is completed. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Form<div class="sub-desc"></div></li><li><code>action</code> : Action<div class="sub-desc">The <a ext:cls="Ext.form.Action" href="output/Ext.form.Action.html">Ext.form.Action</a> that completed</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="event-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-actionfailed"></a>\r
- <b>actionfailed</b> : ( <code>Form this</code>, <code>Action action</code> ) <div class="mdesc">\r
- <div class="short">Fires when an action fails.</div>\r
- <div class="long">\r
- Fires when an action fails. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Form<div class="sub-desc"></div></li><li><code>action</code> : Action<div class="sub-desc">The <a ext:cls="Ext.form.Action" href="output/Ext.form.Action.html">Ext.form.Action</a> that failed</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- <tr class="event-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.form.BasicForm-beforeaction"></a>\r
- <b>beforeaction</b> : ( <code>Form this</code>, <code>Action action</code> ) <div class="mdesc">\r
- <div class="short">Fires before any action is performed. Return false to cancel the action.</div>\r
- <div class="long">\r
- Fires before any action is performed. Return false to cancel the action. <div class="mdetail-params">\r
- <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
- <ul><li><code>this</code> : Form<div class="sub-desc"></div></li><li><code>action</code> : Action<div class="sub-desc">The <a ext:cls="Ext.form.Action" href="output/Ext.form.Action.html">Ext.form.Action</a> to be performed</div></li> </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">BasicForm</td>\r
- </tr>\r
- </table>
-
- </div>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff