1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.form.Field</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.form.Field-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.form.Field-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.form.Field-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.form.Field-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.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
49 <img src="../../images/default/s.gif" height="1" width="60"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.form.Field
54 <!-- ============================== class title / details ============================ -->
57 <h1 class="classTitle">
62 <table cellspacing="0" class="class-summary-table">
64 <tr><td class="label">Package:</td><td class="hd-info">Roo.form</td></tr>
66 <tr><td class="label">Defined In:</td><td class="hd-info">
68 <a href="./src/Roo_form_Field.js.html">Roo/form/Field.js</a>.
71 <tr><td class="label">Class:</td><td class="hd-info">Field</td></tr>
74 <tr><td class="label">Subclasses:</td><td class="hd-info">
75 <a href="./Roo.form.Checkbox.html#constructor" roo:cls="Roo.form.Checkbox.html#constructor">Roo.form.Checkbox</a>, <a href="./Roo.form.ComboBox.html#constructor" roo:cls="Roo.form.ComboBox.html#constructor">Roo.form.ComboBox</a>, <a href="./Roo.form.ComboBoxArray.html#constructor" roo:cls="Roo.form.ComboBoxArray.html#constructor">Roo.form.ComboBoxArray</a>, <a href="./Roo.form.ComboCheck.html#constructor" roo:cls="Roo.form.ComboCheck.html#constructor">Roo.form.ComboCheck</a>, <a href="./Roo.form.DateField.html#constructor" roo:cls="Roo.form.DateField.html#constructor">Roo.form.DateField</a>, <a href="./Roo.form.DayPicker.html#constructor" roo:cls="Roo.form.DayPicker.html#constructor">Roo.form.DayPicker</a>, <a href="./Roo.form.DisplayField.html#constructor" roo:cls="Roo.form.DisplayField.html#constructor">Roo.form.DisplayField</a>, <a href="./Roo.form.FCKeditor.html#constructor" roo:cls="Roo.form.FCKeditor.html#constructor">Roo.form.FCKeditor</a>, <a href="./Roo.form.GridField.html#constructor" roo:cls="Roo.form.GridField.html#constructor">Roo.form.GridField</a>, <a href="./Roo.form.Hidden.html#constructor" roo:cls="Roo.form.Hidden.html#constructor">Roo.form.Hidden</a>, <a href="./Roo.form.HtmlEditor.html#constructor" roo:cls="Roo.form.HtmlEditor.html#constructor">Roo.form.HtmlEditor</a>, <a href="./Roo.form.MonthField.html#constructor" roo:cls="Roo.form.MonthField.html#constructor">Roo.form.MonthField</a>, <a href="./Roo.form.NumberField.html#constructor" roo:cls="Roo.form.NumberField.html#constructor">Roo.form.NumberField</a>, <a href="./Roo.form.Radio.html#constructor" roo:cls="Roo.form.Radio.html#constructor">Roo.form.Radio</a>, <a href="./Roo.form.Select.html#constructor" roo:cls="Roo.form.Select.html#constructor">Roo.form.Select</a>, <a href="./Roo.form.Signature.html#constructor" roo:cls="Roo.form.Signature.html#constructor">Roo.form.Signature</a>, <a href="./Roo.form.TextArea.html#constructor" roo:cls="Roo.form.TextArea.html#constructor">Roo.form.TextArea</a>, <a href="./Roo.form.TextField.html#constructor" roo:cls="Roo.form.TextField.html#constructor">Roo.form.TextField</a>, <a href="./Roo.form.TriggerField.html#constructor" roo:cls="Roo.form.TriggerField.html#constructor">Roo.form.TriggerField</a>
83 <tr><td class="label">Extends:</td><td class="hd-info">
84 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
92 <!-- ============================== class summary ========================== -->
93 <div class="description">
94 Base class for form fields that provides default event handling, sizing, value handling and other functionality.
98 <!-- ============================== Class comment block... ========================== -->
100 <div class="comments">
101 <b>Class Comments / Notes</B> =>
102 <u onclick="parent.CommentDialog.showCommentId = 'Roo.form.Field';">[Add Your comment/notes about this class]</u>
104 <iframe frameborder="0" id="comments-Roo.form" style="border: none;width:100%;"
105 src="/blog.php/GtkDjsComments/Roo.form.Field.html"></iframe>
110 <!-- ============================== config options ========================== -->
115 <div class="hr"></div>
116 <a id="Roo.form.Field-configs"></a>
122 <table cellspacing="0" class="member-table">
123 <caption>Config Options (Usually are also Properties)</caption>
127 <th class="sig-header" colspan="2">Options</th>
129 <th class="msource-header">Defined By</th>
136 <tr class="config-row expandable config-row-alt0">
137 <td class="micon"><a class="exi" href="#expand"> </a></td>
140 <a id="Roo.Component-cfg-actionMode" name=".actionMode"></a>
141 <div class="fixedFont">
142 <b class="itemname">actionMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
148 <div class="short">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
153 which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'
163 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
169 <tr class="config-row expandable config-row-alt1">
170 <td class="micon"><a class="exi" href="#expand"> </a></td>
173 <a id="Roo.Component-cfg-allowDomMove" name=".allowDomMove"></a>
174 <div class="fixedFont">
175 <b class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
181 <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
186 Whether the component can move the Dom node when rendering (defaults to true).
196 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
202 <tr class="config-row expandable config-row-alt0 notInherited">
203 <td class="micon"><a class="exi" href="#expand"> </a></td>
206 <a id="Roo.form.Field-cfg-autoCreate" name=".autoCreate"></a>
207 <div class="fixedFont">
208 <b class="itemname">autoCreate</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object
214 <div class="short">A DomHelper element spec, or true for a default element spec (defaults to<br/>{tag: "input", type: "text", size: "20", autocomplete: "off"})</div>
219 A DomHelper element spec, or true for a default element spec (defaults to<br/>{tag: "input", type: "text", size: "20", autocomplete: "off"})
235 <tr class="config-row expandable config-row-alt1 notInherited">
236 <td class="micon"><a class="exi" href="#expand"> </a></td>
239 <a id="Roo.form.Field-cfg-cls" name=".cls"></a>
240 <div class="fixedFont">
241 <b class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
247 <div class="short">A CSS class to apply to the field's underlying element.</div>
252 A CSS class to apply to the field's underlying element.
268 <tr class="config-row expandable config-row-alt0">
269 <td class="micon"><a class="exi" href="#expand"> </a></td>
272 <a id="Roo.Component-cfg-disableClass" name=".disableClass"></a>
273 <div class="fixedFont">
274 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
280 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
285 CSS class added to the component when it is disabled (defaults to "x-item-disabled").
295 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
301 <tr class="config-row expandable config-row-alt1 notInherited">
302 <td class="micon"><a class="exi" href="#expand"> </a></td>
305 <a id="Roo.form.Field-cfg-disabled" name=".disabled"></a>
306 <div class="fixedFont">
307 <b class="itemname">disabled</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
313 <div class="short">True to disable the field (defaults to false).</div>
318 True to disable the field (defaults to false).
334 <tr class="config-row expandable config-row-alt0 notInherited">
335 <td class="micon"><a class="exi" href="#expand"> </a></td>
338 <a id="Roo.form.Field-cfg-fieldClass" name=".fieldClass"></a>
339 <div class="fixedFont">
340 <b class="itemname">fieldClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
346 <div class="short">The default CSS class for the field (defaults to "x-form-field")</div>
351 The default CSS class for the field (defaults to "x-form-field")
367 <tr class="config-row expandable config-row-alt1 notInherited">
368 <td class="micon"><a class="exi" href="#expand"> </a></td>
371 <a id="Roo.form.Field-cfg-fieldLabel" name=".fieldLabel"></a>
372 <div class="fixedFont">
373 <b class="itemname">fieldLabel</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
379 <div class="short">Label to use when rendering a form.</div>
384 Label to use when rendering a form.
400 <tr class="config-row expandable config-row-alt0 notInherited">
401 <td class="micon"><a class="exi" href="#expand"> </a></td>
404 <a id="Roo.form.Field-cfg-focusClass" name=".focusClass"></a>
405 <div class="fixedFont">
406 <b class="itemname">focusClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
412 <div class="short">The CSS class to use when the field receives focus (defaults to "x-form-focus")</div>
417 The CSS class to use when the field receives focus (defaults to "x-form-focus")
433 <tr class="config-row expandable config-row-alt1">
434 <td class="micon"><a class="exi" href="#expand"> </a></td>
437 <a id="Roo.BoxComponent-cfg-height" name=".height"></a>
438 <div class="fixedFont">
439 <b class="itemname">height</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
445 <div class="short">height (optional) size of component</div>
450 height (optional) size of component
460 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
466 <tr class="config-row expandable config-row-alt0">
467 <td class="micon"><a class="exi" href="#expand"> </a></td>
470 <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
471 <div class="fixedFont">
472 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
478 <div class="short">How this component should hidden.</div>
483 How this component should hidden. Supported values are<br/>"visibility" (css visibility), "offsets" (negative offset position) and<br/>"display" (css display) - defaults to "display".
484 <BR/>Possible Values: display, visibility
493 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
499 <tr class="config-row expandable config-row-alt1 notInherited">
500 <td class="micon"><a class="exi" href="#expand"> </a></td>
503 <a id="Roo.form.Field-cfg-inputType" name=".inputType"></a>
504 <div class="fixedFont">
505 <b class="itemname">inputType</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
511 <div class="short">The type attribute for input fields -- e.g.</div>
516 The type attribute for input fields -- e.g. radio, text, password (defaults to "text").
532 <tr class="config-row expandable config-row-alt0 notInherited">
533 <td class="micon"><a class="exi" href="#expand"> </a></td>
536 <a id="Roo.form.Field-cfg-invalidClass" name=".invalidClass"></a>
537 <div class="fixedFont">
538 <b class="itemname">invalidClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
544 <div class="short">The CSS class to use when marking a field invalid (defaults to "x-form-invalid")</div>
549 The CSS class to use when marking a field invalid (defaults to "x-form-invalid")
565 <tr class="config-row expandable config-row-alt1 notInherited">
566 <td class="micon"><a class="exi" href="#expand"> </a></td>
569 <a id="Roo.form.Field-cfg-invalidText" name=".invalidText"></a>
570 <div class="fixedFont">
571 <b class="itemname">invalidText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
577 <div class="short">The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid")</div>
582 The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid")
598 <tr class="config-row expandable config-row-alt0">
599 <td class="micon"><a class="exi" href="#expand"> </a></td>
602 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
603 <div class="fixedFont">
604 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
610 <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>
615 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>
625 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
631 <tr class="config-row expandable config-row-alt1 notInherited">
632 <td class="micon"><a class="exi" href="#expand"> </a></td>
635 <a id="Roo.form.Field-cfg-msgFx" name=".msgFx"></a>
636 <div class="fixedFont">
637 <b class="itemname">msgFx</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
643 <div class="short"><b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').</div>
648 <b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').
664 <tr class="config-row expandable config-row-alt0 notInherited">
665 <td class="micon"><a class="exi" href="#expand"> </a></td>
668 <a id="Roo.form.Field-cfg-msgTarget" name=".msgTarget"></a>
669 <div class="fixedFont">
670 <b class="itemname">msgTarget</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
676 <div class="short">The location where error text should display.</div>
681 The location where error text should display. Should be one of the following values (defaults to 'qtip'):<br/><pre><br/>Value Description<br/>----------- ----------------------------------------------------------------------<br/>qtip Display a quick tip when the user hovers over the field<br/>title Display a default browser title attribute popup<br/>under Add a block div beneath the field containing the error text<br/>side Add an error icon to the right of the field with a popup on hover<br/>[element id] Add the error text directly to the innerHTML of the specified element<br/></pre>
697 <tr class="config-row expandable config-row-alt1 notInherited">
698 <td class="micon"><a class="exi" href="#expand"> </a></td>
701 <a id="Roo.form.Field-cfg-name" name=".name"></a>
702 <div class="fixedFont">
703 <b class="itemname">name</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
709 <div class="short">The field's HTML name attribute.</div>
714 The field's HTML name attribute.
730 <tr class="config-row expandable config-row-alt0 notInherited">
731 <td class="micon"><a class="exi" href="#expand"> </a></td>
734 <a id="Roo.form.Field-cfg-qtip" name=".qtip"></a>
735 <div class="fixedFont">
736 <b class="itemname">qtip</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
742 <div class="short">Mouse over tip</div>
763 <tr class="config-row expandable config-row-alt1 notInherited">
764 <td class="micon"><a class="exi" href="#expand"> </a></td>
767 <a id="Roo.form.Field-cfg-readOnly" name=".readOnly"></a>
768 <div class="fixedFont">
769 <b class="itemname">readOnly</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
775 <div class="short">True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.</div>
780 True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.
796 <tr class="config-row expandable config-row-alt0 notInherited">
797 <td class="micon"><a class="exi" href="#expand"> </a></td>
800 <a id="Roo.form.Field-cfg-tabIndex" name=".tabIndex"></a>
801 <div class="fixedFont">
802 <b class="itemname">tabIndex</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
808 <div class="short">The tabIndex for this field.</div>
813 The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).
829 <tr class="config-row expandable config-row-alt1 notInherited">
830 <td class="micon"><a class="exi" href="#expand"> </a></td>
833 <a id="Roo.form.Field-cfg-validateOnBlur" name=".validateOnBlur"></a>
834 <div class="fixedFont">
835 <b class="itemname">validateOnBlur</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
841 <div class="short">Whether the field should validate when it loses focus (defaults to true).</div>
846 Whether the field should validate when it loses focus (defaults to true).
862 <tr class="config-row expandable config-row-alt0 notInherited">
863 <td class="micon"><a class="exi" href="#expand"> </a></td>
866 <a id="Roo.form.Field-cfg-validationDelay" name=".validationDelay"></a>
867 <div class="fixedFont">
868 <b class="itemname">validationDelay</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
874 <div class="short">The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)</div>
879 The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)
895 <tr class="config-row expandable config-row-alt1 notInherited">
896 <td class="micon"><a class="exi" href="#expand"> </a></td>
899 <a id="Roo.form.Field-cfg-validationEvent" name=".validationEvent"></a>
900 <div class="fixedFont">
901 <b class="itemname">validationEvent</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Boolean
907 <div class="short">The event that should initiate field validation.</div>
912 The event that should initiate field validation. Set to false to disable<br/> automatic validation (defaults to "keyup").
928 <tr class="config-row expandable config-row-alt0 notInherited">
929 <td class="micon"><a class="exi" href="#expand"> </a></td>
932 <a id="Roo.form.Field-cfg-value" name=".value"></a>
933 <div class="fixedFont">
934 <b class="itemname">value</b> : Mixed
940 <div class="short">A value to initialize this field with.</div>
945 A value to initialize this field with.
961 <tr class="config-row expandable config-row-alt1">
962 <td class="micon"><a class="exi" href="#expand"> </a></td>
965 <a id="Roo.BoxComponent-cfg-width" name=".width"></a>
966 <div class="fixedFont">
967 <b class="itemname">width</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
973 <div class="short">width (optional) size of component</div>
978 width (optional) size of component
988 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
1004 <!-- ============================== public properties ==================== -->
1008 <a id="Roo.form.Field-props"></a>
1014 <table cellspacing="0" class="member-table">
1015 <caption class="Empty">Public Properties - Has None</caption>
1021 <!-- ============================== methods summary / details ======================== -->
1024 <a id="Roo.form.Field-methods"></a>
1025 <!-- constructor?? -->
1032 <!-- then dynamics first -->
1039 <table cellspacing="0" class="member-table">
1040 <caption>Public Methods</caption>
1042 <th class="sig-header" colspan="2">Method</th>
1043 <th class="msource-header">Defined By</th>
1053 <tr class="method-row config-row-alt0 expandable notInherited">
1054 <td class="micon"><a class="exi" href="#expand"> </a></td>
1058 <a id="Roo.form-method-Field" name=".Field"></a>
1059 <div class="fixedFont">
1060 <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">Field</b>
1062 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
1070 <div class="short">Create a new Roo.form.Field</div>
1077 Create a new Roo.form.Field
1080 <dl class="detailList">
1081 <dt class="heading">Parameters:</dt>
1084 <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>
1087 <dd>Configuration options</dd>
1105 <td class="msource">
1111 <tr class="method-row config-row-alt1 expandable">
1112 <td class="micon"><a class="exi" href="#expand"> </a></td>
1116 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
1117 <div class="fixedFont">
1118 <span class="attributes"></span><b class="itemname">addEvents</b>
1120 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
1127 <div class="short">Used to define events on this Observable</div>
1133 Used to define events on this Observable
1140 <dl class="detailList">
1141 <dt class="heading">Parameters:</dt>
1144 <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>
1147 <dd>The object with the events defined</dd>
1165 <td class="msource">
1167 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1173 <tr class="method-row config-row-alt0 expandable">
1174 <td class="micon"><a class="exi" href="#expand"> </a></td>
1178 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
1179 <div class="fixedFont">
1180 <span class="attributes"></span><b class="itemname">addListener</b>
1182 (<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>)
1189 <div class="short">Appends an event handler to this component</div>
1195 Appends an event handler to this component
1202 <dl class="detailList">
1203 <dt class="heading">Parameters:</dt>
1206 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1209 <dd>The type of event to listen for</dd>
1212 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1215 <dd>The method the event invokes</dd>
1218 <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>
1221 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1224 <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>
1227 <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>
1245 <td class="msource">
1247 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1253 <tr class="method-row config-row-alt1 expandable notInherited">
1254 <td class="micon"><a class="exi" href="#expand"> </a></td>
1258 <a id="Roo.form.Field-method-applyTo" name=".applyTo"></a>
1259 <div class="fixedFont">
1260 <span class="attributes"></span><b class="itemname">applyTo</b>
1262 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>)
1268 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
1277 <div class="short">Apply the behaviors of this component to an existing element.</div>
1283 Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>
1290 <dl class="detailList">
1291 <dt class="heading">Parameters:</dt>
1294 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
1297 <dd>The id of the node, a DOM node or an existing Element</dd>
1305 <dl class="detailList">
1306 <dt class="heading">Returns:</dt>
1308 <dd><span class="fixedFont"><a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a></span> this</dd>
1322 <td class="msource">
1330 <tr class="method-row config-row-alt0 expandable notInherited">
1331 <td class="micon"><a class="exi" href="#expand"> </a></td>
1335 <a id="Roo.form.Field-method-clearInvalid" name=".clearInvalid"></a>
1336 <div class="fixedFont">
1337 <span class="attributes"></span><b class="itemname">clearInvalid</b>
1346 <div class="short">Clear any invalid styles/messages for this field</div>
1352 Clear any invalid styles/messages for this field
1373 <td class="msource">
1381 <tr class="method-row config-row-alt1 expandable">
1382 <td class="micon"><a class="exi" href="#expand"> </a></td>
1386 <a id="Roo.Component-method-destroy" name=".destroy"></a>
1387 <div class="fixedFont">
1388 <span class="attributes"></span><b class="itemname">destroy</b>
1397 <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>
1403 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}.
1424 <td class="msource">
1426 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1432 <tr class="method-row config-row-alt0 expandable">
1433 <td class="micon"><a class="exi" href="#expand"> </a></td>
1437 <a id="Roo.Component-method-disable" name=".disable"></a>
1438 <div class="fixedFont">
1439 <span class="attributes"></span><b class="itemname">disable</b>
1447 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1456 <div class="short">Disable this component.</div>
1462 Disable this component.
1473 <dl class="detailList">
1474 <dt class="heading">Returns:</dt>
1476 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1490 <td class="msource">
1492 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1498 <tr class="method-row config-row-alt1 expandable">
1499 <td class="micon"><a class="exi" href="#expand"> </a></td>
1503 <a id="Roo.Component-method-enable" name=".enable"></a>
1504 <div class="fixedFont">
1505 <span class="attributes"></span><b class="itemname">enable</b>
1513 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1522 <div class="short">Enable this component.</div>
1528 Enable this component.
1539 <dl class="detailList">
1540 <dt class="heading">Returns:</dt>
1542 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1556 <td class="msource">
1558 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1564 <tr class="method-row config-row-alt0 expandable">
1565 <td class="micon"><a class="exi" href="#expand"> </a></td>
1569 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1570 <div class="fixedFont">
1571 <span class="attributes"></span><b class="itemname">fireEvent</b>
1573 (<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>)
1579 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1588 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1594 Fires the specified event with the passed parameters (minus the event name).
1601 <dl class="detailList">
1602 <dt class="heading">Parameters:</dt>
1605 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1611 <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>
1614 <dd>Variable number of parameters are passed to handlers</dd>
1622 <dl class="detailList">
1623 <dt class="heading">Returns:</dt>
1625 <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>
1639 <td class="msource">
1641 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1647 <tr class="method-row config-row-alt1 expandable">
1648 <td class="micon"><a class="exi" href="#expand"> </a></td>
1652 <a id="Roo.Component-method-focus" name=".focus"></a>
1653 <div class="fixedFont">
1654 <span class="attributes"></span><b class="itemname">focus</b>
1656 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
1662 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1671 <div class="short">Try to focus this component.</div>
1677 Try to focus this component.
1684 <dl class="detailList">
1685 <dt class="heading">Parameters:</dt>
1688 <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>
1691 <dd>True to also select the text in this component (if applicable)</dd>
1699 <dl class="detailList">
1700 <dt class="heading">Returns:</dt>
1702 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1716 <td class="msource">
1718 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1724 <tr class="method-row config-row-alt0 expandable">
1725 <td class="micon"><a class="exi" href="#expand"> </a></td>
1729 <a id="Roo.BoxComponent-method-getBox" name=".getBox"></a>
1730 <div class="fixedFont">
1731 <span class="attributes"></span><b class="itemname">getBox</b>
1733 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>local</i></B>)
1740 <div class="short">Gets the current box measurements of the component's underlying element.</div>
1746 Gets the current box measurements of the component's underlying element.
1753 <dl class="detailList">
1754 <dt class="heading">Parameters:</dt>
1757 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>local</b>
1760 <dd>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</dd>
1778 <td class="msource">
1780 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
1786 <tr class="method-row config-row-alt1 expandable">
1787 <td class="micon"><a class="exi" href="#expand"> </a></td>
1791 <a id="Roo.Component-method-getEl" name=".getEl"></a>
1792 <div class="fixedFont">
1793 <span class="attributes"></span><b class="itemname">getEl</b>
1801 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1810 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
1816 Returns the underlying {<b>link</b> Roo.Element}.
1827 <dl class="detailList">
1828 <dt class="heading">Returns:</dt>
1830 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1844 <td class="msource">
1846 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1852 <tr class="method-row config-row-alt0 expandable">
1853 <td class="micon"><a class="exi" href="#expand"> </a></td>
1857 <a id="Roo.Component-method-getId" name=".getId"></a>
1858 <div class="fixedFont">
1859 <span class="attributes"></span><b class="itemname">getId</b>
1867 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1876 <div class="short">Returns the id of this component.</div>
1882 Returns the id of this component.
1893 <dl class="detailList">
1894 <dt class="heading">Returns:</dt>
1896 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1910 <td class="msource">
1912 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1918 <tr class="method-row config-row-alt1 expandable notInherited">
1919 <td class="micon"><a class="exi" href="#expand"> </a></td>
1923 <a id="Roo.form.Field-method-getName" name=".getName"></a>
1924 <div class="fixedFont">
1925 <span class="attributes"></span><b class="itemname">getName</b>
1933 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1942 <div class="short">Returns the name attribute of the field if available</div>
1948 Returns the name attribute of the field if available
1959 <dl class="detailList">
1960 <dt class="heading">Returns:</dt>
1962 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> name The field name</dd>
1976 <td class="msource">
1984 <tr class="method-row config-row-alt0 expandable">
1985 <td class="micon"><a class="exi" href="#expand"> </a></td>
1989 <a id="Roo.BoxComponent-method-getPosition" name=".getPosition"></a>
1990 <div class="fixedFont">
1991 <span class="attributes"></span><b class="itemname">getPosition</b>
1993 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>local</i></B>)
1999 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
2008 <div class="short">Gets the current XY position of the component's underlying element.</div>
2014 Gets the current XY position of the component's underlying element.
2021 <dl class="detailList">
2022 <dt class="heading">Parameters:</dt>
2025 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>local</b>
2028 <dd>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</dd>
2036 <dl class="detailList">
2037 <dt class="heading">Returns:</dt>
2039 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> The XY position of the element (e.g., [100, 200])</dd>
2053 <td class="msource">
2055 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2061 <tr class="method-row config-row-alt1 expandable notInherited">
2062 <td class="micon"><a class="exi" href="#expand"> </a></td>
2066 <a id="Roo.form.Field-method-getRawValue" name=".getRawValue"></a>
2067 <div class="fixedFont">
2068 <span class="attributes"></span><b class="itemname">getRawValue</b>
2085 <div class="short">Returns the raw data value which may or may not be a valid, defined value.</div>
2091 Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {<b>link</b> <b>getValue</b>}.
2102 <dl class="detailList">
2103 <dt class="heading">Returns:</dt>
2105 <dd><span class="fixedFont">Mixed</span> value The field value</dd>
2119 <td class="msource">
2127 <tr class="method-row config-row-alt0 expandable">
2128 <td class="micon"><a class="exi" href="#expand"> </a></td>
2132 <a id="Roo.BoxComponent-method-getSize" name=".getSize"></a>
2133 <div class="fixedFont">
2134 <span class="attributes"></span><b class="itemname">getSize</b>
2142 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
2151 <div class="short">Gets the current size of the component's underlying element.</div>
2157 Gets the current size of the component's underlying element.
2168 <dl class="detailList">
2169 <dt class="heading">Returns:</dt>
2171 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> An object containing the element's size {width: (element width), height: (element height)}</dd>
2185 <td class="msource">
2187 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2193 <tr class="method-row config-row-alt1 expandable notInherited">
2194 <td class="micon"><a class="exi" href="#expand"> </a></td>
2198 <a id="Roo.form.Field-method-getValue" name=".getValue"></a>
2199 <div class="fixedFont">
2200 <span class="attributes"></span><b class="itemname">getValue</b>
2217 <div class="short">Returns the normalized data value (undefined or emptyText will be returned as '').</div>
2223 Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {<b>link</b> <b>getRawValue</b>}.
2234 <dl class="detailList">
2235 <dt class="heading">Returns:</dt>
2237 <dd><span class="fixedFont">Mixed</span> value The field value</dd>
2251 <td class="msource">
2259 <tr class="method-row config-row-alt0 expandable notInherited">
2260 <td class="micon"><a class="exi" href="#expand"> </a></td>
2264 <a id="Roo.form.Field-method-hasChanged" name=".hasChanged"></a>
2265 <div class="fixedFont">
2266 <span class="attributes"></span><b class="itemname">hasChanged</b>
2275 <div class="short">checks the current value against the 'loaded' value.</div>
2281 checks the current value against the 'loaded' value.<br/>Note - will return false if 'resetHasChanged' has not been called first.
2302 <td class="msource">
2310 <tr class="method-row config-row-alt1 expandable">
2311 <td class="micon"><a class="exi" href="#expand"> </a></td>
2315 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
2316 <div class="fixedFont">
2317 <span class="attributes"></span><b class="itemname">hasListener</b>
2319 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
2325 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2334 <div class="short">Checks to see if this object has any listeners for a specified event</div>
2340 Checks to see if this object has any listeners for a specified event
2347 <dl class="detailList">
2348 <dt class="heading">Parameters:</dt>
2351 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2354 <dd>The name of the event to check for</dd>
2362 <dl class="detailList">
2363 <dt class="heading">Returns:</dt>
2365 <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>
2379 <td class="msource">
2381 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2387 <tr class="method-row config-row-alt0 expandable">
2388 <td class="micon"><a class="exi" href="#expand"> </a></td>
2392 <a id="Roo.Component-method-hide" name=".hide"></a>
2393 <div class="fixedFont">
2394 <span class="attributes"></span><b class="itemname">hide</b>
2402 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2411 <div class="short">Hide this component.</div>
2417 Hide this component.
2428 <dl class="detailList">
2429 <dt class="heading">Returns:</dt>
2431 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
2445 <td class="msource">
2447 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2453 <tr class="method-row config-row-alt1 expandable notInherited">
2454 <td class="micon"><a class="exi" href="#expand"> </a></td>
2458 <a id="Roo.form.Field-method-isDirty" name=".isDirty"></a>
2459 <div class="fixedFont">
2460 <span class="attributes"></span><b class="itemname">isDirty</b>
2469 <div class="short">Returns true if this field has been changed since it was originally loaded and is not disabled.</div>
2475 Returns true if this field has been changed since it was originally loaded and is not disabled.<br/>DEPRICATED - it never worked well - use hasChanged/resetHasChanged.
2496 <td class="msource">
2504 <tr class="method-row config-row-alt0 expandable notInherited">
2505 <td class="micon"><a class="exi" href="#expand"> </a></td>
2509 <a id="Roo.form.Field-method-isValid" name=".isValid"></a>
2510 <div class="fixedFont">
2511 <span class="attributes"></span><b class="itemname">isValid</b>
2513 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>preventMark</i></B>)
2519 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2528 <div class="short">Returns whether or not the field value is currently valid</div>
2534 Returns whether or not the field value is currently valid
2541 <dl class="detailList">
2542 <dt class="heading">Parameters:</dt>
2545 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>preventMark</b>
2548 <dd>True to disable marking the field invalid</dd>
2556 <dl class="detailList">
2557 <dt class="heading">Returns:</dt>
2559 <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 value is valid, else false</dd>
2573 <td class="msource">
2581 <tr class="method-row config-row-alt1 expandable">
2582 <td class="micon"><a class="exi" href="#expand"> </a></td>
2586 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
2587 <div class="fixedFont">
2588 <span class="attributes"></span><b class="itemname">isVisible</b>
2597 <div class="short">Returns true if this component is visible.</div>
2603 Returns true if this component is visible.
2624 <td class="msource">
2626 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2632 <tr class="method-row config-row-alt0 expandable notInherited">
2633 <td class="micon"><a class="exi" href="#expand"> </a></td>
2637 <a id="Roo.form.Field-method-markInvalid" name=".markInvalid"></a>
2638 <div class="fixedFont">
2639 <span class="attributes"></span><b class="itemname">markInvalid</b>
2641 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>msg</i></B>)
2648 <div class="short">Mark this field as invalid</div>
2654 Mark this field as invalid
2661 <dl class="detailList">
2662 <dt class="heading">Parameters:</dt>
2665 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>msg</b>
2668 <dd>The validation message</dd>
2686 <td class="msource">
2694 <tr class="method-row config-row-alt1 expandable">
2695 <td class="micon"><a class="exi" href="#expand"> </a></td>
2699 <a id="Roo.util.Observable-method-on" name=".on"></a>
2700 <div class="fixedFont">
2701 <span class="attributes"></span><b class="itemname">on</b>
2703 (<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>)
2710 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2716 Appends an event handler to this element (shorthand for addListener)
2723 <dl class="detailList">
2724 <dt class="heading">Parameters:</dt>
2727 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2730 <dd>The type of event to listen for</dd>
2733 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2736 <dd>The method the event invokes</dd>
2739 <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>
2742 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2745 <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>
2766 <td class="msource">
2768 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2774 <tr class="method-row config-row-alt0 expandable">
2775 <td class="micon"><a class="exi" href="#expand"> </a></td>
2779 <a id="Roo.BoxComponent-method-onPosition" name=".onPosition"></a>
2780 <div class="fixedFont">
2781 <span class="attributes"></span><b class="itemname">onPosition</b>
2783 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>x</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>y</i></B>)
2790 <div class="short">Called after the component is moved, this method is empty by default but can be implemented by any<br/>subclass that needs to perform custom logic after a move occurs.</div>
2796 Called after the component is moved, this method is empty by default but can be implemented by any<br/>subclass that needs to perform custom logic after a move occurs.
2803 <dl class="detailList">
2804 <dt class="heading">Parameters:</dt>
2807 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
2810 <dd>The new x position</dd>
2813 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
2816 <dd>The new y position</dd>
2834 <td class="msource">
2836 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2842 <tr class="method-row config-row-alt1 expandable">
2843 <td class="micon"><a class="exi" href="#expand"> </a></td>
2847 <a id="Roo.BoxComponent-method-onResize" name=".onResize"></a>
2848 <div class="fixedFont">
2849 <span class="attributes"></span><b class="itemname">onResize</b>
2851 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>adjWidth</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>adjHeight</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rawWidth</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rawHeight</i></B>)
2858 <div class="short">Called after the component is resized, this method is empty by default but can be implemented by any<br/>subclass that needs to perform custom logic after a resize occurs.</div>
2864 Called after the component is resized, this method is empty by default but can be implemented by any<br/>subclass that needs to perform custom logic after a resize occurs.
2871 <dl class="detailList">
2872 <dt class="heading">Parameters:</dt>
2875 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjWidth</b>
2878 <dd>The box-adjusted width that was set</dd>
2881 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjHeight</b>
2884 <dd>The box-adjusted height that was set</dd>
2887 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawWidth</b>
2890 <dd>The width that was originally specified</dd>
2893 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawHeight</b>
2896 <dd>The height that was originally specified</dd>
2914 <td class="msource">
2916 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2922 <tr class="method-row config-row-alt0 expandable">
2923 <td class="micon"><a class="exi" href="#expand"> </a></td>
2927 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2928 <div class="fixedFont">
2929 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2938 <div class="short">Removes all listeners for this object</div>
2944 Removes all listeners for this object
2965 <td class="msource">
2967 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2973 <tr class="method-row config-row-alt1 expandable">
2974 <td class="micon"><a class="exi" href="#expand"> </a></td>
2978 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2979 <div class="fixedFont">
2980 <span class="attributes"></span><b class="itemname">removeListener</b>
2982 (<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>)
2989 <div class="short">Removes a listener</div>
3002 <dl class="detailList">
3003 <dt class="heading">Parameters:</dt>
3006 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3009 <dd>The type of event to listen for</dd>
3012 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3015 <dd>The handler to remove</dd>
3018 <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>
3021 <dd>(optional) The scope (this object) for the handler</dd>
3039 <td class="msource">
3041 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3047 <tr class="method-row config-row-alt0 expandable">
3048 <td class="micon"><a class="exi" href="#expand"> </a></td>
3052 <a id="Roo.Component-method-render" name=".render"></a>
3053 <div class="fixedFont">
3054 <span class="attributes"></span><b class="itemname">render</b>
3056 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
3063 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
3069 If this is a lazy rendering component, render it to its container element.
3076 <dl class="detailList">
3077 <dt class="heading">Parameters:</dt>
3080 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
3083 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
3101 <td class="msource">
3103 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3109 <tr class="method-row config-row-alt1 expandable notInherited">
3110 <td class="micon"><a class="exi" href="#expand"> </a></td>
3114 <a id="Roo.form.Field-method-reset" name=".reset"></a>
3115 <div class="fixedFont">
3116 <span class="attributes"></span><b class="itemname">reset</b>
3125 <div class="short">Resets the current field value to the originally loaded value and clears any validation messages</div>
3131 Resets the current field value to the originally loaded value and clears any validation messages
3152 <td class="msource">
3160 <tr class="method-row config-row-alt0 expandable notInherited">
3161 <td class="micon"><a class="exi" href="#expand"> </a></td>
3165 <a id="Roo.form.Field-method-resetHasChanged" name=".resetHasChanged"></a>
3166 <div class="fixedFont">
3167 <span class="attributes"></span><b class="itemname">resetHasChanged</b>
3176 <div class="short">stores the current value in loadedValue</div>
3182 stores the current value in loadedValue
3203 <td class="msource">
3211 <tr class="method-row config-row-alt1 expandable">
3212 <td class="micon"><a class="exi" href="#expand"> </a></td>
3216 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
3217 <div class="fixedFont">
3218 <span class="attributes"></span><b class="itemname">setDisabled</b>
3220 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
3227 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
3233 Convenience function for setting disabled/enabled by boolean.
3240 <dl class="detailList">
3241 <dt class="heading">Parameters:</dt>
3244 <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>
3265 <td class="msource">
3267 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3273 <tr class="method-row config-row-alt0 expandable">
3274 <td class="micon"><a class="exi" href="#expand"> </a></td>
3278 <a id="Roo.BoxComponent-method-setPagePosition" name=".setPagePosition"></a>
3279 <div class="fixedFont">
3280 <span class="attributes"></span><b class="itemname">setPagePosition</b>
3282 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>x</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>y</i></B>)
3289 <div class="short">Sets the page XY position of the component.</div>
3295 Sets the page XY position of the component. To set the left and top instead, use {<b>link</b> <b>setPosition</b>}.<br/>This method fires the move event.
3302 <dl class="detailList">
3303 <dt class="heading">Parameters:</dt>
3306 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
3309 <dd>The new x position</dd>
3312 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
3315 <dd>The new y position</dd>
3333 <td class="msource">
3335 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3341 <tr class="method-row config-row-alt1 expandable">
3342 <td class="micon"><a class="exi" href="#expand"> </a></td>
3346 <a id="Roo.BoxComponent-method-setPosition" name=".setPosition"></a>
3347 <div class="fixedFont">
3348 <span class="attributes"></span><b class="itemname">setPosition</b>
3350 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>left</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>top</i></B>)
3357 <div class="short">Sets the left and top of the component.</div>
3363 Sets the left and top of the component. To set the page XY position instead, use {<b>link</b> <b>setPagePosition</b>}.<br/>This method fires the move event.
3370 <dl class="detailList">
3371 <dt class="heading">Parameters:</dt>
3374 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>left</b>
3377 <dd>The new left</dd>
3380 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>top</b>
3383 <dd>The new top</dd>
3401 <td class="msource">
3403 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3409 <tr class="method-row config-row-alt0 expandable notInherited">
3410 <td class="micon"><a class="exi" href="#expand"> </a></td>
3414 <a id="Roo.form.Field-method-setRawValue" name=".setRawValue"></a>
3415 <div class="fixedFont">
3416 <span class="attributes"></span><b class="itemname">setRawValue</b>
3418 (Mixed <B><i>value</i></B>)
3425 <div class="short">Sets the underlying DOM field's value directly, bypassing validation.</div>
3431 Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {<b>link</b> <b>setValue</b>}.
3438 <dl class="detailList">
3439 <dt class="heading">Parameters:</dt>
3442 <span class="fixedFont">Mixed</span> <b>value</b>
3445 <dd>The value to set</dd>
3463 <td class="msource">
3471 <tr class="method-row config-row-alt1 expandable">
3472 <td class="micon"><a class="exi" href="#expand"> </a></td>
3476 <a id="Roo.BoxComponent-method-setSize" name=".setSize"></a>
3477 <div class="fixedFont">
3478 <span class="attributes"></span><b class="itemname">setSize</b>
3480 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/Object <B><i>width</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>height</i></B>)
3486 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3495 <div class="short">Sets the width and height of the component.</div>
3501 Sets the width and height of the component. This method fires the resize event. This method can accept<br/>either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.
3508 <dl class="detailList">
3509 <dt class="heading">Parameters:</dt>
3512 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/Object</span> <b>width</b>
3515 <dd>The new width to set, or a size object in the format {width, height}</dd>
3518 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>height</b>
3521 <dd>The new height to set (not required if a size object is passed as the first arg)</dd>
3529 <dl class="detailList">
3530 <dt class="heading">Returns:</dt>
3532 <dd><span class="fixedFont"><a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a></span> this</dd>
3546 <td class="msource">
3548 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3554 <tr class="method-row config-row-alt0 expandable notInherited">
3555 <td class="micon"><a class="exi" href="#expand"> </a></td>
3559 <a id="Roo.form.Field-method-setValue" name=".setValue"></a>
3560 <div class="fixedFont">
3561 <span class="attributes"></span><b class="itemname">setValue</b>
3563 (Mixed <B><i>value</i></B>)
3570 <div class="short">Sets a data value into the field and validates it.</div>
3576 Sets a data value into the field and validates it. To set the value directly without validation see {<b>link</b> <b>setRawValue</b>}.
3583 <dl class="detailList">
3584 <dt class="heading">Parameters:</dt>
3587 <span class="fixedFont">Mixed</span> <b>value</b>
3590 <dd>The value to set</dd>
3608 <td class="msource">
3616 <tr class="method-row config-row-alt1 expandable">
3617 <td class="micon"><a class="exi" href="#expand"> </a></td>
3621 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
3622 <div class="fixedFont">
3623 <span class="attributes"></span><b class="itemname">setVisible</b>
3625 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
3631 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3640 <div class="short">Convenience function to hide or show this component by boolean.</div>
3646 Convenience function to hide or show this component by boolean.
3653 <dl class="detailList">
3654 <dt class="heading">Parameters:</dt>
3657 <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>
3660 <dd>True to show, false to hide</dd>
3668 <dl class="detailList">
3669 <dt class="heading">Returns:</dt>
3671 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
3685 <td class="msource">
3687 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3693 <tr class="method-row config-row-alt0 expandable">
3694 <td class="micon"><a class="exi" href="#expand"> </a></td>
3698 <a id="Roo.Component-method-show" name=".show"></a>
3699 <div class="fixedFont">
3700 <span class="attributes"></span><b class="itemname">show</b>
3708 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3717 <div class="short">Show this component.</div>
3723 Show this component.
3734 <dl class="detailList">
3735 <dt class="heading">Returns:</dt>
3737 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
3751 <td class="msource">
3753 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3759 <tr class="method-row config-row-alt1 expandable">
3760 <td class="micon"><a class="exi" href="#expand"> </a></td>
3764 <a id="Roo.BoxComponent-method-syncSize" name=".syncSize"></a>
3765 <div class="fixedFont">
3766 <span class="attributes"></span><b class="itemname">syncSize</b>
3775 <div class="short">Force the component's size to recalculate based on the underlying element's current height and width.</div>
3781 Force the component's size to recalculate based on the underlying element's current height and width.
3802 <td class="msource">
3804 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3810 <tr class="method-row config-row-alt0 expandable">
3811 <td class="micon"><a class="exi" href="#expand"> </a></td>
3815 <a id="Roo.util.Observable-method-un" name=".un"></a>
3816 <div class="fixedFont">
3817 <span class="attributes"></span><b class="itemname">un</b>
3819 (<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>)
3826 <div class="short">Removes a listener (shorthand for removeListener)</div>
3832 Removes a listener (shorthand for removeListener)
3839 <dl class="detailList">
3840 <dt class="heading">Parameters:</dt>
3843 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3846 <dd>The type of event to listen for</dd>
3849 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3852 <dd>The handler to remove</dd>
3855 <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>
3858 <dd>(optional) The scope (this object) for the handler</dd>
3876 <td class="msource">
3878 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3884 <tr class="method-row config-row-alt1 expandable">
3885 <td class="micon"><a class="exi" href="#expand"> </a></td>
3889 <a id="Roo.BoxComponent-method-updateBox" name=".updateBox"></a>
3890 <div class="fixedFont">
3891 <span class="attributes"></span><b class="itemname">updateBox</b>
3893 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>box</i></B>)
3900 <div class="short">Sets the current box measurements of the component's underlying element.</div>
3906 Sets the current box measurements of the component's underlying element.
3913 <dl class="detailList">
3914 <dt class="heading">Parameters:</dt>
3917 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>box</b>
3920 <dd>An object in the format {x, y, width, height}</dd>
3938 <td class="msource">
3940 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3946 <tr class="method-row config-row-alt0 expandable notInherited">
3947 <td class="micon"><a class="exi" href="#expand"> </a></td>
3951 <a id="Roo.form.Field-method-validate" name=".validate"></a>
3952 <div class="fixedFont">
3953 <span class="attributes"></span><b class="itemname">validate</b>
3961 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
3970 <div class="short">Validates the field value</div>
3976 Validates the field value
3987 <dl class="detailList">
3988 <dt class="heading">Returns:</dt>
3990 <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 value is valid, else false</dd>
4004 <td class="msource">
4015 <!-- ============================== events summary / details ======================== -->
4018 <a id="Roo.form.Field-events"></a>
4027 <table cellspacing="0" class="member-table">
4028 <caption>Events</caption>
4031 <th class="sig-header" colspan="2">Event</th>
4032 <th class="msource-header">Defined By</th>
4041 <tr class="method-row expandable config-row-alt0">
4042 <td class="micon"><a class="exi" href="#expand"> </a></td>
4045 <a id="Roo.Component-event-*beforedestroy"></a>
4047 <div class="fixedFont">
4048 <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>)
4054 <div class="short">Fires before the component is destroyed.
4060 Fires before the component is destroyed. Return false to stop the destroy.
4066 <dl class="detailList">
4067 <dt class="heading">Parameters:</dt>
4070 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4091 <td class="msource">
4092 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4096 <tr class="method-row expandable config-row-alt1">
4097 <td class="micon"><a class="exi" href="#expand"> </a></td>
4100 <a id="Roo.Component-event-*beforehide"></a>
4102 <div class="fixedFont">
4103 <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>)
4109 <div class="short">Fires before the component is hidden.
4115 Fires before the component is hidden. Return false to stop the hide.
4121 <dl class="detailList">
4122 <dt class="heading">Parameters:</dt>
4125 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4146 <td class="msource">
4147 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4151 <tr class="method-row expandable config-row-alt0">
4152 <td class="micon"><a class="exi" href="#expand"> </a></td>
4155 <a id="Roo.Component-event-*beforerender"></a>
4157 <div class="fixedFont">
4158 <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>)
4164 <div class="short">Fires before the component is rendered.
4170 Fires before the component is rendered. Return false to stop the render.
4176 <dl class="detailList">
4177 <dt class="heading">Parameters:</dt>
4180 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4201 <td class="msource">
4202 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4206 <tr class="method-row expandable config-row-alt1">
4207 <td class="micon"><a class="exi" href="#expand"> </a></td>
4210 <a id="Roo.Component-event-*beforeshow"></a>
4212 <div class="fixedFont">
4213 <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>)
4219 <div class="short">Fires before the component is shown.
4225 Fires before the component is shown. Return false to stop the show.
4231 <dl class="detailList">
4232 <dt class="heading">Parameters:</dt>
4235 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4256 <td class="msource">
4257 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4261 <tr class="method-row expandable config-row-alt0 notInherited">
4262 <td class="micon"><a class="exi" href="#expand"> </a></td>
4265 <a id="Roo.form.Field-event-*blur"></a>
4267 <div class="fixedFont">
4268 <b class="itemname">blur</b> (<a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a> <B><i>this</i></B>)
4274 <div class="short">Fires when this field loses input focus.
4280 Fires when this field loses input focus.
4286 <dl class="detailList">
4287 <dt class="heading">Parameters:</dt>
4290 <span class="fixedFont"><a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a></span> <b>this</b>
4311 <td class="msource">
4316 <tr class="method-row expandable config-row-alt1 notInherited">
4317 <td class="micon"><a class="exi" href="#expand"> </a></td>
4320 <a id="Roo.form.Field-event-*change"></a>
4322 <div class="fixedFont">
4323 <b class="itemname">change</b> (<a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a> <B><i>this</i></B>, Mixed <B><i>newValue</i></B>, Mixed <B><i>oldValue</i></B>)
4329 <div class="short">Fires just before the field blurs if the field value has changed.
4335 Fires just before the field blurs if the field value has changed.
4341 <dl class="detailList">
4342 <dt class="heading">Parameters:</dt>
4345 <span class="fixedFont"><a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a></span> <b>this</b>
4351 <span class="fixedFont">Mixed</span> <b>newValue</b>
4354 <dd>The new value</dd>
4357 <span class="fixedFont">Mixed</span> <b>oldValue</b>
4360 <dd>The original value</dd>
4378 <td class="msource">
4383 <tr class="method-row expandable config-row-alt0">
4384 <td class="micon"><a class="exi" href="#expand"> </a></td>
4387 <a id="Roo.Component-event-*destroy"></a>
4389 <div class="fixedFont">
4390 <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>)
4396 <div class="short">Fires after the component is destroyed.
4402 Fires after the component is destroyed.
4408 <dl class="detailList">
4409 <dt class="heading">Parameters:</dt>
4412 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4433 <td class="msource">
4434 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4438 <tr class="method-row expandable config-row-alt1">
4439 <td class="micon"><a class="exi" href="#expand"> </a></td>
4442 <a id="Roo.Component-event-*disable"></a>
4444 <div class="fixedFont">
4445 <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>)
4451 <div class="short">Fires after the component is disabled.
4457 Fires after the component is disabled.
4463 <dl class="detailList">
4464 <dt class="heading">Parameters:</dt>
4467 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4488 <td class="msource">
4489 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4493 <tr class="method-row expandable config-row-alt0">
4494 <td class="micon"><a class="exi" href="#expand"> </a></td>
4497 <a id="Roo.Component-event-*enable"></a>
4499 <div class="fixedFont">
4500 <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>)
4506 <div class="short">Fires after the component is enabled.
4512 Fires after the component is enabled.
4518 <dl class="detailList">
4519 <dt class="heading">Parameters:</dt>
4522 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4543 <td class="msource">
4544 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4548 <tr class="method-row expandable config-row-alt1 notInherited">
4549 <td class="micon"><a class="exi" href="#expand"> </a></td>
4552 <a id="Roo.form.Field-event-*focus"></a>
4554 <div class="fixedFont">
4555 <b class="itemname">focus</b> (<a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a> <B><i>this</i></B>)
4561 <div class="short">Fires when this field receives input focus.
4567 Fires when this field receives input focus.
4573 <dl class="detailList">
4574 <dt class="heading">Parameters:</dt>
4577 <span class="fixedFont"><a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a></span> <b>this</b>
4598 <td class="msource">
4603 <tr class="method-row expandable config-row-alt0">
4604 <td class="micon"><a class="exi" href="#expand"> </a></td>
4607 <a id="Roo.Component-event-*hide"></a>
4609 <div class="fixedFont">
4610 <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>)
4616 <div class="short">Fires after the component is hidden.
4622 Fires after the component is hidden.
4628 <dl class="detailList">
4629 <dt class="heading">Parameters:</dt>
4632 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4653 <td class="msource">
4654 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4658 <tr class="method-row expandable config-row-alt1 notInherited">
4659 <td class="micon"><a class="exi" href="#expand"> </a></td>
4662 <a id="Roo.form.Field-event-*invalid"></a>
4664 <div class="fixedFont">
4665 <b class="itemname">invalid</b> (<a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a> <B><i>this</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>msg</i></B>)
4671 <div class="short">Fires after the field has been marked as invalid.
4677 Fires after the field has been marked as invalid.
4683 <dl class="detailList">
4684 <dt class="heading">Parameters:</dt>
4687 <span class="fixedFont"><a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a></span> <b>this</b>
4693 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>msg</b>
4696 <dd>The validation message</dd>
4714 <td class="msource">
4719 <tr class="method-row expandable config-row-alt0 notInherited">
4720 <td class="micon"><a class="exi" href="#expand"> </a></td>
4723 <a id="Roo.form.Field-event-*keyup"></a>
4725 <div class="fixedFont">
4726 <b class="itemname">keyup</b> (<a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a> <B><i>this</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
4732 <div class="short">Fires after the key up
4738 Fires after the key up
4744 <dl class="detailList">
4745 <dt class="heading">Parameters:</dt>
4748 <span class="fixedFont"><a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a></span> <b>this</b>
4754 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
4757 <dd>The event Object</dd>
4775 <td class="msource">
4780 <tr class="method-row expandable config-row-alt1">
4781 <td class="micon"><a class="exi" href="#expand"> </a></td>
4784 <a id="Roo.BoxComponent-event-*move"></a>
4786 <div class="fixedFont">
4787 <b class="itemname">move</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>x</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>y</i></B>)
4793 <div class="short">Fires after the component is moved.
4799 Fires after the component is moved.
4805 <dl class="detailList">
4806 <dt class="heading">Parameters:</dt>
4809 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4815 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
4818 <dd>The new x position</dd>
4821 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
4824 <dd>The new y position</dd>
4842 <td class="msource">
4843 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
4847 <tr class="method-row expandable config-row-alt0">
4848 <td class="micon"><a class="exi" href="#expand"> </a></td>
4851 <a id="Roo.Component-event-*render"></a>
4853 <div class="fixedFont">
4854 <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>)
4860 <div class="short">Fires after the component is rendered.
4866 Fires after the component is rendered.
4872 <dl class="detailList">
4873 <dt class="heading">Parameters:</dt>
4876 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4897 <td class="msource">
4898 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4902 <tr class="method-row expandable config-row-alt1">
4903 <td class="micon"><a class="exi" href="#expand"> </a></td>
4906 <a id="Roo.BoxComponent-event-*resize"></a>
4908 <div class="fixedFont">
4909 <b class="itemname">resize</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>adjWidth</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>adjHeight</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rawWidth</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rawHeight</i></B>)
4915 <div class="short">Fires after the component is resized.
4921 Fires after the component is resized.
4927 <dl class="detailList">
4928 <dt class="heading">Parameters:</dt>
4931 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4937 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjWidth</b>
4940 <dd>The box-adjusted width that was set</dd>
4943 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjHeight</b>
4946 <dd>The box-adjusted height that was set</dd>
4949 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawWidth</b>
4952 <dd>The width that was originally specified</dd>
4955 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawHeight</b>
4958 <dd>The height that was originally specified</dd>
4976 <td class="msource">
4977 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
4981 <tr class="method-row expandable config-row-alt0">
4982 <td class="micon"><a class="exi" href="#expand"> </a></td>
4985 <a id="Roo.Component-event-*show"></a>
4987 <div class="fixedFont">
4988 <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>)
4994 <div class="short">Fires after the component is shown.
5000 Fires after the component is shown.
5006 <dl class="detailList">
5007 <dt class="heading">Parameters:</dt>
5010 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
5031 <td class="msource">
5032 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
5036 <tr class="method-row expandable config-row-alt1 notInherited">
5037 <td class="micon"><a class="exi" href="#expand"> </a></td>
5040 <a id="Roo.form.Field-event-*specialkey"></a>
5042 <div class="fixedFont">
5043 <b class="itemname">specialkey</b> (<a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a> <B><i>this</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
5049 <div class="short">Fires when any key related to navigation (arrows, tab, enter, esc, etc.
5055 Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check<br/>{<b>link</b> Roo.EventObject<b>getKey</b>} to determine which key was pressed.
5061 <dl class="detailList">
5062 <dt class="heading">Parameters:</dt>
5065 <span class="fixedFont"><a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a></span> <b>this</b>
5071 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
5074 <dd>The event object</dd>
5092 <td class="msource">
5097 <tr class="method-row expandable config-row-alt0 notInherited">
5098 <td class="micon"><a class="exi" href="#expand"> </a></td>
5101 <a id="Roo.form.Field-event-*valid"></a>
5103 <div class="fixedFont">
5104 <b class="itemname">valid</b> (<a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a> <B><i>this</i></B>)
5110 <div class="short">Fires after the field has been validated with no errors.
5116 Fires after the field has been validated with no errors.
5122 <dl class="detailList">
5123 <dt class="heading">Parameters:</dt>
5126 <span class="fixedFont"><a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a></span> <b>this</b>
5147 <td class="msource">
5159 <!-- ============================== footer ================================= -->
5160 <div class="fineprint" style="clear:both">
5162 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Oct 14 2016 10:07:55 GMT+0800 (HKT)
5164 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>