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.DisplayField</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.DisplayField-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.form.DisplayField-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.form.DisplayField-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.form.DisplayField-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 src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
50 <img src="../../images/default/s.gif" height="1" width="80"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.form.DisplayField
55 <!-- ============================== class title / details ============================ -->
58 <h1 class="classTitle">
60 Class Roo.form.DisplayField
63 <table cellspacing="0" class="class-summary-table">
65 <tr><td class="label">Package:</td><td class="hd-info">Roo.form</td></tr>
67 <tr><td class="label">Defined In:</td><td class="hd-info">
69 <a href="./src/Roo_form_DisplayField.js.html">Roo/form/DisplayField.js</a>.
72 <tr><td class="label">Class:</td><td class="hd-info">DisplayField</td></tr>
77 <tr><td class="label">Extends:</td><td class="hd-info">
78 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
86 <!-- ============================== class summary ========================== -->
87 <div class="description">
88 A generic Field to display non-editable data.
92 <!-- ============================== Class comment block... ========================== -->
94 <div class="comments">
95 <b>Class Comments / Notes</B> =>
96 <u onclick="parent.CommentDialog.showCommentId = 'Roo.form.DisplayField';">[Add Your comment/notes about this class]</u>
98 <iframe frameborder="0" id="comments-Roo.form" style="border: none;width:100%;"
99 src="/blog.php/GtkDjsComments/Roo.form.DisplayField.html"></iframe>
104 <!-- ============================== config options ========================== -->
109 <div class="hr"></div>
110 <a id="Roo.form.DisplayField-configs"></a>
116 <table cellspacing="0" class="member-table">
117 <caption>Config Options (Usually are also Properties)</caption>
121 <th class="sig-header" colspan="2">Options</th>
123 <th class="msource-header">Defined By</th>
130 <tr class="config-row expandable config-row-alt0">
131 <td class="micon"><a class="exi" href="#expand"> </a></td>
134 <a id="Roo.Component-cfg-actionMode" name=".actionMode"></a>
135 <div class="fixedFont">
136 <b class="itemname">actionMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
142 <div class="short">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
146 <div class="long">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
154 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
160 <tr class="config-row expandable config-row-alt1">
161 <td class="micon"><a class="exi" href="#expand"> </a></td>
164 <a id="Roo.Component-cfg-allowDomMove" name=".allowDomMove"></a>
165 <div class="fixedFont">
166 <b class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
172 <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
176 <div class="long">Whether the component can move the Dom node when rendering (defaults to true).</div>
184 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
190 <tr class="config-row expandable config-row-alt0 notInherited">
191 <td class="micon"><a class="exi" href="#expand"> </a></td>
194 <a id="Roo.form.DisplayField-cfg-autoCreate" name=".autoCreate"></a>
195 <div class="fixedFont">
196 <b class="itemname">autoCreate</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object
202 <div class="short">A DomHelper element spec, or true for a default element spec (defaults to<br/>{tag: "input", type: "checkbox", autocomplete: "off"})</div>
206 <div class="long">A DomHelper element spec, or true for a default element spec (defaults to<br/>{tag: "input", type: "checkbox", autocomplete: "off"})</div>
214 Roo.form.DisplayField
220 <tr class="config-row expandable config-row-alt1">
221 <td class="micon"><a class="exi" href="#expand"> </a></td>
224 <a id="Roo.form.Field-cfg-cls" name=".cls"></a>
225 <div class="fixedFont">
226 <b class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
232 <div class="short">A CSS class to apply to the field's underlying element.</div>
236 <div class="long">A CSS class to apply to the field's underlying element.</div>
244 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
250 <tr class="config-row expandable config-row-alt0">
251 <td class="micon"><a class="exi" href="#expand"> </a></td>
254 <a id="Roo.Component-cfg-disableClass" name=".disableClass"></a>
255 <div class="fixedFont">
256 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
262 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
266 <div class="long">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
274 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
280 <tr class="config-row expandable config-row-alt1">
281 <td class="micon"><a class="exi" href="#expand"> </a></td>
284 <a id="Roo.form.Field-cfg-disabled" name=".disabled"></a>
285 <div class="fixedFont">
286 <b class="itemname">disabled</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
292 <div class="short">True to disable the field (defaults to false).</div>
296 <div class="long">True to disable the field (defaults to false).</div>
304 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
310 <tr class="config-row expandable config-row-alt0 notInherited">
311 <td class="micon"><a class="exi" href="#expand"> </a></td>
314 <a id="Roo.form.DisplayField-cfg-fieldClass" name=".fieldClass"></a>
315 <div class="fixedFont">
316 <b class="itemname">fieldClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
322 <div class="short">The default CSS class for the checkbox (defaults to "x-form-field")</div>
326 <div class="long">The default CSS class for the checkbox (defaults to "x-form-field")</div>
334 Roo.form.DisplayField
340 <tr class="config-row expandable config-row-alt1">
341 <td class="micon"><a class="exi" href="#expand"> </a></td>
344 <a id="Roo.form.Field-cfg-fieldLabel" name=".fieldLabel"></a>
345 <div class="fixedFont">
346 <b class="itemname">fieldLabel</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
352 <div class="short">Label to use when rendering a form.</div>
356 <div class="long">Label to use when rendering a form.</div>
364 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
370 <tr class="config-row expandable config-row-alt0 notInherited">
371 <td class="micon"><a class="exi" href="#expand"> </a></td>
374 <a id="Roo.form.DisplayField-cfg-focusClass" name=".focusClass"></a>
375 <div class="fixedFont">
376 <b class="itemname">focusClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
382 <div class="short">The CSS class to use when the checkbox receives focus (defaults to undefined)</div>
386 <div class="long">The CSS class to use when the checkbox receives focus (defaults to undefined)</div>
394 Roo.form.DisplayField
400 <tr class="config-row expandable config-row-alt1">
401 <td class="micon"><a class="exi" href="#expand"> </a></td>
404 <a id="Roo.BoxComponent-cfg-height" name=".height"></a>
405 <div class="fixedFont">
406 <b class="itemname">height</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
412 <div class="short">height (optional) size of component</div>
416 <div class="long">height (optional) size of component</div>
424 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
430 <tr class="config-row expandable config-row-alt0">
431 <td class="micon"><a class="exi" href="#expand"> </a></td>
434 <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
435 <div class="fixedFont">
436 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
442 <div class="short">How this component should hidden.</div>
446 <div class="long">How this component should hidden. Supported values are<br/>"visibility" (css visibility), "offsets" (negative offset position) and<br/>"display" (css display) - defaults to "display".</div>
454 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
460 <tr class="config-row expandable config-row-alt1">
461 <td class="micon"><a class="exi" href="#expand"> </a></td>
464 <a id="Roo.form.Field-cfg-inputType" name=".inputType"></a>
465 <div class="fixedFont">
466 <b class="itemname">inputType</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
472 <div class="short">The type attribute for input fields -- e.g.</div>
476 <div class="long">The type attribute for input fields -- e.g. radio, text, password (defaults to "text").</div>
484 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
490 <tr class="config-row expandable config-row-alt0">
491 <td class="micon"><a class="exi" href="#expand"> </a></td>
494 <a id="Roo.form.Field-cfg-invalidClass" name=".invalidClass"></a>
495 <div class="fixedFont">
496 <b class="itemname">invalidClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
502 <div class="short">The CSS class to use when marking a field invalid (defaults to "x-form-invalid")</div>
506 <div class="long">The CSS class to use when marking a field invalid (defaults to "x-form-invalid")</div>
514 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
520 <tr class="config-row expandable config-row-alt1">
521 <td class="micon"><a class="exi" href="#expand"> </a></td>
524 <a id="Roo.form.Field-cfg-invalidText" name=".invalidText"></a>
525 <div class="fixedFont">
526 <b class="itemname">invalidText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
532 <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>
536 <div class="long">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>
544 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
550 <tr class="config-row expandable config-row-alt0">
551 <td class="micon"><a class="exi" href="#expand"> </a></td>
554 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
555 <div class="fixedFont">
556 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
562 <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>
566 <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>
574 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
580 <tr class="config-row expandable config-row-alt1">
581 <td class="micon"><a class="exi" href="#expand"> </a></td>
584 <a id="Roo.form.Field-cfg-msgFx" name=".msgFx"></a>
585 <div class="fixedFont">
586 <b class="itemname">msgFx</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
592 <div class="short"><b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').</div>
596 <div class="long"><b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').</div>
604 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
610 <tr class="config-row expandable config-row-alt0">
611 <td class="micon"><a class="exi" href="#expand"> </a></td>
614 <a id="Roo.form.Field-cfg-msgTarget" name=".msgTarget"></a>
615 <div class="fixedFont">
616 <b class="itemname">msgTarget</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
622 <div class="short">The location where error text should display.</div>
626 <div class="long">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></div>
634 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
640 <tr class="config-row expandable config-row-alt1">
641 <td class="micon"><a class="exi" href="#expand"> </a></td>
644 <a id="Roo.form.Field-cfg-name" name=".name"></a>
645 <div class="fixedFont">
646 <b class="itemname">name</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
652 <div class="short">The field's HTML name attribute.</div>
656 <div class="long">The field's HTML name attribute.</div>
664 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
670 <tr class="config-row expandable config-row-alt0">
671 <td class="micon"><a class="exi" href="#expand"> </a></td>
674 <a id="Roo.form.Field-cfg-qtip" name=".qtip"></a>
675 <div class="fixedFont">
676 <b class="itemname">qtip</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
682 <div class="short">Mouse over tip</div>
686 <div class="long">Mouse over tip</div>
694 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
700 <tr class="config-row expandable config-row-alt1">
701 <td class="micon"><a class="exi" href="#expand"> </a></td>
704 <a id="Roo.form.Field-cfg-readOnly" name=".readOnly"></a>
705 <div class="fixedFont">
706 <b class="itemname">readOnly</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
712 <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>
716 <div class="long">True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.</div>
724 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
730 <tr class="config-row expandable config-row-alt0">
731 <td class="micon"><a class="exi" href="#expand"> </a></td>
734 <a id="Roo.form.Field-cfg-tabIndex" name=".tabIndex"></a>
735 <div class="fixedFont">
736 <b class="itemname">tabIndex</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
742 <div class="short">The tabIndex for this field.</div>
746 <div class="long">The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).</div>
754 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
760 <tr class="config-row expandable config-row-alt1">
761 <td class="micon"><a class="exi" href="#expand"> </a></td>
764 <a id="Roo.form.Field-cfg-validateOnBlur" name=".validateOnBlur"></a>
765 <div class="fixedFont">
766 <b class="itemname">validateOnBlur</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
772 <div class="short">Whether the field should validate when it loses focus (defaults to true).</div>
776 <div class="long">Whether the field should validate when it loses focus (defaults to true).</div>
784 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
790 <tr class="config-row expandable config-row-alt0">
791 <td class="micon"><a class="exi" href="#expand"> </a></td>
794 <a id="Roo.form.Field-cfg-validationDelay" name=".validationDelay"></a>
795 <div class="fixedFont">
796 <b class="itemname">validationDelay</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
802 <div class="short">The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)</div>
806 <div class="long">The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)</div>
814 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
820 <tr class="config-row expandable config-row-alt1">
821 <td class="micon"><a class="exi" href="#expand"> </a></td>
824 <a id="Roo.form.Field-cfg-validationEvent" name=".validationEvent"></a>
825 <div class="fixedFont">
826 <b class="itemname">validationEvent</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Boolean
832 <div class="short">The event that should initiate field validation.</div>
836 <div class="long">The event that should initiate field validation. Set to false to disable<br/> automatic validation (defaults to "keyup").</div>
844 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
850 <tr class="config-row expandable config-row-alt0">
851 <td class="micon"><a class="exi" href="#expand"> </a></td>
854 <a id="Roo.form.Field-cfg-value" name=".value"></a>
855 <div class="fixedFont">
856 <b class="itemname">value</b> : Mixed
862 <div class="short">A value to initialize this field with.</div>
866 <div class="long">A value to initialize this field with.</div>
874 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
880 <tr class="config-row expandable config-row-alt1 notInherited">
881 <td class="micon"><a class="exi" href="#expand"> </a></td>
884 <a id="Roo.form.DisplayField-cfg-valueRenderer" name=".valueRenderer"></a>
885 <div class="fixedFont">
886 <b class="itemname">valueRenderer</b> : <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>
892 <div class="short">The renderer for the field (so you can reformat output).</div>
896 <div class="long">The renderer for the field (so you can reformat output). should return raw HTML</div>
904 Roo.form.DisplayField
910 <tr class="config-row expandable config-row-alt0">
911 <td class="micon"><a class="exi" href="#expand"> </a></td>
914 <a id="Roo.BoxComponent-cfg-width" name=".width"></a>
915 <div class="fixedFont">
916 <b class="itemname">width</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
922 <div class="short">width (optional) size of component</div>
926 <div class="long">width (optional) size of component</div>
934 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
950 <!-- ============================== public properties ==================== -->
954 <a id="Roo.form.DisplayField-props"></a>
960 <table cellspacing="0" class="member-table">
961 <caption class="Empty">Public Properties - Has None</caption>
967 <!-- ============================== methods summary / details ======================== -->
970 <a id="Roo.form.DisplayField-methods"></a>
971 <!-- constructor?? -->
978 <!-- then dynamics first -->
985 <table cellspacing="0" class="member-table">
986 <caption>Public Methods</caption>
988 <th class="sig-header" colspan="2">Method</th>
989 <th class="msource-header">Defined By</th>
999 <tr class="method-row config-row-alt0 expandable notInherited">
1000 <td class="micon"><a class="exi" href="#expand"> </a></td>
1004 <a id="Roo.form-method-DisplayField" name=".DisplayField"></a>
1005 <div class="fixedFont">
1006 <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">DisplayField</b>
1008 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
1016 <div class="short">Create a new Roo.form.DisplayField</div>
1023 Create a new Roo.form.DisplayField
1026 <dl class="detailList">
1027 <dt class="heading">Parameters:</dt>
1030 <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>
1033 <dd>Configuration options</dd>
1051 <td class="msource">
1057 <tr class="method-row config-row-alt1 expandable">
1058 <td class="micon"><a class="exi" href="#expand"> </a></td>
1062 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
1063 <div class="fixedFont">
1064 <span class="attributes"></span><b class="itemname">addEvents</b>
1066 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
1073 <div class="short">Used to define events on this Observable</div>
1079 Used to define events on this Observable
1086 <dl class="detailList">
1087 <dt class="heading">Parameters:</dt>
1090 <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>
1093 <dd>The object with the events defined</dd>
1111 <td class="msource">
1113 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1119 <tr class="method-row config-row-alt0 expandable">
1120 <td class="micon"><a class="exi" href="#expand"> </a></td>
1124 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
1125 <div class="fixedFont">
1126 <span class="attributes"></span><b class="itemname">addListener</b>
1128 (<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>)
1135 <div class="short">Appends an event handler to this component</div>
1141 Appends an event handler to this component
1148 <dl class="detailList">
1149 <dt class="heading">Parameters:</dt>
1152 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1155 <dd>The type of event to listen for</dd>
1158 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1161 <dd>The method the event invokes</dd>
1164 <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>
1167 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1170 <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>
1173 <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>
1191 <td class="msource">
1193 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1199 <tr class="method-row config-row-alt1 expandable">
1200 <td class="micon"><a class="exi" href="#expand"> </a></td>
1204 <a id="Roo.form.Field-method-applyTo" name=".applyTo"></a>
1205 <div class="fixedFont">
1206 <span class="attributes"></span><b class="itemname">applyTo</b>
1208 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>)
1214 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
1223 <div class="short">Apply the behaviors of this component to an existing element.</div>
1229 Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>
1236 <dl class="detailList">
1237 <dt class="heading">Parameters:</dt>
1240 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
1243 <dd>The id of the node, a DOM node or an existing Element</dd>
1251 <dl class="detailList">
1252 <dt class="heading">Returns:</dt>
1254 <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>
1268 <td class="msource">
1270 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
1276 <tr class="method-row config-row-alt0 expandable">
1277 <td class="micon"><a class="exi" href="#expand"> </a></td>
1281 <a id="Roo.form.Field-method-clearInvalid" name=".clearInvalid"></a>
1282 <div class="fixedFont">
1283 <span class="attributes"></span><b class="itemname">clearInvalid</b>
1292 <div class="short">Clear any invalid styles/messages for this field</div>
1298 Clear any invalid styles/messages for this field
1319 <td class="msource">
1321 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
1327 <tr class="method-row config-row-alt1 expandable">
1328 <td class="micon"><a class="exi" href="#expand"> </a></td>
1332 <a id="Roo.Component-method-destroy" name=".destroy"></a>
1333 <div class="fixedFont">
1334 <span class="attributes"></span><b class="itemname">destroy</b>
1343 <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>
1349 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}.
1370 <td class="msource">
1372 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1378 <tr class="method-row config-row-alt0 expandable">
1379 <td class="micon"><a class="exi" href="#expand"> </a></td>
1383 <a id="Roo.Component-method-disable" name=".disable"></a>
1384 <div class="fixedFont">
1385 <span class="attributes"></span><b class="itemname">disable</b>
1393 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1402 <div class="short">Disable this component.</div>
1408 Disable this component.
1419 <dl class="detailList">
1420 <dt class="heading">Returns:</dt>
1422 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1436 <td class="msource">
1438 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1444 <tr class="method-row config-row-alt1 expandable">
1445 <td class="micon"><a class="exi" href="#expand"> </a></td>
1449 <a id="Roo.Component-method-enable" name=".enable"></a>
1450 <div class="fixedFont">
1451 <span class="attributes"></span><b class="itemname">enable</b>
1459 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1468 <div class="short">Enable this component.</div>
1474 Enable this component.
1485 <dl class="detailList">
1486 <dt class="heading">Returns:</dt>
1488 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1502 <td class="msource">
1504 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1510 <tr class="method-row config-row-alt0 expandable">
1511 <td class="micon"><a class="exi" href="#expand"> </a></td>
1515 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1516 <div class="fixedFont">
1517 <span class="attributes"></span><b class="itemname">fireEvent</b>
1519 (<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>)
1525 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1534 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1540 Fires the specified event with the passed parameters (minus the event name).
1547 <dl class="detailList">
1548 <dt class="heading">Parameters:</dt>
1551 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1557 <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>
1560 <dd>Variable number of parameters are passed to handlers</dd>
1568 <dl class="detailList">
1569 <dt class="heading">Returns:</dt>
1571 <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>
1585 <td class="msource">
1587 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1593 <tr class="method-row config-row-alt1 expandable">
1594 <td class="micon"><a class="exi" href="#expand"> </a></td>
1598 <a id="Roo.Component-method-focus" name=".focus"></a>
1599 <div class="fixedFont">
1600 <span class="attributes"></span><b class="itemname">focus</b>
1602 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
1608 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1617 <div class="short">Try to focus this component.</div>
1623 Try to focus this component.
1630 <dl class="detailList">
1631 <dt class="heading">Parameters:</dt>
1634 <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>
1637 <dd>True to also select the text in this component (if applicable)</dd>
1645 <dl class="detailList">
1646 <dt class="heading">Returns:</dt>
1648 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1662 <td class="msource">
1664 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1670 <tr class="method-row config-row-alt0 expandable">
1671 <td class="micon"><a class="exi" href="#expand"> </a></td>
1675 <a id="Roo.BoxComponent-method-getBox" name=".getBox"></a>
1676 <div class="fixedFont">
1677 <span class="attributes"></span><b class="itemname">getBox</b>
1679 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>local</i></B>)
1686 <div class="short">Gets the current box measurements of the component's underlying element.</div>
1692 Gets the current box measurements of the component's underlying element.
1699 <dl class="detailList">
1700 <dt class="heading">Parameters:</dt>
1703 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>local</b>
1706 <dd>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</dd>
1724 <td class="msource">
1726 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
1732 <tr class="method-row config-row-alt1 expandable">
1733 <td class="micon"><a class="exi" href="#expand"> </a></td>
1737 <a id="Roo.Component-method-getEl" name=".getEl"></a>
1738 <div class="fixedFont">
1739 <span class="attributes"></span><b class="itemname">getEl</b>
1747 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1756 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
1762 Returns the underlying {<b>link</b> Roo.Element}.
1773 <dl class="detailList">
1774 <dt class="heading">Returns:</dt>
1776 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1790 <td class="msource">
1792 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1798 <tr class="method-row config-row-alt0 expandable">
1799 <td class="micon"><a class="exi" href="#expand"> </a></td>
1803 <a id="Roo.Component-method-getId" name=".getId"></a>
1804 <div class="fixedFont">
1805 <span class="attributes"></span><b class="itemname">getId</b>
1813 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1822 <div class="short">Returns the id of this component.</div>
1828 Returns the id of this component.
1839 <dl class="detailList">
1840 <dt class="heading">Returns:</dt>
1842 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1856 <td class="msource">
1858 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1864 <tr class="method-row config-row-alt1 expandable">
1865 <td class="micon"><a class="exi" href="#expand"> </a></td>
1869 <a id="Roo.form.Field-method-getName" name=".getName"></a>
1870 <div class="fixedFont">
1871 <span class="attributes"></span><b class="itemname">getName</b>
1879 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1888 <div class="short">Returns the name attribute of the field if available</div>
1894 Returns the name attribute of the field if available
1905 <dl class="detailList">
1906 <dt class="heading">Returns:</dt>
1908 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> name The field name</dd>
1922 <td class="msource">
1924 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
1930 <tr class="method-row config-row-alt0 expandable">
1931 <td class="micon"><a class="exi" href="#expand"> </a></td>
1935 <a id="Roo.BoxComponent-method-getPosition" name=".getPosition"></a>
1936 <div class="fixedFont">
1937 <span class="attributes"></span><b class="itemname">getPosition</b>
1939 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>local</i></B>)
1945 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
1954 <div class="short">Gets the current XY position of the component's underlying element.</div>
1960 Gets the current XY position of the component's underlying element.
1967 <dl class="detailList">
1968 <dt class="heading">Parameters:</dt>
1971 <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>
1974 <dd>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</dd>
1982 <dl class="detailList">
1983 <dt class="heading">Returns:</dt>
1985 <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>
1999 <td class="msource">
2001 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2007 <tr class="method-row config-row-alt1 expandable">
2008 <td class="micon"><a class="exi" href="#expand"> </a></td>
2012 <a id="Roo.form.Field-method-getRawValue" name=".getRawValue"></a>
2013 <div class="fixedFont">
2014 <span class="attributes"></span><b class="itemname">getRawValue</b>
2031 <div class="short">Returns the raw data value which may or may not be a valid, defined value.</div>
2037 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>}.
2048 <dl class="detailList">
2049 <dt class="heading">Returns:</dt>
2051 <dd><span class="fixedFont">Mixed</span> value The field value</dd>
2065 <td class="msource">
2067 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2073 <tr class="method-row config-row-alt0 expandable">
2074 <td class="micon"><a class="exi" href="#expand"> </a></td>
2078 <a id="Roo.BoxComponent-method-getSize" name=".getSize"></a>
2079 <div class="fixedFont">
2080 <span class="attributes"></span><b class="itemname">getSize</b>
2088 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
2097 <div class="short">Gets the current size of the component's underlying element.</div>
2103 Gets the current size of the component's underlying element.
2114 <dl class="detailList">
2115 <dt class="heading">Returns:</dt>
2117 <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>
2131 <td class="msource">
2133 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2139 <tr class="method-row config-row-alt1 expandable">
2140 <td class="micon"><a class="exi" href="#expand"> </a></td>
2144 <a id="Roo.form.Field-method-getValue" name=".getValue"></a>
2145 <div class="fixedFont">
2146 <span class="attributes"></span><b class="itemname">getValue</b>
2163 <div class="short">Returns the normalized data value (undefined or emptyText will be returned as '').</div>
2169 Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {<b>link</b> <b>getRawValue</b>}.
2180 <dl class="detailList">
2181 <dt class="heading">Returns:</dt>
2183 <dd><span class="fixedFont">Mixed</span> value The field value</dd>
2197 <td class="msource">
2199 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2205 <tr class="method-row config-row-alt0 expandable">
2206 <td class="micon"><a class="exi" href="#expand"> </a></td>
2210 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
2211 <div class="fixedFont">
2212 <span class="attributes"></span><b class="itemname">hasListener</b>
2214 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
2220 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2229 <div class="short">Checks to see if this object has any listeners for a specified event</div>
2235 Checks to see if this object has any listeners for a specified event
2242 <dl class="detailList">
2243 <dt class="heading">Parameters:</dt>
2246 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2249 <dd>The name of the event to check for</dd>
2257 <dl class="detailList">
2258 <dt class="heading">Returns:</dt>
2260 <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>
2274 <td class="msource">
2276 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2282 <tr class="method-row config-row-alt1 expandable">
2283 <td class="micon"><a class="exi" href="#expand"> </a></td>
2287 <a id="Roo.Component-method-hide" name=".hide"></a>
2288 <div class="fixedFont">
2289 <span class="attributes"></span><b class="itemname">hide</b>
2297 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2306 <div class="short">Hide this component.</div>
2312 Hide this component.
2323 <dl class="detailList">
2324 <dt class="heading">Returns:</dt>
2326 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
2340 <td class="msource">
2342 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2348 <tr class="method-row config-row-alt0 expandable">
2349 <td class="micon"><a class="exi" href="#expand"> </a></td>
2353 <a id="Roo.form.Field-method-isDirty" name=".isDirty"></a>
2354 <div class="fixedFont">
2355 <span class="attributes"></span><b class="itemname">isDirty</b>
2364 <div class="short">Returns true if this field has been changed since it was originally loaded and is not disabled.</div>
2370 Returns true if this field has been changed since it was originally loaded and is not disabled.
2391 <td class="msource">
2393 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2399 <tr class="method-row config-row-alt1 expandable">
2400 <td class="micon"><a class="exi" href="#expand"> </a></td>
2404 <a id="Roo.form.Field-method-isValid" name=".isValid"></a>
2405 <div class="fixedFont">
2406 <span class="attributes"></span><b class="itemname">isValid</b>
2408 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>preventMark</i></B>)
2414 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2423 <div class="short">Returns whether or not the field value is currently valid</div>
2429 Returns whether or not the field value is currently valid
2436 <dl class="detailList">
2437 <dt class="heading">Parameters:</dt>
2440 <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>
2443 <dd>True to disable marking the field invalid</dd>
2451 <dl class="detailList">
2452 <dt class="heading">Returns:</dt>
2454 <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>
2468 <td class="msource">
2470 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2476 <tr class="method-row config-row-alt0 expandable">
2477 <td class="micon"><a class="exi" href="#expand"> </a></td>
2481 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
2482 <div class="fixedFont">
2483 <span class="attributes"></span><b class="itemname">isVisible</b>
2492 <div class="short">Returns true if this component is visible.</div>
2498 Returns true if this component is visible.
2519 <td class="msource">
2521 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2527 <tr class="method-row config-row-alt1 expandable">
2528 <td class="micon"><a class="exi" href="#expand"> </a></td>
2532 <a id="Roo.form.Field-method-markInvalid" name=".markInvalid"></a>
2533 <div class="fixedFont">
2534 <span class="attributes"></span><b class="itemname">markInvalid</b>
2536 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>msg</i></B>)
2543 <div class="short">Mark this field as invalid</div>
2549 Mark this field as invalid
2556 <dl class="detailList">
2557 <dt class="heading">Parameters:</dt>
2560 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>msg</b>
2563 <dd>The validation message</dd>
2581 <td class="msource">
2583 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2589 <tr class="method-row config-row-alt0 expandable">
2590 <td class="micon"><a class="exi" href="#expand"> </a></td>
2594 <a id="Roo.util.Observable-method-on" name=".on"></a>
2595 <div class="fixedFont">
2596 <span class="attributes"></span><b class="itemname">on</b>
2598 (<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>)
2605 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2611 Appends an event handler to this element (shorthand for addListener)
2618 <dl class="detailList">
2619 <dt class="heading">Parameters:</dt>
2622 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2625 <dd>The type of event to listen for</dd>
2628 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2631 <dd>The method the event invokes</dd>
2634 <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>
2637 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2640 <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>
2661 <td class="msource">
2663 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2669 <tr class="method-row config-row-alt1 expandable">
2670 <td class="micon"><a class="exi" href="#expand"> </a></td>
2674 <a id="Roo.BoxComponent-method-onPosition" name=".onPosition"></a>
2675 <div class="fixedFont">
2676 <span class="attributes"></span><b class="itemname">onPosition</b>
2678 (<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>)
2685 <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>
2691 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.
2698 <dl class="detailList">
2699 <dt class="heading">Parameters:</dt>
2702 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
2705 <dd>The new x position</dd>
2708 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
2711 <dd>The new y position</dd>
2729 <td class="msource">
2731 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2737 <tr class="method-row config-row-alt0 expandable">
2738 <td class="micon"><a class="exi" href="#expand"> </a></td>
2742 <a id="Roo.BoxComponent-method-onResize" name=".onResize"></a>
2743 <div class="fixedFont">
2744 <span class="attributes"></span><b class="itemname">onResize</b>
2746 (<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>)
2753 <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>
2759 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.
2766 <dl class="detailList">
2767 <dt class="heading">Parameters:</dt>
2770 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjWidth</b>
2773 <dd>The box-adjusted width that was set</dd>
2776 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjHeight</b>
2779 <dd>The box-adjusted height that was set</dd>
2782 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawWidth</b>
2785 <dd>The width that was originally specified</dd>
2788 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawHeight</b>
2791 <dd>The height that was originally specified</dd>
2809 <td class="msource">
2811 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2817 <tr class="method-row config-row-alt1 expandable">
2818 <td class="micon"><a class="exi" href="#expand"> </a></td>
2822 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2823 <div class="fixedFont">
2824 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2833 <div class="short">Removes all listeners for this object</div>
2839 Removes all listeners for this object
2860 <td class="msource">
2862 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2868 <tr class="method-row config-row-alt0 expandable">
2869 <td class="micon"><a class="exi" href="#expand"> </a></td>
2873 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2874 <div class="fixedFont">
2875 <span class="attributes"></span><b class="itemname">removeListener</b>
2877 (<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>)
2884 <div class="short">Removes a listener</div>
2897 <dl class="detailList">
2898 <dt class="heading">Parameters:</dt>
2901 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2904 <dd>The type of event to listen for</dd>
2907 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2910 <dd>The handler to remove</dd>
2913 <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>
2916 <dd>(optional) The scope (this object) for the handler</dd>
2934 <td class="msource">
2936 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2942 <tr class="method-row config-row-alt1 expandable">
2943 <td class="micon"><a class="exi" href="#expand"> </a></td>
2947 <a id="Roo.Component-method-render" name=".render"></a>
2948 <div class="fixedFont">
2949 <span class="attributes"></span><b class="itemname">render</b>
2951 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
2958 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
2964 If this is a lazy rendering component, render it to its container element.
2971 <dl class="detailList">
2972 <dt class="heading">Parameters:</dt>
2975 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
2978 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
2996 <td class="msource">
2998 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3004 <tr class="method-row config-row-alt0 expandable">
3005 <td class="micon"><a class="exi" href="#expand"> </a></td>
3009 <a id="Roo.form.Field-method-reset" name=".reset"></a>
3010 <div class="fixedFont">
3011 <span class="attributes"></span><b class="itemname">reset</b>
3020 <div class="short">Resets the current field value to the originally loaded value and clears any validation messages</div>
3026 Resets the current field value to the originally loaded value and clears any validation messages
3047 <td class="msource">
3049 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
3055 <tr class="method-row config-row-alt1 expandable">
3056 <td class="micon"><a class="exi" href="#expand"> </a></td>
3060 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
3061 <div class="fixedFont">
3062 <span class="attributes"></span><b class="itemname">setDisabled</b>
3064 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
3071 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
3077 Convenience function for setting disabled/enabled by boolean.
3084 <dl class="detailList">
3085 <dt class="heading">Parameters:</dt>
3088 <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>
3109 <td class="msource">
3111 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3117 <tr class="method-row config-row-alt0 expandable">
3118 <td class="micon"><a class="exi" href="#expand"> </a></td>
3122 <a id="Roo.BoxComponent-method-setPagePosition" name=".setPagePosition"></a>
3123 <div class="fixedFont">
3124 <span class="attributes"></span><b class="itemname">setPagePosition</b>
3126 (<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>)
3133 <div class="short">Sets the page XY position of the component.</div>
3139 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.
3146 <dl class="detailList">
3147 <dt class="heading">Parameters:</dt>
3150 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
3153 <dd>The new x position</dd>
3156 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
3159 <dd>The new y position</dd>
3177 <td class="msource">
3179 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3185 <tr class="method-row config-row-alt1 expandable">
3186 <td class="micon"><a class="exi" href="#expand"> </a></td>
3190 <a id="Roo.BoxComponent-method-setPosition" name=".setPosition"></a>
3191 <div class="fixedFont">
3192 <span class="attributes"></span><b class="itemname">setPosition</b>
3194 (<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>)
3201 <div class="short">Sets the left and top of the component.</div>
3207 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.
3214 <dl class="detailList">
3215 <dt class="heading">Parameters:</dt>
3218 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>left</b>
3221 <dd>The new left</dd>
3224 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>top</b>
3227 <dd>The new top</dd>
3245 <td class="msource">
3247 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3253 <tr class="method-row config-row-alt0 expandable">
3254 <td class="micon"><a class="exi" href="#expand"> </a></td>
3258 <a id="Roo.form.Field-method-setRawValue" name=".setRawValue"></a>
3259 <div class="fixedFont">
3260 <span class="attributes"></span><b class="itemname">setRawValue</b>
3262 (Mixed <B><i>value</i></B>)
3269 <div class="short">Sets the underlying DOM field's value directly, bypassing validation.</div>
3275 Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {<b>link</b> <b>setValue</b>}.
3282 <dl class="detailList">
3283 <dt class="heading">Parameters:</dt>
3286 <span class="fixedFont">Mixed</span> <b>value</b>
3289 <dd>The value to set</dd>
3307 <td class="msource">
3309 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
3315 <tr class="method-row config-row-alt1 expandable">
3316 <td class="micon"><a class="exi" href="#expand"> </a></td>
3320 <a id="Roo.BoxComponent-method-setSize" name=".setSize"></a>
3321 <div class="fixedFont">
3322 <span class="attributes"></span><b class="itemname">setSize</b>
3324 (<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>)
3330 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3339 <div class="short">Sets the width and height of the component.</div>
3345 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}.
3352 <dl class="detailList">
3353 <dt class="heading">Parameters:</dt>
3356 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/Object</span> <b>width</b>
3359 <dd>The new width to set, or a size object in the format {width, height}</dd>
3362 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>height</b>
3365 <dd>The new height to set (not required if a size object is passed as the first arg)</dd>
3373 <dl class="detailList">
3374 <dt class="heading">Returns:</dt>
3376 <dd><span class="fixedFont"><a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a></span> this</dd>
3390 <td class="msource">
3392 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3398 <tr class="method-row config-row-alt0 expandable notInherited">
3399 <td class="micon"><a class="exi" href="#expand"> </a></td>
3403 <a id="Roo.form.DisplayField-method-setValue" name=".setValue"></a>
3404 <div class="fixedFont">
3405 <span class="attributes"></span><b class="itemname">setValue</b>
3407 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/String <B><i>checked</i></B>)
3414 <div class="short">Sets the checked state of the checkbox.</div>
3420 Sets the checked state of the checkbox.
3427 <dl class="detailList">
3428 <dt class="heading">Parameters:</dt>
3431 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/String</span> <b>checked</b>
3434 <dd>True, 'true', '1', or 'on' to check the checkbox, any other value will uncheck it.</dd>
3452 <td class="msource">
3454 Roo.form.DisplayField
3460 <tr class="method-row config-row-alt1 expandable">
3461 <td class="micon"><a class="exi" href="#expand"> </a></td>
3465 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
3466 <div class="fixedFont">
3467 <span class="attributes"></span><b class="itemname">setVisible</b>
3469 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
3475 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3484 <div class="short">Convenience function to hide or show this component by boolean.</div>
3490 Convenience function to hide or show this component by boolean.
3497 <dl class="detailList">
3498 <dt class="heading">Parameters:</dt>
3501 <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>
3504 <dd>True to show, false to hide</dd>
3512 <dl class="detailList">
3513 <dt class="heading">Returns:</dt>
3515 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
3529 <td class="msource">
3531 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3537 <tr class="method-row config-row-alt0 expandable">
3538 <td class="micon"><a class="exi" href="#expand"> </a></td>
3542 <a id="Roo.Component-method-show" name=".show"></a>
3543 <div class="fixedFont">
3544 <span class="attributes"></span><b class="itemname">show</b>
3552 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3561 <div class="short">Show this component.</div>
3567 Show this component.
3578 <dl class="detailList">
3579 <dt class="heading">Returns:</dt>
3581 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
3595 <td class="msource">
3597 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3603 <tr class="method-row config-row-alt1 expandable">
3604 <td class="micon"><a class="exi" href="#expand"> </a></td>
3608 <a id="Roo.BoxComponent-method-syncSize" name=".syncSize"></a>
3609 <div class="fixedFont">
3610 <span class="attributes"></span><b class="itemname">syncSize</b>
3619 <div class="short">Force the component's size to recalculate based on the underlying element's current height and width.</div>
3625 Force the component's size to recalculate based on the underlying element's current height and width.
3646 <td class="msource">
3648 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3654 <tr class="method-row config-row-alt0 expandable">
3655 <td class="micon"><a class="exi" href="#expand"> </a></td>
3659 <a id="Roo.util.Observable-method-un" name=".un"></a>
3660 <div class="fixedFont">
3661 <span class="attributes"></span><b class="itemname">un</b>
3663 (<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>)
3670 <div class="short">Removes a listener (shorthand for removeListener)</div>
3676 Removes a listener (shorthand for removeListener)
3683 <dl class="detailList">
3684 <dt class="heading">Parameters:</dt>
3687 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3690 <dd>The type of event to listen for</dd>
3693 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3696 <dd>The handler to remove</dd>
3699 <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>
3702 <dd>(optional) The scope (this object) for the handler</dd>
3720 <td class="msource">
3722 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3728 <tr class="method-row config-row-alt1 expandable">
3729 <td class="micon"><a class="exi" href="#expand"> </a></td>
3733 <a id="Roo.BoxComponent-method-updateBox" name=".updateBox"></a>
3734 <div class="fixedFont">
3735 <span class="attributes"></span><b class="itemname">updateBox</b>
3737 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>box</i></B>)
3744 <div class="short">Sets the current box measurements of the component's underlying element.</div>
3750 Sets the current box measurements of the component's underlying element.
3757 <dl class="detailList">
3758 <dt class="heading">Parameters:</dt>
3761 <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>
3764 <dd>An object in the format {x, y, width, height}</dd>
3782 <td class="msource">
3784 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3790 <tr class="method-row config-row-alt0 expandable">
3791 <td class="micon"><a class="exi" href="#expand"> </a></td>
3795 <a id="Roo.form.Field-method-validate" name=".validate"></a>
3796 <div class="fixedFont">
3797 <span class="attributes"></span><b class="itemname">validate</b>
3805 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
3814 <div class="short">Validates the field value</div>
3820 Validates the field value
3831 <dl class="detailList">
3832 <dt class="heading">Returns:</dt>
3834 <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>
3848 <td class="msource">
3850 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
3859 <!-- ============================== events summary / details ======================== -->
3862 <a id="Roo.form.DisplayField-events"></a>
3871 <table cellspacing="0" class="member-table">
3872 <caption>Events</caption>
3875 <th class="sig-header" colspan="2">Event</th>
3876 <th class="msource-header">Defined By</th>
3885 <tr class="method-row expandable config-row-alt0">
3886 <td class="micon"><a class="exi" href="#expand"> </a></td>
3889 <a id="Roo.Component-event-*beforedestroy"></a>
3891 <div class="fixedFont">
3892 <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>)
3898 <div class="short">Fires before the component is destroyed.
3904 Fires before the component is destroyed. Return false to stop the destroy.
3910 <dl class="detailList">
3911 <dt class="heading">Parameters:</dt>
3914 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3935 <td class="msource">
3936 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3940 <tr class="method-row expandable config-row-alt1">
3941 <td class="micon"><a class="exi" href="#expand"> </a></td>
3944 <a id="Roo.Component-event-*beforehide"></a>
3946 <div class="fixedFont">
3947 <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>)
3953 <div class="short">Fires before the component is hidden.
3959 Fires before the component is hidden. Return false to stop the hide.
3965 <dl class="detailList">
3966 <dt class="heading">Parameters:</dt>
3969 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3990 <td class="msource">
3991 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3995 <tr class="method-row expandable config-row-alt0">
3996 <td class="micon"><a class="exi" href="#expand"> </a></td>
3999 <a id="Roo.Component-event-*beforerender"></a>
4001 <div class="fixedFont">
4002 <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>)
4008 <div class="short">Fires before the component is rendered.
4014 Fires before the component is rendered. Return false to stop the render.
4020 <dl class="detailList">
4021 <dt class="heading">Parameters:</dt>
4024 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4045 <td class="msource">
4046 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4050 <tr class="method-row expandable config-row-alt1">
4051 <td class="micon"><a class="exi" href="#expand"> </a></td>
4054 <a id="Roo.Component-event-*beforeshow"></a>
4056 <div class="fixedFont">
4057 <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>)
4063 <div class="short">Fires before the component is shown.
4069 Fires before the component is shown. Return false to stop the show.
4075 <dl class="detailList">
4076 <dt class="heading">Parameters:</dt>
4079 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4100 <td class="msource">
4101 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4105 <tr class="method-row expandable config-row-alt0">
4106 <td class="micon"><a class="exi" href="#expand"> </a></td>
4109 <a id="Roo.form.Field-event-*blur"></a>
4111 <div class="fixedFont">
4112 <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>)
4118 <div class="short">Fires when this field loses input focus.
4124 Fires when this field loses input focus.
4130 <dl class="detailList">
4131 <dt class="heading">Parameters:</dt>
4134 <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>
4155 <td class="msource">
4156 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
4160 <tr class="method-row expandable config-row-alt1">
4161 <td class="micon"><a class="exi" href="#expand"> </a></td>
4164 <a id="Roo.form.Field-event-*change"></a>
4166 <div class="fixedFont">
4167 <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>)
4173 <div class="short">Fires just before the field blurs if the field value has changed.
4179 Fires just before the field blurs if the field value has changed.
4185 <dl class="detailList">
4186 <dt class="heading">Parameters:</dt>
4189 <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>
4195 <span class="fixedFont">Mixed</span> <b>newValue</b>
4198 <dd>The new value</dd>
4201 <span class="fixedFont">Mixed</span> <b>oldValue</b>
4204 <dd>The original value</dd>
4222 <td class="msource">
4223 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
4227 <tr class="method-row expandable config-row-alt0">
4228 <td class="micon"><a class="exi" href="#expand"> </a></td>
4231 <a id="Roo.Component-event-*destroy"></a>
4233 <div class="fixedFont">
4234 <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>)
4240 <div class="short">Fires after the component is destroyed.
4246 Fires after the component is destroyed.
4252 <dl class="detailList">
4253 <dt class="heading">Parameters:</dt>
4256 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4277 <td class="msource">
4278 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4282 <tr class="method-row expandable config-row-alt1">
4283 <td class="micon"><a class="exi" href="#expand"> </a></td>
4286 <a id="Roo.Component-event-*disable"></a>
4288 <div class="fixedFont">
4289 <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>)
4295 <div class="short">Fires after the component is disabled.
4301 Fires after the component is disabled.
4307 <dl class="detailList">
4308 <dt class="heading">Parameters:</dt>
4311 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4332 <td class="msource">
4333 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4337 <tr class="method-row expandable config-row-alt0">
4338 <td class="micon"><a class="exi" href="#expand"> </a></td>
4341 <a id="Roo.Component-event-*enable"></a>
4343 <div class="fixedFont">
4344 <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>)
4350 <div class="short">Fires after the component is enabled.
4356 Fires after the component is enabled.
4362 <dl class="detailList">
4363 <dt class="heading">Parameters:</dt>
4366 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4387 <td class="msource">
4388 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4392 <tr class="method-row expandable config-row-alt1">
4393 <td class="micon"><a class="exi" href="#expand"> </a></td>
4396 <a id="Roo.form.Field-event-*focus"></a>
4398 <div class="fixedFont">
4399 <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>)
4405 <div class="short">Fires when this field receives input focus.
4411 Fires when this field receives input focus.
4417 <dl class="detailList">
4418 <dt class="heading">Parameters:</dt>
4421 <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>
4442 <td class="msource">
4443 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
4447 <tr class="method-row expandable config-row-alt0">
4448 <td class="micon"><a class="exi" href="#expand"> </a></td>
4451 <a id="Roo.Component-event-*hide"></a>
4453 <div class="fixedFont">
4454 <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>)
4460 <div class="short">Fires after the component is hidden.
4466 Fires after the component is hidden.
4472 <dl class="detailList">
4473 <dt class="heading">Parameters:</dt>
4476 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4497 <td class="msource">
4498 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4502 <tr class="method-row expandable config-row-alt1">
4503 <td class="micon"><a class="exi" href="#expand"> </a></td>
4506 <a id="Roo.form.Field-event-*invalid"></a>
4508 <div class="fixedFont">
4509 <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>)
4515 <div class="short">Fires after the field has been marked as invalid.
4521 Fires after the field has been marked as invalid.
4527 <dl class="detailList">
4528 <dt class="heading">Parameters:</dt>
4531 <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>
4537 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>msg</b>
4540 <dd>The validation message</dd>
4558 <td class="msource">
4559 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
4563 <tr class="method-row expandable config-row-alt0">
4564 <td class="micon"><a class="exi" href="#expand"> </a></td>
4567 <a id="Roo.form.Field-event-*keyup"></a>
4569 <div class="fixedFont">
4570 <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>)
4576 <div class="short">Fires after the key up
4582 Fires after the key up
4588 <dl class="detailList">
4589 <dt class="heading">Parameters:</dt>
4592 <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 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
4601 <dd>The event Object</dd>
4619 <td class="msource">
4620 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
4624 <tr class="method-row expandable config-row-alt1">
4625 <td class="micon"><a class="exi" href="#expand"> </a></td>
4628 <a id="Roo.BoxComponent-event-*move"></a>
4630 <div class="fixedFont">
4631 <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>)
4637 <div class="short">Fires after the component is moved.
4643 Fires after the component is moved.
4649 <dl class="detailList">
4650 <dt class="heading">Parameters:</dt>
4653 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4659 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
4662 <dd>The new x position</dd>
4665 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
4668 <dd>The new y position</dd>
4686 <td class="msource">
4687 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
4691 <tr class="method-row expandable config-row-alt0">
4692 <td class="micon"><a class="exi" href="#expand"> </a></td>
4695 <a id="Roo.Component-event-*render"></a>
4697 <div class="fixedFont">
4698 <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>)
4704 <div class="short">Fires after the component is rendered.
4710 Fires after the component is rendered.
4716 <dl class="detailList">
4717 <dt class="heading">Parameters:</dt>
4720 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4741 <td class="msource">
4742 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4746 <tr class="method-row expandable config-row-alt1">
4747 <td class="micon"><a class="exi" href="#expand"> </a></td>
4750 <a id="Roo.BoxComponent-event-*resize"></a>
4752 <div class="fixedFont">
4753 <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>)
4759 <div class="short">Fires after the component is resized.
4765 Fires after the component is resized.
4771 <dl class="detailList">
4772 <dt class="heading">Parameters:</dt>
4775 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4781 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjWidth</b>
4784 <dd>The box-adjusted width that was set</dd>
4787 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjHeight</b>
4790 <dd>The box-adjusted height that was set</dd>
4793 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawWidth</b>
4796 <dd>The width that was originally specified</dd>
4799 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawHeight</b>
4802 <dd>The height that was originally specified</dd>
4820 <td class="msource">
4821 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
4825 <tr class="method-row expandable config-row-alt0">
4826 <td class="micon"><a class="exi" href="#expand"> </a></td>
4829 <a id="Roo.Component-event-*show"></a>
4831 <div class="fixedFont">
4832 <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>)
4838 <div class="short">Fires after the component is shown.
4844 Fires after the component is shown.
4850 <dl class="detailList">
4851 <dt class="heading">Parameters:</dt>
4854 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4875 <td class="msource">
4876 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4880 <tr class="method-row expandable config-row-alt1">
4881 <td class="micon"><a class="exi" href="#expand"> </a></td>
4884 <a id="Roo.form.Field-event-*specialkey"></a>
4886 <div class="fixedFont">
4887 <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>)
4893 <div class="short">Fires when any key related to navigation (arrows, tab, enter, esc, etc.
4899 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.
4905 <dl class="detailList">
4906 <dt class="heading">Parameters:</dt>
4909 <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>
4915 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
4918 <dd>The event object</dd>
4936 <td class="msource">
4937 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
4941 <tr class="method-row expandable config-row-alt0">
4942 <td class="micon"><a class="exi" href="#expand"> </a></td>
4945 <a id="Roo.form.Field-event-*valid"></a>
4947 <div class="fixedFont">
4948 <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>)
4954 <div class="short">Fires after the field has been validated with no errors.
4960 Fires after the field has been validated with no errors.
4966 <dl class="detailList">
4967 <dt class="heading">Parameters:</dt>
4970 <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>
4991 <td class="msource">
4992 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
5003 <!-- ============================== footer ================================= -->
5004 <div class="fineprint" style="clear:both">
5006 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jan 14 2011 17:01:50 GMT+0800 (HKT)
5008 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>