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>
151 Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.
167 <tr class="config-row expandable config-row-alt1 notInherited">
168 <td class="micon"><a class="exi" href="#expand"> </a></td>
171 <a id="Roo.form.BasicForm-cfg-errorReader" name=".errorReader"></a>
172 <div class="fixedFont">
173 <b class="itemname">errorReader</b> : DataReader
179 <div class="short">An Roo.data.DataReader (e.g.</div>
184 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.
200 <tr class="config-row expandable config-row-alt0 notInherited">
201 <td class="micon"><a class="exi" href="#expand"> </a></td>
204 <a id="Roo.form.BasicForm-cfg-fileUpload" name=".fileUpload"></a>
205 <div class="fixedFont">
206 <b class="itemname">fileUpload</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
212 <div class="short">Set to true if this form is a file upload.</div>
217 Set to true if this form is a file upload.
233 <tr class="config-row expandable config-row-alt1">
234 <td class="micon"><a class="exi" href="#expand"> </a></td>
237 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
238 <div class="fixedFont">
239 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
245 <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>
250 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>
260 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
266 <tr class="config-row expandable config-row-alt0 notInherited">
267 <td class="micon"><a class="exi" href="#expand"> </a></td>
270 <a id="Roo.form.BasicForm-cfg-method" name=".method"></a>
271 <div class="fixedFont">
272 <b class="itemname">method</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
278 <div class="short">The request method to use (GET or POST) for form actions if one isn't supplied in the action options.</div>
283 The request method to use (GET or POST) for form actions if one isn't supplied in the action options.
299 <tr class="config-row expandable config-row-alt1 notInherited">
300 <td class="micon"><a class="exi" href="#expand"> </a></td>
303 <a id="Roo.form.BasicForm-cfg-reader" name=".reader"></a>
304 <div class="fixedFont">
305 <b class="itemname">reader</b> : DataReader
311 <div class="short">An Roo.data.DataReader (e.g.</div>
316 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.
332 <tr class="config-row expandable config-row-alt0 notInherited">
333 <td class="micon"><a class="exi" href="#expand"> </a></td>
336 <a id="Roo.form.BasicForm-cfg-timeout" name=".timeout"></a>
337 <div class="fixedFont">
338 <b class="itemname">timeout</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
344 <div class="short">Timeout for form actions in seconds (default is 30 seconds).</div>
349 Timeout for form actions in seconds (default is 30 seconds).
365 <tr class="config-row expandable config-row-alt1 notInherited">
366 <td class="micon"><a class="exi" href="#expand"> </a></td>
369 <a id="Roo.form.BasicForm-cfg-trackResetOnLoad" name=".trackResetOnLoad"></a>
370 <div class="fixedFont">
371 <b class="itemname">trackResetOnLoad</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
377 <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>
382 If set to true, form.reset() resets to the last loaded<br/>or setValues() data instead of when the form was first created.
398 <tr class="config-row expandable config-row-alt0 notInherited">
399 <td class="micon"><a class="exi" href="#expand"> </a></td>
402 <a id="Roo.form.BasicForm-cfg-url" name=".url"></a>
403 <div class="fixedFont">
404 <b class="itemname">url</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
410 <div class="short">The URL to use for form actions if one isn't supplied in the action options.</div>
415 The URL to use for form actions if one isn't supplied in the action options.
441 <!-- ============================== public properties ==================== -->
445 <a id="Roo.form.BasicForm-props"></a>
451 <table cellspacing="0" class="member-table">
452 <caption class="Empty">Public Properties - Has None</caption>
458 <!-- ============================== methods summary / details ======================== -->
461 <a id="Roo.form.BasicForm-methods"></a>
462 <!-- constructor?? -->
469 <!-- then dynamics first -->
476 <table cellspacing="0" class="member-table">
477 <caption>Public Methods</caption>
479 <th class="sig-header" colspan="2">Method</th>
480 <th class="msource-header">Defined By</th>
490 <tr class="method-row config-row-alt0 expandable notInherited">
491 <td class="micon"><a class="exi" href="#expand"> </a></td>
495 <a id="Roo.form-method-BasicForm" name=".BasicForm"></a>
496 <div class="fixedFont">
497 <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">BasicForm</b>
499 (<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>)
507 <div class="short">Create a new Roo.form.BasicForm</div>
514 Create a new Roo.form.BasicForm
517 <dl class="detailList">
518 <dt class="heading">Parameters:</dt>
521 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span> <b>el</b>
524 <dd>The form element or its id</dd>
527 <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>
530 <dd>Configuration options</dd>
554 <tr class="method-row config-row-alt1 expandable notInherited">
555 <td class="micon"><a class="exi" href="#expand"> </a></td>
559 <a id="Roo.form.BasicForm-method-add" name=".add"></a>
560 <div class="fixedFont">
561 <span class="attributes"></span><b class="itemname">add</b>
563 (Field <B><i>field1</i></B>, Field <B><i>field2</i></B>, Field <B><i>etc</i></B>)
578 <div class="short">Add Roo.form components to this form.</div>
584 Add Roo.form components to this form.
591 <dl class="detailList">
592 <dt class="heading">Parameters:</dt>
595 <span class="fixedFont">Field</span> <b>field1</b>
601 <span class="fixedFont">Field</span> <b>field2</b>
607 <span class="fixedFont">Field</span> <b>etc</b>
618 <dl class="detailList">
619 <dt class="heading">Returns:</dt>
621 <dd><span class="fixedFont">BasicForm</span> this</dd>
643 <tr class="method-row config-row-alt0 expandable">
644 <td class="micon"><a class="exi" href="#expand"> </a></td>
648 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
649 <div class="fixedFont">
650 <span class="attributes"></span><b class="itemname">addEvents</b>
652 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
659 <div class="short">Used to define events on this Observable</div>
665 Used to define events on this Observable
672 <dl class="detailList">
673 <dt class="heading">Parameters:</dt>
676 <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>
679 <dd>The object with the events defined</dd>
699 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
705 <tr class="method-row config-row-alt1 expandable notInherited">
706 <td class="micon"><a class="exi" href="#expand"> </a></td>
710 <a id="Roo.form.BasicForm-method-addForm" name=".addForm"></a>
711 <div class="fixedFont">
712 <span class="attributes"></span><b class="itemname">addForm</b>
714 (<a href="./Roo.form.Form.html#constructor" roo:cls="Roo.form.Form.html#constructor">Roo.form.Form</a> <B><i>form</i></B>)
721 <div class="short">Add a secondary form to this one, <br/>Used to provide tabbed forms.</div>
727 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.
734 <dl class="detailList">
735 <dt class="heading">Parameters:</dt>
738 <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>
767 <tr class="method-row config-row-alt0 expandable">
768 <td class="micon"><a class="exi" href="#expand"> </a></td>
772 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
773 <div class="fixedFont">
774 <span class="attributes"></span><b class="itemname">addListener</b>
776 (<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>)
783 <div class="short">Appends an event handler to this component</div>
789 Appends an event handler to this component
796 <dl class="detailList">
797 <dt class="heading">Parameters:</dt>
800 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
803 <dd>The type of event to listen for</dd>
806 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
809 <dd>The method the event invokes</dd>
812 <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>
815 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
818 <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>
821 <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>
841 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
847 <tr class="method-row config-row-alt1 expandable notInherited">
848 <td class="micon"><a class="exi" href="#expand"> </a></td>
852 <a id="Roo.form.BasicForm-method-applyIfToFields" name=".applyIfToFields"></a>
853 <div class="fixedFont">
854 <span class="attributes"></span><b class="itemname">applyIfToFields</b>
856 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>)
871 <div class="short">Calls {<b>link</b> Ext<b>applyIf</b>} for all field in this form with the passed object.</div>
877 Calls {<b>link</b> Ext<b>applyIf</b>} for all field in this form with the passed object.
884 <dl class="detailList">
885 <dt class="heading">Parameters:</dt>
888 <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>
899 <dl class="detailList">
900 <dt class="heading">Returns:</dt>
902 <dd><span class="fixedFont">BasicForm</span> this</dd>
924 <tr class="method-row config-row-alt0 expandable notInherited">
925 <td class="micon"><a class="exi" href="#expand"> </a></td>
929 <a id="Roo.form.BasicForm-method-applyToFields" name=".applyToFields"></a>
930 <div class="fixedFont">
931 <span class="attributes"></span><b class="itemname">applyToFields</b>
933 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>)
948 <div class="short">Calls {<b>link</b> Ext<b>apply</b>} for all fields in this form with the passed object.</div>
954 Calls {<b>link</b> Ext<b>apply</b>} for all fields in this form with the passed object.
961 <dl class="detailList">
962 <dt class="heading">Parameters:</dt>
965 <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>
976 <dl class="detailList">
977 <dt class="heading">Returns:</dt>
979 <dd><span class="fixedFont">BasicForm</span> this</dd>
1001 <tr class="method-row config-row-alt1 expandable notInherited">
1002 <td class="micon"><a class="exi" href="#expand"> </a></td>
1006 <a id="Roo.form.BasicForm-method-clearInvalid" name=".clearInvalid"></a>
1007 <div class="fixedFont">
1008 <span class="attributes"></span><b class="itemname">clearInvalid</b>
1025 <div class="short">Clears all invalid messages in this form.</div>
1031 Clears all invalid messages in this form.
1042 <dl class="detailList">
1043 <dt class="heading">Returns:</dt>
1045 <dd><span class="fixedFont">BasicForm</span> this</dd>
1059 <td class="msource">
1067 <tr class="method-row config-row-alt0 expandable notInherited">
1068 <td class="micon"><a class="exi" href="#expand"> </a></td>
1072 <a id="Roo.form.BasicForm-method-doAction" name=".doAction"></a>
1073 <div class="fixedFont">
1074 <span class="attributes"></span><b class="itemname">doAction</b>
1076 (<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>)
1091 <div class="short">Performs a predefined action (submit or load) or custom actions you define on this form.</div>
1097 Performs a predefined action (submit or load) or custom actions you define on this form.
1104 <dl class="detailList">
1105 <dt class="heading">Parameters:</dt>
1108 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>actionName</b>
1111 <dd>The name of the action type</dd>
1114 <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>
1117 <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>
1125 <dl class="detailList">
1126 <dt class="heading">Returns:</dt>
1128 <dd><span class="fixedFont">BasicForm</span> this</dd>
1142 <td class="msource">
1150 <tr class="method-row config-row-alt1 expandable notInherited">
1151 <td class="micon"><a class="exi" href="#expand"> </a></td>
1155 <a id="Roo.form.BasicForm-method-findField" name=".findField"></a>
1156 <div class="fixedFont">
1157 <span class="attributes"></span><b class="itemname">findField</b>
1159 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1174 <div class="short">Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName</div>
1180 Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName
1187 <dl class="detailList">
1188 <dt class="heading">Parameters:</dt>
1191 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1194 <dd>The value to search for</dd>
1202 <dl class="detailList">
1203 <dt class="heading">Returns:</dt>
1219 <td class="msource">
1227 <tr class="method-row config-row-alt0 expandable">
1228 <td class="micon"><a class="exi" href="#expand"> </a></td>
1232 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1233 <div class="fixedFont">
1234 <span class="attributes"></span><b class="itemname">fireEvent</b>
1236 (<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>)
1242 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1251 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1257 Fires the specified event with the passed parameters (minus the event name).
1264 <dl class="detailList">
1265 <dt class="heading">Parameters:</dt>
1268 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1274 <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>
1277 <dd>Variable number of parameters are passed to handlers</dd>
1285 <dl class="detailList">
1286 <dt class="heading">Returns:</dt>
1288 <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>
1302 <td class="msource">
1304 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1310 <tr class="method-row config-row-alt1 expandable notInherited">
1311 <td class="micon"><a class="exi" href="#expand"> </a></td>
1315 <a id="Roo.form.BasicForm-method-getFieldValues" name=".getFieldValues"></a>
1316 <div class="fixedFont">
1317 <span class="attributes"></span><b class="itemname">getFieldValues</b>
1325 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1334 <div class="short">Returns the fields in this form as an object with key/value pairs.</div>
1340 Returns the fields in this form as an object with key/value pairs. <br/>This differs from getValues as it calls getValue on each child item, rather than using dom data.
1351 <dl class="detailList">
1352 <dt class="heading">Returns:</dt>
1354 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> </dd>
1368 <td class="msource">
1376 <tr class="method-row config-row-alt0 expandable notInherited">
1377 <td class="micon"><a class="exi" href="#expand"> </a></td>
1381 <a id="Roo.form.BasicForm-method-getValues" name=".getValues"></a>
1382 <div class="fixedFont">
1383 <span class="attributes"></span><b class="itemname">getValues</b>
1385 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>asString</i></B>)
1391 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1400 <div class="short">Returns the fields in this form as an object with key/value pairs.</div>
1406 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.
1413 <dl class="detailList">
1414 <dt class="heading">Parameters:</dt>
1417 <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>
1428 <dl class="detailList">
1429 <dt class="heading">Returns:</dt>
1431 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> </dd>
1445 <td class="msource">
1453 <tr class="method-row config-row-alt1 expandable">
1454 <td class="micon"><a class="exi" href="#expand"> </a></td>
1458 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1459 <div class="fixedFont">
1460 <span class="attributes"></span><b class="itemname">hasListener</b>
1462 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1468 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1477 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1483 Checks to see if this object has any listeners for a specified event
1490 <dl class="detailList">
1491 <dt class="heading">Parameters:</dt>
1494 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1497 <dd>The name of the event to check for</dd>
1505 <dl class="detailList">
1506 <dt class="heading">Returns:</dt>
1508 <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>
1522 <td class="msource">
1524 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1530 <tr class="method-row config-row-alt0 expandable notInherited">
1531 <td class="micon"><a class="exi" href="#expand"> </a></td>
1535 <a id="Roo.form.BasicForm-method-isDirty" name=".isDirty"></a>
1536 <div class="fixedFont">
1537 <span class="attributes"></span><b class="itemname">isDirty</b>
1554 <div class="short">Returns true if any fields in this form have changed since their original load.</div>
1560 Returns true if any fields in this form have changed since their original load.
1571 <dl class="detailList">
1572 <dt class="heading">Returns:</dt>
1588 <td class="msource">
1596 <tr class="method-row config-row-alt1 expandable notInherited">
1597 <td class="micon"><a class="exi" href="#expand"> </a></td>
1601 <a id="Roo.form.BasicForm-method-isValid" name=".isValid"></a>
1602 <div class="fixedFont">
1603 <span class="attributes"></span><b class="itemname">isValid</b>
1620 <div class="short">Returns true if client-side validation on the form is successful.</div>
1626 Returns true if client-side validation on the form is successful.
1637 <dl class="detailList">
1638 <dt class="heading">Returns:</dt>
1654 <td class="msource">
1662 <tr class="method-row config-row-alt0 expandable notInherited">
1663 <td class="micon"><a class="exi" href="#expand"> </a></td>
1667 <a id="Roo.form.BasicForm-method-load" name=".load"></a>
1668 <div class="fixedFont">
1669 <span class="attributes"></span><b class="itemname">load</b>
1671 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1686 <div class="short">Shortcut to do a load action.</div>
1692 Shortcut to do a load action.
1699 <dl class="detailList">
1700 <dt class="heading">Parameters:</dt>
1703 <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>
1706 <dd>The options to pass to the action (see {<b>link</b> <b>doAction</b>} for details)</dd>
1714 <dl class="detailList">
1715 <dt class="heading">Returns:</dt>
1717 <dd><span class="fixedFont">BasicForm</span> this</dd>
1731 <td class="msource">
1739 <tr class="method-row config-row-alt1 expandable notInherited">
1740 <td class="micon"><a class="exi" href="#expand"> </a></td>
1744 <a id="Roo.form.BasicForm-method-loadRecord" name=".loadRecord"></a>
1745 <div class="fixedFont">
1746 <span class="attributes"></span><b class="itemname">loadRecord</b>
1748 (Record <B><i>record</i></B>)
1763 <div class="short">Loads an Roo.data.Record into this form.</div>
1769 Loads an Roo.data.Record into this form.
1776 <dl class="detailList">
1777 <dt class="heading">Parameters:</dt>
1780 <span class="fixedFont">Record</span> <b>record</b>
1783 <dd>The record to load</dd>
1791 <dl class="detailList">
1792 <dt class="heading">Returns:</dt>
1794 <dd><span class="fixedFont">BasicForm</span> this</dd>
1808 <td class="msource">
1816 <tr class="method-row config-row-alt0 expandable notInherited">
1817 <td class="micon"><a class="exi" href="#expand"> </a></td>
1821 <a id="Roo.form.BasicForm-method-markInvalid" name=".markInvalid"></a>
1822 <div class="fixedFont">
1823 <span class="attributes"></span><b class="itemname">markInvalid</b>
1825 (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>errors</i></B>)
1840 <div class="short">Mark fields in this form invalid in bulk.</div>
1846 Mark fields in this form invalid in bulk.
1853 <dl class="detailList">
1854 <dt class="heading">Parameters:</dt>
1857 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span> <b>errors</b>
1860 <dd>Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}</dd>
1868 <dl class="detailList">
1869 <dt class="heading">Returns:</dt>
1871 <dd><span class="fixedFont">BasicForm</span> this</dd>
1885 <td class="msource">
1893 <tr class="method-row config-row-alt1 expandable">
1894 <td class="micon"><a class="exi" href="#expand"> </a></td>
1898 <a id="Roo.util.Observable-method-on" name=".on"></a>
1899 <div class="fixedFont">
1900 <span class="attributes"></span><b class="itemname">on</b>
1902 (<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>)
1909 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1915 Appends an event handler to this element (shorthand for addListener)
1922 <dl class="detailList">
1923 <dt class="heading">Parameters:</dt>
1926 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1929 <dd>The type of event to listen for</dd>
1932 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1935 <dd>The method the event invokes</dd>
1938 <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>
1941 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1944 <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>
1965 <td class="msource">
1967 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1973 <tr class="method-row config-row-alt0 expandable">
1974 <td class="micon"><a class="exi" href="#expand"> </a></td>
1978 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1979 <div class="fixedFont">
1980 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1989 <div class="short">Removes all listeners for this object</div>
1995 Removes all listeners for this object
2016 <td class="msource">
2018 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2024 <tr class="method-row config-row-alt1 expandable notInherited">
2025 <td class="micon"><a class="exi" href="#expand"> </a></td>
2029 <a id="Roo.form.BasicForm-method-remove" name=".remove"></a>
2030 <div class="fixedFont">
2031 <span class="attributes"></span><b class="itemname">remove</b>
2033 (Field <B><i>field</i></B>)
2048 <div class="short">Removes a field from the items collection (does NOT remove its markup).</div>
2054 Removes a field from the items collection (does NOT remove its markup).
2061 <dl class="detailList">
2062 <dt class="heading">Parameters:</dt>
2065 <span class="fixedFont">Field</span> <b>field</b>
2076 <dl class="detailList">
2077 <dt class="heading">Returns:</dt>
2079 <dd><span class="fixedFont">BasicForm</span> this</dd>
2093 <td class="msource">
2101 <tr class="method-row config-row-alt0 expandable">
2102 <td class="micon"><a class="exi" href="#expand"> </a></td>
2106 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2107 <div class="fixedFont">
2108 <span class="attributes"></span><b class="itemname">removeListener</b>
2110 (<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>)
2117 <div class="short">Removes a listener</div>
2130 <dl class="detailList">
2131 <dt class="heading">Parameters:</dt>
2134 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2137 <dd>The type of event to listen for</dd>
2140 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2143 <dd>The handler to remove</dd>
2146 <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>
2149 <dd>(optional) The scope (this object) for the handler</dd>
2167 <td class="msource">
2169 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2175 <tr class="method-row config-row-alt1 expandable notInherited">
2176 <td class="micon"><a class="exi" href="#expand"> </a></td>
2180 <a id="Roo.form.BasicForm-method-render" name=".render"></a>
2181 <div class="fixedFont">
2182 <span class="attributes"></span><b class="itemname">render</b>
2199 <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>
2205 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.
2216 <dl class="detailList">
2217 <dt class="heading">Returns:</dt>
2219 <dd><span class="fixedFont">BasicForm</span> this</dd>
2233 <td class="msource">
2241 <tr class="method-row config-row-alt0 expandable notInherited">
2242 <td class="micon"><a class="exi" href="#expand"> </a></td>
2246 <a id="Roo.form.BasicForm-method-reset" name=".reset"></a>
2247 <div class="fixedFont">
2248 <span class="attributes"></span><b class="itemname">reset</b>
2265 <div class="short">Resets this form.</div>
2282 <dl class="detailList">
2283 <dt class="heading">Returns:</dt>
2285 <dd><span class="fixedFont">BasicForm</span> this</dd>
2299 <td class="msource">
2307 <tr class="method-row config-row-alt1 expandable notInherited">
2308 <td class="micon"><a class="exi" href="#expand"> </a></td>
2312 <a id="Roo.form.BasicForm-method-setValues" name=".setValues"></a>
2313 <div class="fixedFont">
2314 <span class="attributes"></span><b class="itemname">setValues</b>
2316 (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>values</i></B>)
2331 <div class="short">Set values for fields in this form in bulk.</div>
2337 Set values for fields in this form in bulk.
2344 <dl class="detailList">
2345 <dt class="heading">Parameters:</dt>
2348 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span> <b>values</b>
2351 <dd>Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}</dd>
2359 <dl class="detailList">
2360 <dt class="heading">Returns:</dt>
2362 <dd><span class="fixedFont">BasicForm</span> this</dd>
2376 <td class="msource">
2384 <tr class="method-row config-row-alt0 expandable notInherited">
2385 <td class="micon"><a class="exi" href="#expand"> </a></td>
2389 <a id="Roo.form.BasicForm-method-submit" name=".submit"></a>
2390 <div class="fixedFont">
2391 <span class="attributes"></span><b class="itemname">submit</b>
2393 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
2408 <div class="short">Shortcut to do a submit action.</div>
2414 Shortcut to do a submit action.
2421 <dl class="detailList">
2422 <dt class="heading">Parameters:</dt>
2425 <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>
2428 <dd>The options to pass to the action (see {<b>link</b> <b>doAction</b>} for details)</dd>
2436 <dl class="detailList">
2437 <dt class="heading">Returns:</dt>
2439 <dd><span class="fixedFont">BasicForm</span> this</dd>
2453 <td class="msource">
2461 <tr class="method-row config-row-alt1 expandable">
2462 <td class="micon"><a class="exi" href="#expand"> </a></td>
2466 <a id="Roo.util.Observable-method-un" name=".un"></a>
2467 <div class="fixedFont">
2468 <span class="attributes"></span><b class="itemname">un</b>
2470 (<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>)
2477 <div class="short">Removes a listener (shorthand for removeListener)</div>
2483 Removes a listener (shorthand for removeListener)
2490 <dl class="detailList">
2491 <dt class="heading">Parameters:</dt>
2494 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2497 <dd>The type of event to listen for</dd>
2500 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2503 <dd>The handler to remove</dd>
2506 <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>
2509 <dd>(optional) The scope (this object) for the handler</dd>
2527 <td class="msource">
2529 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2535 <tr class="method-row config-row-alt0 expandable notInherited">
2536 <td class="micon"><a class="exi" href="#expand"> </a></td>
2540 <a id="Roo.form.BasicForm-method-updateRecord" name=".updateRecord"></a>
2541 <div class="fixedFont">
2542 <span class="attributes"></span><b class="itemname">updateRecord</b>
2544 (Record <B><i>record</i></B>)
2559 <div class="short">Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.</div>
2565 Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.
2572 <dl class="detailList">
2573 <dt class="heading">Parameters:</dt>
2576 <span class="fixedFont">Record</span> <b>record</b>
2579 <dd>The record to edit</dd>
2587 <dl class="detailList">
2588 <dt class="heading">Returns:</dt>
2590 <dd><span class="fixedFont">BasicForm</span> this</dd>
2604 <td class="msource">
2615 <!-- ============================== events summary / details ======================== -->
2618 <a id="Roo.form.BasicForm-events"></a>
2627 <table cellspacing="0" class="member-table">
2628 <caption>Events</caption>
2631 <th class="sig-header" colspan="2">Event</th>
2632 <th class="msource-header">Defined By</th>
2641 <tr class="method-row expandable config-row-alt0 notInherited">
2642 <td class="micon"><a class="exi" href="#expand"> </a></td>
2645 <a id="Roo.form.BasicForm-event-*actioncomplete"></a>
2647 <div class="fixedFont">
2648 <b class="itemname">actioncomplete</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
2654 <div class="short">Fires when an action is completed.
2660 Fires when an action is completed.
2666 <dl class="detailList">
2667 <dt class="heading">Parameters:</dt>
2670 <span class="fixedFont">Form</span> <b>this</b>
2676 <span class="fixedFont">Action</span> <b>action</b>
2679 <dd>The action that completed</dd>
2697 <td class="msource">
2702 <tr class="method-row expandable config-row-alt1 notInherited">
2703 <td class="micon"><a class="exi" href="#expand"> </a></td>
2706 <a id="Roo.form.BasicForm-event-*actionfailed"></a>
2708 <div class="fixedFont">
2709 <b class="itemname">actionfailed</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
2715 <div class="short">Fires when an action fails.
2721 Fires when an action fails.
2727 <dl class="detailList">
2728 <dt class="heading">Parameters:</dt>
2731 <span class="fixedFont">Form</span> <b>this</b>
2737 <span class="fixedFont">Action</span> <b>action</b>
2740 <dd>The action that failed</dd>
2758 <td class="msource">
2763 <tr class="method-row expandable config-row-alt0 notInherited">
2764 <td class="micon"><a class="exi" href="#expand"> </a></td>
2767 <a id="Roo.form.BasicForm-event-*beforeaction"></a>
2769 <div class="fixedFont">
2770 <b class="itemname">beforeaction</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
2776 <div class="short">Fires before any action is performed.
2782 Fires before any action is performed. Return false to cancel the action.
2788 <dl class="detailList">
2789 <dt class="heading">Parameters:</dt>
2792 <span class="fixedFont">Form</span> <b>this</b>
2798 <span class="fixedFont">Action</span> <b>action</b>
2801 <dd>The action to be performed</dd>
2819 <td class="msource">
2831 <!-- ============================== footer ================================= -->
2832 <div class="fineprint" style="clear:both">
2834 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Wed Apr 13 2016 12:50:04 GMT+0800 (HKT)
2836 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>