+++ /dev/null
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-
- <head>
- <meta http-equiv="content-type" content="text/html; charset=undefined" />
- <meta name="generator" content="JsDoc Toolkit" />
-
-
- <title>JsDoc Reference - Roo.form.Form</title>
-
-
- <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
- <link rel="stylesheet" type="text/css" href="../default.css" />
-
-
- <script type="text/javascript" src="../page.js">
-
- </script>
-
-
- </head>
-
- <body onload="RooDocsPage.onload();">
-
-
-<div class="body-wrap">
-
- <!-- ============================== links to methods. ================================= -->
-
- <div class="top-tools">
- <!--
- <a class="inner-link" href="#Roo.form.Form-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Roo.form.Form-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Roo.form.Form-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
- <a class="inner-link" href="#Roo.form.Form-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
- <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
- -->
- </div>
-
-
-<!-- ============================== inheritance Block. ================================= -->
-
- <div class="inheritance res-block">
- <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-<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>
-<img src="../../images/default/s.gif" height="1" width="40"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.form.Form
-
- </pre>
- </div>
-
-<!-- ============================== class title / details ============================ -->
-
-
- <h1 class="classTitle">
-
- Class Roo.form.Form
- </h1>
-
- <table cellspacing="0" class="class-summary-table">
-
- <tr><td class="label">Package:</td><td class="hd-info">Roo.form</td></tr>
-
- <tr><td class="label">Defined In:</td><td class="hd-info">
-
- <a href="./src/Roo_form_Form.js.html">Roo/form/Form.js</a>.
-
- </td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">Form</td></tr>
-
-
-
-
- <tr><td class="label">Extends:</td><td class="hd-info">
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td></tr>
-
-
- </table>
-
-
-<!-- ============================== class summary ========================== -->
- <div class="description">
- Adds the ability to dynamically render forms with JavaScript to {<b>link</b> Roo.form.BasicForm}.
- </div>
-
-
-<!-- ============================== Class comment block... ========================== -->
-
-<div class="comments">
- <b>Class Comments / Notes</B> =>
- <u onclick="parent.CommentDialog.showCommentId = 'Roo.form.Form';">[Add Your comment/notes about this class]</u>
- <br/>
- <iframe frameborder="0" id="comments-Roo.form" style="border: none;width:100%;"
- src="/blog.php/GtkDjsComments/Roo.form.Form.html"></iframe>
-</div>
-
-
-
-<!-- ============================== config options ========================== -->
-
-
-
-
- <div class="hr"></div>
- <a id="Roo.form.Form-configs"></a>
-
-
-
-
-
- <table cellspacing="0" class="member-table">
- <caption>Config Options (Usually are also Properties)</caption>
-
-
- <tr>
- <th class="sig-header" colspan="2">Options</th>
-
- <th class="msource-header">Defined By</th>
- </tr>
-
-
-
-
-
- <tr class="config-row expandable config-row-alt0">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.form.BasicForm-cfg-baseParams" name=".baseParams"></a>
- <div class="fixedFont">
- <b class="itemname">baseParams</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">Parameters to pass with all requests.</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt1 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.form.Form-cfg-buttonAlign" name=".buttonAlign"></a>
- <div class="fixedFont">
- <b class="itemname">buttonAlign</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">Valid values are "left," "center" and "right" (defaults to "center")</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- Valid values are "left," "center" and "right" (defaults to "center")
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt0">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.form.BasicForm-cfg-errorReader" name=".errorReader"></a>
- <div class="fixedFont">
- <b class="itemname">errorReader</b> : DataReader
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">An Roo.data.DataReader (e.g.</div>
- </div>
-
- <div class="mdesc">
- <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>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt1">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.form.BasicForm-cfg-fileUpload" name=".fileUpload"></a>
- <div class="fixedFont">
- <b class="itemname">fileUpload</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">Set to true if this form is a file upload.</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- Set to true if this form is a file upload.
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt0 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.form.Form-cfg-itemCls" name=".itemCls"></a>
- <div class="fixedFont">
- <b class="itemname">itemCls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">A css class to apply to the x-form-item of fields.</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- A css class to apply to the x-form-item of fields. This property cascades to child containers.
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt1 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.form.Form-cfg-labelAlign" name=".labelAlign"></a>
- <div class="fixedFont">
- <b class="itemname">labelAlign</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">Valid values are "left," "top" and "right" (defaults to "left").</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- Valid values are "left," "top" and "right" (defaults to "left").<br/>This property cascades to child containers if not set.
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt0 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.form.Form-cfg-labelWidth" name=".labelWidth"></a>
- <div class="fixedFont">
- <b class="itemname">labelWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">The width of labels.</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- The width of labels. This property cascades to child containers.
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt1">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
- <div class="fixedFont">
- <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
-
-
- </div>
-
- <div class="mdesc">
- <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>
- </div>
-
- <div class="mdesc">
- <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>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt0">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.form.BasicForm-cfg-method" name=".method"></a>
- <div class="fixedFont">
- <b class="itemname">method</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">The request method to use (GET or POST) for form actions if one isn't supplied in the action options.</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- The request method to use (GET or POST) for form actions if one isn't supplied in the action options.
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt1 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.form.Form-cfg-minButtonWidth" name=".minButtonWidth"></a>
- <div class="fixedFont">
- <b class="itemname">minButtonWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">Minimum width of all buttons in pixels (defaults to 75)</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- Minimum width of all buttons in pixels (defaults to 75)
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt0 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.form.Form-cfg-monitorPoll" name=".monitorPoll"></a>
- <div class="fixedFont">
- <b class="itemname">monitorPoll</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt1 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.form.Form-cfg-monitorValid" name=".monitorValid"></a>
- <div class="fixedFont">
- <b class="itemname">monitorValid</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
-
-
- </div>
-
- <div class="mdesc">
- <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>
- </div>
-
- <div class="mdesc">
- <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>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt0 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.form.Form-cfg-progressUrl" name=".progressUrl"></a>
- <div class="fixedFont">
- <b class="itemname">progressUrl</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">- Url to return progress data</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- - Url to return progress data
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt1">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.form.BasicForm-cfg-reader" name=".reader"></a>
- <div class="fixedFont">
- <b class="itemname">reader</b> : DataReader
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">An Roo.data.DataReader (e.g.</div>
- </div>
-
- <div class="mdesc">
- <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>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt0">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.form.BasicForm-cfg-timeout" name=".timeout"></a>
- <div class="fixedFont">
- <b class="itemname">timeout</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">Timeout for form actions in seconds (default is 30 seconds).</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- Timeout for form actions in seconds (default is 30 seconds).
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt1">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.form.BasicForm-cfg-trackResetOnLoad" name=".trackResetOnLoad"></a>
- <div class="fixedFont">
- <b class="itemname">trackResetOnLoad</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
-
-
- </div>
-
- <div class="mdesc">
- <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>
- </div>
-
- <div class="mdesc">
- <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>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt0">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.form.BasicForm-cfg-url" name=".url"></a>
- <div class="fixedFont">
- <b class="itemname">url</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">The URL to use for form actions if one isn't supplied in the action options.</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- The URL to use for form actions if one isn't supplied in the action options.
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- </table>
-
-
-
-
-
-
-
-
-
- <!-- ============================== public properties ==================== -->
-
-
-
- <a id="Roo.form.Form-props"></a>
-
-
-
-
-
- <table cellspacing="0" class="member-table">
- <caption class="Empty">Public Properties - Has None</caption>
- </table>
-
-
-
-
- <!-- ============================== methods summary / details ======================== -->
-
-
- <a id="Roo.form.Form-methods"></a>
- <!-- constructor?? -->
-
- <!-- static's first
-
-
- -->
-
- <!-- then dynamics first -->
-
-
-
-
-
-
- <table cellspacing="0" class="member-table">
- <caption>Public Methods</caption>
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
-
- </tr>
-
-
-
-
-
-
-
- <tr class="method-row config-row-alt0 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form-method-Form" name=".Form"></a>
- <div class="fixedFont">
- <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">Form</b>
-
- (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
-
-
-
- </div>
- <div class="mdesc">
-
-
- <div class="short">Create a new Roo.form.Form</div>
-
-
- <div class="long">
-
-
-
- Create a new Roo.form.Form
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <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>
-
- </dt>
- <dd>Configuration options</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.Form-method-add" name=".add"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">add</b>
-
- (Field <B><i>field1</i></B>, Field <B><i>field2</i></B>)
-
-
- :
-
-
- Form
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Add Roo.form components to the current open container (e.g.</div>
-
-
-
- <div class="long">
-
- 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.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont">Field</span> <b>field1</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <span class="fixedFont">Field</span> <b>field2</b>
-
- </dt>
- <dd>(optional)</dd>
-
- <dt>
- <span class="fixedFont">Field</span> <b>etc.</b>
-
- </dt>
- <dd>(optional)</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">Form</span> this</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.Form-method-addButton" name=".addButton"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">addButton</b>
-
- (<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>)
-
-
- :
-
-
- <a href="./Roo.Button.html#constructor" roo:cls="Roo.Button.html#constructor">Roo.Button</a>
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered.</div>
-
-
-
- <div class="long">
-
- Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span> <b>config</b>
-
- </dt>
- <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>
-
- <dt>
- <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
-
- </dt>
- <dd>The function called when the button is clicked</dd>
-
- <dt>
- <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>
-
- </dt>
- <dd>(optional) The scope of the handler function</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont"><a href="./Roo.Button.html#constructor" roo:cls="Roo.Button.html#constructor">Roo.Button</a></span> </dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">addEvents</b>
-
- (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Used to define events on this Observable</div>
-
-
-
- <div class="long">
-
- Used to define events on this Observable
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <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>
-
- </dt>
- <dd>The object with the events defined</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-addForm" name=".addForm"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">addForm</b>
-
- (<a href="./Roo.form.Form.html#constructor" roo:cls="Roo.form.Form.html#constructor">Roo.form.Form</a> <B><i>form</i></B>)
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Add a secondary form to this one, <br/>Used to provide tabbed forms.</div>
-
-
-
- <div class="long">
-
- 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.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <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>
-
- </dt>
- <dd>to add.</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">addListener</b>
-
- (<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>)
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Appends an event handler to this component</div>
-
-
-
- <div class="long">
-
- Appends an event handler to this component
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
-
- </dt>
- <dd>The type of event to listen for</dd>
-
- <dt>
- <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
-
- </dt>
- <dd>The method the event invokes</dd>
-
- <dt>
- <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>
-
- </dt>
- <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
-
- <dt>
- <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>
-
- </dt>
- <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>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.Form-method-addxtype" name=".addxtype"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">addxtype</b>
-
- (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Adds a series of form elements (using the xtype property as the factory method.</div>
-
-
-
- <div class="long">
-
- 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)
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <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>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-applyIfToFields" name=".applyIfToFields"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">applyIfToFields</b>
-
- (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>)
-
-
- :
-
-
- BasicForm
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Calls {<b>link</b> Ext<b>applyIf</b>} for all field in this form with the passed object.</div>
-
-
-
- <div class="long">
-
- Calls {<b>link</b> Ext<b>applyIf</b>} for all field in this form with the passed object.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <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>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">BasicForm</span> this</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-applyToFields" name=".applyToFields"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">applyToFields</b>
-
- (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>values</i></B>)
-
-
- :
-
-
- BasicForm
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Calls {<b>link</b> Ext<b>apply</b>} for all fields in this form with the passed object.</div>
-
-
-
- <div class="long">
-
- Calls {<b>link</b> Ext<b>apply</b>} for all fields in this form with the passed object.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <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>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">BasicForm</span> this</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-clearInvalid" name=".clearInvalid"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">clearInvalid</b>
-
- ()
-
-
- :
-
-
- BasicForm
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Clears all invalid messages in this form.</div>
-
-
-
- <div class="long">
-
- Clears all invalid messages in this form.
-
-
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">BasicForm</span> this</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.Form-method-column" name=".column"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">column</b>
-
- (<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>)
-
-
- :
-
-
-
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Opens a new {<b>link</b> Roo.form.Column} container in the layout stack.</div>
-
-
-
- <div class="long">
-
- 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.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <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>
-
- </dt>
- <dd>The config to pass to the column</dd>
-
- <dt>
- <span class="fixedFont">Field</span> <b>field1</b>
-
- </dt>
- <dd>(optional)</dd>
-
- <dt>
- <span class="fixedFont">Field</span> <b>field2</b>
-
- </dt>
- <dd>(optional)</dd>
-
- <dt>
- <span class="fixedFont">Field</span> <b>etc</b>
-
- </dt>
- <dd>(optional)</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd> Column The column container object</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.Form-method-container" name=".container"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">container</b>
-
- (<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>)
-
-
- :
-
-
-
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Opens a new {<b>link</b> Roo.form.Layout} container in the layout stack.</div>
-
-
-
- <div class="long">
-
- 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.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <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>
-
- </dt>
- <dd>The config to pass to the Layout</dd>
-
- <dt>
- <span class="fixedFont">Field</span> <b>field1</b>
-
- </dt>
- <dd>(optional)</dd>
-
- <dt>
- <span class="fixedFont">Field</span> <b>field2</b>
-
- </dt>
- <dd>(optional)</dd>
-
- <dt>
- <span class="fixedFont">Field</span> <b>etc</b>
-
- </dt>
- <dd>(optional)</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd> Layout The container object</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-doAction" name=".doAction"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">doAction</b>
-
- (<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>)
-
-
- :
-
-
- BasicForm
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Performs a predefined action (submit or load) or custom actions you define on this form.</div>
-
-
-
- <div class="long">
-
- Performs a predefined action (submit or load) or custom actions you define on this form.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>actionName</b>
-
- </dt>
- <dd>The name of the action type</dd>
-
- <dt>
- <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>
-
- </dt>
- <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>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">BasicForm</span> this</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.Form-method-end" name=".end"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">end</b>
-
- ()
-
-
- :
-
-
- Form
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Closes the current open container</div>
-
-
-
- <div class="long">
-
- Closes the current open container
-
-
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">Form</span> this</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.Form-method-fieldset" name=".fieldset"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">fieldset</b>
-
- (<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>)
-
-
- :
-
-
-
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Opens a new {<b>link</b> Roo.form.FieldSet} container in the layout stack.</div>
-
-
-
- <div class="long">
-
- 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.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <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>
-
- </dt>
- <dd>The config to pass to the fieldset</dd>
-
- <dt>
- <span class="fixedFont">Field</span> <b>field1</b>
-
- </dt>
- <dd>(optional)</dd>
-
- <dt>
- <span class="fixedFont">Field</span> <b>field2</b>
-
- </dt>
- <dd>(optional)</dd>
-
- <dt>
- <span class="fixedFont">Field</span> <b>etc</b>
-
- </dt>
- <dd>(optional)</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd> FieldSet The fieldset container object</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-findField" name=".findField"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">findField</b>
-
- (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
-
-
- :
-
-
-
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName</div>
-
-
-
- <div class="long">
-
- Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
-
- </dt>
- <dd>The value to search for</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd> Field</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.Form-method-findbyId" name=".findbyId"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">findbyId</b>
-
- (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
-
-
- :
-
-
- Element
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <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>
-
-
-
- <div class="long">
-
- 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..
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
-
- </dt>
- <dd>- id or name to find.</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">Element</span> e - or false if nothing found.</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">fireEvent</b>
-
- (<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>)
-
-
- :
-
-
- <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
-
-
-
- <div class="long">
-
- Fires the specified event with the passed parameters (minus the event name).
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <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>
-
- </dt>
- <dd>Variable number of parameters are passed to handlers</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <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>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-getFieldValues" name=".getFieldValues"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">getFieldValues</b>
-
- ()
-
-
- :
-
-
- <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Returns the fields in this form as an object with key/value pairs.</div>
-
-
-
- <div class="long">
-
- 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.
-
-
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> </dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-getValues" name=".getValues"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">getValues</b>
-
- (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>asString</i></B>)
-
-
- :
-
-
- <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Returns the fields in this form as an object with key/value pairs.</div>
-
-
-
- <div class="long">
-
- 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.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <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>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> </dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-hasChanged" name=".hasChanged"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">hasChanged</b>
-
- ()
-
-
- :
-
-
-
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Returns true if any fields in this form have changed since their original load.</div>
-
-
-
- <div class="long">
-
- Returns true if any fields in this form have changed since their original load. (New version)
-
-
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd> Boolean</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">hasListener</b>
-
- (<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:Boolean">Boolean</a>
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Checks to see if this object has any listeners for a specified event</div>
-
-
-
- <div class="long">
-
- Checks to see if this object has any listeners for a specified event
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
-
- </dt>
- <dd>The name of the event to check for</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <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>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-isDirty" name=".isDirty"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">isDirty</b>
-
- ()
-
-
- :
-
-
-
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">DEPRICATED Returns true if any fields in this form have changed since their original load.</div>
-
-
-
- <div class="long">
-
- DEPRICATED Returns true if any fields in this form have changed since their original load.
-
-
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd> Boolean</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-isValid" name=".isValid"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">isValid</b>
-
- ()
-
-
- :
-
-
-
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Returns true if client-side validation on the form is successful.</div>
-
-
-
- <div class="long">
-
- Returns true if client-side validation on the form is successful.
-
-
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd> Boolean</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-load" name=".load"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">load</b>
-
- (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
-
-
- :
-
-
- BasicForm
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Shortcut to do a load action.</div>
-
-
-
- <div class="long">
-
- Shortcut to do a load action.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <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>
-
- </dt>
- <dd>The options to pass to the action (see {<b>link</b> <b>doAction</b>} for details)</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">BasicForm</span> this</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-loadRecord" name=".loadRecord"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">loadRecord</b>
-
- (Record <B><i>record</i></B>)
-
-
- :
-
-
- BasicForm
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Loads an Roo.data.Record into this form.</div>
-
-
-
- <div class="long">
-
- Loads an Roo.data.Record into this form.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont">Record</span> <b>record</b>
-
- </dt>
- <dd>The record to load</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">BasicForm</span> this</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-markInvalid" name=".markInvalid"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">markInvalid</b>
-
- (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>errors</i></B>)
-
-
- :
-
-
- BasicForm
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Mark fields in this form invalid in bulk.</div>
-
-
-
- <div class="long">
-
- Mark fields in this form invalid in bulk.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span> <b>errors</b>
-
- </dt>
- <dd>Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">BasicForm</span> this</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.util.Observable-method-on" name=".on"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">on</b>
-
- (<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>)
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
-
-
-
- <div class="long">
-
- Appends an event handler to this element (shorthand for addListener)
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
-
- </dt>
- <dd>The type of event to listen for</dd>
-
- <dt>
- <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
-
- </dt>
- <dd>The method the event invokes</dd>
-
- <dt>
- <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>
-
- </dt>
- <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
-
- <dt>
- <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>
-
- </dt>
- <dd>(optional)</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">purgeListeners</b>
-
- ()
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Removes all listeners for this object</div>
-
-
-
- <div class="long">
-
- Removes all listeners for this object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-remove" name=".remove"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">remove</b>
-
- (Field <B><i>field</i></B>)
-
-
- :
-
-
- BasicForm
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Removes a field from the items collection (does NOT remove its markup).</div>
-
-
-
- <div class="long">
-
- Removes a field from the items collection (does NOT remove its markup).
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont">Field</span> <b>field</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">BasicForm</span> this</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">removeListener</b>
-
- (<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>)
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Removes a listener</div>
-
-
-
- <div class="long">
-
- Removes a listener
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
-
- </dt>
- <dd>The type of event to listen for</dd>
-
- <dt>
- <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
-
- </dt>
- <dd>The handler to remove</dd>
-
- <dt>
- <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>
-
- </dt>
- <dd>(optional) The scope (this object) for the handler</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.Form-method-render" name=".render"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">render</b>
-
- (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
-
-
- :
-
-
- Form
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Render this form into the passed container.</div>
-
-
-
- <div class="long">
-
- Render this form into the passed container. This should only be called once!
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
-
- </dt>
- <dd>The element this component should be rendered into</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">Form</span> this</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-reset" name=".reset"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">reset</b>
-
- ()
-
-
- :
-
-
- BasicForm
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Resets this form.</div>
-
-
-
- <div class="long">
-
- Resets this form.
-
-
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">BasicForm</span> this</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-resetHasChanged" name=".resetHasChanged"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">resetHasChanged</b>
-
- ()
-
-
- :
-
-
-
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Resets all hasChanged to 'false' -<br/>The old 'isDirty' used 'original value.</div>
-
-
-
- <div class="long">
-
- Resets all hasChanged to 'false' -<br/>The old 'isDirty' used 'original value..' however this breaks reset() and a few other things.<br/>So hasChanged storage is only to be used for this purpose
-
-
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd> Boolean</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-setValues" name=".setValues"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">setValues</b>
-
- (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>values</i></B>)
-
-
- :
-
-
- BasicForm
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Set values for fields in this form in bulk.</div>
-
-
-
- <div class="long">
-
- Set values for fields in this form in bulk.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span> <b>values</b>
-
- </dt>
- <dd>Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">BasicForm</span> this</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.Form-method-start" name=".start"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">start</b>
-
- (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>container</i></B>)
-
-
- :
-
-
- Form
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Opens the passed container in the layout stack.</div>
-
-
-
- <div class="long">
-
- Opens the passed container in the layout stack. The container can be any {<b>link</b> Roo.form.Layout} or subclass.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <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>
-
- </dt>
- <dd>A Roo.form.Layout or subclass of Layout</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">Form</span> this</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.Form-method-startMonitoring" name=".startMonitoring"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">startMonitoring</b>
-
- ()
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Starts monitoring of the valid state of this form.</div>
-
-
-
- <div class="long">
-
- Starts monitoring of the valid state of this form. Usually this is done by passing the config<br/>option "monitorValid"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.Form-method-stopMonitoring" name=".stopMonitoring"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">stopMonitoring</b>
-
- ()
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Stops monitoring of the valid state of this form</div>
-
-
-
- <div class="long">
-
- Stops monitoring of the valid state of this form
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- Roo.form.Form
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-submit" name=".submit"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">submit</b>
-
- (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
-
-
- :
-
-
- BasicForm
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Shortcut to do a submit action.</div>
-
-
-
- <div class="long">
-
- Shortcut to do a submit action.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <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>
-
- </dt>
- <dd>The options to pass to the action (see {<b>link</b> <b>doAction</b>} for details)</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">BasicForm</span> this</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.util.Observable-method-un" name=".un"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">un</b>
-
- (<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>)
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Removes a listener (shorthand for removeListener)</div>
-
-
-
- <div class="long">
-
- Removes a listener (shorthand for removeListener)
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
-
- </dt>
- <dd>The type of event to listen for</dd>
-
- <dt>
- <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
-
- </dt>
- <dd>The handler to remove</dd>
-
- <dt>
- <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>
-
- </dt>
- <dd>(optional) The scope (this object) for the handler</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.form.BasicForm-method-updateRecord" name=".updateRecord"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">updateRecord</b>
-
- (Record <B><i>record</i></B>)
-
-
- :
-
-
- BasicForm
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.</div>
-
-
-
- <div class="long">
-
- Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont">Record</span> <b>record</b>
-
- </dt>
- <dd>The record to edit</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="fixedFont">BasicForm</span> this</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
-
- </td>
- </tr>
-
-
- </table>
-
-
- <!-- ============================== events summary / details ======================== -->
-
-
- <a id="Roo.form.Form-events"></a>
-
-
-
-
-
-
-
-
- <table cellspacing="0" class="member-table">
- <caption>Events</caption>
- <thead>
- <tr>
- <th class="sig-header" colspan="2">Event</th>
- <th class="msource-header">Defined By</th>
-
- </tr>
- </thead>
-
-
-
-
-
- <tr class="method-row expandable config-row-alt0">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
- <td class="sig">
- <a id="Roo.form.BasicForm-event-*actioncomplete"></a>
-
- <div class="fixedFont">
- <b class="itemname">actioncomplete</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
-
- </div>
-
- <div class="mdesc">
-
- <div class="short">Fires when an action is completed.
-
- </div>
-
- <div class="long">
-
- Fires when an action is completed.
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont">Form</span> <b>this</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <span class="fixedFont">Action</span> <b>action</b>
-
- </dt>
- <dd>The action that completed</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
- </td>
- </tr>
-
- <tr class="method-row expandable config-row-alt1">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
- <td class="sig">
- <a id="Roo.form.BasicForm-event-*actionfailed"></a>
-
- <div class="fixedFont">
- <b class="itemname">actionfailed</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
-
- </div>
-
- <div class="mdesc">
-
- <div class="short">Fires when an action fails.
-
- </div>
-
- <div class="long">
-
- Fires when an action fails.
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont">Form</span> <b>this</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <span class="fixedFont">Action</span> <b>action</b>
-
- </dt>
- <dd>The action that failed</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
- </td>
- </tr>
-
- <tr class="method-row expandable config-row-alt0">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
- <td class="sig">
- <a id="Roo.form.BasicForm-event-*beforeaction"></a>
-
- <div class="fixedFont">
- <b class="itemname">beforeaction</b> (Form <B><i>this</i></B>, Action <B><i>action</i></B>)
-
- </div>
-
- <div class="mdesc">
-
- <div class="short">Fires before any action is performed.
-
- </div>
-
- <div class="long">
-
- Fires before any action is performed. Return false to cancel the action.
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont">Form</span> <b>this</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <span class="fixedFont">Action</span> <b>action</b>
-
- </dt>
- <dd>The action to be performed</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
- <a href="./Roo.form.BasicForm.html#constructor" roo:cls="Roo.form.BasicForm.html#constructor">Roo.form.BasicForm</a>
- </td>
- </tr>
-
- <tr class="method-row expandable config-row-alt1 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
- <td class="sig">
- <a id="Roo.form.Form-event-*clientvalidation"></a>
-
- <div class="fixedFont">
- <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>)
-
- </div>
-
- <div class="mdesc">
-
- <div class="short">If the monitorValid config option is true, this event fires repetitively to notify of valid state
-
- </div>
-
- <div class="long">
-
- If the monitorValid config option is true, this event fires repetitively to notify of valid state
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="fixedFont">Form</span> <b>this</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <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>
-
- </dt>
- <dd>true if the form has passed client-side validation</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
- Roo.form.Form
- </td>
- </tr>
-
- <tr class="method-row expandable config-row-alt0 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
- <td class="sig">
- <a id="Roo.form.Form-event-*rendered"></a>
-
- <div class="fixedFont">
- <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>)
-
- </div>
-
- <div class="mdesc">
-
- <div class="short">Fires when the form is rendered
-
- </div>
-
- <div class="long">
-
- Fires when the form is rendered
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <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>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
- Roo.form.Form
- </td>
- </tr>
-
-
- </table>
-
-
-
-
-
-<!-- ============================== footer ================================= -->
- <div class="fineprint" style="clear:both">
-
- Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 13 2018 14:10:54 GMT+0800 (HKT)
- Based on
- <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
- </div>
- </body>
-</html>
projects / roojs1 / blobdiff