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.Form</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.Form-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.form.Form-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.form.Form-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.form.Form-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 src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
48 <img src="../../images/default/s.gif" height="1" width="40"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.form.Form
53 <!-- ============================== class title / details ============================ -->
56 <h1 class="classTitle">
61 <table cellspacing="0" class="class-summary-table">
63 <tr><td class="label">Package:</td><td class="hd-info">Roo.form</td></tr>
65 <tr><td class="label">Defined In:</td><td class="hd-info">
67 <a href="./src/Roo_form_Form.js.html">Roo/form/Form.js</a>.
70 <tr><td class="label">Class:</td><td class="hd-info">Form</td></tr>
75 <tr><td class="label">Extends:</td><td class="hd-info">
76 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
84 <!-- ============================== class summary ========================== -->
85 <div class="description">
86 Adds the ability to dynamically render forms with JavaScript to {<b>link</b> Roo.form.BasicForm}.
90 <!-- ============================== Class comment block... ========================== -->
92 <div class="comments">
93 <b>Class Comments / Notes</B> =>
94 <u onclick="parent.CommentDialog.showCommentId = 'Roo.form.Form';">[Add Your comment/notes about this class]</u>
96 <iframe frameborder="0" id="comments-Roo.form" style="border: none;width:100%;"
97 src="/blog.php/GtkDjsComments/Roo.form.Form.html"></iframe>
102 <!-- ============================== config options ========================== -->
107 <div class="hr"></div>
108 <a id="Roo.form.Form-configs"></a>
114 <table cellspacing="0" class="member-table">
115 <caption>Config Options (Usually are also Properties)</caption>
119 <th class="sig-header" colspan="2">Options</th>
121 <th class="msource-header">Defined By</th>
128 <tr class="config-row expandable config-row-alt0">
129 <td class="micon"><a class="exi" href="#expand"> </a></td>
132 <a id="Roo.form.BasicForm-cfg-baseParams" name=".baseParams"></a>
133 <div class="fixedFont">
134 <b class="itemname">baseParams</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
140 <div class="short">Parameters to pass with all requests.</div>
144 <div class="long">Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.</div>
152 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
158 <tr class="config-row expandable config-row-alt1 notInherited">
159 <td class="micon"><a class="exi" href="#expand"> </a></td>
162 <a id="Roo.form.Form-cfg-buttonAlign" name=".buttonAlign"></a>
163 <div class="fixedFont">
164 <b class="itemname">buttonAlign</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
170 <div class="short">Valid values are "left," "center" and "right" (defaults to "center")</div>
174 <div class="long">Valid values are "left," "center" and "right" (defaults to "center")</div>
188 <tr class="config-row expandable config-row-alt0">
189 <td class="micon"><a class="exi" href="#expand"> </a></td>
192 <a id="Roo.form.BasicForm-cfg-errorReader" name=".errorReader"></a>
193 <div class="fixedFont">
194 <b class="itemname">errorReader</b> : DataReader
200 <div class="short">An Roo.data.DataReader (e.g.</div>
204 <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>
212 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
218 <tr class="config-row expandable config-row-alt1">
219 <td class="micon"><a class="exi" href="#expand"> </a></td>
222 <a id="Roo.form.BasicForm-cfg-fileUpload" name=".fileUpload"></a>
223 <div class="fixedFont">
224 <b class="itemname">fileUpload</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
230 <div class="short">Set to true if this form is a file upload.</div>
234 <div class="long">Set to true if this form is a file upload.</div>
242 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
248 <tr class="config-row expandable config-row-alt0 notInherited">
249 <td class="micon"><a class="exi" href="#expand"> </a></td>
252 <a id="Roo.form.Form-cfg-itemCls" name=".itemCls"></a>
253 <div class="fixedFont">
254 <b class="itemname">itemCls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
260 <div class="short">A css class to apply to the x-form-item of fields.</div>
264 <div class="long">A css class to apply to the x-form-item of fields. This property cascades to child containers.</div>
278 <tr class="config-row expandable config-row-alt1 notInherited">
279 <td class="micon"><a class="exi" href="#expand"> </a></td>
282 <a id="Roo.form.Form-cfg-labelAlign" name=".labelAlign"></a>
283 <div class="fixedFont">
284 <b class="itemname">labelAlign</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
290 <div class="short">Valid values are "left," "top" and "right" (defaults to "left").</div>
294 <div class="long">Valid values are "left," "top" and "right" (defaults to "left").<br/>This property cascades to child containers if not set.</div>
308 <tr class="config-row expandable config-row-alt0 notInherited">
309 <td class="micon"><a class="exi" href="#expand"> </a></td>
312 <a id="Roo.form.Form-cfg-labelWidth" name=".labelWidth"></a>
313 <div class="fixedFont">
314 <b class="itemname">labelWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
320 <div class="short">The width of labels.</div>
324 <div class="long">The width of labels. This property cascades to child containers.</div>
338 <tr class="config-row expandable config-row-alt1">
339 <td class="micon"><a class="exi" href="#expand"> </a></td>
342 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
343 <div class="fixedFont">
344 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
350 <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>
354 <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>
362 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
368 <tr class="config-row expandable config-row-alt0">
369 <td class="micon"><a class="exi" href="#expand"> </a></td>
372 <a id="Roo.form.BasicForm-cfg-method" name=".method"></a>
373 <div class="fixedFont">
374 <b class="itemname">method</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
380 <div class="short">The request method to use (GET or POST) for form actions if one isn't supplied in the action options.</div>
384 <div class="long">The request method to use (GET or POST) for form actions if one isn't supplied in the action options.</div>
392 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
398 <tr class="config-row expandable config-row-alt1 notInherited">
399 <td class="micon"><a class="exi" href="#expand"> </a></td>
402 <a id="Roo.form.Form-cfg-minButtonWidth" name=".minButtonWidth"></a>
403 <div class="fixedFont">
404 <b class="itemname">minButtonWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
410 <div class="short">Minimum width of all buttons in pixels (defaults to 75)</div>
414 <div class="long">Minimum width of all buttons in pixels (defaults to 75)</div>
428 <tr class="config-row expandable config-row-alt0 notInherited">
429 <td class="micon"><a class="exi" href="#expand"> </a></td>
432 <a id="Roo.form.Form-cfg-monitorPoll" name=".monitorPoll"></a>
433 <div class="fixedFont">
434 <b class="itemname">monitorPoll</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
440 <div class="short">The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)</div>
444 <div class="long">The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)</div>
458 <tr class="config-row expandable config-row-alt1 notInherited">
459 <td class="micon"><a class="exi" href="#expand"> </a></td>
462 <a id="Roo.form.Form-cfg-monitorValid" name=".monitorValid"></a>
463 <div class="fixedFont">
464 <b class="itemname">monitorValid</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
470 <div class="short">If true the form monitors its valid state <b>client-side</b> and<br/>fires a looping event with that state.</div>
474 <div class="long">If true the form monitors its valid state <b>client-side</b> and<br/>fires a looping event with that state. This is required to bind buttons to the valid<br/>state using the config value formBind:true on the button.</div>
488 <tr class="config-row expandable config-row-alt0 notInherited">
489 <td class="micon"><a class="exi" href="#expand"> </a></td>
492 <a id="Roo.form.Form-cfg-progressUrl" name=".progressUrl"></a>
493 <div class="fixedFont">
494 <b class="itemname">progressUrl</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
500 <div class="short">- Url to return progress data</div>
504 <div class="long">- Url to return progress data</div>
518 <tr class="config-row expandable config-row-alt1">
519 <td class="micon"><a class="exi" href="#expand"> </a></td>
522 <a id="Roo.form.BasicForm-cfg-reader" name=".reader"></a>
523 <div class="fixedFont">
524 <b class="itemname">reader</b> : DataReader
530 <div class="short">An Roo.data.DataReader (e.g.</div>
534 <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>
542 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
548 <tr class="config-row expandable config-row-alt0">
549 <td class="micon"><a class="exi" href="#expand"> </a></td>
552 <a id="Roo.form.BasicForm-cfg-timeout" name=".timeout"></a>
553 <div class="fixedFont">
554 <b class="itemname">timeout</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
560 <div class="short">Timeout for form actions in seconds (default is 30 seconds).</div>
564 <div class="long">Timeout for form actions in seconds (default is 30 seconds).</div>
572 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
578 <tr class="config-row expandable config-row-alt1">
579 <td class="micon"><a class="exi" href="#expand"> </a></td>
582 <a id="Roo.form.BasicForm-cfg-trackResetOnLoad" name=".trackResetOnLoad"></a>
583 <div class="fixedFont">
584 <b class="itemname">trackResetOnLoad</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
590 <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>
594 <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>
602 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
608 <tr class="config-row expandable config-row-alt0">
609 <td class="micon"><a class="exi" href="#expand"> </a></td>
612 <a id="Roo.form.BasicForm-cfg-url" name=".url"></a>
613 <div class="fixedFont">
614 <b class="itemname">url</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
620 <div class="short">The URL to use for form actions if one isn't supplied in the action options.</div>
624 <div class="long">The URL to use for form actions if one isn't supplied in the action options.</div>
632 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
648 <!-- ============================== public properties ==================== -->
652 <a id="Roo.form.Form-props"></a>
658 <table cellspacing="0" class="member-table">
659 <caption class="Empty">Public Properties - Has None</caption>
665 <!-- ============================== methods summary / details ======================== -->
668 <a id="Roo.form.Form-methods"></a>
669 <!-- constructor?? -->
676 <!-- then dynamics first -->
683 <table cellspacing="0" class="member-table">
684 <caption>Public Methods</caption>
686 <th class="sig-header" colspan="2">Method</th>
687 <th class="msource-header">Defined By</th>
697 <tr class="method-row config-row-alt0 expandable notInherited">
698 <td class="micon"><a class="exi" href="#expand"> </a></td>
702 <a id="Roo.form-method-Form" name=".Form"></a>
703 <div class="fixedFont">
704 <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">Form</b>
706 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
714 <div class="short">Create a new Roo.form.Form</div>
721 Create a new Roo.form.Form
724 <dl class="detailList">
725 <dt class="heading">Parameters:</dt>
728 <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>
731 <dd>Configuration options</dd>
755 <tr class="method-row config-row-alt1 expandable notInherited">
756 <td class="micon"><a class="exi" href="#expand"> </a></td>
760 <a id="Roo.form.Form-method-add" name=".add"></a>
761 <div class="fixedFont">
762 <span class="attributes"></span><b class="itemname">add</b>
764 (Field <B><i>field1</i></B>, Field <B><i>field2</i></B>)
779 <div class="short">Add Roo.form components to the current open container (e.g.</div>
785 Add Roo.form components to the current open container (e.g. column, fieldset, etc.). Fields added via this method<br/>can also be passed with an additional property of fieldLabel, which if supplied, will provide the text to display<br/>as the label of the field.
792 <dl class="detailList">
793 <dt class="heading">Parameters:</dt>
796 <span class="fixedFont">Field</span> <b>field1</b>
802 <span class="fixedFont">Field</span> <b>field2</b>
808 <span class="fixedFont">Field</span> <b>etc.</b>
819 <dl class="detailList">
820 <dt class="heading">Returns:</dt>
822 <dd><span class="fixedFont">Form</span> this</dd>
844 <tr class="method-row config-row-alt0 expandable notInherited">
845 <td class="micon"><a class="exi" href="#expand"> </a></td>
849 <a id="Roo.form.Form-method-addButton" name=".addButton"></a>
850 <div class="fixedFont">
851 <span class="attributes"></span><b class="itemname">addButton</b>
853 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object <B><i>config</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>)
859 <a href="./Roo.Button.html#constructor" roo:cls="Roo.Button.html#constructor">Roo.Button</a>
868 <div class="short">Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered.</div>
874 Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered.
881 <dl class="detailList">
882 <dt class="heading">Parameters:</dt>
885 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span> <b>config</b>
888 <dd>A string becomes the button text, an object can either be a Button config<br/>object or a valid Roo.DomHelper element config</dd>
891 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
894 <dd>The function called when the button is clicked</dd>
897 <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>
900 <dd>(optional) The scope of the handler function</dd>
908 <dl class="detailList">
909 <dt class="heading">Returns:</dt>
911 <dd><span class="fixedFont"><a href="./Roo.Button.html#constructor" roo:cls="Roo.Button.html#constructor">Roo.Button</a></span> </dd>
933 <tr class="method-row config-row-alt1 expandable">
934 <td class="micon"><a class="exi" href="#expand"> </a></td>
938 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
939 <div class="fixedFont">
940 <span class="attributes"></span><b class="itemname">addEvents</b>
942 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
949 <div class="short">Used to define events on this Observable</div>
955 Used to define events on this Observable
962 <dl class="detailList">
963 <dt class="heading">Parameters:</dt>
966 <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>
969 <dd>The object with the events defined</dd>
989 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
995 <tr class="method-row config-row-alt0 expandable">
996 <td class="micon"><a class="exi" href="#expand"> </a></td>
1000 <a id="Roo.form.BasicForm-method-addForm" name=".addForm"></a>
1001 <div class="fixedFont">
1002 <span class="attributes"></span><b class="itemname">addForm</b>
1004 (<a href="./Roo.form.Form.html#constructor" roo:cls="Roo.form.Form.html#constructor">Roo.form.Form</a> <B><i>form</i></B>)
1011 <div class="short">Add a secondary form to this one, <br/>Used to provide tabbed forms.</div>
1017 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.
1024 <dl class="detailList">
1025 <dt class="heading">Parameters:</dt>
1028 <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>
1049 <td class="msource">
1051 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
1057 <tr class="method-row config-row-alt1 expandable">
1058 <td class="micon"><a class="exi" href="#expand"> </a></td>
1062 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
1063 <div class="fixedFont">
1064 <span class="attributes"></span><b class="itemname">addListener</b>
1066 (<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>)
1073 <div class="short">Appends an event handler to this component</div>
1079 Appends an event handler to this component
1086 <dl class="detailList">
1087 <dt class="heading">Parameters:</dt>
1090 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1093 <dd>The type of event to listen for</dd>
1096 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1099 <dd>The method the event invokes</dd>
1102 <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>
1105 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1108 <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>
1111 <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>
1129 <td class="msource">
1131 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1137 <tr class="method-row config-row-alt0 expandable notInherited">
1138 <td class="micon"><a class="exi" href="#expand"> </a></td>
1142 <a id="Roo.form.Form-method-addxtype" name=".addxtype"></a>
1143 <div class="fixedFont">
1144 <span class="attributes"></span><b class="itemname">addxtype</b>
1146 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
1153 <div class="short">Adds a series of form elements (using the xtype property as the factory method.</div>
1159 Adds a series of form elements (using the xtype property as the factory method.<br/>Valid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column, (and 'end' to close a block)
1166 <dl class="detailList">
1167 <dt class="heading">Parameters:</dt>
1170 <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>
1191 <td class="msource">
1199 <tr class="method-row config-row-alt1 expandable">
1200 <td class="micon"><a class="exi" href="#expand"> </a></td>
1204 <a id="Roo.form.BasicForm-method-applyIfToFields" name=".applyIfToFields"></a>
1205 <div class="fixedFont">
1206 <span class="attributes"></span><b class="itemname">applyIfToFields</b>
1208 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>)
1223 <div class="short">Calls {<b>link</b> Ext<b>applyIf</b>} for all field in this form with the passed object.</div>
1229 Calls {<b>link</b> Ext<b>applyIf</b>} for all field in this form with the passed object.
1236 <dl class="detailList">
1237 <dt class="heading">Parameters:</dt>
1240 <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>
1251 <dl class="detailList">
1252 <dt class="heading">Returns:</dt>
1254 <dd><span class="fixedFont">BasicForm</span> this</dd>
1268 <td class="msource">
1270 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
1276 <tr class="method-row config-row-alt0 expandable">
1277 <td class="micon"><a class="exi" href="#expand"> </a></td>
1281 <a id="Roo.form.BasicForm-method-applyToFields" name=".applyToFields"></a>
1282 <div class="fixedFont">
1283 <span class="attributes"></span><b class="itemname">applyToFields</b>
1285 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>)
1300 <div class="short">Calls {<b>link</b> Ext<b>apply</b>} for all fields in this form with the passed object.</div>
1306 Calls {<b>link</b> Ext<b>apply</b>} for all fields in this form with the passed object.
1313 <dl class="detailList">
1314 <dt class="heading">Parameters:</dt>
1317 <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>
1328 <dl class="detailList">
1329 <dt class="heading">Returns:</dt>
1331 <dd><span class="fixedFont">BasicForm</span> this</dd>
1345 <td class="msource">
1347 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
1353 <tr class="method-row config-row-alt1 expandable">
1354 <td class="micon"><a class="exi" href="#expand"> </a></td>
1358 <a id="Roo.form.BasicForm-method-clearInvalid" name=".clearInvalid"></a>
1359 <div class="fixedFont">
1360 <span class="attributes"></span><b class="itemname">clearInvalid</b>
1377 <div class="short">Clears all invalid messages in this form.</div>
1383 Clears all invalid messages in this form.
1394 <dl class="detailList">
1395 <dt class="heading">Returns:</dt>
1397 <dd><span class="fixedFont">BasicForm</span> this</dd>
1411 <td class="msource">
1413 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
1419 <tr class="method-row config-row-alt0 expandable notInherited">
1420 <td class="micon"><a class="exi" href="#expand"> </a></td>
1424 <a id="Roo.form.Form-method-column" name=".column"></a>
1425 <div class="fixedFont">
1426 <span class="attributes"></span><b class="itemname">column</b>
1428 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>, Field <B><i>field1</i></B>, Field <B><i>field2</i></B>, Field <B><i>etc</i></B>)
1443 <div class="short">Opens a new {<b>link</b> Roo.form.Column} container in the layout stack.</div>
1449 Opens a new {<b>link</b> Roo.form.Column} container in the layout stack. If fields are passed after the config, the<br/>fields are added and the column is closed. If no fields are passed the column remains open<br/>until end() is called.
1456 <dl class="detailList">
1457 <dt class="heading">Parameters:</dt>
1460 <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>
1463 <dd>The config to pass to the column</dd>
1466 <span class="fixedFont">Field</span> <b>field1</b>
1472 <span class="fixedFont">Field</span> <b>field2</b>
1478 <span class="fixedFont">Field</span> <b>etc</b>
1489 <dl class="detailList">
1490 <dt class="heading">Returns:</dt>
1492 <dd> Column The column container object</dd>
1506 <td class="msource">
1514 <tr class="method-row config-row-alt1 expandable notInherited">
1515 <td class="micon"><a class="exi" href="#expand"> </a></td>
1519 <a id="Roo.form.Form-method-container" name=".container"></a>
1520 <div class="fixedFont">
1521 <span class="attributes"></span><b class="itemname">container</b>
1523 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>, Field <B><i>field1</i></B>, Field <B><i>field2</i></B>, Field <B><i>etc</i></B>)
1538 <div class="short">Opens a new {<b>link</b> Roo.form.Layout} container in the layout stack.</div>
1544 Opens a new {<b>link</b> Roo.form.Layout} container in the layout stack. If fields are passed after the config, the<br/>fields are added and the container is closed. If no fields are passed the container remains open<br/>until end() is called.
1551 <dl class="detailList">
1552 <dt class="heading">Parameters:</dt>
1555 <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>
1558 <dd>The config to pass to the Layout</dd>
1561 <span class="fixedFont">Field</span> <b>field1</b>
1567 <span class="fixedFont">Field</span> <b>field2</b>
1573 <span class="fixedFont">Field</span> <b>etc</b>
1584 <dl class="detailList">
1585 <dt class="heading">Returns:</dt>
1587 <dd> Layout The container object</dd>
1601 <td class="msource">
1609 <tr class="method-row config-row-alt0 expandable">
1610 <td class="micon"><a class="exi" href="#expand"> </a></td>
1614 <a id="Roo.form.BasicForm-method-doAction" name=".doAction"></a>
1615 <div class="fixedFont">
1616 <span class="attributes"></span><b class="itemname">doAction</b>
1618 (<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>)
1633 <div class="short">Performs a predefined action (submit or load) or custom actions you define on this form.</div>
1639 Performs a predefined action (submit or load) or custom actions you define on this form.
1646 <dl class="detailList">
1647 <dt class="heading">Parameters:</dt>
1650 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>actionName</b>
1653 <dd>The name of the action type</dd>
1656 <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>
1659 <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>
1667 <dl class="detailList">
1668 <dt class="heading">Returns:</dt>
1670 <dd><span class="fixedFont">BasicForm</span> this</dd>
1684 <td class="msource">
1686 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
1692 <tr class="method-row config-row-alt1 expandable notInherited">
1693 <td class="micon"><a class="exi" href="#expand"> </a></td>
1697 <a id="Roo.form.Form-method-end" name=".end"></a>
1698 <div class="fixedFont">
1699 <span class="attributes"></span><b class="itemname">end</b>
1716 <div class="short">Closes the current open container</div>
1722 Closes the current open container
1733 <dl class="detailList">
1734 <dt class="heading">Returns:</dt>
1736 <dd><span class="fixedFont">Form</span> this</dd>
1750 <td class="msource">
1758 <tr class="method-row config-row-alt0 expandable notInherited">
1759 <td class="micon"><a class="exi" href="#expand"> </a></td>
1763 <a id="Roo.form.Form-method-fieldset" name=".fieldset"></a>
1764 <div class="fixedFont">
1765 <span class="attributes"></span><b class="itemname">fieldset</b>
1767 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>, Field <B><i>field1</i></B>, Field <B><i>field2</i></B>, Field <B><i>etc</i></B>)
1782 <div class="short">Opens a new {<b>link</b> Roo.form.FieldSet} container in the layout stack.</div>
1788 Opens a new {<b>link</b> Roo.form.FieldSet} container in the layout stack. If fields are passed after the config, the<br/>fields are added and the fieldset is closed. If no fields are passed the fieldset remains open<br/>until end() is called.
1795 <dl class="detailList">
1796 <dt class="heading">Parameters:</dt>
1799 <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>
1802 <dd>The config to pass to the fieldset</dd>
1805 <span class="fixedFont">Field</span> <b>field1</b>
1811 <span class="fixedFont">Field</span> <b>field2</b>
1817 <span class="fixedFont">Field</span> <b>etc</b>
1828 <dl class="detailList">
1829 <dt class="heading">Returns:</dt>
1831 <dd> FieldSet The fieldset container object</dd>
1845 <td class="msource">
1853 <tr class="method-row config-row-alt1 expandable">
1854 <td class="micon"><a class="exi" href="#expand"> </a></td>
1858 <a id="Roo.form.BasicForm-method-findField" name=".findField"></a>
1859 <div class="fixedFont">
1860 <span class="attributes"></span><b class="itemname">findField</b>
1862 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1877 <div class="short">Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName</div>
1883 Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName
1890 <dl class="detailList">
1891 <dt class="heading">Parameters:</dt>
1894 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1897 <dd>The value to search for</dd>
1905 <dl class="detailList">
1906 <dt class="heading">Returns:</dt>
1922 <td class="msource">
1924 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
1930 <tr class="method-row config-row-alt0 expandable notInherited">
1931 <td class="micon"><a class="exi" href="#expand"> </a></td>
1935 <a id="Roo.form.Form-method-findbyId" name=".findbyId"></a>
1936 <div class="fixedFont">
1937 <span class="attributes"></span><b class="itemname">findbyId</b>
1939 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1954 <div class="short">Find any element that has been added to a form, using it's ID or name<br/>This can include framesets, columns etc.</div>
1960 Find any element that has been added to a form, using it's ID or name<br/>This can include framesets, columns etc. along with regular fields..
1967 <dl class="detailList">
1968 <dt class="heading">Parameters:</dt>
1971 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1974 <dd>- id or name to find.</dd>
1982 <dl class="detailList">
1983 <dt class="heading">Returns:</dt>
1985 <dd><span class="fixedFont">Element</span> e - or false if nothing found.</dd>
1999 <td class="msource">
2007 <tr class="method-row config-row-alt1 expandable">
2008 <td class="micon"><a class="exi" href="#expand"> </a></td>
2012 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
2013 <div class="fixedFont">
2014 <span class="attributes"></span><b class="itemname">fireEvent</b>
2016 (<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>)
2022 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2031 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
2037 Fires the specified event with the passed parameters (minus the event name).
2044 <dl class="detailList">
2045 <dt class="heading">Parameters:</dt>
2048 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2054 <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>
2057 <dd>Variable number of parameters are passed to handlers</dd>
2065 <dl class="detailList">
2066 <dt class="heading">Returns:</dt>
2068 <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>
2082 <td class="msource">
2084 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2090 <tr class="method-row config-row-alt0 expandable">
2091 <td class="micon"><a class="exi" href="#expand"> </a></td>
2095 <a id="Roo.form.BasicForm-method-getFieldValues" name=".getFieldValues"></a>
2096 <div class="fixedFont">
2097 <span class="attributes"></span><b class="itemname">getFieldValues</b>
2105 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
2114 <div class="short">Returns the fields in this form as an object with key/value pairs.</div>
2120 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.
2131 <dl class="detailList">
2132 <dt class="heading">Returns:</dt>
2134 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> </dd>
2148 <td class="msource">
2150 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
2156 <tr class="method-row config-row-alt1 expandable">
2157 <td class="micon"><a class="exi" href="#expand"> </a></td>
2161 <a id="Roo.form.BasicForm-method-getValues" name=".getValues"></a>
2162 <div class="fixedFont">
2163 <span class="attributes"></span><b class="itemname">getValues</b>
2165 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>asString</i></B>)
2171 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
2180 <div class="short">Returns the fields in this form as an object with key/value pairs.</div>
2186 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.
2193 <dl class="detailList">
2194 <dt class="heading">Parameters:</dt>
2197 <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>
2208 <dl class="detailList">
2209 <dt class="heading">Returns:</dt>
2211 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> </dd>
2225 <td class="msource">
2227 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
2233 <tr class="method-row config-row-alt0 expandable">
2234 <td class="micon"><a class="exi" href="#expand"> </a></td>
2238 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
2239 <div class="fixedFont">
2240 <span class="attributes"></span><b class="itemname">hasListener</b>
2242 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
2248 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2257 <div class="short">Checks to see if this object has any listeners for a specified event</div>
2263 Checks to see if this object has any listeners for a specified event
2270 <dl class="detailList">
2271 <dt class="heading">Parameters:</dt>
2274 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2277 <dd>The name of the event to check for</dd>
2285 <dl class="detailList">
2286 <dt class="heading">Returns:</dt>
2288 <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>
2302 <td class="msource">
2304 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2310 <tr class="method-row config-row-alt1 expandable">
2311 <td class="micon"><a class="exi" href="#expand"> </a></td>
2315 <a id="Roo.form.BasicForm-method-isDirty" name=".isDirty"></a>
2316 <div class="fixedFont">
2317 <span class="attributes"></span><b class="itemname">isDirty</b>
2334 <div class="short">Returns true if any fields in this form have changed since their original load.</div>
2340 Returns true if any fields in this form have changed since their original load.
2351 <dl class="detailList">
2352 <dt class="heading">Returns:</dt>
2368 <td class="msource">
2370 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
2376 <tr class="method-row config-row-alt0 expandable">
2377 <td class="micon"><a class="exi" href="#expand"> </a></td>
2381 <a id="Roo.form.BasicForm-method-isValid" name=".isValid"></a>
2382 <div class="fixedFont">
2383 <span class="attributes"></span><b class="itemname">isValid</b>
2400 <div class="short">Returns true if client-side validation on the form is successful.</div>
2406 Returns true if client-side validation on the form is successful.
2417 <dl class="detailList">
2418 <dt class="heading">Returns:</dt>
2434 <td class="msource">
2436 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
2442 <tr class="method-row config-row-alt1 expandable">
2443 <td class="micon"><a class="exi" href="#expand"> </a></td>
2447 <a id="Roo.form.BasicForm-method-load" name=".load"></a>
2448 <div class="fixedFont">
2449 <span class="attributes"></span><b class="itemname">load</b>
2451 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
2466 <div class="short">Shortcut to do a load action.</div>
2472 Shortcut to do a load action.
2479 <dl class="detailList">
2480 <dt class="heading">Parameters:</dt>
2483 <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>
2486 <dd>The options to pass to the action (see {<b>link</b> <b>doAction</b>} for details)</dd>
2494 <dl class="detailList">
2495 <dt class="heading">Returns:</dt>
2497 <dd><span class="fixedFont">BasicForm</span> this</dd>
2511 <td class="msource">
2513 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
2519 <tr class="method-row config-row-alt0 expandable">
2520 <td class="micon"><a class="exi" href="#expand"> </a></td>
2524 <a id="Roo.form.BasicForm-method-loadRecord" name=".loadRecord"></a>
2525 <div class="fixedFont">
2526 <span class="attributes"></span><b class="itemname">loadRecord</b>
2528 (Record <B><i>record</i></B>)
2543 <div class="short">Loads an Roo.data.Record into this form.</div>
2549 Loads an Roo.data.Record into this form.
2556 <dl class="detailList">
2557 <dt class="heading">Parameters:</dt>
2560 <span class="fixedFont">Record</span> <b>record</b>
2563 <dd>The record to load</dd>
2571 <dl class="detailList">
2572 <dt class="heading">Returns:</dt>
2574 <dd><span class="fixedFont">BasicForm</span> this</dd>
2588 <td class="msource">
2590 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
2596 <tr class="method-row config-row-alt1 expandable">
2597 <td class="micon"><a class="exi" href="#expand"> </a></td>
2601 <a id="Roo.form.BasicForm-method-markInvalid" name=".markInvalid"></a>
2602 <div class="fixedFont">
2603 <span class="attributes"></span><b class="itemname">markInvalid</b>
2605 (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>errors</i></B>)
2620 <div class="short">Mark fields in this form invalid in bulk.</div>
2626 Mark fields in this form invalid in bulk.
2633 <dl class="detailList">
2634 <dt class="heading">Parameters:</dt>
2637 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span> <b>errors</b>
2640 <dd>Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}</dd>
2648 <dl class="detailList">
2649 <dt class="heading">Returns:</dt>
2651 <dd><span class="fixedFont">BasicForm</span> this</dd>
2665 <td class="msource">
2667 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
2673 <tr class="method-row config-row-alt0 expandable">
2674 <td class="micon"><a class="exi" href="#expand"> </a></td>
2678 <a id="Roo.util.Observable-method-on" name=".on"></a>
2679 <div class="fixedFont">
2680 <span class="attributes"></span><b class="itemname">on</b>
2682 (<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>)
2689 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2695 Appends an event handler to this element (shorthand for addListener)
2702 <dl class="detailList">
2703 <dt class="heading">Parameters:</dt>
2706 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2709 <dd>The type of event to listen for</dd>
2712 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2715 <dd>The method the event invokes</dd>
2718 <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>
2721 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2724 <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>
2745 <td class="msource">
2747 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2753 <tr class="method-row config-row-alt1 expandable">
2754 <td class="micon"><a class="exi" href="#expand"> </a></td>
2758 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2759 <div class="fixedFont">
2760 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2769 <div class="short">Removes all listeners for this object</div>
2775 Removes all listeners for this object
2796 <td class="msource">
2798 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2804 <tr class="method-row config-row-alt0 expandable">
2805 <td class="micon"><a class="exi" href="#expand"> </a></td>
2809 <a id="Roo.form.BasicForm-method-remove" name=".remove"></a>
2810 <div class="fixedFont">
2811 <span class="attributes"></span><b class="itemname">remove</b>
2813 (Field <B><i>field</i></B>)
2828 <div class="short">Removes a field from the items collection (does NOT remove its markup).</div>
2834 Removes a field from the items collection (does NOT remove its markup).
2841 <dl class="detailList">
2842 <dt class="heading">Parameters:</dt>
2845 <span class="fixedFont">Field</span> <b>field</b>
2856 <dl class="detailList">
2857 <dt class="heading">Returns:</dt>
2859 <dd><span class="fixedFont">BasicForm</span> this</dd>
2873 <td class="msource">
2875 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
2881 <tr class="method-row config-row-alt1 expandable">
2882 <td class="micon"><a class="exi" href="#expand"> </a></td>
2886 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2887 <div class="fixedFont">
2888 <span class="attributes"></span><b class="itemname">removeListener</b>
2890 (<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>)
2897 <div class="short">Removes a listener</div>
2910 <dl class="detailList">
2911 <dt class="heading">Parameters:</dt>
2914 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2917 <dd>The type of event to listen for</dd>
2920 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2923 <dd>The handler to remove</dd>
2926 <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>
2929 <dd>(optional) The scope (this object) for the handler</dd>
2947 <td class="msource">
2949 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2955 <tr class="method-row config-row-alt0 expandable notInherited">
2956 <td class="micon"><a class="exi" href="#expand"> </a></td>
2960 <a id="Roo.form.Form-method-render" name=".render"></a>
2961 <div class="fixedFont">
2962 <span class="attributes"></span><b class="itemname">render</b>
2964 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
2979 <div class="short">Render this form into the passed container.</div>
2985 Render this form into the passed container. This should only be called once!
2992 <dl class="detailList">
2993 <dt class="heading">Parameters:</dt>
2996 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
2999 <dd>The element this component should be rendered into</dd>
3007 <dl class="detailList">
3008 <dt class="heading">Returns:</dt>
3010 <dd><span class="fixedFont">Form</span> this</dd>
3024 <td class="msource">
3032 <tr class="method-row config-row-alt1 expandable">
3033 <td class="micon"><a class="exi" href="#expand"> </a></td>
3037 <a id="Roo.form.BasicForm-method-reset" name=".reset"></a>
3038 <div class="fixedFont">
3039 <span class="attributes"></span><b class="itemname">reset</b>
3056 <div class="short">Resets this form.</div>
3073 <dl class="detailList">
3074 <dt class="heading">Returns:</dt>
3076 <dd><span class="fixedFont">BasicForm</span> this</dd>
3090 <td class="msource">
3092 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
3098 <tr class="method-row config-row-alt0 expandable">
3099 <td class="micon"><a class="exi" href="#expand"> </a></td>
3103 <a id="Roo.form.BasicForm-method-setValues" name=".setValues"></a>
3104 <div class="fixedFont">
3105 <span class="attributes"></span><b class="itemname">setValues</b>
3107 (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>values</i></B>)
3122 <div class="short">Set values for fields in this form in bulk.</div>
3128 Set values for fields in this form in bulk.
3135 <dl class="detailList">
3136 <dt class="heading">Parameters:</dt>
3139 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span> <b>values</b>
3142 <dd>Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}</dd>
3150 <dl class="detailList">
3151 <dt class="heading">Returns:</dt>
3153 <dd><span class="fixedFont">BasicForm</span> this</dd>
3167 <td class="msource">
3169 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
3175 <tr class="method-row config-row-alt1 expandable notInherited">
3176 <td class="micon"><a class="exi" href="#expand"> </a></td>
3180 <a id="Roo.form.Form-method-start" name=".start"></a>
3181 <div class="fixedFont">
3182 <span class="attributes"></span><b class="itemname">start</b>
3184 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>container</i></B>)
3199 <div class="short">Opens the passed container in the layout stack.</div>
3205 Opens the passed container in the layout stack. The container can be any {<b>link</b> Roo.form.Layout} or subclass.
3212 <dl class="detailList">
3213 <dt class="heading">Parameters:</dt>
3216 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>container</b>
3219 <dd>A Roo.form.Layout or subclass of Layout</dd>
3227 <dl class="detailList">
3228 <dt class="heading">Returns:</dt>
3230 <dd><span class="fixedFont">Form</span> this</dd>
3244 <td class="msource">
3252 <tr class="method-row config-row-alt0 expandable notInherited">
3253 <td class="micon"><a class="exi" href="#expand"> </a></td>
3257 <a id="Roo.form.Form-method-startMonitoring" name=".startMonitoring"></a>
3258 <div class="fixedFont">
3259 <span class="attributes"></span><b class="itemname">startMonitoring</b>
3268 <div class="short">Starts monitoring of the valid state of this form.</div>
3274 Starts monitoring of the valid state of this form. Usually this is done by passing the config<br/>option "monitorValid"
3295 <td class="msource">
3303 <tr class="method-row config-row-alt1 expandable notInherited">
3304 <td class="micon"><a class="exi" href="#expand"> </a></td>
3308 <a id="Roo.form.Form-method-stopMonitoring" name=".stopMonitoring"></a>
3309 <div class="fixedFont">
3310 <span class="attributes"></span><b class="itemname">stopMonitoring</b>
3319 <div class="short">Stops monitoring of the valid state of this form</div>
3325 Stops monitoring of the valid state of this form
3346 <td class="msource">
3354 <tr class="method-row config-row-alt0 expandable">
3355 <td class="micon"><a class="exi" href="#expand"> </a></td>
3359 <a id="Roo.form.BasicForm-method-submit" name=".submit"></a>
3360 <div class="fixedFont">
3361 <span class="attributes"></span><b class="itemname">submit</b>
3363 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
3378 <div class="short">Shortcut to do a submit action.</div>
3384 Shortcut to do a submit action.
3391 <dl class="detailList">
3392 <dt class="heading">Parameters:</dt>
3395 <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>
3398 <dd>The options to pass to the action (see {<b>link</b> <b>doAction</b>} for details)</dd>
3406 <dl class="detailList">
3407 <dt class="heading">Returns:</dt>
3409 <dd><span class="fixedFont">BasicForm</span> this</dd>
3423 <td class="msource">
3425 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
3431 <tr class="method-row config-row-alt1 expandable">
3432 <td class="micon"><a class="exi" href="#expand"> </a></td>
3436 <a id="Roo.util.Observable-method-un" name=".un"></a>
3437 <div class="fixedFont">
3438 <span class="attributes"></span><b class="itemname">un</b>
3440 (<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>)
3447 <div class="short">Removes a listener (shorthand for removeListener)</div>
3453 Removes a listener (shorthand for removeListener)
3460 <dl class="detailList">
3461 <dt class="heading">Parameters:</dt>
3464 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3467 <dd>The type of event to listen for</dd>
3470 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3473 <dd>The handler to remove</dd>
3476 <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>
3479 <dd>(optional) The scope (this object) for the handler</dd>
3497 <td class="msource">
3499 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3505 <tr class="method-row config-row-alt0 expandable">
3506 <td class="micon"><a class="exi" href="#expand"> </a></td>
3510 <a id="Roo.form.BasicForm-method-updateRecord" name=".updateRecord"></a>
3511 <div class="fixedFont">
3512 <span class="attributes"></span><b class="itemname">updateRecord</b>
3514 (Record <B><i>record</i></B>)
3529 <div class="short">Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.</div>
3535 Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.
3542 <dl class="detailList">
3543 <dt class="heading">Parameters:</dt>
3546 <span class="fixedFont">Record</span> <b>record</b>
3549 <dd>The record to edit</dd>
3557 <dl class="detailList">
3558 <dt class="heading">Returns:</dt>
3560 <dd><span class="fixedFont">BasicForm</span> this</dd>
3574 <td class="msource">
3576 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
3585 <!-- ============================== events summary / details ======================== -->
3588 <a id="Roo.form.Form-events"></a>
3597 <table cellspacing="0" class="member-table">
3598 <caption>Events</caption>
3601 <th class="sig-header" colspan="2">Event</th>
3602 <th class="msource-header">Defined By</th>
3611 <tr class="method-row expandable config-row-alt0">
3612 <td class="micon"><a class="exi" href="#expand"> </a></td>
3615 <a id="Roo.form.BasicForm-event-*actioncomplete"></a>
3617 <div class="fixedFont">
3618 <b class="itemname">actioncomplete</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
3624 <div class="short">Fires when an action is completed.
3630 Fires when an action is completed.
3636 <dl class="detailList">
3637 <dt class="heading">Parameters:</dt>
3640 <span class="fixedFont">Form</span> <b>this</b>
3646 <span class="fixedFont">Action</span> <b>action</b>
3649 <dd>The action that completed</dd>
3667 <td class="msource">
3668 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
3672 <tr class="method-row expandable config-row-alt1">
3673 <td class="micon"><a class="exi" href="#expand"> </a></td>
3676 <a id="Roo.form.BasicForm-event-*actionfailed"></a>
3678 <div class="fixedFont">
3679 <b class="itemname">actionfailed</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
3685 <div class="short">Fires when an action fails.
3691 Fires when an action fails.
3697 <dl class="detailList">
3698 <dt class="heading">Parameters:</dt>
3701 <span class="fixedFont">Form</span> <b>this</b>
3707 <span class="fixedFont">Action</span> <b>action</b>
3710 <dd>The action that failed</dd>
3728 <td class="msource">
3729 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
3733 <tr class="method-row expandable config-row-alt0">
3734 <td class="micon"><a class="exi" href="#expand"> </a></td>
3737 <a id="Roo.form.BasicForm-event-*beforeaction"></a>
3739 <div class="fixedFont">
3740 <b class="itemname">beforeaction</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
3746 <div class="short">Fires before any action is performed.
3752 Fires before any action is performed. Return false to cancel the action.
3758 <dl class="detailList">
3759 <dt class="heading">Parameters:</dt>
3762 <span class="fixedFont">Form</span> <b>this</b>
3768 <span class="fixedFont">Action</span> <b>action</b>
3771 <dd>The action to be performed</dd>
3789 <td class="msource">
3790 <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
3794 <tr class="method-row expandable config-row-alt1 notInherited">
3795 <td class="micon"><a class="exi" href="#expand"> </a></td>
3798 <a id="Roo.form.Form-event-*clientvalidation"></a>
3800 <div class="fixedFont">
3801 <b class="itemname">clientvalidation</b> (Form <B><i>this</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>valid</i></B>)
3807 <div class="short">If the monitorValid config option is true, this event fires repetitively to notify of valid state
3813 If the monitorValid config option is true, this event fires repetitively to notify of valid state
3819 <dl class="detailList">
3820 <dt class="heading">Parameters:</dt>
3823 <span class="fixedFont">Form</span> <b>this</b>
3829 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>valid</b>
3832 <dd>true if the form has passed client-side validation</dd>
3850 <td class="msource">
3855 <tr class="method-row expandable config-row-alt0 notInherited">
3856 <td class="micon"><a class="exi" href="#expand"> </a></td>
3859 <a id="Roo.form.Form-event-*rendered"></a>
3861 <div class="fixedFont">
3862 <b class="itemname">rendered</b> (<a href="./Roo.form.Form.html#constructor" roo:cls="Roo.form.Form.html#constructor">Roo.form.Form</a> <B><i>form</i></B>)
3868 <div class="short">Fires when the form is rendered
3874 Fires when the form is rendered
3880 <dl class="detailList">
3881 <dt class="heading">Parameters:</dt>
3884 <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>
3905 <td class="msource">
3917 <!-- ============================== footer ================================= -->
3918 <div class="fineprint" style="clear:both">
3920 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Wed May 02 2012 14:21:10 GMT+0800 (HKT)
3922 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
projects / roojs1 / blob