750f83fabd602bde633aff0dc34b31bcc65c5984.svn-base 50 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911
  1. <div class="body-wrap">
  2. <div class="top-tools">
  3. <a class="inner-link" href="#Ext.form.BasicForm-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
  4. <a class="inner-link" href="#Ext.form.BasicForm-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
  5. <a class="inner-link" href="#Ext.form.BasicForm-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
  6. <a class="inner-link" href="#Ext.form.BasicForm-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
  7. <a class="bookmark" href="../docs/?class=Ext.form.BasicForm"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
  8. </div>
  9. <div class="inheritance res-block">
  10. <pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
  11. <img src="resources/elbow-end.gif"/>BasicForm</pre></div>
  12. <h1>Class Ext.form.BasicForm</h1>
  13. <table cellspacing="0">
  14. <tr><td class="label">Package:</td><td class="hd-info">Ext.form</td></tr>
  15. <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/BasicForm.js" target="_blank">BasicForm.js</a></td></tr>
  16. <tr><td class="label">Class:</td><td class="hd-info">BasicForm</td></tr>
  17. <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>
  18. </table>
  19. <div class="description">
  20. Supplies the functionality to do "actions" on forms and initialize Ext.form.Field types on existing markup.
  21. <br><br>
  22. By default, Ext Forms are submitted through Ajax, using <a ext:cls="Ext.form.Action" href="output/Ext.form.Action.html">Ext.form.Action</a>.
  23. To enable normal browser submission of an Ext Form, override the Form's onSubmit,
  24. and submit methods:<br><br><pre><code>var myForm = <b>new</b> Ext.form.BasicForm(<em>"form-el-id"</em>, {
  25. onSubmit: Ext.emptyFn,
  26. submit: <b>function</b>() {
  27. <b>this</b>.getEl().dom.submit();
  28. }
  29. });</code></pre><br> </div>
  30. <div class="hr"></div>
  31. <a id="Ext.form.BasicForm-configs"></a>
  32. <h2>Config Options</h2>
  33. <table cellspacing="0" class="member-table">
  34. <tr>
  35. <th class="sig-header" colspan="2">Config Options</th>
  36. <th class="msource-header">Defined By</th>
  37. </tr>
  38. <tr class="config-row">
  39. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  40. <td class="sig">
  41. <a id="Ext.form.BasicForm-baseParams"></a>
  42. <b>baseParams</b> : Object <div class="mdesc">
  43. Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}. </div>
  44. </td>
  45. <td class="msource">BasicForm</td>
  46. </tr>
  47. <tr class="config-row alt expandable">
  48. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  49. <td class="sig">
  50. <a id="Ext.form.BasicForm-errorReader"></a>
  51. <b>errorReader</b> : DataReader <div class="mdesc">
  52. <div class="short">An Ext.data.DataReader (e.g. Ext.data.XmlReader) to be used to read data when reading validation errors on "submit" a...</div>
  53. <div class="long">
  54. 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 reading validation errors on "submit" actions. This is completely optional as there is built-in support for processing JSON. </div>
  55. </div>
  56. </td>
  57. <td class="msource">BasicForm</td>
  58. </tr>
  59. <tr class="config-row">
  60. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  61. <td class="sig">
  62. <a id="Ext.form.BasicForm-fileUpload"></a>
  63. <b>fileUpload</b> : Boolean <div class="mdesc">
  64. Set to true if this form is a file upload. </div>
  65. </td>
  66. <td class="msource">BasicForm</td>
  67. </tr>
  68. <tr class="config-row inherited alt expandable">
  69. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  70. <td class="sig">
  71. <a id="Ext.form.BasicForm-listeners"></a>
  72. <b>listeners</b> : Object <div class="mdesc">
  73. <div class="short">A config object containing one or more event handlers to be added to this object during initialization. This should b...</div>
  74. <div class="long">
  75. 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>
  76. </div>
  77. </td>
  78. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>
  79. </tr>
  80. <tr class="config-row">
  81. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  82. <td class="sig">
  83. <a id="Ext.form.BasicForm-method"></a>
  84. <b>method</b> : String <div class="mdesc">
  85. The request method to use (GET or POST) for form actions if one isn't supplied in the action options. </div>
  86. </td>
  87. <td class="msource">BasicForm</td>
  88. </tr>
  89. <tr class="config-row alt expandable">
  90. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  91. <td class="sig">
  92. <a id="Ext.form.BasicForm-reader"></a>
  93. <b>reader</b> : DataReader <div class="mdesc">
  94. <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>
  95. <div class="long">
  96. 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>
  97. </div>
  98. </td>
  99. <td class="msource">BasicForm</td>
  100. </tr>
  101. <tr class="config-row">
  102. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  103. <td class="sig">
  104. <a id="Ext.form.BasicForm-timeout"></a>
  105. <b>timeout</b> : Number <div class="mdesc">
  106. Timeout for form actions in seconds (default is 30 seconds). </div>
  107. </td>
  108. <td class="msource">BasicForm</td>
  109. </tr>
  110. <tr class="config-row alt">
  111. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  112. <td class="sig">
  113. <a id="Ext.form.BasicForm-trackResetOnLoad"></a>
  114. <b>trackResetOnLoad</b> : Boolean <div class="mdesc">
  115. If set to true, form.reset() resets to the last loaded or setValues() data instead of when the form was first created. </div>
  116. </td>
  117. <td class="msource">BasicForm</td>
  118. </tr>
  119. <tr class="config-row">
  120. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  121. <td class="sig">
  122. <a id="Ext.form.BasicForm-url"></a>
  123. <b>url</b> : String <div class="mdesc">
  124. The URL to use for form actions if one isn't supplied in the action options. </div>
  125. </td>
  126. <td class="msource">BasicForm</td>
  127. </tr>
  128. </table>
  129. <a id="Ext.form.BasicForm-props"></a>
  130. <h2>Public Properties</h2>
  131. <table cellspacing="0" class="member-table">
  132. <tr>
  133. <th class="sig-header" colspan="2">Property</th>
  134. <th class="msource-header">Defined By</th>
  135. </tr>
  136. <tr class="property-row expandable">
  137. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  138. <td class="sig">
  139. <a id="Ext.form.BasicForm-waitMsgTarget"></a>
  140. <b>waitMsgTarget</b> : Mixed <div class="mdesc">
  141. <div class="short">By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific
  142. element by passing it or i...</div>
  143. <div class="long">
  144. By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific
  145. element by passing it or its id or mask the form itself by passing in true. </div>
  146. </div>
  147. </td>
  148. <td class="msource">BasicForm</td>
  149. </tr>
  150. </table>
  151. <a id="Ext.form.BasicForm-methods"></a>
  152. <h2>Public Methods</h2>
  153. <table cellspacing="0" class="member-table">
  154. <tr>
  155. <th class="sig-header" colspan="2">Method</th>
  156. <th class="msource-header">Defined By</th>
  157. </tr>
  158. <tr class="method-row expandable">
  159. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  160. <td class="sig">
  161. <a id="Ext.form.BasicForm-BasicForm"></a>
  162. <b>BasicForm</b>(&nbsp;<code>Mixed el</code>, <code>Object config</code>&nbsp;) <div class="mdesc">
  163. <div class="short"></div>
  164. <div class="long">
  165. <div class="mdetail-params">
  166. <strong>Parameters:</strong>
  167. <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>
  168. <strong>Returns:</strong>
  169. <ul>
  170. <li><code></code></li>
  171. </ul>
  172. </div>
  173. </div>
  174. </div>
  175. </td>
  176. <td class="msource">BasicForm</td>
  177. </tr>
  178. <tr class="method-row alt expandable">
  179. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  180. <td class="sig">
  181. <a id="Ext.form.BasicForm-add"></a>
  182. <b>add</b>(&nbsp;<code>Field field1</code>, <span class="optional" title="Optional">[<code>Field field2</code>]</span>, <span class="optional" title="Optional">[<code>Field etc</code>]</span>&nbsp;) : BasicForm <div class="mdesc">
  183. <div class="short">Add Ext.form components to this form.</div>
  184. <div class="long">
  185. Add Ext.form components to this form. <div class="mdetail-params">
  186. <strong>Parameters:</strong>
  187. <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>
  188. <strong>Returns:</strong>
  189. <ul>
  190. <li><code>BasicForm</code><div class="sub-desc">this</div></li>
  191. </ul>
  192. </div>
  193. </div>
  194. </div>
  195. </td>
  196. <td class="msource">BasicForm</td>
  197. </tr>
  198. <tr class="method-row inherited expandable">
  199. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  200. <td class="sig">
  201. <a id="Ext.form.BasicForm-addEvents"></a>
  202. <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void <div class="mdesc">
  203. <div class="short">Used to define events on this Observable</div>
  204. <div class="long">
  205. Used to define events on this Observable <div class="mdetail-params">
  206. <strong>Parameters:</strong>
  207. <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li> </ul>
  208. <strong>Returns:</strong>
  209. <ul>
  210. <li><code>void</code></li>
  211. </ul>
  212. </div>
  213. </div>
  214. </div>
  215. </td>
  216. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>
  217. </tr>
  218. <tr class="method-row inherited alt expandable">
  219. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  220. <td class="sig">
  221. <a id="Ext.form.BasicForm-addListener"></a>
  222. <b>addListener</b>(&nbsp;<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>&nbsp;) : void <div class="mdesc">
  223. <div class="short">Appends an event handler to this component</div>
  224. <div class="long">
  225. Appends an event handler to this component <div class="mdetail-params">
  226. <strong>Parameters:</strong>
  227. <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
  228. function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
  229. properties. This may contain any of the following properties:<ul>
  230. <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>
  231. <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>
  232. <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>
  233. <li>buffer {Number} 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
  234. by the specified number of milliseconds. If the event fires again within that time, the original
  235. handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>
  236. </ul><br>
  237. <p>
  238. <b>Combining Options</b><br>
  239. Using the options argument, it is possible to combine different types of listeners:<br>
  240. <br>
  241. A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
  242. <pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
  243. single: true,
  244. delay: 100,
  245. forumId: 4
  246. });</code></pre>
  247. <p>
  248. <b>Attaching multiple handlers in 1 call</b><br>
  249. The method also allows for a single argument to be passed which is a config object containing properties
  250. which specify multiple handlers.
  251. <p>
  252. <pre><code>foo.on({
  253. <em>'click'</em> : {
  254. fn: <b>this</b>.onClick,
  255. scope: <b>this</b>,
  256. delay: 100
  257. },
  258. <em>'mouseover'</em> : {
  259. fn: <b>this</b>.onMouseOver,
  260. scope: <b>this</b>
  261. },
  262. <em>'mouseout'</em> : {
  263. fn: <b>this</b>.onMouseOut,
  264. scope: <b>this</b>
  265. }
  266. });</code></pre>
  267. <p>
  268. Or a shorthand syntax:<br>
  269. <pre><code>foo.on({
  270. <em>'click'</em> : <b>this</b>.onClick,
  271. <em>'mouseover'</em> : <b>this</b>.onMouseOver,
  272. <em>'mouseout'</em> : <b>this</b>.onMouseOut,
  273. scope: <b>this</b>
  274. });</code></pre></div></li> </ul>
  275. <strong>Returns:</strong>
  276. <ul>
  277. <li><code>void</code></li>
  278. </ul>
  279. </div>
  280. </div>
  281. </div>
  282. </td>
  283. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>
  284. </tr>
  285. <tr class="method-row expandable">
  286. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  287. <td class="sig">
  288. <a id="Ext.form.BasicForm-applyIfToFields"></a>
  289. <b>applyIfToFields</b>(&nbsp;<code>Object values</code>&nbsp;) : BasicForm <div class="mdesc">
  290. <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>
  291. <div class="long">
  292. 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">
  293. <strong>Parameters:</strong>
  294. <ul><li><code>values</code> : Object<div class="sub-desc"></div></li> </ul>
  295. <strong>Returns:</strong>
  296. <ul>
  297. <li><code>BasicForm</code><div class="sub-desc">this</div></li>
  298. </ul>
  299. </div>
  300. </div>
  301. </div>
  302. </td>
  303. <td class="msource">BasicForm</td>
  304. </tr>
  305. <tr class="method-row alt expandable">
  306. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  307. <td class="sig">
  308. <a id="Ext.form.BasicForm-applyToFields"></a>
  309. <b>applyToFields</b>(&nbsp;<code>Object values</code>&nbsp;) : BasicForm <div class="mdesc">
  310. <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>
  311. <div class="long">
  312. 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">
  313. <strong>Parameters:</strong>
  314. <ul><li><code>values</code> : Object<div class="sub-desc"></div></li> </ul>
  315. <strong>Returns:</strong>
  316. <ul>
  317. <li><code>BasicForm</code><div class="sub-desc">this</div></li>
  318. </ul>
  319. </div>
  320. </div>
  321. </div>
  322. </td>
  323. <td class="msource">BasicForm</td>
  324. </tr>
  325. <tr class="method-row expandable">
  326. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  327. <td class="sig">
  328. <a id="Ext.form.BasicForm-clearInvalid"></a>
  329. <b>clearInvalid</b>() : BasicForm <div class="mdesc">
  330. <div class="short">Clears all invalid messages in this form.</div>
  331. <div class="long">
  332. Clears all invalid messages in this form. <div class="mdetail-params">
  333. <strong>Parameters:</strong>
  334. <ul><li>None.</li> </ul>
  335. <strong>Returns:</strong>
  336. <ul>
  337. <li><code>BasicForm</code><div class="sub-desc">this</div></li>
  338. </ul>
  339. </div>
  340. </div>
  341. </div>
  342. </td>
  343. <td class="msource">BasicForm</td>
  344. </tr>
  345. <tr class="method-row alt expandable">
  346. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  347. <td class="sig">
  348. <a id="Ext.form.BasicForm-doAction"></a>
  349. <b>doAction</b>(&nbsp;<code>String/Object actionName</code>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : BasicForm <div class="mdesc">
  350. <div class="short">Performs a predefined action (Ext.form.Action.Submit or
  351. Ext.form.Action.Load) or a custom extension of Ext.form.Actio...</div>
  352. <div class="long">
  353. Performs a predefined action (<a ext:cls="Ext.form.Action.Submit" href="output/Ext.form.Action.Submit.html">Ext.form.Action.Submit</a> or
  354. <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>
  355. to perform application-specific processing. <div class="mdetail-params">
  356. <strong>Parameters:</strong>
  357. <ul><li><code>actionName</code> : String/Object<div class="sub-desc">The name of the predefined action type,
  358. 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>.
  359. All of the config options listed below are supported by both the submit
  360. and load actions unless otherwise noted (custom actions could also accept
  361. other config options):<ul>
  362. <li><b>url</b> : String<p style="margin-left:1em">The url for the action (defaults
  363. to the form's url.)</p></li>
  364. <li><b>method</b> : String<p style="margin-left:1em">The form method to use (defaults
  365. to the form's method, or POST if not defined)</p></li>
  366. <li><b>params</b> : String/Object<p style="margin-left:1em">The params to pass
  367. (defaults to the form's baseParams, or none if not defined)</p></li>
  368. <li><b>success</b> : Function<p style="margin-left:1em">The callback that will
  369. be invoked after a successful response. Note that this is HTTP success
  370. (the transaction was sent and received correctly), but the resulting response data
  371. can still contain data errors. The function is passed the following parameters:<ul>
  372. <li><code>form</code> : Ext.form.BasicForm<div class="sub-desc">The form that requested the action</div></li>
  373. <li><code>action</code> : Ext.form.Action<div class="sub-desc">The Action class. The <a ext:cls="Ext.form.Action" ext:member="result" href="output/Ext.form.Action.html#result">result</a>
  374. property of this object may be examined to perform custom postprocessing.</div></li>
  375. </ul></p></li>
  376. <li><b>failure</b> : Function<p style="margin-left:1em">The callback that will
  377. be invoked after a failed transaction attempt. Note that this is HTTP failure,
  378. which means a non-successful HTTP code was returned from the server. The function
  379. is passed the following parameters:<ul>
  380. <li><code>form</code> : Ext.form.BasicForm<div class="sub-desc">The form that requested the action</div></li>
  381. <li><code>action</code> : Ext.form.Action<div class="sub-desc">The Action class. If an Ajax
  382. 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>
  383. property of this object may be examined to perform custom postprocessing.</div></li>
  384. </ul></p></li>
  385. <li><b>scope</b> : Object<p style="margin-left:1em">The scope in which to call the
  386. callback functions (The <tt>this</tt> reference for the callback functions).</p></li>
  387. <li><b>clientValidation</b> : Boolean<p style="margin-left:1em">Submit Action only.
  388. Determines whether a Form's fields are validated in a final call to
  389. <a ext:cls="Ext.form.BasicForm" ext:member="isValid" href="output/Ext.form.BasicForm.html#isValid">isValid</a> prior to submission. Pass <tt>false</tt>
  390. in the to prevent this. If not defined, pre-submission field validation is performed.</p></li></ul></div></li> </ul>
  391. <strong>Returns:</strong>
  392. <ul>
  393. <li><code>BasicForm</code><div class="sub-desc">this</div></li>
  394. </ul>
  395. </div>
  396. </div>
  397. </div>
  398. </td>
  399. <td class="msource">BasicForm</td>
  400. </tr>
  401. <tr class="method-row expandable">
  402. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  403. <td class="sig">
  404. <a id="Ext.form.BasicForm-findField"></a>
  405. <b>findField</b>(&nbsp;<code>String id</code>&nbsp;) : Field <div class="mdesc">
  406. <div class="short">Find a Ext.form.Field in this form by id, dataIndex, name or hiddenName.</div>
  407. <div class="long">
  408. Find a Ext.form.Field in this form by id, dataIndex, name or hiddenName. <div class="mdetail-params">
  409. <strong>Parameters:</strong>
  410. <ul><li><code>id</code> : String<div class="sub-desc">The value to search for</div></li> </ul>
  411. <strong>Returns:</strong>
  412. <ul>
  413. <li><code>Field</code></li>
  414. </ul>
  415. </div>
  416. </div>
  417. </div>
  418. </td>
  419. <td class="msource">BasicForm</td>
  420. </tr>
  421. <tr class="method-row inherited alt expandable">
  422. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  423. <td class="sig">
  424. <a id="Ext.form.BasicForm-fireEvent"></a>
  425. <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean <div class="mdesc">
  426. <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
  427. <div class="long">
  428. Fires the specified event with the passed parameters (minus the event name). <div class="mdetail-params">
  429. <strong>Parameters:</strong>
  430. <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>
  431. <strong>Returns:</strong>
  432. <ul>
  433. <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
  434. </ul>
  435. </div>
  436. </div>
  437. </div>
  438. </td>
  439. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>
  440. </tr>
  441. <tr class="method-row expandable">
  442. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  443. <td class="sig">
  444. <a id="Ext.form.BasicForm-getEl"></a>
  445. <b>getEl</b>() : Ext.Element <div class="mdesc">
  446. <div class="short">Get the HTML form Element</div>
  447. <div class="long">
  448. Get the HTML form Element <div class="mdetail-params">
  449. <strong>Parameters:</strong>
  450. <ul><li>None.</li> </ul>
  451. <strong>Returns:</strong>
  452. <ul>
  453. <li><code>Ext.Element</code></li>
  454. </ul>
  455. </div>
  456. </div>
  457. </div>
  458. </td>
  459. <td class="msource">BasicForm</td>
  460. </tr>
  461. <tr class="method-row alt expandable">
  462. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  463. <td class="sig">
  464. <a id="Ext.form.BasicForm-getValues"></a>
  465. <b>getValues</b>(&nbsp;<span class="optional" title="Optional">[<code>Boolean asString</code>]</span>&nbsp;) : String/Object <div class="mdesc">
  466. <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>
  467. <div class="long">
  468. Returns the fields in this form as an object with key/value pairs as they would be submitted using a standard form submit.
  469. If multiple fields exist with the same name they are returned as an array. <div class="mdetail-params">
  470. <strong>Parameters:</strong>
  471. <ul><li><code>asString</code> : Boolean<div class="sub-desc">(optional) false to return the the values as an object (defaults to returning as a string)</div></li> </ul>
  472. <strong>Returns:</strong>
  473. <ul>
  474. <li><code>String/Object</code></li>
  475. </ul>
  476. </div>
  477. </div>
  478. </div>
  479. </td>
  480. <td class="msource">BasicForm</td>
  481. </tr>
  482. <tr class="method-row inherited expandable">
  483. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  484. <td class="sig">
  485. <a id="Ext.form.BasicForm-hasListener"></a>
  486. <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean <div class="mdesc">
  487. <div class="short">Checks to see if this object has any listeners for a specified event</div>
  488. <div class="long">
  489. Checks to see if this object has any listeners for a specified event <div class="mdetail-params">
  490. <strong>Parameters:</strong>
  491. <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li> </ul>
  492. <strong>Returns:</strong>
  493. <ul>
  494. <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>
  495. </ul>
  496. </div>
  497. </div>
  498. </div>
  499. </td>
  500. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>
  501. </tr>
  502. <tr class="method-row alt expandable">
  503. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  504. <td class="sig">
  505. <a id="Ext.form.BasicForm-isDirty"></a>
  506. <b>isDirty</b>() : Boolean <div class="mdesc">
  507. <div class="short">Returns true if any fields in this form have changed since their original load.</div>
  508. <div class="long">
  509. Returns true if any fields in this form have changed since their original load. <div class="mdetail-params">
  510. <strong>Parameters:</strong>
  511. <ul><li>None.</li> </ul>
  512. <strong>Returns:</strong>
  513. <ul>
  514. <li><code>Boolean</code></li>
  515. </ul>
  516. </div>
  517. </div>
  518. </div>
  519. </td>
  520. <td class="msource">BasicForm</td>
  521. </tr>
  522. <tr class="method-row expandable">
  523. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  524. <td class="sig">
  525. <a id="Ext.form.BasicForm-isValid"></a>
  526. <b>isValid</b>() : Boolean <div class="mdesc">
  527. <div class="short">Returns true if client-side validation on the form is successful.</div>
  528. <div class="long">
  529. Returns true if client-side validation on the form is successful. <div class="mdetail-params">
  530. <strong>Parameters:</strong>
  531. <ul><li>None.</li> </ul>
  532. <strong>Returns:</strong>
  533. <ul>
  534. <li><code>Boolean</code></li>
  535. </ul>
  536. </div>
  537. </div>
  538. </div>
  539. </td>
  540. <td class="msource">BasicForm</td>
  541. </tr>
  542. <tr class="method-row alt expandable">
  543. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  544. <td class="sig">
  545. <a id="Ext.form.BasicForm-load"></a>
  546. <b>load</b>(&nbsp;<code>Object options</code>&nbsp;) : BasicForm <div class="mdesc">
  547. <div class="short">Shortcut to do a load action.</div>
  548. <div class="long">
  549. Shortcut to do a load action. <div class="mdetail-params">
  550. <strong>Parameters:</strong>
  551. <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>
  552. <strong>Returns:</strong>
  553. <ul>
  554. <li><code>BasicForm</code><div class="sub-desc">this</div></li>
  555. </ul>
  556. </div>
  557. </div>
  558. </div>
  559. </td>
  560. <td class="msource">BasicForm</td>
  561. </tr>
  562. <tr class="method-row expandable">
  563. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  564. <td class="sig">
  565. <a id="Ext.form.BasicForm-loadRecord"></a>
  566. <b>loadRecord</b>(&nbsp;<code>Record record</code>&nbsp;) : BasicForm <div class="mdesc">
  567. <div class="short">Loads an Ext.data.Record into this form.</div>
  568. <div class="long">
  569. Loads an Ext.data.Record into this form. <div class="mdetail-params">
  570. <strong>Parameters:</strong>
  571. <ul><li><code>record</code> : Record<div class="sub-desc">The record to load</div></li> </ul>
  572. <strong>Returns:</strong>
  573. <ul>
  574. <li><code>BasicForm</code><div class="sub-desc">this</div></li>
  575. </ul>
  576. </div>
  577. </div>
  578. </div>
  579. </td>
  580. <td class="msource">BasicForm</td>
  581. </tr>
  582. <tr class="method-row alt expandable">
  583. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  584. <td class="sig">
  585. <a id="Ext.form.BasicForm-markInvalid"></a>
  586. <b>markInvalid</b>(&nbsp;<code>Array/Object errors</code>&nbsp;) : BasicForm <div class="mdesc">
  587. <div class="short">Mark fields in this form invalid in bulk.</div>
  588. <div class="long">
  589. Mark fields in this form invalid in bulk. <div class="mdetail-params">
  590. <strong>Parameters:</strong>
  591. <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>
  592. <strong>Returns:</strong>
  593. <ul>
  594. <li><code>BasicForm</code><div class="sub-desc">this</div></li>
  595. </ul>
  596. </div>
  597. </div>
  598. </div>
  599. </td>
  600. <td class="msource">BasicForm</td>
  601. </tr>
  602. <tr class="method-row inherited expandable">
  603. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  604. <td class="sig">
  605. <a id="Ext.form.BasicForm-on"></a>
  606. <b>on</b>(&nbsp;<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>&nbsp;) : void <div class="mdesc">
  607. <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
  608. <div class="long">
  609. Appends an event handler to this element (shorthand for addListener) <div class="mdetail-params">
  610. <strong>Parameters:</strong>
  611. <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
  612. function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li> </ul>
  613. <strong>Returns:</strong>
  614. <ul>
  615. <li><code>void</code></li>
  616. </ul>
  617. </div>
  618. </div>
  619. </div>
  620. </td>
  621. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>
  622. </tr>
  623. <tr class="method-row inherited alt expandable">
  624. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  625. <td class="sig">
  626. <a id="Ext.form.BasicForm-purgeListeners"></a>
  627. <b>purgeListeners</b>() : void <div class="mdesc">
  628. <div class="short">Removes all listeners for this object</div>
  629. <div class="long">
  630. Removes all listeners for this object <div class="mdetail-params">
  631. <strong>Parameters:</strong>
  632. <ul><li>None.</li> </ul>
  633. <strong>Returns:</strong>
  634. <ul>
  635. <li><code>void</code></li>
  636. </ul>
  637. </div>
  638. </div>
  639. </div>
  640. </td>
  641. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>
  642. </tr>
  643. <tr class="method-row expandable">
  644. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  645. <td class="sig">
  646. <a id="Ext.form.BasicForm-remove"></a>
  647. <b>remove</b>(&nbsp;<code>Field field</code>&nbsp;) : BasicForm <div class="mdesc">
  648. <div class="short">Removes a field from the items collection (does NOT remove its markup).</div>
  649. <div class="long">
  650. Removes a field from the items collection (does NOT remove its markup). <div class="mdetail-params">
  651. <strong>Parameters:</strong>
  652. <ul><li><code>field</code> : Field<div class="sub-desc"></div></li> </ul>
  653. <strong>Returns:</strong>
  654. <ul>
  655. <li><code>BasicForm</code><div class="sub-desc">this</div></li>
  656. </ul>
  657. </div>
  658. </div>
  659. </div>
  660. </td>
  661. <td class="msource">BasicForm</td>
  662. </tr>
  663. <tr class="method-row inherited alt expandable">
  664. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  665. <td class="sig">
  666. <a id="Ext.form.BasicForm-removeListener"></a>
  667. <b>removeListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void <div class="mdesc">
  668. <div class="short">Removes a listener</div>
  669. <div class="long">
  670. Removes a listener <div class="mdetail-params">
  671. <strong>Parameters:</strong>
  672. <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>
  673. <strong>Returns:</strong>
  674. <ul>
  675. <li><code>void</code></li>
  676. </ul>
  677. </div>
  678. </div>
  679. </div>
  680. </td>
  681. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>
  682. </tr>
  683. <tr class="method-row expandable">
  684. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  685. <td class="sig">
  686. <a id="Ext.form.BasicForm-render"></a>
  687. <b>render</b>() : BasicForm <div class="mdesc">
  688. <div class="short">Looks at the fields in this form, checks them for an id attribute,
  689. and calls applyTo on the existing dom element with...</div>
  690. <div class="long">
  691. Looks at the fields in this form, checks them for an id attribute,
  692. and calls applyTo on the existing dom element with that id. <div class="mdetail-params">
  693. <strong>Parameters:</strong>
  694. <ul><li>None.</li> </ul>
  695. <strong>Returns:</strong>
  696. <ul>
  697. <li><code>BasicForm</code><div class="sub-desc">this</div></li>
  698. </ul>
  699. </div>
  700. </div>
  701. </div>
  702. </td>
  703. <td class="msource">BasicForm</td>
  704. </tr>
  705. <tr class="method-row alt expandable">
  706. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  707. <td class="sig">
  708. <a id="Ext.form.BasicForm-reset"></a>
  709. <b>reset</b>() : BasicForm <div class="mdesc">
  710. <div class="short">Resets this form.</div>
  711. <div class="long">
  712. Resets this form. <div class="mdetail-params">
  713. <strong>Parameters:</strong>
  714. <ul><li>None.</li> </ul>
  715. <strong>Returns:</strong>
  716. <ul>
  717. <li><code>BasicForm</code><div class="sub-desc">this</div></li>
  718. </ul>
  719. </div>
  720. </div>
  721. </div>
  722. </td>
  723. <td class="msource">BasicForm</td>
  724. </tr>
  725. <tr class="method-row inherited expandable">
  726. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  727. <td class="sig">
  728. <a id="Ext.form.BasicForm-resumeEvents"></a>
  729. <b>resumeEvents</b>() : void <div class="mdesc">
  730. <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>
  731. <div class="long">
  732. 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">
  733. <strong>Parameters:</strong>
  734. <ul><li>None.</li> </ul>
  735. <strong>Returns:</strong>
  736. <ul>
  737. <li><code>void</code></li>
  738. </ul>
  739. </div>
  740. </div>
  741. </div>
  742. </td>
  743. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>
  744. </tr>
  745. <tr class="method-row alt expandable">
  746. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  747. <td class="sig">
  748. <a id="Ext.form.BasicForm-setValues"></a>
  749. <b>setValues</b>(&nbsp;<code>Array/Object values</code>&nbsp;) : BasicForm <div class="mdesc">
  750. <div class="short">Set values for fields in this form in bulk.</div>
  751. <div class="long">
  752. Set values for fields in this form in bulk. <div class="mdetail-params">
  753. <strong>Parameters:</strong>
  754. <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'},
  755. {id:'portOfLoading', value:'FXT'},
  756. {id:'portOfDischarge', value:'OSL'} ]</pre></code><br><br>
  757. or an object hash of the form:<br><br><code><pre>{
  758. clientName: 'Fred. Olsen Lines',
  759. portOfLoading: 'FXT',
  760. portOfDischarge: 'OSL'
  761. }</pre></code><br></div></li> </ul>
  762. <strong>Returns:</strong>
  763. <ul>
  764. <li><code>BasicForm</code><div class="sub-desc">this</div></li>
  765. </ul>
  766. </div>
  767. </div>
  768. </div>
  769. </td>
  770. <td class="msource">BasicForm</td>
  771. </tr>
  772. <tr class="method-row expandable">
  773. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  774. <td class="sig">
  775. <a id="Ext.form.BasicForm-submit"></a>
  776. <b>submit</b>(&nbsp;<code>Object options</code>&nbsp;) : BasicForm <div class="mdesc">
  777. <div class="short">Shortcut to do a submit action.</div>
  778. <div class="long">
  779. Shortcut to do a submit action. <div class="mdetail-params">
  780. <strong>Parameters:</strong>
  781. <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>
  782. <strong>Returns:</strong>
  783. <ul>
  784. <li><code>BasicForm</code><div class="sub-desc">this</div></li>
  785. </ul>
  786. </div>
  787. </div>
  788. </div>
  789. </td>
  790. <td class="msource">BasicForm</td>
  791. </tr>
  792. <tr class="method-row inherited alt expandable">
  793. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  794. <td class="sig">
  795. <a id="Ext.form.BasicForm-suspendEvents"></a>
  796. <b>suspendEvents</b>() : void <div class="mdesc">
  797. <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>
  798. <div class="long">
  799. 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">
  800. <strong>Parameters:</strong>
  801. <ul><li>None.</li> </ul>
  802. <strong>Returns:</strong>
  803. <ul>
  804. <li><code>void</code></li>
  805. </ul>
  806. </div>
  807. </div>
  808. </div>
  809. </td>
  810. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>
  811. </tr>
  812. <tr class="method-row inherited expandable">
  813. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  814. <td class="sig">
  815. <a id="Ext.form.BasicForm-un"></a>
  816. <b>un</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void <div class="mdesc">
  817. <div class="short">Removes a listener (shorthand for removeListener)</div>
  818. <div class="long">
  819. Removes a listener (shorthand for removeListener) <div class="mdetail-params">
  820. <strong>Parameters:</strong>
  821. <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>
  822. <strong>Returns:</strong>
  823. <ul>
  824. <li><code>void</code></li>
  825. </ul>
  826. </div>
  827. </div>
  828. </div>
  829. </td>
  830. <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>
  831. </tr>
  832. <tr class="method-row alt expandable">
  833. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  834. <td class="sig">
  835. <a id="Ext.form.BasicForm-updateRecord"></a>
  836. <b>updateRecord</b>(&nbsp;<code>Record record</code>&nbsp;) : BasicForm <div class="mdesc">
  837. <div class="short">Persists the values in this form into the passed Ext.data.Record object in a beginEdit/endEdit block.</div>
  838. <div class="long">
  839. Persists the values in this form into the passed Ext.data.Record object in a beginEdit/endEdit block. <div class="mdetail-params">
  840. <strong>Parameters:</strong>
  841. <ul><li><code>record</code> : Record<div class="sub-desc">The record to edit</div></li> </ul>
  842. <strong>Returns:</strong>
  843. <ul>
  844. <li><code>BasicForm</code><div class="sub-desc">this</div></li>
  845. </ul>
  846. </div>
  847. </div>
  848. </div>
  849. </td>
  850. <td class="msource">BasicForm</td>
  851. </tr>
  852. </table>
  853. <a id="Ext.form.BasicForm-events"></a>
  854. <h2>Public Events</h2>
  855. <table cellspacing="0" class="member-table">
  856. <tr>
  857. <th class="sig-header" colspan="2">Event</th>
  858. <th class="msource-header">Defined By</th>
  859. </tr>
  860. <tr class="event-row expandable">
  861. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  862. <td class="sig">
  863. <a id="Ext.form.BasicForm-actioncomplete"></a>
  864. <b>actioncomplete</b> : (&nbsp;<code>Form this</code>, <code>Action action</code>&nbsp;) <div class="mdesc">
  865. <div class="short">Fires when an action is completed.</div>
  866. <div class="long">
  867. Fires when an action is completed. <div class="mdetail-params">
  868. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  869. <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>
  870. </div>
  871. </div>
  872. </div>
  873. </td>
  874. <td class="msource">BasicForm</td>
  875. </tr>
  876. <tr class="event-row alt expandable">
  877. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  878. <td class="sig">
  879. <a id="Ext.form.BasicForm-actionfailed"></a>
  880. <b>actionfailed</b> : (&nbsp;<code>Form this</code>, <code>Action action</code>&nbsp;) <div class="mdesc">
  881. <div class="short">Fires when an action fails.</div>
  882. <div class="long">
  883. Fires when an action fails. <div class="mdetail-params">
  884. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  885. <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>
  886. </div>
  887. </div>
  888. </div>
  889. </td>
  890. <td class="msource">BasicForm</td>
  891. </tr>
  892. <tr class="event-row expandable">
  893. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  894. <td class="sig">
  895. <a id="Ext.form.BasicForm-beforeaction"></a>
  896. <b>beforeaction</b> : (&nbsp;<code>Form this</code>, <code>Action action</code>&nbsp;) <div class="mdesc">
  897. <div class="short">Fires before any action is performed. Return false to cancel the action.</div>
  898. <div class="long">
  899. Fires before any action is performed. Return false to cancel the action. <div class="mdetail-params">
  900. <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>
  901. <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>
  902. </div>
  903. </div>
  904. </div>
  905. </td>
  906. <td class="msource">BasicForm</td>
  907. </tr>
  908. </table>
  909. </div>