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>
72 <tr><td class="label">Subclasses:</td><td class="hd-info">
73 <a href="./Roo.form.Form.html#constructor" roo:cls="Roo.form.Form.html#constructor">Roo.form.Form</a>
81 <tr><td class="label">Extends:</td><td class="hd-info">
82 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
90 <!-- ============================== class summary ========================== -->
91 <div class="description">
92 Supplies the functionality to do "actions" on forms and initialize Roo.form.Field types on existing markup.
96 <!-- ============================== Class comment block... ========================== -->
98 <div class="comments">
99 <b>Class Comments / Notes</B> =>
100 <u onclick="parent.CommentDialog.showCommentId = 'Roo.form.BasicForm';">[Add Your comment/notes about this class]</u>
102 <iframe frameborder="0" id="comments-Roo.form" style="border: none;width:100%;"
103 src="/blog.php/GtkDjsComments/Roo.form.BasicForm.html"></iframe>
108 <!-- ============================== config options ========================== -->
113 <div class="hr"></div>
114 <a id="Roo.form.BasicForm-configs"></a>
120 <table cellspacing="0" class="member-table">
121 <caption>Config Options (Usually are also Properties)</caption>
125 <th class="sig-header" colspan="2">Options</th>
127 <th class="msource-header">Defined By</th>
134 <tr class="config-row expandable config-row-alt0 notInherited">
135 <td class="micon"><a class="exi" href="#expand"> </a></td>
138 <a id="Roo.form.BasicForm-cfg-baseParams" name=".baseParams"></a>
139 <div class="fixedFont">
140 <b class="itemname">baseParams</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
146 <div class="short">Parameters to pass with all requests.</div>
150 <div class="long">Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.</div>
164 <tr class="config-row expandable config-row-alt1 notInherited">
165 <td class="micon"><a class="exi" href="#expand"> </a></td>
168 <a id="Roo.form.BasicForm-cfg-errorReader" name=".errorReader"></a>
169 <div class="fixedFont">
170 <b class="itemname">errorReader</b> : DataReader
176 <div class="short">An Roo.data.DataReader (e.g.</div>
180 <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>
194 <tr class="config-row expandable config-row-alt0 notInherited">
195 <td class="micon"><a class="exi" href="#expand"> </a></td>
198 <a id="Roo.form.BasicForm-cfg-fileUpload" name=".fileUpload"></a>
199 <div class="fixedFont">
200 <b class="itemname">fileUpload</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
206 <div class="short">Set to true if this form is a file upload.</div>
210 <div class="long">Set to true if this form is a file upload.</div>
224 <tr class="config-row expandable config-row-alt1">
225 <td class="micon"><a class="exi" href="#expand"> </a></td>
228 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
229 <div class="fixedFont">
230 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
236 <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> .</div>
240 <div class="long">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> ..... <br/> } ,<br/> .... <br/> } <br/> </code></pre></div>
248 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
254 <tr class="config-row expandable config-row-alt0 notInherited">
255 <td class="micon"><a class="exi" href="#expand"> </a></td>
258 <a id="Roo.form.BasicForm-cfg-method" name=".method"></a>
259 <div class="fixedFont">
260 <b class="itemname">method</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
266 <div class="short">The request method to use (GET or POST) for form actions if one isn't supplied in the action options.</div>
270 <div class="long">The request method to use (GET or POST) for form actions if one isn't supplied in the action options.</div>
284 <tr class="config-row expandable config-row-alt1 notInherited">
285 <td class="micon"><a class="exi" href="#expand"> </a></td>
288 <a id="Roo.form.BasicForm-cfg-reader" name=".reader"></a>
289 <div class="fixedFont">
290 <b class="itemname">reader</b> : DataReader
296 <div class="short">An Roo.data.DataReader (e.g.</div>
300 <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>
314 <tr class="config-row expandable config-row-alt0 notInherited">
315 <td class="micon"><a class="exi" href="#expand"> </a></td>
318 <a id="Roo.form.BasicForm-cfg-timeout" name=".timeout"></a>
319 <div class="fixedFont">
320 <b class="itemname">timeout</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
326 <div class="short">Timeout for form actions in seconds (default is 30 seconds).</div>
330 <div class="long">Timeout for form actions in seconds (default is 30 seconds).</div>
344 <tr class="config-row expandable config-row-alt1 notInherited">
345 <td class="micon"><a class="exi" href="#expand"> </a></td>
348 <a id="Roo.form.BasicForm-cfg-trackResetOnLoad" name=".trackResetOnLoad"></a>
349 <div class="fixedFont">
350 <b class="itemname">trackResetOnLoad</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
356 <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>
360 <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>
374 <tr class="config-row expandable config-row-alt0 notInherited">
375 <td class="micon"><a class="exi" href="#expand"> </a></td>
378 <a id="Roo.form.BasicForm-cfg-url" name=".url"></a>
379 <div class="fixedFont">
380 <b class="itemname">url</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
386 <div class="short">The URL to use for form actions if one isn't supplied in the action options.</div>
390 <div class="long">The URL to use for form actions if one isn't supplied in the action options.</div>
414 <!-- ============================== public properties ==================== -->
418 <a id="Roo.form.BasicForm-props"></a>
424 <table cellspacing="0" class="member-table">
425 <caption class="Empty">Public Properties - Has None</caption>
431 <!-- ============================== methods summary / details ======================== -->
434 <a id="Roo.form.BasicForm-methods"></a>
435 <!-- constructor?? -->
442 <!-- then dynamics first -->
449 <table cellspacing="0" class="member-table">
450 <caption>Public Methods</caption>
452 <th class="sig-header" colspan="2">Method</th>
453 <th class="msource-header">Defined By</th>
463 <tr class="method-row config-row-alt0 expandable notInherited">
464 <td class="micon"><a class="exi" href="#expand"> </a></td>
468 <a id="Roo.form-method-BasicForm" name=".BasicForm"></a>
469 <div class="fixedFont">
470 <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">BasicForm</b>
472 (<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>)
480 <div class="short">Create a new Roo.form.BasicForm</div>
487 Create a new Roo.form.BasicForm
490 <dl class="detailList">
491 <dt class="heading">Parameters:</dt>
494 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span> <b>el</b>
497 <dd>The form element or its id</dd>
500 <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>
503 <dd>Configuration options</dd>
527 <tr class="method-row config-row-alt1 expandable notInherited">
528 <td class="micon"><a class="exi" href="#expand"> </a></td>
532 <a id="Roo.form.BasicForm-method-add" name=".add"></a>
533 <div class="fixedFont">
534 <span class="attributes"></span><b class="itemname">add</b>
536 (Field <B><i>field1</i></B>, Field <B><i>field2</i></B>, Field <B><i>etc</i></B>)
551 <div class="short">Add Roo.form components to this form.</div>
557 Add Roo.form components to this form.
564 <dl class="detailList">
565 <dt class="heading">Parameters:</dt>
568 <span class="fixedFont">Field</span> <b>field1</b>
574 <span class="fixedFont">Field</span> <b>field2</b>
580 <span class="fixedFont">Field</span> <b>etc</b>
591 <dl class="detailList">
592 <dt class="heading">Returns:</dt>
594 <dd><span class="fixedFont">BasicForm</span> this</dd>
616 <tr class="method-row config-row-alt0 expandable">
617 <td class="micon"><a class="exi" href="#expand"> </a></td>
621 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
622 <div class="fixedFont">
623 <span class="attributes"></span><b class="itemname">addEvents</b>
625 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
632 <div class="short">Used to define events on this Observable</div>
638 Used to define events on this Observable
645 <dl class="detailList">
646 <dt class="heading">Parameters:</dt>
649 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>object</b>
652 <dd>The object with the events defined</dd>
672 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
678 <tr class="method-row config-row-alt1 expandable notInherited">
679 <td class="micon"><a class="exi" href="#expand"> </a></td>
683 <a id="Roo.form.BasicForm-method-addForm" name=".addForm"></a>
684 <div class="fixedFont">
685 <span class="attributes"></span><b class="itemname">addForm</b>
687 (<a href="./Roo.form.Form.html#constructor" roo:cls="Roo.form.Form.html#constructor">Roo.form.Form</a> <B><i>form</i></B>)
694 <div class="short">Add a secondary form to this one, <br/>Used to provide tabbed forms.</div>
700 Add a secondary form to this one, <br/>Used to provide tabbed forms. One form is primary, with hidden values <br/>which mirror the elements from the other forms.
707 <dl class="detailList">
708 <dt class="heading">Parameters:</dt>
711 <span class="fixedFont"><a href="./Roo.form.Form.html#constructor" roo:cls="Roo.form.Form.html#constructor">Roo.form.Form</a></span> <b>form</b>
740 <tr class="method-row config-row-alt0 expandable">
741 <td class="micon"><a class="exi" href="#expand"> </a></td>
745 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
746 <div class="fixedFont">
747 <span class="attributes"></span><b class="itemname">addListener</b>
749 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</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>)
756 <div class="short">Appends an event handler to this component</div>
762 Appends an event handler to this component
769 <dl class="detailList">
770 <dt class="heading">Parameters:</dt>
773 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
776 <dd>The type of event to listen for</dd>
779 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
782 <dd>The method the event invokes</dd>
785 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
788 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
791 <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>
794 <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/> <pre><code><br/> el.on('click', this.onClick, this, {<br/> single: true,<br/> delay: 100,<br/> forumId: 4<br/> });<br/> </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/> el.on({<br/> 'click': {<br/> fn: this.onClick,<br/> scope: this,<br/> delay: 100<br/> }, <br/> 'mouseover': {<br/> fn: this.onMouseOver,<br/> scope: this<br/> },<br/> 'mouseout': {<br/> fn: this.onMouseOut,<br/> scope: this<br/> }<br/> });<br/> </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/> <pre><code><br/> el.on({<br/> 'click': this.onClick,<br/> 'mouseover': this.onMouseOver,<br/> 'mouseout': this.onMouseOut,<br/> scope: this<br/> });<br/> </code></pre></dd>
814 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
820 <tr class="method-row config-row-alt1 expandable notInherited">
821 <td class="micon"><a class="exi" href="#expand"> </a></td>
825 <a id="Roo.form.BasicForm-method-applyIfToFields" name=".applyIfToFields"></a>
826 <div class="fixedFont">
827 <span class="attributes"></span><b class="itemname">applyIfToFields</b>
829 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>)
844 <div class="short">Calls {<b>link</b> Ext<b>applyIf</b>} for all field in this form with the passed object.</div>
850 Calls {<b>link</b> Ext<b>applyIf</b>} for all field in this form with the passed object.
857 <dl class="detailList">
858 <dt class="heading">Parameters:</dt>
861 <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>
872 <dl class="detailList">
873 <dt class="heading">Returns:</dt>
875 <dd><span class="fixedFont">BasicForm</span> this</dd>
897 <tr class="method-row config-row-alt0 expandable notInherited">
898 <td class="micon"><a class="exi" href="#expand"> </a></td>
902 <a id="Roo.form.BasicForm-method-applyToFields" name=".applyToFields"></a>
903 <div class="fixedFont">
904 <span class="attributes"></span><b class="itemname">applyToFields</b>
906 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>)
921 <div class="short">Calls {<b>link</b> Ext<b>apply</b>} for all fields in this form with the passed object.</div>
927 Calls {<b>link</b> Ext<b>apply</b>} for all fields in this form with the passed object.
934 <dl class="detailList">
935 <dt class="heading">Parameters:</dt>
938 <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>
949 <dl class="detailList">
950 <dt class="heading">Returns:</dt>
952 <dd><span class="fixedFont">BasicForm</span> this</dd>
974 <tr class="method-row config-row-alt1 expandable notInherited">
975 <td class="micon"><a class="exi" href="#expand"> </a></td>
979 <a id="Roo.form.BasicForm-method-clearInvalid" name=".clearInvalid"></a>
980 <div class="fixedFont">
981 <span class="attributes"></span><b class="itemname">clearInvalid</b>
998 <div class="short">Clears all invalid messages in this form.</div>
1004 Clears all invalid messages in this form.
1015 <dl class="detailList">
1016 <dt class="heading">Returns:</dt>
1018 <dd><span class="fixedFont">BasicForm</span> this</dd>
1032 <td class="msource">
1040 <tr class="method-row config-row-alt0 expandable notInherited">
1041 <td class="micon"><a class="exi" href="#expand"> </a></td>
1045 <a id="Roo.form.BasicForm-method-doAction" name=".doAction"></a>
1046 <div class="fixedFont">
1047 <span class="attributes"></span><b class="itemname">doAction</b>
1049 (<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>)
1064 <div class="short">Performs a predefined action (submit or load) or custom actions you define on this form.</div>
1070 Performs a predefined action (submit or load) or custom actions you define on this form.
1077 <dl class="detailList">
1078 <dt class="heading">Parameters:</dt>
1081 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>actionName</b>
1084 <dd>The name of the action type</dd>
1087 <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>
1090 <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>
1098 <dl class="detailList">
1099 <dt class="heading">Returns:</dt>
1101 <dd><span class="fixedFont">BasicForm</span> this</dd>
1115 <td class="msource">
1123 <tr class="method-row config-row-alt1 expandable notInherited">
1124 <td class="micon"><a class="exi" href="#expand"> </a></td>
1128 <a id="Roo.form.BasicForm-method-findField" name=".findField"></a>
1129 <div class="fixedFont">
1130 <span class="attributes"></span><b class="itemname">findField</b>
1132 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1147 <div class="short">Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName</div>
1153 Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName
1160 <dl class="detailList">
1161 <dt class="heading">Parameters:</dt>
1164 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1167 <dd>The value to search for</dd>
1175 <dl class="detailList">
1176 <dt class="heading">Returns:</dt>
1192 <td class="msource">
1200 <tr class="method-row config-row-alt0 expandable">
1201 <td class="micon"><a class="exi" href="#expand"> </a></td>
1205 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1206 <div class="fixedFont">
1207 <span class="attributes"></span><b class="itemname">fireEvent</b>
1209 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
1215 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1224 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1230 Fires the specified event with the passed parameters (minus the event name).
1237 <dl class="detailList">
1238 <dt class="heading">Parameters:</dt>
1241 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1247 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span> <b>args</b>
1250 <dd>Variable number of parameters are passed to handlers</dd>
1258 <dl class="detailList">
1259 <dt class="heading">Returns:</dt>
1261 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> returns false if any of the handlers return false otherwise it returns true</dd>
1275 <td class="msource">
1277 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1283 <tr class="method-row config-row-alt1 expandable notInherited">
1284 <td class="micon"><a class="exi" href="#expand"> </a></td>
1288 <a id="Roo.form.BasicForm-method-getValues" name=".getValues"></a>
1289 <div class="fixedFont">
1290 <span class="attributes"></span><b class="itemname">getValues</b>
1292 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>asString</i></B>)
1298 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1307 <div class="short">Returns the fields in this form as an object with key/value pairs.</div>
1313 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.
1320 <dl class="detailList">
1321 <dt class="heading">Parameters:</dt>
1324 <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>
1335 <dl class="detailList">
1336 <dt class="heading">Returns:</dt>
1338 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> </dd>
1352 <td class="msource">
1360 <tr class="method-row config-row-alt0 expandable">
1361 <td class="micon"><a class="exi" href="#expand"> </a></td>
1365 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1366 <div class="fixedFont">
1367 <span class="attributes"></span><b class="itemname">hasListener</b>
1369 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1375 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1384 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1390 Checks to see if this object has any listeners for a specified event
1397 <dl class="detailList">
1398 <dt class="heading">Parameters:</dt>
1401 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1404 <dd>The name of the event to check for</dd>
1412 <dl class="detailList">
1413 <dt class="heading">Returns:</dt>
1415 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if the event is being listened for, else false</dd>
1429 <td class="msource">
1431 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1437 <tr class="method-row config-row-alt1 expandable notInherited">
1438 <td class="micon"><a class="exi" href="#expand"> </a></td>
1442 <a id="Roo.form.BasicForm-method-isDirty" name=".isDirty"></a>
1443 <div class="fixedFont">
1444 <span class="attributes"></span><b class="itemname">isDirty</b>
1461 <div class="short">Returns true if any fields in this form have changed since their original load.</div>
1467 Returns true if any fields in this form have changed since their original load.
1478 <dl class="detailList">
1479 <dt class="heading">Returns:</dt>
1495 <td class="msource">
1503 <tr class="method-row config-row-alt0 expandable notInherited">
1504 <td class="micon"><a class="exi" href="#expand"> </a></td>
1508 <a id="Roo.form.BasicForm-method-isValid" name=".isValid"></a>
1509 <div class="fixedFont">
1510 <span class="attributes"></span><b class="itemname">isValid</b>
1527 <div class="short">Returns true if client-side validation on the form is successful.</div>
1533 Returns true if client-side validation on the form is successful.
1544 <dl class="detailList">
1545 <dt class="heading">Returns:</dt>
1561 <td class="msource">
1569 <tr class="method-row config-row-alt1 expandable notInherited">
1570 <td class="micon"><a class="exi" href="#expand"> </a></td>
1574 <a id="Roo.form.BasicForm-method-load" name=".load"></a>
1575 <div class="fixedFont">
1576 <span class="attributes"></span><b class="itemname">load</b>
1578 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1593 <div class="short">Shortcut to do a load action.</div>
1599 Shortcut to do a load action.
1606 <dl class="detailList">
1607 <dt class="heading">Parameters:</dt>
1610 <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>
1613 <dd>The options to pass to the action (see {<b>link</b> <b>doAction</b>} for details)</dd>
1621 <dl class="detailList">
1622 <dt class="heading">Returns:</dt>
1624 <dd><span class="fixedFont">BasicForm</span> this</dd>
1638 <td class="msource">
1646 <tr class="method-row config-row-alt0 expandable notInherited">
1647 <td class="micon"><a class="exi" href="#expand"> </a></td>
1651 <a id="Roo.form.BasicForm-method-loadRecord" name=".loadRecord"></a>
1652 <div class="fixedFont">
1653 <span class="attributes"></span><b class="itemname">loadRecord</b>
1655 (Record <B><i>record</i></B>)
1670 <div class="short">Loads an Roo.data.Record into this form.</div>
1676 Loads an Roo.data.Record into this form.
1683 <dl class="detailList">
1684 <dt class="heading">Parameters:</dt>
1687 <span class="fixedFont">Record</span> <b>record</b>
1690 <dd>The record to load</dd>
1698 <dl class="detailList">
1699 <dt class="heading">Returns:</dt>
1701 <dd><span class="fixedFont">BasicForm</span> this</dd>
1715 <td class="msource">
1723 <tr class="method-row config-row-alt1 expandable notInherited">
1724 <td class="micon"><a class="exi" href="#expand"> </a></td>
1728 <a id="Roo.form.BasicForm-method-markInvalid" name=".markInvalid"></a>
1729 <div class="fixedFont">
1730 <span class="attributes"></span><b class="itemname">markInvalid</b>
1732 (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>errors</i></B>)
1747 <div class="short">Mark fields in this form invalid in bulk.</div>
1753 Mark fields in this form invalid in bulk.
1760 <dl class="detailList">
1761 <dt class="heading">Parameters:</dt>
1764 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span> <b>errors</b>
1767 <dd>Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}</dd>
1775 <dl class="detailList">
1776 <dt class="heading">Returns:</dt>
1778 <dd><span class="fixedFont">BasicForm</span> this</dd>
1792 <td class="msource">
1800 <tr class="method-row config-row-alt0 expandable">
1801 <td class="micon"><a class="exi" href="#expand"> </a></td>
1805 <a id="Roo.util.Observable-method-on" name=".on"></a>
1806 <div class="fixedFont">
1807 <span class="attributes"></span><b class="itemname">on</b>
1809 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</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>)
1816 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1822 Appends an event handler to this element (shorthand for addListener)
1829 <dl class="detailList">
1830 <dt class="heading">Parameters:</dt>
1833 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1836 <dd>The type of event to listen for</dd>
1839 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1842 <dd>The method the event invokes</dd>
1845 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1848 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1851 <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>
1872 <td class="msource">
1874 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1880 <tr class="method-row config-row-alt1 expandable">
1881 <td class="micon"><a class="exi" href="#expand"> </a></td>
1885 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1886 <div class="fixedFont">
1887 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1896 <div class="short">Removes all listeners for this object</div>
1902 Removes all listeners for this object
1923 <td class="msource">
1925 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1931 <tr class="method-row config-row-alt0 expandable notInherited">
1932 <td class="micon"><a class="exi" href="#expand"> </a></td>
1936 <a id="Roo.form.BasicForm-method-remove" name=".remove"></a>
1937 <div class="fixedFont">
1938 <span class="attributes"></span><b class="itemname">remove</b>
1940 (Field <B><i>field</i></B>)
1955 <div class="short">Removes a field from the items collection (does NOT remove its markup).</div>
1961 Removes a field from the items collection (does NOT remove its markup).
1968 <dl class="detailList">
1969 <dt class="heading">Parameters:</dt>
1972 <span class="fixedFont">Field</span> <b>field</b>
1983 <dl class="detailList">
1984 <dt class="heading">Returns:</dt>
1986 <dd><span class="fixedFont">BasicForm</span> this</dd>
2000 <td class="msource">
2008 <tr class="method-row config-row-alt1 expandable">
2009 <td class="micon"><a class="exi" href="#expand"> </a></td>
2013 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2014 <div class="fixedFont">
2015 <span class="attributes"></span><b class="itemname">removeListener</b>
2017 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
2024 <div class="short">Removes a listener</div>
2037 <dl class="detailList">
2038 <dt class="heading">Parameters:</dt>
2041 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2044 <dd>The type of event to listen for</dd>
2047 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2050 <dd>The handler to remove</dd>
2053 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
2056 <dd>(optional) The scope (this object) for the handler</dd>
2074 <td class="msource">
2076 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2082 <tr class="method-row config-row-alt0 expandable notInherited">
2083 <td class="micon"><a class="exi" href="#expand"> </a></td>
2087 <a id="Roo.form.BasicForm-method-render" name=".render"></a>
2088 <div class="fixedFont">
2089 <span class="attributes"></span><b class="itemname">render</b>
2106 <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>
2112 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.
2123 <dl class="detailList">
2124 <dt class="heading">Returns:</dt>
2126 <dd><span class="fixedFont">BasicForm</span> this</dd>
2140 <td class="msource">
2148 <tr class="method-row config-row-alt1 expandable notInherited">
2149 <td class="micon"><a class="exi" href="#expand"> </a></td>
2153 <a id="Roo.form.BasicForm-method-reset" name=".reset"></a>
2154 <div class="fixedFont">
2155 <span class="attributes"></span><b class="itemname">reset</b>
2172 <div class="short">Resets this form.</div>
2189 <dl class="detailList">
2190 <dt class="heading">Returns:</dt>
2192 <dd><span class="fixedFont">BasicForm</span> this</dd>
2206 <td class="msource">
2214 <tr class="method-row config-row-alt0 expandable notInherited">
2215 <td class="micon"><a class="exi" href="#expand"> </a></td>
2219 <a id="Roo.form.BasicForm-method-setValues" name=".setValues"></a>
2220 <div class="fixedFont">
2221 <span class="attributes"></span><b class="itemname">setValues</b>
2223 (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>values</i></B>)
2238 <div class="short">Set values for fields in this form in bulk.</div>
2244 Set values for fields in this form in bulk.
2251 <dl class="detailList">
2252 <dt class="heading">Parameters:</dt>
2255 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span> <b>values</b>
2258 <dd>Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}</dd>
2266 <dl class="detailList">
2267 <dt class="heading">Returns:</dt>
2269 <dd><span class="fixedFont">BasicForm</span> this</dd>
2283 <td class="msource">
2291 <tr class="method-row config-row-alt1 expandable notInherited">
2292 <td class="micon"><a class="exi" href="#expand"> </a></td>
2296 <a id="Roo.form.BasicForm-method-submit" name=".submit"></a>
2297 <div class="fixedFont">
2298 <span class="attributes"></span><b class="itemname">submit</b>
2300 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
2315 <div class="short">Shortcut to do a submit action.</div>
2321 Shortcut to do a submit action.
2328 <dl class="detailList">
2329 <dt class="heading">Parameters:</dt>
2332 <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>
2335 <dd>The options to pass to the action (see {<b>link</b> <b>doAction</b>} for details)</dd>
2343 <dl class="detailList">
2344 <dt class="heading">Returns:</dt>
2346 <dd><span class="fixedFont">BasicForm</span> this</dd>
2360 <td class="msource">
2368 <tr class="method-row config-row-alt0 expandable">
2369 <td class="micon"><a class="exi" href="#expand"> </a></td>
2373 <a id="Roo.util.Observable-method-un" name=".un"></a>
2374 <div class="fixedFont">
2375 <span class="attributes"></span><b class="itemname">un</b>
2377 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
2384 <div class="short">Removes a listener (shorthand for removeListener)</div>
2390 Removes a listener (shorthand for removeListener)
2397 <dl class="detailList">
2398 <dt class="heading">Parameters:</dt>
2401 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2404 <dd>The type of event to listen for</dd>
2407 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2410 <dd>The handler to remove</dd>
2413 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
2416 <dd>(optional) The scope (this object) for the handler</dd>
2434 <td class="msource">
2436 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2442 <tr class="method-row config-row-alt1 expandable notInherited">
2443 <td class="micon"><a class="exi" href="#expand"> </a></td>
2447 <a id="Roo.form.BasicForm-method-updateRecord" name=".updateRecord"></a>
2448 <div class="fixedFont">
2449 <span class="attributes"></span><b class="itemname">updateRecord</b>
2451 (Record <B><i>record</i></B>)
2466 <div class="short">Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.</div>
2472 Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.
2479 <dl class="detailList">
2480 <dt class="heading">Parameters:</dt>
2483 <span class="fixedFont">Record</span> <b>record</b>
2486 <dd>The record to edit</dd>
2494 <dl class="detailList">
2495 <dt class="heading">Returns:</dt>
2497 <dd><span class="fixedFont">BasicForm</span> this</dd>
2511 <td class="msource">
2522 <!-- ============================== events summary / details ======================== -->
2525 <a id="Roo.form.BasicForm-events"></a>
2534 <table cellspacing="0" class="member-table">
2535 <caption>Events</caption>
2538 <th class="sig-header" colspan="2">Event</th>
2539 <th class="msource-header">Defined By</th>
2548 <tr class="method-row expandable config-row-alt0 notInherited">
2549 <td class="micon"><a class="exi" href="#expand"> </a></td>
2552 <a id="Roo.form.BasicForm-event-*actioncomplete"></a>
2554 <div class="fixedFont">
2555 <b class="itemname">actioncomplete</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
2561 <div class="short">Fires when an action is completed.
2567 Fires when an action is completed.
2573 <dl class="detailList">
2574 <dt class="heading">Parameters:</dt>
2577 <span class="fixedFont">Form</span> <b>this</b>
2583 <span class="fixedFont">Action</span> <b>action</b>
2586 <dd>The action that completed</dd>
2604 <td class="msource">
2609 <tr class="method-row expandable config-row-alt1 notInherited">
2610 <td class="micon"><a class="exi" href="#expand"> </a></td>
2613 <a id="Roo.form.BasicForm-event-*actionfailed"></a>
2615 <div class="fixedFont">
2616 <b class="itemname">actionfailed</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
2622 <div class="short">Fires when an action fails.
2628 Fires when an action fails.
2634 <dl class="detailList">
2635 <dt class="heading">Parameters:</dt>
2638 <span class="fixedFont">Form</span> <b>this</b>
2644 <span class="fixedFont">Action</span> <b>action</b>
2647 <dd>The action that failed</dd>
2665 <td class="msource">
2670 <tr class="method-row expandable config-row-alt0 notInherited">
2671 <td class="micon"><a class="exi" href="#expand"> </a></td>
2674 <a id="Roo.form.BasicForm-event-*beforeaction"></a>
2676 <div class="fixedFont">
2677 <b class="itemname">beforeaction</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
2683 <div class="short">Fires before any action is performed.
2689 Fires before any action is performed. Return false to cancel the action.
2695 <dl class="detailList">
2696 <dt class="heading">Parameters:</dt>
2699 <span class="fixedFont">Form</span> <b>this</b>
2705 <span class="fixedFont">Action</span> <b>action</b>
2708 <dd>The action to be performed</dd>
2726 <td class="msource">
2738 <!-- ============================== footer ================================= -->
2739 <div class="fineprint" style="clear:both">
2741 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Jul 27 2010 10:58:47 GMT+0800 (HKT)
2743 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>