1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.form.BasicForm</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.form.BasicForm-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.form.BasicForm-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.form.BasicForm-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.form.BasicForm-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.form.BasicForm
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.form.BasicForm
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.form</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_form_BasicForm.js.html">Roo/form/BasicForm.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">BasicForm</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 Supplies the functionality to do "actions" on forms and initialize Roo.form.Field types on existing markup.
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.form.BasicForm';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo.form" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.form.BasicForm.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.form.BasicForm-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0 notInherited">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
131 <a id="Roo.form.BasicForm-cfg-baseParams" name=".baseParams"></a>
132 <div class="fixedFont">
133 <b class="itemname">baseParams</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
139 <div class="short">Parameters to pass with all requests.</div>
143 <div class="long">Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.</div>
157 <tr class="config-row expandable config-row-alt1 notInherited">
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
161 <a id="Roo.form.BasicForm-cfg-errorReader" name=".errorReader"></a>
162 <div class="fixedFont">
163 <b class="itemname">errorReader</b> : DataReader
169 <div class="short">An Roo.data.DataReader (e.g.</div>
173 <div class="long">An Roo.data.DataReader (e.g. {<b>link</b> Roo.data.XmlReader}) to be used to read data when reading validation errors on "submit" actions.<br/>This is completely optional as there is built-in support for processing JSON.</div>
187 <tr class="config-row expandable config-row-alt0 notInherited">
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
191 <a id="Roo.form.BasicForm-cfg-fileUpload" name=".fileUpload"></a>
192 <div class="fixedFont">
193 <b class="itemname">fileUpload</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
199 <div class="short">Set to true if this form is a file upload.</div>
203 <div class="long">Set to true if this form is a file upload.</div>
217 <tr class="config-row expandable config-row-alt1 notInherited">
218 <td class="micon"><a class="exi" href="#expand"> </a></td>
221 <a id="Roo.form.BasicForm-cfg-method" name=".method"></a>
222 <div class="fixedFont">
223 <b class="itemname">method</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
229 <div class="short">The request method to use (GET or POST) for form actions if one isn't supplied in the action options.</div>
233 <div class="long">The request method to use (GET or POST) for form actions if one isn't supplied in the action options.</div>
247 <tr class="config-row expandable config-row-alt0 notInherited">
248 <td class="micon"><a class="exi" href="#expand"> </a></td>
251 <a id="Roo.form.BasicForm-cfg-reader" name=".reader"></a>
252 <div class="fixedFont">
253 <b class="itemname">reader</b> : DataReader
259 <div class="short">An Roo.data.DataReader (e.g.</div>
263 <div class="long">An Roo.data.DataReader (e.g. {<b>link</b> Roo.data.XmlReader}) to be used to read data when executing "load" actions.<br/>This is optional as there is built-in support for processing JSON.</div>
277 <tr class="config-row expandable config-row-alt1 notInherited">
278 <td class="micon"><a class="exi" href="#expand"> </a></td>
281 <a id="Roo.form.BasicForm-cfg-timeout" name=".timeout"></a>
282 <div class="fixedFont">
283 <b class="itemname">timeout</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
289 <div class="short">Timeout for form actions in seconds (default is 30 seconds).</div>
293 <div class="long">Timeout for form actions in seconds (default is 30 seconds).</div>
307 <tr class="config-row expandable config-row-alt0 notInherited">
308 <td class="micon"><a class="exi" href="#expand"> </a></td>
311 <a id="Roo.form.BasicForm-cfg-trackResetOnLoad" name=".trackResetOnLoad"></a>
312 <div class="fixedFont">
313 <b class="itemname">trackResetOnLoad</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
319 <div class="short">If set to true, form.reset() resets to the last loaded<br/>or setValues() data instead of when the form was first created.</div>
323 <div class="long">If set to true, form.reset() resets to the last loaded<br/>or setValues() data instead of when the form was first created.</div>
337 <tr class="config-row expandable config-row-alt1 notInherited">
338 <td class="micon"><a class="exi" href="#expand"> </a></td>
341 <a id="Roo.form.BasicForm-cfg-url" name=".url"></a>
342 <div class="fixedFont">
343 <b class="itemname">url</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
349 <div class="short">The URL to use for form actions if one isn't supplied in the action options.</div>
353 <div class="long">The URL to use for form actions if one isn't supplied in the action options.</div>
377 <!-- ============================== public properties ==================== -->
381 <a id="Roo.form.BasicForm-props"></a>
387 <table cellspacing="0" class="member-table">
388 <caption class="Empty">Public Properties - Has None</caption>
394 <!-- ============================== methods summary / details ======================== -->
397 <a id="Roo.form.BasicForm-methods"></a>
398 <!-- constructor?? -->
405 <!-- then dynamics first -->
412 <table cellspacing="0" class="member-table">
413 <caption>Public Methods</caption>
415 <th class="sig-header" colspan="2">Method</th>
416 <th class="msource-header">Defined By</th>
426 <tr class="method-row config-row-alt0 expandable notInherited">
427 <td class="micon"><a class="exi" href="#expand"> </a></td>
431 <a id="Roo.form-method-BasicForm" name=".BasicForm"></a>
432 <div class="fixedFont">
433 <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">BasicForm</b>
435 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
443 <div class="short">Create a new Roo.form.BasicForm</div>
450 Create a new Roo.form.BasicForm
453 <dl class="detailList">
454 <dt class="heading">Parameters:</dt>
457 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span> <b>el</b>
460 <dd>The form element or its id</dd>
463 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
466 <dd>Configuration options</dd>
490 <tr class="method-row config-row-alt1 expandable notInherited">
491 <td class="micon"><a class="exi" href="#expand"> </a></td>
495 <a id="Roo.form.BasicForm-method-add" name=".add"></a>
496 <div class="fixedFont">
497 <span class="attributes"></span><b class="itemname">add</b>
499 (Field <B><i>field1</i></B>, Field <B><i>field2</i></B>, Field <B><i>etc</i></B>)
514 <div class="short">Add Roo.form components to this form.</div>
520 Add Roo.form components to this form.
527 <dl class="detailList">
528 <dt class="heading">Parameters:</dt>
531 <span class="fixedFont">Field</span> <b>field1</b>
537 <span class="fixedFont">Field</span> <b>field2</b>
543 <span class="fixedFont">Field</span> <b>etc</b>
554 <dl class="detailList">
555 <dt class="heading">Returns:</dt>
557 <dd><span class="fixedFont">BasicForm</span> this</dd>
579 <tr class="method-row config-row-alt0 expandable notInherited">
580 <td class="micon"><a class="exi" href="#expand"> </a></td>
584 <a id="Roo.form.BasicForm-method-applyIfToFields" name=".applyIfToFields"></a>
585 <div class="fixedFont">
586 <span class="attributes"></span><b class="itemname">applyIfToFields</b>
588 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>)
603 <div class="short">Calls {<b>link</b> Ext<b>applyIf</b>} for all field in this form with the passed object.</div>
609 Calls {<b>link</b> Ext<b>applyIf</b>} for all field in this form with the passed object.
616 <dl class="detailList">
617 <dt class="heading">Parameters:</dt>
620 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>values</b>
631 <dl class="detailList">
632 <dt class="heading">Returns:</dt>
634 <dd><span class="fixedFont">BasicForm</span> this</dd>
656 <tr class="method-row config-row-alt1 expandable notInherited">
657 <td class="micon"><a class="exi" href="#expand"> </a></td>
661 <a id="Roo.form.BasicForm-method-applyToFields" name=".applyToFields"></a>
662 <div class="fixedFont">
663 <span class="attributes"></span><b class="itemname">applyToFields</b>
665 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>)
680 <div class="short">Calls {<b>link</b> Ext<b>apply</b>} for all fields in this form with the passed object.</div>
686 Calls {<b>link</b> Ext<b>apply</b>} for all fields in this form with the passed object.
693 <dl class="detailList">
694 <dt class="heading">Parameters:</dt>
697 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>values</b>
708 <dl class="detailList">
709 <dt class="heading">Returns:</dt>
711 <dd><span class="fixedFont">BasicForm</span> this</dd>
733 <tr class="method-row config-row-alt0 expandable notInherited">
734 <td class="micon"><a class="exi" href="#expand"> </a></td>
738 <a id="Roo.form.BasicForm-method-clearInvalid" name=".clearInvalid"></a>
739 <div class="fixedFont">
740 <span class="attributes"></span><b class="itemname">clearInvalid</b>
757 <div class="short">Clears all invalid messages in this form.</div>
763 Clears all invalid messages in this form.
774 <dl class="detailList">
775 <dt class="heading">Returns:</dt>
777 <dd><span class="fixedFont">BasicForm</span> this</dd>
799 <tr class="method-row config-row-alt1 expandable notInherited">
800 <td class="micon"><a class="exi" href="#expand"> </a></td>
804 <a id="Roo.form.BasicForm-method-doAction" name=".doAction"></a>
805 <div class="fixedFont">
806 <span class="attributes"></span><b class="itemname">doAction</b>
808 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>actionName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
823 <div class="short">Performs a predefined action (submit or load) or custom actions you define on this form.</div>
829 Performs a predefined action (submit or load) or custom actions you define on this form.
836 <dl class="detailList">
837 <dt class="heading">Parameters:</dt>
840 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>actionName</b>
843 <dd>The name of the action type</dd>
846 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
849 <dd>(optional) The options to pass to the action. All of the config options listed<br/>below are supported by both the submit and load actions unless otherwise noted (custom actions could also<br/>accept other config options):<br/><pre><br/>Property Type Description<br/>---------------- --------------- ----------------------------------------------------------------------------------<br/>url String The url for the action (defaults to the form's url)<br/>method String The form method to use (defaults to the form's method, or POST if not defined)<br/>params String/Object The params to pass (defaults to the form's baseParams, or none if not defined)<br/>clientValidation Boolean Applies to submit only. Pass true to call form.isValid() prior to posting to<br/> validate the form on the client (defaults to false)<br/></pre></dd>
857 <dl class="detailList">
858 <dt class="heading">Returns:</dt>
860 <dd><span class="fixedFont">BasicForm</span> this</dd>
882 <tr class="method-row config-row-alt0 expandable notInherited">
883 <td class="micon"><a class="exi" href="#expand"> </a></td>
887 <a id="Roo.form.BasicForm-method-findField" name=".findField"></a>
888 <div class="fixedFont">
889 <span class="attributes"></span><b class="itemname">findField</b>
891 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
906 <div class="short">Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName</div>
912 Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName
919 <dl class="detailList">
920 <dt class="heading">Parameters:</dt>
923 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
926 <dd>The value to search for</dd>
934 <dl class="detailList">
935 <dt class="heading">Returns:</dt>
959 <tr class="method-row config-row-alt1 expandable notInherited">
960 <td class="micon"><a class="exi" href="#expand"> </a></td>
964 <a id="Roo.form.BasicForm-method-getValues" name=".getValues"></a>
965 <div class="fixedFont">
966 <span class="attributes"></span><b class="itemname">getValues</b>
968 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>asString</i></B>)
974 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
983 <div class="short">Returns the fields in this form as an object with key/value pairs.</div>
989 Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name<br/>they are returned as an array.
996 <dl class="detailList">
997 <dt class="heading">Parameters:</dt>
1000 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>asString</b>
1011 <dl class="detailList">
1012 <dt class="heading">Returns:</dt>
1014 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> </dd>
1028 <td class="msource">
1036 <tr class="method-row config-row-alt0 expandable notInherited">
1037 <td class="micon"><a class="exi" href="#expand"> </a></td>
1041 <a id="Roo.form.BasicForm-method-isDirty" name=".isDirty"></a>
1042 <div class="fixedFont">
1043 <span class="attributes"></span><b class="itemname">isDirty</b>
1060 <div class="short">Returns true if any fields in this form have changed since their original load.</div>
1066 Returns true if any fields in this form have changed since their original load.
1077 <dl class="detailList">
1078 <dt class="heading">Returns:</dt>
1094 <td class="msource">
1102 <tr class="method-row config-row-alt1 expandable notInherited">
1103 <td class="micon"><a class="exi" href="#expand"> </a></td>
1107 <a id="Roo.form.BasicForm-method-isValid" name=".isValid"></a>
1108 <div class="fixedFont">
1109 <span class="attributes"></span><b class="itemname">isValid</b>
1126 <div class="short">Returns true if client-side validation on the form is successful.</div>
1132 Returns true if client-side validation on the form is successful.
1143 <dl class="detailList">
1144 <dt class="heading">Returns:</dt>
1160 <td class="msource">
1168 <tr class="method-row config-row-alt0 expandable notInherited">
1169 <td class="micon"><a class="exi" href="#expand"> </a></td>
1173 <a id="Roo.form.BasicForm-method-load" name=".load"></a>
1174 <div class="fixedFont">
1175 <span class="attributes"></span><b class="itemname">load</b>
1177 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1192 <div class="short">Shortcut to do a load action.</div>
1198 Shortcut to do a load action.
1205 <dl class="detailList">
1206 <dt class="heading">Parameters:</dt>
1209 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
1212 <dd>The options to pass to the action (see {<b>link</b> <b>doAction</b>} for details)</dd>
1220 <dl class="detailList">
1221 <dt class="heading">Returns:</dt>
1223 <dd><span class="fixedFont">BasicForm</span> this</dd>
1237 <td class="msource">
1245 <tr class="method-row config-row-alt1 expandable notInherited">
1246 <td class="micon"><a class="exi" href="#expand"> </a></td>
1250 <a id="Roo.form.BasicForm-method-loadRecord" name=".loadRecord"></a>
1251 <div class="fixedFont">
1252 <span class="attributes"></span><b class="itemname">loadRecord</b>
1254 (Record <B><i>record</i></B>)
1269 <div class="short">Loads an Roo.data.Record into this form.</div>
1275 Loads an Roo.data.Record into this form.
1282 <dl class="detailList">
1283 <dt class="heading">Parameters:</dt>
1286 <span class="fixedFont">Record</span> <b>record</b>
1289 <dd>The record to load</dd>
1297 <dl class="detailList">
1298 <dt class="heading">Returns:</dt>
1300 <dd><span class="fixedFont">BasicForm</span> this</dd>
1314 <td class="msource">
1322 <tr class="method-row config-row-alt0 expandable notInherited">
1323 <td class="micon"><a class="exi" href="#expand"> </a></td>
1327 <a id="Roo.form.BasicForm-method-markInvalid" name=".markInvalid"></a>
1328 <div class="fixedFont">
1329 <span class="attributes"></span><b class="itemname">markInvalid</b>
1331 (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>errors</i></B>)
1346 <div class="short">Mark fields in this form invalid in bulk.</div>
1352 Mark fields in this form invalid in bulk.
1359 <dl class="detailList">
1360 <dt class="heading">Parameters:</dt>
1363 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span> <b>errors</b>
1366 <dd>Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}</dd>
1374 <dl class="detailList">
1375 <dt class="heading">Returns:</dt>
1377 <dd><span class="fixedFont">BasicForm</span> this</dd>
1391 <td class="msource">
1399 <tr class="method-row config-row-alt1 expandable notInherited">
1400 <td class="micon"><a class="exi" href="#expand"> </a></td>
1404 <a id="Roo.form.BasicForm-method-remove" name=".remove"></a>
1405 <div class="fixedFont">
1406 <span class="attributes"></span><b class="itemname">remove</b>
1408 (Field <B><i>field</i></B>)
1423 <div class="short">Removes a field from the items collection (does NOT remove its markup).</div>
1429 Removes a field from the items collection (does NOT remove its markup).
1436 <dl class="detailList">
1437 <dt class="heading">Parameters:</dt>
1440 <span class="fixedFont">Field</span> <b>field</b>
1451 <dl class="detailList">
1452 <dt class="heading">Returns:</dt>
1454 <dd><span class="fixedFont">BasicForm</span> this</dd>
1468 <td class="msource">
1476 <tr class="method-row config-row-alt0 expandable notInherited">
1477 <td class="micon"><a class="exi" href="#expand"> </a></td>
1481 <a id="Roo.form.BasicForm-method-render" name=".render"></a>
1482 <div class="fixedFont">
1483 <span class="attributes"></span><b class="itemname">render</b>
1500 <div class="short">Looks at the fields in this form, checks them for an id attribute,<br/>and calls applyTo on the existing dom element with that id.</div>
1506 Looks at the fields in this form, checks them for an id attribute,<br/>and calls applyTo on the existing dom element with that id.
1517 <dl class="detailList">
1518 <dt class="heading">Returns:</dt>
1520 <dd><span class="fixedFont">BasicForm</span> this</dd>
1534 <td class="msource">
1542 <tr class="method-row config-row-alt1 expandable notInherited">
1543 <td class="micon"><a class="exi" href="#expand"> </a></td>
1547 <a id="Roo.form.BasicForm-method-reset" name=".reset"></a>
1548 <div class="fixedFont">
1549 <span class="attributes"></span><b class="itemname">reset</b>
1566 <div class="short">Resets this form.</div>
1583 <dl class="detailList">
1584 <dt class="heading">Returns:</dt>
1586 <dd><span class="fixedFont">BasicForm</span> this</dd>
1600 <td class="msource">
1608 <tr class="method-row config-row-alt0 expandable notInherited">
1609 <td class="micon"><a class="exi" href="#expand"> </a></td>
1613 <a id="Roo.form.BasicForm-method-setValues" name=".setValues"></a>
1614 <div class="fixedFont">
1615 <span class="attributes"></span><b class="itemname">setValues</b>
1617 (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>values</i></B>)
1632 <div class="short">Set values for fields in this form in bulk.</div>
1638 Set values for fields in this form in bulk.
1645 <dl class="detailList">
1646 <dt class="heading">Parameters:</dt>
1649 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span> <b>values</b>
1652 <dd>Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}</dd>
1660 <dl class="detailList">
1661 <dt class="heading">Returns:</dt>
1663 <dd><span class="fixedFont">BasicForm</span> this</dd>
1677 <td class="msource">
1685 <tr class="method-row config-row-alt1 expandable notInherited">
1686 <td class="micon"><a class="exi" href="#expand"> </a></td>
1690 <a id="Roo.form.BasicForm-method-submit" name=".submit"></a>
1691 <div class="fixedFont">
1692 <span class="attributes"></span><b class="itemname">submit</b>
1694 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1709 <div class="short">Shortcut to do a submit action.</div>
1715 Shortcut to do a submit action.
1722 <dl class="detailList">
1723 <dt class="heading">Parameters:</dt>
1726 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
1729 <dd>The options to pass to the action (see {<b>link</b> <b>doAction</b>} for details)</dd>
1737 <dl class="detailList">
1738 <dt class="heading">Returns:</dt>
1740 <dd><span class="fixedFont">BasicForm</span> this</dd>
1754 <td class="msource">
1762 <tr class="method-row config-row-alt0 expandable notInherited">
1763 <td class="micon"><a class="exi" href="#expand"> </a></td>
1767 <a id="Roo.form.BasicForm-method-updateRecord" name=".updateRecord"></a>
1768 <div class="fixedFont">
1769 <span class="attributes"></span><b class="itemname">updateRecord</b>
1771 (Record <B><i>record</i></B>)
1786 <div class="short">Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.</div>
1792 Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.
1799 <dl class="detailList">
1800 <dt class="heading">Parameters:</dt>
1803 <span class="fixedFont">Record</span> <b>record</b>
1806 <dd>The record to edit</dd>
1814 <dl class="detailList">
1815 <dt class="heading">Returns:</dt>
1817 <dd><span class="fixedFont">BasicForm</span> this</dd>
1831 <td class="msource">
1842 <!-- ============================== events summary / details ======================== -->
1845 <a id="Roo.form.BasicForm-events"></a>
1854 <table cellspacing="0" class="member-table">
1855 <caption>Events</caption>
1858 <th class="sig-header" colspan="2">Event</th>
1859 <th class="msource-header">Defined By</th>
1868 <tr class="method-row expandable config-row-alt0 notInherited">
1869 <td class="micon"><a class="exi" href="#expand"> </a></td>
1872 <a id="Roo.form.BasicForm-event-*actioncomplete"></a>
1874 <div class="fixedFont">
1875 <b class="itemname">actioncomplete</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
1881 <div class="short">Fires when an action is completed.
1887 Fires when an action is completed.
1893 <dl class="detailList">
1894 <dt class="heading">Parameters:</dt>
1897 <span class="fixedFont">Form</span> <b>this</b>
1903 <span class="fixedFont">Action</span> <b>action</b>
1906 <dd>The action that completed</dd>
1924 <td class="msource">
1929 <tr class="method-row expandable config-row-alt1 notInherited">
1930 <td class="micon"><a class="exi" href="#expand"> </a></td>
1933 <a id="Roo.form.BasicForm-event-*actionfailed"></a>
1935 <div class="fixedFont">
1936 <b class="itemname">actionfailed</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
1942 <div class="short">Fires when an action fails.
1948 Fires when an action fails.
1954 <dl class="detailList">
1955 <dt class="heading">Parameters:</dt>
1958 <span class="fixedFont">Form</span> <b>this</b>
1964 <span class="fixedFont">Action</span> <b>action</b>
1967 <dd>The action that failed</dd>
1985 <td class="msource">
1990 <tr class="method-row expandable config-row-alt0 notInherited">
1991 <td class="micon"><a class="exi" href="#expand"> </a></td>
1994 <a id="Roo.form.BasicForm-event-*beforeaction"></a>
1996 <div class="fixedFont">
1997 <b class="itemname">beforeaction</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
2003 <div class="short">Fires before any action is performed.
2009 Fires before any action is performed. Return false to cancel the action.
2015 <dl class="detailList">
2016 <dt class="heading">Parameters:</dt>
2019 <span class="fixedFont">Form</span> <b>this</b>
2025 <span class="fixedFont">Action</span> <b>action</b>
2028 <dd>The action to be performed</dd>
2046 <td class="msource">
2058 <!-- ============================== footer ================================= -->
2059 <div class="fineprint" style="clear:both">
2061 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 16:11:54 GMT+0800 (HKT)
2063 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>