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">
679 <td class="micon"><a class="exi" href="#expand"> </a></td>
683 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
684 <div class="fixedFont">
685 <span class="attributes"></span><b class="itemname">addListener</b>
687 (<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>)
694 <div class="short">Appends an event handler to this component</div>
700 Appends an event handler to this component
707 <dl class="detailList">
708 <dt class="heading">Parameters:</dt>
711 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
714 <dd>The type of event to listen for</dd>
717 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
720 <dd>The method the event invokes</dd>
723 <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>
726 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
729 <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>
732 <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>
752 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
758 <tr class="method-row config-row-alt0 expandable notInherited">
759 <td class="micon"><a class="exi" href="#expand"> </a></td>
763 <a id="Roo.form.BasicForm-method-applyIfToFields" name=".applyIfToFields"></a>
764 <div class="fixedFont">
765 <span class="attributes"></span><b class="itemname">applyIfToFields</b>
767 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>)
782 <div class="short">Calls {<b>link</b> Ext<b>applyIf</b>} for all field in this form with the passed object.</div>
788 Calls {<b>link</b> Ext<b>applyIf</b>} for all field in this form with the passed object.
795 <dl class="detailList">
796 <dt class="heading">Parameters:</dt>
799 <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>
810 <dl class="detailList">
811 <dt class="heading">Returns:</dt>
813 <dd><span class="fixedFont">BasicForm</span> this</dd>
835 <tr class="method-row config-row-alt1 expandable notInherited">
836 <td class="micon"><a class="exi" href="#expand"> </a></td>
840 <a id="Roo.form.BasicForm-method-applyToFields" name=".applyToFields"></a>
841 <div class="fixedFont">
842 <span class="attributes"></span><b class="itemname">applyToFields</b>
844 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>)
859 <div class="short">Calls {<b>link</b> Ext<b>apply</b>} for all fields in this form with the passed object.</div>
865 Calls {<b>link</b> Ext<b>apply</b>} for all fields in this form with the passed object.
872 <dl class="detailList">
873 <dt class="heading">Parameters:</dt>
876 <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>
887 <dl class="detailList">
888 <dt class="heading">Returns:</dt>
890 <dd><span class="fixedFont">BasicForm</span> this</dd>
912 <tr class="method-row config-row-alt0 expandable notInherited">
913 <td class="micon"><a class="exi" href="#expand"> </a></td>
917 <a id="Roo.form.BasicForm-method-clearInvalid" name=".clearInvalid"></a>
918 <div class="fixedFont">
919 <span class="attributes"></span><b class="itemname">clearInvalid</b>
936 <div class="short">Clears all invalid messages in this form.</div>
942 Clears all invalid messages in this form.
953 <dl class="detailList">
954 <dt class="heading">Returns:</dt>
956 <dd><span class="fixedFont">BasicForm</span> this</dd>
978 <tr class="method-row config-row-alt1 expandable notInherited">
979 <td class="micon"><a class="exi" href="#expand"> </a></td>
983 <a id="Roo.form.BasicForm-method-doAction" name=".doAction"></a>
984 <div class="fixedFont">
985 <span class="attributes"></span><b class="itemname">doAction</b>
987 (<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>)
1002 <div class="short">Performs a predefined action (submit or load) or custom actions you define on this form.</div>
1008 Performs a predefined action (submit or load) or custom actions you define on this form.
1015 <dl class="detailList">
1016 <dt class="heading">Parameters:</dt>
1019 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>actionName</b>
1022 <dd>The name of the action type</dd>
1025 <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>
1028 <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>
1036 <dl class="detailList">
1037 <dt class="heading">Returns:</dt>
1039 <dd><span class="fixedFont">BasicForm</span> this</dd>
1053 <td class="msource">
1061 <tr class="method-row config-row-alt0 expandable notInherited">
1062 <td class="micon"><a class="exi" href="#expand"> </a></td>
1066 <a id="Roo.form.BasicForm-method-findField" name=".findField"></a>
1067 <div class="fixedFont">
1068 <span class="attributes"></span><b class="itemname">findField</b>
1070 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1085 <div class="short">Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName</div>
1091 Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName
1098 <dl class="detailList">
1099 <dt class="heading">Parameters:</dt>
1102 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1105 <dd>The value to search for</dd>
1113 <dl class="detailList">
1114 <dt class="heading">Returns:</dt>
1130 <td class="msource">
1138 <tr class="method-row config-row-alt1 expandable">
1139 <td class="micon"><a class="exi" href="#expand"> </a></td>
1143 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1144 <div class="fixedFont">
1145 <span class="attributes"></span><b class="itemname">fireEvent</b>
1147 (<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>)
1153 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1162 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1168 Fires the specified event with the passed parameters (minus the event name).
1175 <dl class="detailList">
1176 <dt class="heading">Parameters:</dt>
1179 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1185 <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>
1188 <dd>Variable number of parameters are passed to handlers</dd>
1196 <dl class="detailList">
1197 <dt class="heading">Returns:</dt>
1199 <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>
1213 <td class="msource">
1215 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1221 <tr class="method-row config-row-alt0 expandable notInherited">
1222 <td class="micon"><a class="exi" href="#expand"> </a></td>
1226 <a id="Roo.form.BasicForm-method-getValues" name=".getValues"></a>
1227 <div class="fixedFont">
1228 <span class="attributes"></span><b class="itemname">getValues</b>
1230 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>asString</i></B>)
1236 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1245 <div class="short">Returns the fields in this form as an object with key/value pairs.</div>
1251 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.
1258 <dl class="detailList">
1259 <dt class="heading">Parameters:</dt>
1262 <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>
1273 <dl class="detailList">
1274 <dt class="heading">Returns:</dt>
1276 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> </dd>
1290 <td class="msource">
1298 <tr class="method-row config-row-alt1 expandable">
1299 <td class="micon"><a class="exi" href="#expand"> </a></td>
1303 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1304 <div class="fixedFont">
1305 <span class="attributes"></span><b class="itemname">hasListener</b>
1307 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1313 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1322 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1328 Checks to see if this object has any listeners for a specified event
1335 <dl class="detailList">
1336 <dt class="heading">Parameters:</dt>
1339 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1342 <dd>The name of the event to check for</dd>
1350 <dl class="detailList">
1351 <dt class="heading">Returns:</dt>
1353 <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>
1367 <td class="msource">
1369 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1375 <tr class="method-row config-row-alt0 expandable notInherited">
1376 <td class="micon"><a class="exi" href="#expand"> </a></td>
1380 <a id="Roo.form.BasicForm-method-isDirty" name=".isDirty"></a>
1381 <div class="fixedFont">
1382 <span class="attributes"></span><b class="itemname">isDirty</b>
1399 <div class="short">Returns true if any fields in this form have changed since their original load.</div>
1405 Returns true if any fields in this form have changed since their original load.
1416 <dl class="detailList">
1417 <dt class="heading">Returns:</dt>
1433 <td class="msource">
1441 <tr class="method-row config-row-alt1 expandable notInherited">
1442 <td class="micon"><a class="exi" href="#expand"> </a></td>
1446 <a id="Roo.form.BasicForm-method-isValid" name=".isValid"></a>
1447 <div class="fixedFont">
1448 <span class="attributes"></span><b class="itemname">isValid</b>
1465 <div class="short">Returns true if client-side validation on the form is successful.</div>
1471 Returns true if client-side validation on the form is successful.
1482 <dl class="detailList">
1483 <dt class="heading">Returns:</dt>
1499 <td class="msource">
1507 <tr class="method-row config-row-alt0 expandable notInherited">
1508 <td class="micon"><a class="exi" href="#expand"> </a></td>
1512 <a id="Roo.form.BasicForm-method-load" name=".load"></a>
1513 <div class="fixedFont">
1514 <span class="attributes"></span><b class="itemname">load</b>
1516 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1531 <div class="short">Shortcut to do a load action.</div>
1537 Shortcut to do a load action.
1544 <dl class="detailList">
1545 <dt class="heading">Parameters:</dt>
1548 <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>
1551 <dd>The options to pass to the action (see {<b>link</b> <b>doAction</b>} for details)</dd>
1559 <dl class="detailList">
1560 <dt class="heading">Returns:</dt>
1562 <dd><span class="fixedFont">BasicForm</span> this</dd>
1576 <td class="msource">
1584 <tr class="method-row config-row-alt1 expandable notInherited">
1585 <td class="micon"><a class="exi" href="#expand"> </a></td>
1589 <a id="Roo.form.BasicForm-method-loadRecord" name=".loadRecord"></a>
1590 <div class="fixedFont">
1591 <span class="attributes"></span><b class="itemname">loadRecord</b>
1593 (Record <B><i>record</i></B>)
1608 <div class="short">Loads an Roo.data.Record into this form.</div>
1614 Loads an Roo.data.Record into this form.
1621 <dl class="detailList">
1622 <dt class="heading">Parameters:</dt>
1625 <span class="fixedFont">Record</span> <b>record</b>
1628 <dd>The record to load</dd>
1636 <dl class="detailList">
1637 <dt class="heading">Returns:</dt>
1639 <dd><span class="fixedFont">BasicForm</span> this</dd>
1653 <td class="msource">
1661 <tr class="method-row config-row-alt0 expandable notInherited">
1662 <td class="micon"><a class="exi" href="#expand"> </a></td>
1666 <a id="Roo.form.BasicForm-method-markInvalid" name=".markInvalid"></a>
1667 <div class="fixedFont">
1668 <span class="attributes"></span><b class="itemname">markInvalid</b>
1670 (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>errors</i></B>)
1685 <div class="short">Mark fields in this form invalid in bulk.</div>
1691 Mark fields in this form invalid in bulk.
1698 <dl class="detailList">
1699 <dt class="heading">Parameters:</dt>
1702 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span> <b>errors</b>
1705 <dd>Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}</dd>
1713 <dl class="detailList">
1714 <dt class="heading">Returns:</dt>
1716 <dd><span class="fixedFont">BasicForm</span> this</dd>
1730 <td class="msource">
1738 <tr class="method-row config-row-alt1 expandable">
1739 <td class="micon"><a class="exi" href="#expand"> </a></td>
1743 <a id="Roo.util.Observable-method-on" name=".on"></a>
1744 <div class="fixedFont">
1745 <span class="attributes"></span><b class="itemname">on</b>
1747 (<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>)
1754 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1760 Appends an event handler to this element (shorthand for addListener)
1767 <dl class="detailList">
1768 <dt class="heading">Parameters:</dt>
1771 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1774 <dd>The type of event to listen for</dd>
1777 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1780 <dd>The method the event invokes</dd>
1783 <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>
1786 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1789 <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>
1810 <td class="msource">
1812 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1818 <tr class="method-row config-row-alt0 expandable">
1819 <td class="micon"><a class="exi" href="#expand"> </a></td>
1823 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1824 <div class="fixedFont">
1825 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1834 <div class="short">Removes all listeners for this object</div>
1840 Removes all listeners for this object
1861 <td class="msource">
1863 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1869 <tr class="method-row config-row-alt1 expandable notInherited">
1870 <td class="micon"><a class="exi" href="#expand"> </a></td>
1874 <a id="Roo.form.BasicForm-method-remove" name=".remove"></a>
1875 <div class="fixedFont">
1876 <span class="attributes"></span><b class="itemname">remove</b>
1878 (Field <B><i>field</i></B>)
1893 <div class="short">Removes a field from the items collection (does NOT remove its markup).</div>
1899 Removes a field from the items collection (does NOT remove its markup).
1906 <dl class="detailList">
1907 <dt class="heading">Parameters:</dt>
1910 <span class="fixedFont">Field</span> <b>field</b>
1921 <dl class="detailList">
1922 <dt class="heading">Returns:</dt>
1924 <dd><span class="fixedFont">BasicForm</span> this</dd>
1938 <td class="msource">
1946 <tr class="method-row config-row-alt0 expandable">
1947 <td class="micon"><a class="exi" href="#expand"> </a></td>
1951 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1952 <div class="fixedFont">
1953 <span class="attributes"></span><b class="itemname">removeListener</b>
1955 (<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>)
1962 <div class="short">Removes a listener</div>
1975 <dl class="detailList">
1976 <dt class="heading">Parameters:</dt>
1979 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1982 <dd>The type of event to listen for</dd>
1985 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1988 <dd>The handler to remove</dd>
1991 <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>
1994 <dd>(optional) The scope (this object) for the handler</dd>
2012 <td class="msource">
2014 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2020 <tr class="method-row config-row-alt1 expandable notInherited">
2021 <td class="micon"><a class="exi" href="#expand"> </a></td>
2025 <a id="Roo.form.BasicForm-method-render" name=".render"></a>
2026 <div class="fixedFont">
2027 <span class="attributes"></span><b class="itemname">render</b>
2044 <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>
2050 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.
2061 <dl class="detailList">
2062 <dt class="heading">Returns:</dt>
2064 <dd><span class="fixedFont">BasicForm</span> this</dd>
2078 <td class="msource">
2086 <tr class="method-row config-row-alt0 expandable notInherited">
2087 <td class="micon"><a class="exi" href="#expand"> </a></td>
2091 <a id="Roo.form.BasicForm-method-reset" name=".reset"></a>
2092 <div class="fixedFont">
2093 <span class="attributes"></span><b class="itemname">reset</b>
2110 <div class="short">Resets this form.</div>
2127 <dl class="detailList">
2128 <dt class="heading">Returns:</dt>
2130 <dd><span class="fixedFont">BasicForm</span> this</dd>
2144 <td class="msource">
2152 <tr class="method-row config-row-alt1 expandable notInherited">
2153 <td class="micon"><a class="exi" href="#expand"> </a></td>
2157 <a id="Roo.form.BasicForm-method-setValues" name=".setValues"></a>
2158 <div class="fixedFont">
2159 <span class="attributes"></span><b class="itemname">setValues</b>
2161 (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>values</i></B>)
2176 <div class="short">Set values for fields in this form in bulk.</div>
2182 Set values for fields in this form in bulk.
2189 <dl class="detailList">
2190 <dt class="heading">Parameters:</dt>
2193 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span> <b>values</b>
2196 <dd>Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}</dd>
2204 <dl class="detailList">
2205 <dt class="heading">Returns:</dt>
2207 <dd><span class="fixedFont">BasicForm</span> this</dd>
2221 <td class="msource">
2229 <tr class="method-row config-row-alt0 expandable notInherited">
2230 <td class="micon"><a class="exi" href="#expand"> </a></td>
2234 <a id="Roo.form.BasicForm-method-submit" name=".submit"></a>
2235 <div class="fixedFont">
2236 <span class="attributes"></span><b class="itemname">submit</b>
2238 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
2253 <div class="short">Shortcut to do a submit action.</div>
2259 Shortcut to do a submit action.
2266 <dl class="detailList">
2267 <dt class="heading">Parameters:</dt>
2270 <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>
2273 <dd>The options to pass to the action (see {<b>link</b> <b>doAction</b>} for details)</dd>
2281 <dl class="detailList">
2282 <dt class="heading">Returns:</dt>
2284 <dd><span class="fixedFont">BasicForm</span> this</dd>
2298 <td class="msource">
2306 <tr class="method-row config-row-alt1 expandable">
2307 <td class="micon"><a class="exi" href="#expand"> </a></td>
2311 <a id="Roo.util.Observable-method-un" name=".un"></a>
2312 <div class="fixedFont">
2313 <span class="attributes"></span><b class="itemname">un</b>
2315 (<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>)
2322 <div class="short">Removes a listener (shorthand for removeListener)</div>
2328 Removes a listener (shorthand for removeListener)
2335 <dl class="detailList">
2336 <dt class="heading">Parameters:</dt>
2339 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2342 <dd>The type of event to listen for</dd>
2345 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2348 <dd>The handler to remove</dd>
2351 <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>
2354 <dd>(optional) The scope (this object) for the handler</dd>
2372 <td class="msource">
2374 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2380 <tr class="method-row config-row-alt0 expandable notInherited">
2381 <td class="micon"><a class="exi" href="#expand"> </a></td>
2385 <a id="Roo.form.BasicForm-method-updateRecord" name=".updateRecord"></a>
2386 <div class="fixedFont">
2387 <span class="attributes"></span><b class="itemname">updateRecord</b>
2389 (Record <B><i>record</i></B>)
2404 <div class="short">Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.</div>
2410 Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.
2417 <dl class="detailList">
2418 <dt class="heading">Parameters:</dt>
2421 <span class="fixedFont">Record</span> <b>record</b>
2424 <dd>The record to edit</dd>
2432 <dl class="detailList">
2433 <dt class="heading">Returns:</dt>
2435 <dd><span class="fixedFont">BasicForm</span> this</dd>
2449 <td class="msource">
2460 <!-- ============================== events summary / details ======================== -->
2463 <a id="Roo.form.BasicForm-events"></a>
2472 <table cellspacing="0" class="member-table">
2473 <caption>Events</caption>
2476 <th class="sig-header" colspan="2">Event</th>
2477 <th class="msource-header">Defined By</th>
2486 <tr class="method-row expandable config-row-alt0 notInherited">
2487 <td class="micon"><a class="exi" href="#expand"> </a></td>
2490 <a id="Roo.form.BasicForm-event-*actioncomplete"></a>
2492 <div class="fixedFont">
2493 <b class="itemname">actioncomplete</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
2499 <div class="short">Fires when an action is completed.
2505 Fires when an action is completed.
2511 <dl class="detailList">
2512 <dt class="heading">Parameters:</dt>
2515 <span class="fixedFont">Form</span> <b>this</b>
2521 <span class="fixedFont">Action</span> <b>action</b>
2524 <dd>The action that completed</dd>
2542 <td class="msource">
2547 <tr class="method-row expandable config-row-alt1 notInherited">
2548 <td class="micon"><a class="exi" href="#expand"> </a></td>
2551 <a id="Roo.form.BasicForm-event-*actionfailed"></a>
2553 <div class="fixedFont">
2554 <b class="itemname">actionfailed</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
2560 <div class="short">Fires when an action fails.
2566 Fires when an action fails.
2572 <dl class="detailList">
2573 <dt class="heading">Parameters:</dt>
2576 <span class="fixedFont">Form</span> <b>this</b>
2582 <span class="fixedFont">Action</span> <b>action</b>
2585 <dd>The action that failed</dd>
2603 <td class="msource">
2608 <tr class="method-row expandable config-row-alt0 notInherited">
2609 <td class="micon"><a class="exi" href="#expand"> </a></td>
2612 <a id="Roo.form.BasicForm-event-*beforeaction"></a>
2614 <div class="fixedFont">
2615 <b class="itemname">beforeaction</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
2621 <div class="short">Fires before any action is performed.
2627 Fires before any action is performed. Return false to cancel the action.
2633 <dl class="detailList">
2634 <dt class="heading">Parameters:</dt>
2637 <span class="fixedFont">Form</span> <b>this</b>
2643 <span class="fixedFont">Action</span> <b>action</b>
2646 <dd>The action to be performed</dd>
2664 <td class="msource">
2676 <!-- ============================== footer ================================= -->
2677 <div class="fineprint" style="clear:both">
2679 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu Jul 22 2010 10:40:18 GMT+0800 (HKT)
2681 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
projects / roojs1 / blob