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.bootstrap.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.bootstrap.Form-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.bootstrap.Form-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.bootstrap.Form-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.bootstrap.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.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
48 <img src="../../images/default/s.gif" height="1" width="40"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
49 <img src="../../images/default/s.gif" height="1" width="60"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.bootstrap.Form
54 <!-- ============================== class title / details ============================ -->
57 <h1 class="classTitle">
59 Class Roo.bootstrap.Form
62 <table cellspacing="0" class="class-summary-table">
64 <tr><td class="label">Package:</td><td class="hd-info">Roo.bootstrap</td></tr>
66 <tr><td class="label">Defined In:</td><td class="hd-info">
68 <a href="./src/Roo_bootstrap_Form.js.html">Roo/bootstrap/Form.js</a>.
71 <tr><td class="label">Class:</td><td class="hd-info">Form</td></tr>
76 <tr><td class="label">Extends:</td><td class="hd-info">
77 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
85 <!-- ============================== class summary ========================== -->
86 <div class="description">
91 <!-- ============================== Class comment block... ========================== -->
93 <div class="comments">
94 <b>Class Comments / Notes</B> =>
95 <u onclick="parent.CommentDialog.showCommentId = 'Roo.bootstrap.Form';">[Add Your comment/notes about this class]</u>
97 <iframe frameborder="0" id="comments-Roo.bootstrap" style="border: none;width:100%;"
98 src="/blog.php/GtkDjsComments/Roo.bootstrap.Form.html"></iframe>
103 <!-- ============================== config options ========================== -->
108 <div class="hr"></div>
109 <a id="Roo.bootstrap.Form-configs"></a>
115 <table cellspacing="0" class="member-table">
116 <caption>Config Options (Usually are also Properties)</caption>
120 <th class="sig-header" colspan="2">Options</th>
122 <th class="msource-header">Defined By</th>
129 <tr class="config-row expandable config-row-alt0">
130 <td class="micon"><a class="exi" href="#expand"> </a></td>
133 <a id="Roo.Component-cfg-actionMode" name=".actionMode"></a>
134 <div class="fixedFont">
135 <b class="itemname">actionMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
141 <div class="short">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
145 <div class="long">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
153 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
159 <tr class="config-row expandable config-row-alt1 notInherited">
160 <td class="micon"><a class="exi" href="#expand"> </a></td>
163 <a id="Roo.bootstrap.Form-cfg-align" name=".align"></a>
164 <div class="fixedFont">
165 <b class="itemname">align</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
171 <div class="short">left | right - for navbars</div>
175 <div class="long">left | right - for navbars</div>
189 <tr class="config-row expandable config-row-alt0">
190 <td class="micon"><a class="exi" href="#expand"> </a></td>
193 <a id="Roo.Component-cfg-allowDomMove" name=".allowDomMove"></a>
194 <div class="fixedFont">
195 <b class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
201 <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
205 <div class="long">Whether the component can move the Dom node when rendering (defaults to true).</div>
213 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
219 <tr class="config-row expandable config-row-alt1 notInherited">
220 <td class="micon"><a class="exi" href="#expand"> </a></td>
223 <a id="Roo.bootstrap.Form-cfg-baseParams" name=".baseParams"></a>
224 <div class="fixedFont">
225 <b class="itemname">baseParams</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
231 <div class="short">Parameters to pass with all requests.</div>
235 <div class="long">Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.</div>
249 <tr class="config-row expandable config-row-alt0">
250 <td class="micon"><a class="exi" href="#expand"> </a></td>
253 <a id="Roo.bootstrap.Component-cfg-can_build_overlaid" name=".can_build_overlaid"></a>
254 <div class="fixedFont">
255 <b class="itemname">can_build_overlaid</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
261 <div class="short">True if element can be rebuild from a HTML page</div>
265 <div class="long">True if element can be rebuild from a HTML page</div>
273 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
279 <tr class="config-row expandable config-row-alt1">
280 <td class="micon"><a class="exi" href="#expand"> </a></td>
283 <a id="Roo.bootstrap.Component-cfg-cls" name=".cls"></a>
284 <div class="fixedFont">
285 <b class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
291 <div class="short">css class</div>
295 <div class="long">css class</div>
303 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
309 <tr class="config-row expandable config-row-alt0">
310 <td class="micon"><a class="exi" href="#expand"> </a></td>
313 <a id="Roo.bootstrap.Component-cfg-dataId" name=".dataId"></a>
314 <div class="fixedFont">
315 <b class="itemname">dataId</b> : string
321 <div class="short">cutomer id</div>
325 <div class="long">cutomer id</div>
333 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
339 <tr class="config-row expandable config-row-alt1">
340 <td class="micon"><a class="exi" href="#expand"> </a></td>
343 <a id="Roo.Component-cfg-disableClass" name=".disableClass"></a>
344 <div class="fixedFont">
345 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
351 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
355 <div class="long">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
363 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
369 <tr class="config-row expandable config-row-alt0 notInherited">
370 <td class="micon"><a class="exi" href="#expand"> </a></td>
373 <a id="Roo.bootstrap.Form-cfg-fileUpload" name=".fileUpload"></a>
374 <div class="fixedFont">
375 <b class="itemname">fileUpload</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
381 <div class="short">Set to true if this form is a file upload.</div>
385 <div class="long">Set to true if this form is a file upload.</div>
399 <tr class="config-row expandable config-row-alt1">
400 <td class="micon"><a class="exi" href="#expand"> </a></td>
403 <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
404 <div class="fixedFont">
405 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
411 <div class="short">How this component should hidden.</div>
415 <div class="long">How this component should hidden. Supported values are<br/>"visibility" (css visibility), "offsets" (negative offset position) and<br/>"display" (css display) - defaults to "display".</div>
423 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
429 <tr class="config-row expandable config-row-alt0 notInherited">
430 <td class="micon"><a class="exi" href="#expand"> </a></td>
433 <a id="Roo.bootstrap.Form-cfg-labelAlign" name=".labelAlign"></a>
434 <div class="fixedFont">
435 <b class="itemname">labelAlign</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
441 <div class="short">top | left (default top)</div>
445 <div class="long">top | left (default top)</div>
459 <tr class="config-row expandable config-row-alt1">
460 <td class="micon"><a class="exi" href="#expand"> </a></td>
463 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
464 <div class="fixedFont">
465 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
471 <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>
475 <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>
483 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
489 <tr class="config-row expandable config-row-alt0 notInherited">
490 <td class="micon"><a class="exi" href="#expand"> </a></td>
493 <a id="Roo.bootstrap.Form-cfg-method" name=".method"></a>
494 <div class="fixedFont">
495 <b class="itemname">method</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
501 <div class="short">GET | POST (default POST)</div>
505 <div class="long">GET | POST (default POST)</div>
519 <tr class="config-row expandable config-row-alt1">
520 <td class="micon"><a class="exi" href="#expand"> </a></td>
523 <a id="Roo.bootstrap.Component-cfg-name" name=".name"></a>
524 <div class="fixedFont">
525 <b class="itemname">name</b> : string
531 <div class="short">Specifies name attribute</div>
535 <div class="long">Specifies name attribute</div>
543 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
549 <tr class="config-row expandable config-row-alt0">
550 <td class="micon"><a class="exi" href="#expand"> </a></td>
553 <a id="Roo.bootstrap.Component-cfg-style" name=".style"></a>
554 <div class="fixedFont">
555 <b class="itemname">style</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
561 <div class="short">any extra css</div>
565 <div class="long">any extra css</div>
573 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
579 <tr class="config-row expandable config-row-alt1 notInherited">
580 <td class="micon"><a class="exi" href="#expand"> </a></td>
583 <a id="Roo.bootstrap.Form-cfg-timeout" name=".timeout"></a>
584 <div class="fixedFont">
585 <b class="itemname">timeout</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
591 <div class="short">Timeout for form actions in seconds (default is 30 seconds).</div>
595 <div class="long">Timeout for form actions in seconds (default is 30 seconds).</div>
609 <tr class="config-row expandable config-row-alt0 notInherited">
610 <td class="micon"><a class="exi" href="#expand"> </a></td>
613 <a id="Roo.bootstrap.Form-cfg-url" name=".url"></a>
614 <div class="fixedFont">
615 <b class="itemname">url</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
621 <div class="short">The URL to use for form actions if one isn't supplied in the action options.</div>
625 <div class="long">The URL to use for form actions if one isn't supplied in the action options.</div>
639 <tr class="config-row expandable config-row-alt1">
640 <td class="micon"><a class="exi" href="#expand"> </a></td>
643 <a id="Roo.bootstrap.Component-cfg-xattr" name=".xattr"></a>
644 <div class="fixedFont">
645 <b class="itemname">xattr</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
651 <div class="short">extra attributes to add to 'element' (used by builder to store stuff.</div>
655 <div class="long">extra attributes to add to 'element' (used by builder to store stuff.)</div>
663 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
679 <!-- ============================== public properties ==================== -->
683 <a id="Roo.bootstrap.Form-props"></a>
689 <table cellspacing="0" class="member-table">
690 <caption class="Empty">Public Properties - Has None</caption>
696 <!-- ============================== methods summary / details ======================== -->
699 <a id="Roo.bootstrap.Form-methods"></a>
700 <!-- constructor?? -->
707 <!-- then dynamics first -->
714 <table cellspacing="0" class="member-table">
715 <caption>Public Methods</caption>
717 <th class="sig-header" colspan="2">Method</th>
718 <th class="msource-header">Defined By</th>
728 <tr class="method-row config-row-alt0 expandable notInherited">
729 <td class="micon"><a class="exi" href="#expand"> </a></td>
733 <a id="Roo.bootstrap-method-Form" name=".Form"></a>
734 <div class="fixedFont">
735 <span class="attributes">new <B>Roo.bootstrap.</B></span><b class="itemname">Form</b>
737 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
745 <div class="short">Create a new Roo.bootstrap.Form</div>
752 Create a new Roo.bootstrap.Form
755 <dl class="detailList">
756 <dt class="heading">Parameters:</dt>
759 <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>
762 <dd>The config object</dd>
786 <tr class="method-row config-row-alt1 expandable">
787 <td class="micon"><a class="exi" href="#expand"> </a></td>
791 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
792 <div class="fixedFont">
793 <span class="attributes"></span><b class="itemname">addEvents</b>
795 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
802 <div class="short">Used to define events on this Observable</div>
808 Used to define events on this Observable
815 <dl class="detailList">
816 <dt class="heading">Parameters:</dt>
819 <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>
822 <dd>The object with the events defined</dd>
842 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
848 <tr class="method-row config-row-alt0 expandable">
849 <td class="micon"><a class="exi" href="#expand"> </a></td>
853 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
854 <div class="fixedFont">
855 <span class="attributes"></span><b class="itemname">addListener</b>
857 (<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>)
864 <div class="short">Appends an event handler to this component</div>
870 Appends an event handler to this component
877 <dl class="detailList">
878 <dt class="heading">Parameters:</dt>
881 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
884 <dd>The type of event to listen for</dd>
887 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
890 <dd>The method the event invokes</dd>
893 <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>
896 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
899 <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>
902 <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>
922 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
928 <tr class="method-row config-row-alt1 expandable notInherited">
929 <td class="micon"><a class="exi" href="#expand"> </a></td>
933 <a id="Roo.bootstrap.Form-method-clearInvalid" name=".clearInvalid"></a>
934 <div class="fixedFont">
935 <span class="attributes"></span><b class="itemname">clearInvalid</b>
952 <div class="short">Clears all invalid messages in this form.</div>
958 Clears all invalid messages in this form.
969 <dl class="detailList">
970 <dt class="heading">Returns:</dt>
972 <dd><span class="fixedFont">BasicForm</span> this</dd>
994 <tr class="method-row config-row-alt0 expandable">
995 <td class="micon"><a class="exi" href="#expand"> </a></td>
999 <a id="Roo.Component-method-destroy" name=".destroy"></a>
1000 <div class="fixedFont">
1001 <span class="attributes"></span><b class="itemname">destroy</b>
1010 <div class="short">Destroys this component by purging any event listeners, removing the component's element from the DOM,<br/>removing the component from its {<b>link</b> Roo.Container} (if applicable) and unregistering it from {<b>link</b> Roo.ComponentMgr}.</div>
1016 Destroys this component by purging any event listeners, removing the component's element from the DOM,<br/>removing the component from its {<b>link</b> Roo.Container} (if applicable) and unregistering it from {<b>link</b> Roo.ComponentMgr}.
1037 <td class="msource">
1039 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1045 <tr class="method-row config-row-alt1 expandable">
1046 <td class="micon"><a class="exi" href="#expand"> </a></td>
1050 <a id="Roo.Component-method-disable" name=".disable"></a>
1051 <div class="fixedFont">
1052 <span class="attributes"></span><b class="itemname">disable</b>
1060 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1069 <div class="short">Disable this component.</div>
1075 Disable this component.
1086 <dl class="detailList">
1087 <dt class="heading">Returns:</dt>
1089 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1103 <td class="msource">
1105 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1111 <tr class="method-row config-row-alt0 expandable notInherited">
1112 <td class="micon"><a class="exi" href="#expand"> </a></td>
1116 <a id="Roo.bootstrap.Form-method-doAction" name=".doAction"></a>
1117 <div class="fixedFont">
1118 <span class="attributes"></span><b class="itemname">doAction</b>
1120 (<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>)
1135 <div class="short">Performs a predefined action (submit or load) or custom actions you define on this form.</div>
1141 Performs a predefined action (submit or load) or custom actions you define on this form.
1148 <dl class="detailList">
1149 <dt class="heading">Parameters:</dt>
1152 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>actionName</b>
1155 <dd>The name of the action type</dd>
1158 <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>
1161 <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>
1169 <dl class="detailList">
1170 <dt class="heading">Returns:</dt>
1172 <dd><span class="fixedFont">BasicForm</span> this</dd>
1186 <td class="msource">
1194 <tr class="method-row config-row-alt1 expandable">
1195 <td class="micon"><a class="exi" href="#expand"> </a></td>
1199 <a id="Roo.Component-method-enable" name=".enable"></a>
1200 <div class="fixedFont">
1201 <span class="attributes"></span><b class="itemname">enable</b>
1209 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1218 <div class="short">Enable this component.</div>
1224 Enable this component.
1235 <dl class="detailList">
1236 <dt class="heading">Returns:</dt>
1238 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1252 <td class="msource">
1254 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1260 <tr class="method-row config-row-alt0 expandable notInherited">
1261 <td class="micon"><a class="exi" href="#expand"> </a></td>
1265 <a id="Roo.bootstrap.Form-method-findField" name=".findField"></a>
1266 <div class="fixedFont">
1267 <span class="attributes"></span><b class="itemname">findField</b>
1269 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1284 <div class="short">Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName</div>
1290 Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName
1297 <dl class="detailList">
1298 <dt class="heading">Parameters:</dt>
1301 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
1304 <dd>The value to search for</dd>
1312 <dl class="detailList">
1313 <dt class="heading">Returns:</dt>
1329 <td class="msource">
1337 <tr class="method-row config-row-alt1 expandable">
1338 <td class="micon"><a class="exi" href="#expand"> </a></td>
1342 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1343 <div class="fixedFont">
1344 <span class="attributes"></span><b class="itemname">fireEvent</b>
1346 (<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>)
1352 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1361 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1367 Fires the specified event with the passed parameters (minus the event name).
1374 <dl class="detailList">
1375 <dt class="heading">Parameters:</dt>
1378 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1384 <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>
1387 <dd>Variable number of parameters are passed to handlers</dd>
1395 <dl class="detailList">
1396 <dt class="heading">Returns:</dt>
1398 <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>
1412 <td class="msource">
1414 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1420 <tr class="method-row config-row-alt0 expandable">
1421 <td class="micon"><a class="exi" href="#expand"> </a></td>
1425 <a id="Roo.Component-method-focus" name=".focus"></a>
1426 <div class="fixedFont">
1427 <span class="attributes"></span><b class="itemname">focus</b>
1429 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
1435 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1444 <div class="short">Try to focus this component.</div>
1450 Try to focus this component.
1457 <dl class="detailList">
1458 <dt class="heading">Parameters:</dt>
1461 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>selectText</b>
1464 <dd>True to also select the text in this component (if applicable)</dd>
1472 <dl class="detailList">
1473 <dt class="heading">Returns:</dt>
1475 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1489 <td class="msource">
1491 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1497 <tr class="method-row config-row-alt1 expandable notInherited">
1498 <td class="micon"><a class="exi" href="#expand"> </a></td>
1502 <a id="Roo.bootstrap.Form-method-getAutoCreate" name=".getAutoCreate"></a>
1503 <div class="fixedFont">
1504 <span class="attributes"></span><b class="itemname">getAutoCreate</b>
1513 <div class="short">By default wait messages are displayed with Roo.MessageBox.wait.</div>
1519 By default wait messages are displayed with Roo.MessageBox.wait. You can target a specific<br/>element by passing it or its id or mask the form itself by passing in true.
1540 <td class="msource">
1548 <tr class="method-row config-row-alt0 expandable">
1549 <td class="micon"><a class="exi" href="#expand"> </a></td>
1553 <a id="Roo.Component-method-getEl" name=".getEl"></a>
1554 <div class="fixedFont">
1555 <span class="attributes"></span><b class="itemname">getEl</b>
1563 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1572 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
1578 Returns the underlying {<b>link</b> Roo.Element}.
1589 <dl class="detailList">
1590 <dt class="heading">Returns:</dt>
1592 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1606 <td class="msource">
1608 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1614 <tr class="method-row config-row-alt1 expandable notInherited">
1615 <td class="micon"><a class="exi" href="#expand"> </a></td>
1619 <a id="Roo.bootstrap.Form-method-getFieldValues" name=".getFieldValues"></a>
1620 <div class="fixedFont">
1621 <span class="attributes"></span><b class="itemname">getFieldValues</b>
1629 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1638 <div class="short">Returns the fields in this form as an object with key/value pairs.</div>
1644 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.
1655 <dl class="detailList">
1656 <dt class="heading">Returns:</dt>
1658 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> </dd>
1672 <td class="msource">
1680 <tr class="method-row config-row-alt0 expandable">
1681 <td class="micon"><a class="exi" href="#expand"> </a></td>
1685 <a id="Roo.Component-method-getId" name=".getId"></a>
1686 <div class="fixedFont">
1687 <span class="attributes"></span><b class="itemname">getId</b>
1695 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1704 <div class="short">Returns the id of this component.</div>
1710 Returns the id of this component.
1721 <dl class="detailList">
1722 <dt class="heading">Returns:</dt>
1724 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1738 <td class="msource">
1740 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1746 <tr class="method-row config-row-alt1 expandable notInherited">
1747 <td class="micon"><a class="exi" href="#expand"> </a></td>
1751 <a id="Roo.bootstrap.Form-method-getValues" name=".getValues"></a>
1752 <div class="fixedFont">
1753 <span class="attributes"></span><b class="itemname">getValues</b>
1755 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>asString</i></B>)
1761 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1770 <div class="short">Returns the fields in this form as an object with key/value pairs.</div>
1776 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.
1783 <dl class="detailList">
1784 <dt class="heading">Parameters:</dt>
1787 <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>
1798 <dl class="detailList">
1799 <dt class="heading">Returns:</dt>
1801 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> </dd>
1815 <td class="msource">
1823 <tr class="method-row config-row-alt0 expandable">
1824 <td class="micon"><a class="exi" href="#expand"> </a></td>
1828 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1829 <div class="fixedFont">
1830 <span class="attributes"></span><b class="itemname">hasListener</b>
1832 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1838 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1847 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1853 Checks to see if this object has any listeners for a specified event
1860 <dl class="detailList">
1861 <dt class="heading">Parameters:</dt>
1864 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1867 <dd>The name of the event to check for</dd>
1875 <dl class="detailList">
1876 <dt class="heading">Returns:</dt>
1878 <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>
1892 <td class="msource">
1894 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1900 <tr class="method-row config-row-alt1 expandable">
1901 <td class="micon"><a class="exi" href="#expand"> </a></td>
1905 <a id="Roo.Component-method-hide" name=".hide"></a>
1906 <div class="fixedFont">
1907 <span class="attributes"></span><b class="itemname">hide</b>
1915 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1924 <div class="short">Hide this component.</div>
1930 Hide this component.
1941 <dl class="detailList">
1942 <dt class="heading">Returns:</dt>
1944 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1958 <td class="msource">
1960 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1966 <tr class="method-row config-row-alt0 expandable notInherited">
1967 <td class="micon"><a class="exi" href="#expand"> </a></td>
1971 <a id="Roo.bootstrap.Form-method-isDirty" name=".isDirty"></a>
1972 <div class="fixedFont">
1973 <span class="attributes"></span><b class="itemname">isDirty</b>
1990 <div class="short">Returns true if any fields in this form have changed since their original load.</div>
1996 Returns true if any fields in this form have changed since their original load.
2007 <dl class="detailList">
2008 <dt class="heading">Returns:</dt>
2024 <td class="msource">
2032 <tr class="method-row config-row-alt1 expandable notInherited">
2033 <td class="micon"><a class="exi" href="#expand"> </a></td>
2037 <a id="Roo.bootstrap.Form-method-isValid" name=".isValid"></a>
2038 <div class="fixedFont">
2039 <span class="attributes"></span><b class="itemname">isValid</b>
2056 <div class="short">Returns true if client-side validation on the form is successful.</div>
2062 Returns true if client-side validation on the form is successful.
2073 <dl class="detailList">
2074 <dt class="heading">Returns:</dt>
2090 <td class="msource">
2098 <tr class="method-row config-row-alt0 expandable">
2099 <td class="micon"><a class="exi" href="#expand"> </a></td>
2103 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
2104 <div class="fixedFont">
2105 <span class="attributes"></span><b class="itemname">isVisible</b>
2114 <div class="short">Returns true if this component is visible.</div>
2120 Returns true if this component is visible.
2141 <td class="msource">
2143 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2149 <tr class="method-row config-row-alt1 expandable notInherited">
2150 <td class="micon"><a class="exi" href="#expand"> </a></td>
2154 <a id="Roo.bootstrap.Form-method-markInvalid" name=".markInvalid"></a>
2155 <div class="fixedFont">
2156 <span class="attributes"></span><b class="itemname">markInvalid</b>
2158 (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>errors</i></B>)
2173 <div class="short">Mark fields in this form invalid in bulk.</div>
2179 Mark fields in this form invalid in bulk.
2186 <dl class="detailList">
2187 <dt class="heading">Parameters:</dt>
2190 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span> <b>errors</b>
2193 <dd>Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}</dd>
2201 <dl class="detailList">
2202 <dt class="heading">Returns:</dt>
2204 <dd><span class="fixedFont">BasicForm</span> this</dd>
2218 <td class="msource">
2226 <tr class="method-row config-row-alt0 expandable">
2227 <td class="micon"><a class="exi" href="#expand"> </a></td>
2231 <a id="Roo.util.Observable-method-on" name=".on"></a>
2232 <div class="fixedFont">
2233 <span class="attributes"></span><b class="itemname">on</b>
2235 (<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>)
2242 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2248 Appends an event handler to this element (shorthand for addListener)
2255 <dl class="detailList">
2256 <dt class="heading">Parameters:</dt>
2259 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2262 <dd>The type of event to listen for</dd>
2265 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2268 <dd>The method the event invokes</dd>
2271 <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>
2274 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2277 <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>
2298 <td class="msource">
2300 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2306 <tr class="method-row config-row-alt1 expandable">
2307 <td class="micon"><a class="exi" href="#expand"> </a></td>
2311 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2312 <div class="fixedFont">
2313 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2322 <div class="short">Removes all listeners for this object</div>
2328 Removes all listeners for this object
2349 <td class="msource">
2351 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2357 <tr class="method-row config-row-alt0 expandable">
2358 <td class="micon"><a class="exi" href="#expand"> </a></td>
2362 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2363 <div class="fixedFont">
2364 <span class="attributes"></span><b class="itemname">removeListener</b>
2366 (<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>)
2373 <div class="short">Removes a listener</div>
2386 <dl class="detailList">
2387 <dt class="heading">Parameters:</dt>
2390 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2393 <dd>The type of event to listen for</dd>
2396 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2399 <dd>The handler to remove</dd>
2402 <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>
2405 <dd>(optional) The scope (this object) for the handler</dd>
2423 <td class="msource">
2425 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2431 <tr class="method-row config-row-alt1 expandable">
2432 <td class="micon"><a class="exi" href="#expand"> </a></td>
2436 <a id="Roo.Component-method-render" name=".render"></a>
2437 <div class="fixedFont">
2438 <span class="attributes"></span><b class="itemname">render</b>
2440 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
2447 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
2453 If this is a lazy rendering component, render it to its container element.
2460 <dl class="detailList">
2461 <dt class="heading">Parameters:</dt>
2464 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
2467 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
2485 <td class="msource">
2487 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2493 <tr class="method-row config-row-alt0 expandable notInherited">
2494 <td class="micon"><a class="exi" href="#expand"> </a></td>
2498 <a id="Roo.bootstrap.Form-method-reset" name=".reset"></a>
2499 <div class="fixedFont">
2500 <span class="attributes"></span><b class="itemname">reset</b>
2517 <div class="short">Resets this form.</div>
2534 <dl class="detailList">
2535 <dt class="heading">Returns:</dt>
2537 <dd><span class="fixedFont">BasicForm</span> this</dd>
2551 <td class="msource">
2559 <tr class="method-row config-row-alt1 expandable">
2560 <td class="micon"><a class="exi" href="#expand"> </a></td>
2564 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
2565 <div class="fixedFont">
2566 <span class="attributes"></span><b class="itemname">setDisabled</b>
2568 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
2575 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
2581 Convenience function for setting disabled/enabled by boolean.
2588 <dl class="detailList">
2589 <dt class="heading">Parameters:</dt>
2592 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>disabled</b>
2613 <td class="msource">
2615 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2621 <tr class="method-row config-row-alt0 expandable notInherited">
2622 <td class="micon"><a class="exi" href="#expand"> </a></td>
2626 <a id="Roo.bootstrap.Form-method-setValues" name=".setValues"></a>
2627 <div class="fixedFont">
2628 <span class="attributes"></span><b class="itemname">setValues</b>
2630 (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>values</i></B>)
2645 <div class="short">Set values for fields in this form in bulk.</div>
2651 Set values for fields in this form in bulk.
2658 <dl class="detailList">
2659 <dt class="heading">Parameters:</dt>
2662 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span> <b>values</b>
2665 <dd>Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}</dd>
2673 <dl class="detailList">
2674 <dt class="heading">Returns:</dt>
2676 <dd><span class="fixedFont">BasicForm</span> this</dd>
2690 <td class="msource">
2698 <tr class="method-row config-row-alt1 expandable">
2699 <td class="micon"><a class="exi" href="#expand"> </a></td>
2703 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
2704 <div class="fixedFont">
2705 <span class="attributes"></span><b class="itemname">setVisible</b>
2707 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
2713 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2722 <div class="short">Convenience function to hide or show this component by boolean.</div>
2728 Convenience function to hide or show this component by boolean.
2735 <dl class="detailList">
2736 <dt class="heading">Parameters:</dt>
2739 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>visible</b>
2742 <dd>True to show, false to hide</dd>
2750 <dl class="detailList">
2751 <dt class="heading">Returns:</dt>
2753 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
2767 <td class="msource">
2769 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2775 <tr class="method-row config-row-alt0 expandable">
2776 <td class="micon"><a class="exi" href="#expand"> </a></td>
2780 <a id="Roo.Component-method-show" name=".show"></a>
2781 <div class="fixedFont">
2782 <span class="attributes"></span><b class="itemname">show</b>
2790 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2799 <div class="short">Show this component.</div>
2805 Show this component.
2816 <dl class="detailList">
2817 <dt class="heading">Returns:</dt>
2819 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
2833 <td class="msource">
2835 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2841 <tr class="method-row config-row-alt1 expandable">
2842 <td class="micon"><a class="exi" href="#expand"> </a></td>
2846 <a id="Roo.util.Observable-method-un" name=".un"></a>
2847 <div class="fixedFont">
2848 <span class="attributes"></span><b class="itemname">un</b>
2850 (<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>)
2857 <div class="short">Removes a listener (shorthand for removeListener)</div>
2863 Removes a listener (shorthand for removeListener)
2870 <dl class="detailList">
2871 <dt class="heading">Parameters:</dt>
2874 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2877 <dd>The type of event to listen for</dd>
2880 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2883 <dd>The handler to remove</dd>
2886 <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>
2889 <dd>(optional) The scope (this object) for the handler</dd>
2907 <td class="msource">
2909 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2918 <!-- ============================== events summary / details ======================== -->
2921 <a id="Roo.bootstrap.Form-events"></a>
2930 <table cellspacing="0" class="member-table">
2931 <caption>Events</caption>
2934 <th class="sig-header" colspan="2">Event</th>
2935 <th class="msource-header">Defined By</th>
2944 <tr class="method-row expandable config-row-alt0 notInherited">
2945 <td class="micon"><a class="exi" href="#expand"> </a></td>
2948 <a id="Roo.bootstrap.Form-event-*actioncomplete"></a>
2950 <div class="fixedFont">
2951 <b class="itemname">actioncomplete</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
2957 <div class="short">Fires when an action is completed.
2963 Fires when an action is completed.
2969 <dl class="detailList">
2970 <dt class="heading">Parameters:</dt>
2973 <span class="fixedFont">Form</span> <b>this</b>
2979 <span class="fixedFont">Action</span> <b>action</b>
2982 <dd>The action that completed</dd>
3000 <td class="msource">
3005 <tr class="method-row expandable config-row-alt1 notInherited">
3006 <td class="micon"><a class="exi" href="#expand"> </a></td>
3009 <a id="Roo.bootstrap.Form-event-*actionfailed"></a>
3011 <div class="fixedFont">
3012 <b class="itemname">actionfailed</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
3018 <div class="short">Fires when an action fails.
3024 Fires when an action fails.
3030 <dl class="detailList">
3031 <dt class="heading">Parameters:</dt>
3034 <span class="fixedFont">Form</span> <b>this</b>
3040 <span class="fixedFont">Action</span> <b>action</b>
3043 <dd>The action that failed</dd>
3061 <td class="msource">
3066 <tr class="method-row expandable config-row-alt0 notInherited">
3067 <td class="micon"><a class="exi" href="#expand"> </a></td>
3070 <a id="Roo.bootstrap.Form-event-*beforeaction"></a>
3072 <div class="fixedFont">
3073 <b class="itemname">beforeaction</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
3079 <div class="short">Fires before any action is performed.
3085 Fires before any action is performed. Return false to cancel the action.
3091 <dl class="detailList">
3092 <dt class="heading">Parameters:</dt>
3095 <span class="fixedFont">Form</span> <b>this</b>
3101 <span class="fixedFont">Action</span> <b>action</b>
3104 <dd>The action to be performed</dd>
3122 <td class="msource">
3127 <tr class="method-row expandable config-row-alt1">
3128 <td class="micon"><a class="exi" href="#expand"> </a></td>
3131 <a id="Roo.Component-event-*beforedestroy"></a>
3133 <div class="fixedFont">
3134 <b class="itemname">beforedestroy</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
3140 <div class="short">Fires before the component is destroyed.
3146 Fires before the component is destroyed. Return false to stop the destroy.
3152 <dl class="detailList">
3153 <dt class="heading">Parameters:</dt>
3156 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3177 <td class="msource">
3178 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3182 <tr class="method-row expandable config-row-alt0">
3183 <td class="micon"><a class="exi" href="#expand"> </a></td>
3186 <a id="Roo.Component-event-*beforehide"></a>
3188 <div class="fixedFont">
3189 <b class="itemname">beforehide</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
3195 <div class="short">Fires before the component is hidden.
3201 Fires before the component is hidden. Return false to stop the hide.
3207 <dl class="detailList">
3208 <dt class="heading">Parameters:</dt>
3211 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3232 <td class="msource">
3233 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3237 <tr class="method-row expandable config-row-alt1">
3238 <td class="micon"><a class="exi" href="#expand"> </a></td>
3241 <a id="Roo.Component-event-*beforerender"></a>
3243 <div class="fixedFont">
3244 <b class="itemname">beforerender</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
3250 <div class="short">Fires before the component is rendered.
3256 Fires before the component is rendered. Return false to stop the render.
3262 <dl class="detailList">
3263 <dt class="heading">Parameters:</dt>
3266 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3287 <td class="msource">
3288 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3292 <tr class="method-row expandable config-row-alt0">
3293 <td class="micon"><a class="exi" href="#expand"> </a></td>
3296 <a id="Roo.Component-event-*beforeshow"></a>
3298 <div class="fixedFont">
3299 <b class="itemname">beforeshow</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
3305 <div class="short">Fires before the component is shown.
3311 Fires before the component is shown. Return false to stop the show.
3317 <dl class="detailList">
3318 <dt class="heading">Parameters:</dt>
3321 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3342 <td class="msource">
3343 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3347 <tr class="method-row expandable config-row-alt1 notInherited">
3348 <td class="micon"><a class="exi" href="#expand"> </a></td>
3351 <a id="Roo.bootstrap.Form-event-*clientvalidation"></a>
3353 <div class="fixedFont">
3354 <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>)
3360 <div class="short">If the monitorValid config option is true, this event fires repetitively to notify of valid state
3366 If the monitorValid config option is true, this event fires repetitively to notify of valid state
3372 <dl class="detailList">
3373 <dt class="heading">Parameters:</dt>
3376 <span class="fixedFont">Form</span> <b>this</b>
3382 <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>
3385 <dd>true if the form has passed client-side validation</dd>
3403 <td class="msource">
3408 <tr class="method-row expandable config-row-alt0">
3409 <td class="micon"><a class="exi" href="#expand"> </a></td>
3412 <a id="Roo.Component-event-*destroy"></a>
3414 <div class="fixedFont">
3415 <b class="itemname">destroy</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
3421 <div class="short">Fires after the component is destroyed.
3427 Fires after the component is destroyed.
3433 <dl class="detailList">
3434 <dt class="heading">Parameters:</dt>
3437 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3458 <td class="msource">
3459 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3463 <tr class="method-row expandable config-row-alt1">
3464 <td class="micon"><a class="exi" href="#expand"> </a></td>
3467 <a id="Roo.Component-event-*disable"></a>
3469 <div class="fixedFont">
3470 <b class="itemname">disable</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
3476 <div class="short">Fires after the component is disabled.
3482 Fires after the component is disabled.
3488 <dl class="detailList">
3489 <dt class="heading">Parameters:</dt>
3492 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3513 <td class="msource">
3514 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3518 <tr class="method-row expandable config-row-alt0">
3519 <td class="micon"><a class="exi" href="#expand"> </a></td>
3522 <a id="Roo.Component-event-*enable"></a>
3524 <div class="fixedFont">
3525 <b class="itemname">enable</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
3531 <div class="short">Fires after the component is enabled.
3537 Fires after the component is enabled.
3543 <dl class="detailList">
3544 <dt class="heading">Parameters:</dt>
3547 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3568 <td class="msource">
3569 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3573 <tr class="method-row expandable config-row-alt1">
3574 <td class="micon"><a class="exi" href="#expand"> </a></td>
3577 <a id="Roo.Component-event-*hide"></a>
3579 <div class="fixedFont">
3580 <b class="itemname">hide</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
3586 <div class="short">Fires after the component is hidden.
3592 Fires after the component is hidden.
3598 <dl class="detailList">
3599 <dt class="heading">Parameters:</dt>
3602 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3623 <td class="msource">
3624 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3628 <tr class="method-row expandable config-row-alt0">
3629 <td class="micon"><a class="exi" href="#expand"> </a></td>
3632 <a id="Roo.Component-event-*render"></a>
3634 <div class="fixedFont">
3635 <b class="itemname">render</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
3641 <div class="short">Fires after the component is rendered.
3647 Fires after the component is rendered.
3653 <dl class="detailList">
3654 <dt class="heading">Parameters:</dt>
3657 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3678 <td class="msource">
3679 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3683 <tr class="method-row expandable config-row-alt1">
3684 <td class="micon"><a class="exi" href="#expand"> </a></td>
3687 <a id="Roo.Component-event-*show"></a>
3689 <div class="fixedFont">
3690 <b class="itemname">show</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
3696 <div class="short">Fires after the component is shown.
3702 Fires after the component is shown.
3708 <dl class="detailList">
3709 <dt class="heading">Parameters:</dt>
3712 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3733 <td class="msource">
3734 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3745 <!-- ============================== footer ================================= -->
3746 <div class="fineprint" style="clear:both">
3748 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Apr 08 2014 22:03:34 GMT+0800 (HKT)
3750 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>