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.GridField</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.GridField-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.form.GridField-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.form.GridField-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.form.GridField-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.GridField
55 <!-- ============================== class title / details ============================ -->
58 <h1 class="classTitle">
60 Class Roo.form.GridField
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_GridField.js.html">Roo/form/GridField.js</a>.
72 <tr><td class="label">Class:</td><td class="hd-info">GridField</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 Embed a grid (or editable grid into a form)<br/>STATUS ALPHA<br/><br/>This embeds a grid in a form, the value of the field should be the json encoded array of rows<br/>it needs <br/>xgrid.store = Roo.data.Store<br/>xgrid.store.proxy = Roo.data.MemoryProxy (data = [] )<br/>xgrid.store.reader = Roo.data.JsonReader
92 <!-- ============================== Class comment block... ========================== -->
94 <div class="comments">
95 <b>Class Comments / Notes</B> =>
96 <u onclick="parent.CommentDialog.showCommentId = 'Roo.form.GridField';">[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.GridField.html"></iframe>
104 <!-- ============================== config options ========================== -->
109 <div class="hr"></div>
110 <a id="Roo.form.GridField-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>
147 which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'
157 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
163 <tr class="config-row expandable config-row-alt1 notInherited">
164 <td class="micon"><a class="exi" href="#expand"> </a></td>
167 <a id="Roo.form.GridField-cfg-addTitle" name=".addTitle"></a>
168 <div class="fixedFont">
169 <b class="itemname">addTitle</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
175 <div class="short">Text to include for adding a title.</div>
180 Text to include for adding a title.
196 <tr class="config-row expandable config-row-alt0">
197 <td class="micon"><a class="exi" href="#expand"> </a></td>
200 <a id="Roo.Component-cfg-allowDomMove" name=".allowDomMove"></a>
201 <div class="fixedFont">
202 <b class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
208 <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
213 Whether the component can move the Dom node when rendering (defaults to true).
223 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
229 <tr class="config-row expandable config-row-alt1 notInherited">
230 <td class="micon"><a class="exi" href="#expand"> </a></td>
233 <a id="Roo.form.GridField-cfg-autoCreate" name=".autoCreate"></a>
234 <div class="fixedFont">
235 <b class="itemname">autoCreate</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object
241 <div class="short">A DomHelper element spec, or true for a default element spec (defaults to<br/>{tag: "input", type: "checkbox", autocomplete: "off"})</div>
246 A DomHelper element spec, or true for a default element spec (defaults to<br/>{tag: "input", type: "checkbox", autocomplete: "off"})
262 <tr class="config-row expandable config-row-alt0">
263 <td class="micon"><a class="exi" href="#expand"> </a></td>
266 <a id="Roo.form.Field-cfg-cls" name=".cls"></a>
267 <div class="fixedFont">
268 <b class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
274 <div class="short">A CSS class to apply to the field's underlying element.</div>
279 A CSS class to apply to the field's underlying element.
289 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
295 <tr class="config-row expandable config-row-alt1">
296 <td class="micon"><a class="exi" href="#expand"> </a></td>
299 <a id="Roo.Component-cfg-disableClass" name=".disableClass"></a>
300 <div class="fixedFont">
301 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
307 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
312 CSS class added to the component when it is disabled (defaults to "x-item-disabled").
322 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
328 <tr class="config-row expandable config-row-alt0">
329 <td class="micon"><a class="exi" href="#expand"> </a></td>
332 <a id="Roo.form.Field-cfg-disabled" name=".disabled"></a>
333 <div class="fixedFont">
334 <b class="itemname">disabled</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
340 <div class="short">True to disable the field (defaults to false).</div>
345 True to disable the field (defaults to false).
355 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
361 <tr class="config-row expandable config-row-alt1">
362 <td class="micon"><a class="exi" href="#expand"> </a></td>
365 <a id="Roo.form.Field-cfg-fieldClass" name=".fieldClass"></a>
366 <div class="fixedFont">
367 <b class="itemname">fieldClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
373 <div class="short">The default CSS class for the field (defaults to "x-form-field")</div>
378 The default CSS class for the field (defaults to "x-form-field")
388 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
394 <tr class="config-row expandable config-row-alt0">
395 <td class="micon"><a class="exi" href="#expand"> </a></td>
398 <a id="Roo.form.Field-cfg-fieldLabel" name=".fieldLabel"></a>
399 <div class="fixedFont">
400 <b class="itemname">fieldLabel</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
406 <div class="short">Label to use when rendering a form.</div>
411 Label to use when rendering a form.
421 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
427 <tr class="config-row expandable config-row-alt1">
428 <td class="micon"><a class="exi" href="#expand"> </a></td>
431 <a id="Roo.form.Field-cfg-focusClass" name=".focusClass"></a>
432 <div class="fixedFont">
433 <b class="itemname">focusClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
439 <div class="short">The CSS class to use when the field receives focus (defaults to "x-form-focus")</div>
444 The CSS class to use when the field receives focus (defaults to "x-form-focus")
454 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
460 <tr class="config-row expandable config-row-alt0 notInherited">
461 <td class="micon"><a class="exi" href="#expand"> </a></td>
464 <a id="Roo.form.GridField-cfg-height" name=".height"></a>
465 <div class="fixedFont">
466 <b class="itemname">height</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
472 <div class="short">- used to restrict height of grid.</div>
477 - used to restrict height of grid..
493 <tr class="config-row expandable config-row-alt1">
494 <td class="micon"><a class="exi" href="#expand"> </a></td>
497 <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
498 <div class="fixedFont">
499 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
505 <div class="short">How this component should hidden.</div>
510 How this component should hidden. Supported values are<br/>"visibility" (css visibility), "offsets" (negative offset position) and<br/>"display" (css display) - defaults to "display".
511 <BR/>Possible Values: display, visibility
520 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
526 <tr class="config-row expandable config-row-alt0">
527 <td class="micon"><a class="exi" href="#expand"> </a></td>
530 <a id="Roo.form.Field-cfg-inputType" name=".inputType"></a>
531 <div class="fixedFont">
532 <b class="itemname">inputType</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
538 <div class="short">The type attribute for input fields -- e.g.</div>
543 The type attribute for input fields -- e.g. radio, text, password (defaults to "text").
553 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
559 <tr class="config-row expandable config-row-alt1">
560 <td class="micon"><a class="exi" href="#expand"> </a></td>
563 <a id="Roo.form.Field-cfg-invalidClass" name=".invalidClass"></a>
564 <div class="fixedFont">
565 <b class="itemname">invalidClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
571 <div class="short">The CSS class to use when marking a field invalid (defaults to "x-form-invalid")</div>
576 The CSS class to use when marking a field invalid (defaults to "x-form-invalid")
586 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
592 <tr class="config-row expandable config-row-alt0">
593 <td class="micon"><a class="exi" href="#expand"> </a></td>
596 <a id="Roo.form.Field-cfg-invalidText" name=".invalidText"></a>
597 <div class="fixedFont">
598 <b class="itemname">invalidText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
604 <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>
609 The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid")
619 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
625 <tr class="config-row expandable config-row-alt1">
626 <td class="micon"><a class="exi" href="#expand"> </a></td>
629 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
630 <div class="fixedFont">
631 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
637 <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>
642 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>
652 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
658 <tr class="config-row expandable config-row-alt0">
659 <td class="micon"><a class="exi" href="#expand"> </a></td>
662 <a id="Roo.form.Field-cfg-msgFx" name=".msgFx"></a>
663 <div class="fixedFont">
664 <b class="itemname">msgFx</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
670 <div class="short"><b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').</div>
675 <b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').
685 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
691 <tr class="config-row expandable config-row-alt1">
692 <td class="micon"><a class="exi" href="#expand"> </a></td>
695 <a id="Roo.form.Field-cfg-msgTarget" name=".msgTarget"></a>
696 <div class="fixedFont">
697 <b class="itemname">msgTarget</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
703 <div class="short">The location where error text should display.</div>
708 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>
718 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
724 <tr class="config-row expandable config-row-alt0">
725 <td class="micon"><a class="exi" href="#expand"> </a></td>
728 <a id="Roo.form.Field-cfg-name" name=".name"></a>
729 <div class="fixedFont">
730 <b class="itemname">name</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
736 <div class="short">The field's HTML name attribute.</div>
741 The field's HTML name attribute.
751 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
757 <tr class="config-row expandable config-row-alt1">
758 <td class="micon"><a class="exi" href="#expand"> </a></td>
761 <a id="Roo.form.Field-cfg-qtip" name=".qtip"></a>
762 <div class="fixedFont">
763 <b class="itemname">qtip</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
769 <div class="short">Mouse over tip</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-readOnly" name=".readOnly"></a>
795 <div class="fixedFont">
796 <b class="itemname">readOnly</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
802 <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>
807 True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.
817 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
823 <tr class="config-row expandable config-row-alt1">
824 <td class="micon"><a class="exi" href="#expand"> </a></td>
827 <a id="Roo.form.Field-cfg-tabIndex" name=".tabIndex"></a>
828 <div class="fixedFont">
829 <b class="itemname">tabIndex</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
835 <div class="short">The tabIndex for this field.</div>
840 The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).
850 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
856 <tr class="config-row expandable config-row-alt0">
857 <td class="micon"><a class="exi" href="#expand"> </a></td>
860 <a id="Roo.form.Field-cfg-validateOnBlur" name=".validateOnBlur"></a>
861 <div class="fixedFont">
862 <b class="itemname">validateOnBlur</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
868 <div class="short">Whether the field should validate when it loses focus (defaults to true).</div>
873 Whether the field should validate when it loses focus (defaults to true).
883 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
889 <tr class="config-row expandable config-row-alt1">
890 <td class="micon"><a class="exi" href="#expand"> </a></td>
893 <a id="Roo.form.Field-cfg-validationDelay" name=".validationDelay"></a>
894 <div class="fixedFont">
895 <b class="itemname">validationDelay</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
901 <div class="short">The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)</div>
906 The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)
916 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
922 <tr class="config-row expandable config-row-alt0">
923 <td class="micon"><a class="exi" href="#expand"> </a></td>
926 <a id="Roo.form.Field-cfg-validationEvent" name=".validationEvent"></a>
927 <div class="fixedFont">
928 <b class="itemname">validationEvent</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Boolean
934 <div class="short">The event that should initiate field validation.</div>
939 The event that should initiate field validation. Set to false to disable<br/> automatic validation (defaults to "keyup").
949 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
955 <tr class="config-row expandable config-row-alt1">
956 <td class="micon"><a class="exi" href="#expand"> </a></td>
959 <a id="Roo.form.Field-cfg-value" name=".value"></a>
960 <div class="fixedFont">
961 <b class="itemname">value</b> : Mixed
967 <div class="short">A value to initialize this field with.</div>
972 A value to initialize this field with.
982 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
988 <tr class="config-row expandable config-row-alt0 notInherited">
989 <td class="micon"><a class="exi" href="#expand"> </a></td>
992 <a id="Roo.form.GridField-cfg-width" name=".width"></a>
993 <div class="fixedFont">
994 <b class="itemname">width</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1000 <div class="short">- used to restrict width of grid.</div>
1005 - used to restrict width of grid..
1013 <td class="msource">
1021 <tr class="config-row expandable config-row-alt1 notInherited">
1022 <td class="micon"><a class="exi" href="#expand"> </a></td>
1025 <a id="Roo.form.GridField-cfg-xgrid" name=".xgrid"></a>
1026 <div class="fixedFont">
1027 <b class="itemname">xgrid</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1033 <div class="short">(xtype'd description of grid) { xtype : 'Grid', dataSource: .</div>
1038 (xtype'd description of grid) { xtype : 'Grid', dataSource: .... }<br/><br/>}
1046 <td class="msource">
1064 <!-- ============================== public properties ==================== -->
1068 <a id="Roo.form.GridField-props"></a>
1074 <table cellspacing="0" class="member-table">
1075 <caption class="Empty">Public Properties - Has None</caption>
1081 <!-- ============================== methods summary / details ======================== -->
1084 <a id="Roo.form.GridField-methods"></a>
1085 <!-- constructor?? -->
1092 <!-- then dynamics first -->
1099 <table cellspacing="0" class="member-table">
1100 <caption>Public Methods</caption>
1102 <th class="sig-header" colspan="2">Method</th>
1103 <th class="msource-header">Defined By</th>
1113 <tr class="method-row config-row-alt0 expandable notInherited">
1114 <td class="micon"><a class="exi" href="#expand"> </a></td>
1118 <a id="Roo.form-method-GridField" name=".GridField"></a>
1119 <div class="fixedFont">
1120 <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">GridField</b>
1122 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
1130 <div class="short">Create a new Roo.form.GridField</div>
1137 Create a new Roo.form.GridField
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>config</b>
1147 <dd>Configuration options</dd>
1165 <td class="msource">
1171 <tr class="method-row config-row-alt1 expandable">
1172 <td class="micon"><a class="exi" href="#expand"> </a></td>
1176 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
1177 <div class="fixedFont">
1178 <span class="attributes"></span><b class="itemname">addEvents</b>
1180 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
1187 <div class="short">Used to define events on this Observable</div>
1193 Used to define events on this Observable
1200 <dl class="detailList">
1201 <dt class="heading">Parameters:</dt>
1204 <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>
1207 <dd>The object with the events defined</dd>
1225 <td class="msource">
1227 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1233 <tr class="method-row config-row-alt0 expandable">
1234 <td class="micon"><a class="exi" href="#expand"> </a></td>
1238 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
1239 <div class="fixedFont">
1240 <span class="attributes"></span><b class="itemname">addListener</b>
1242 (<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>)
1249 <div class="short">Appends an event handler to this component</div>
1255 Appends an event handler to this component
1262 <dl class="detailList">
1263 <dt class="heading">Parameters:</dt>
1266 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1269 <dd>The type of event to listen for</dd>
1272 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1275 <dd>The method the event invokes</dd>
1278 <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>
1281 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1284 <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>
1287 <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>
1305 <td class="msource">
1307 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1313 <tr class="method-row config-row-alt1 expandable">
1314 <td class="micon"><a class="exi" href="#expand"> </a></td>
1318 <a id="Roo.form.Field-method-applyTo" name=".applyTo"></a>
1319 <div class="fixedFont">
1320 <span class="attributes"></span><b class="itemname">applyTo</b>
1322 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>)
1328 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
1337 <div class="short">Apply the behaviors of this component to an existing element.</div>
1343 Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>
1350 <dl class="detailList">
1351 <dt class="heading">Parameters:</dt>
1354 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
1357 <dd>The id of the node, a DOM node or an existing Element</dd>
1365 <dl class="detailList">
1366 <dt class="heading">Returns:</dt>
1368 <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>
1382 <td class="msource">
1384 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
1390 <tr class="method-row config-row-alt0 expandable">
1391 <td class="micon"><a class="exi" href="#expand"> </a></td>
1395 <a id="Roo.form.Field-method-clearInvalid" name=".clearInvalid"></a>
1396 <div class="fixedFont">
1397 <span class="attributes"></span><b class="itemname">clearInvalid</b>
1406 <div class="short">Clear any invalid styles/messages for this field</div>
1412 Clear any invalid styles/messages for this field
1433 <td class="msource">
1435 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
1441 <tr class="method-row config-row-alt1 expandable">
1442 <td class="micon"><a class="exi" href="#expand"> </a></td>
1446 <a id="Roo.Component-method-destroy" name=".destroy"></a>
1447 <div class="fixedFont">
1448 <span class="attributes"></span><b class="itemname">destroy</b>
1457 <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>
1463 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}.
1484 <td class="msource">
1486 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1492 <tr class="method-row config-row-alt0 expandable">
1493 <td class="micon"><a class="exi" href="#expand"> </a></td>
1497 <a id="Roo.Component-method-disable" name=".disable"></a>
1498 <div class="fixedFont">
1499 <span class="attributes"></span><b class="itemname">disable</b>
1507 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1516 <div class="short">Disable this component.</div>
1522 Disable this component.
1533 <dl class="detailList">
1534 <dt class="heading">Returns:</dt>
1536 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1550 <td class="msource">
1552 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1558 <tr class="method-row config-row-alt1 expandable">
1559 <td class="micon"><a class="exi" href="#expand"> </a></td>
1563 <a id="Roo.Component-method-enable" name=".enable"></a>
1564 <div class="fixedFont">
1565 <span class="attributes"></span><b class="itemname">enable</b>
1573 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1582 <div class="short">Enable this component.</div>
1588 Enable this component.
1599 <dl class="detailList">
1600 <dt class="heading">Returns:</dt>
1602 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1616 <td class="msource">
1618 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1624 <tr class="method-row config-row-alt0 expandable">
1625 <td class="micon"><a class="exi" href="#expand"> </a></td>
1629 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1630 <div class="fixedFont">
1631 <span class="attributes"></span><b class="itemname">fireEvent</b>
1633 (<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>)
1639 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1648 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1654 Fires the specified event with the passed parameters (minus the event name).
1661 <dl class="detailList">
1662 <dt class="heading">Parameters:</dt>
1665 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1671 <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>
1674 <dd>Variable number of parameters are passed to handlers</dd>
1682 <dl class="detailList">
1683 <dt class="heading">Returns:</dt>
1685 <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>
1699 <td class="msource">
1701 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1707 <tr class="method-row config-row-alt1 expandable">
1708 <td class="micon"><a class="exi" href="#expand"> </a></td>
1712 <a id="Roo.Component-method-focus" name=".focus"></a>
1713 <div class="fixedFont">
1714 <span class="attributes"></span><b class="itemname">focus</b>
1716 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
1722 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1731 <div class="short">Try to focus this component.</div>
1737 Try to focus this component.
1744 <dl class="detailList">
1745 <dt class="heading">Parameters:</dt>
1748 <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>
1751 <dd>True to also select the text in this component (if applicable)</dd>
1759 <dl class="detailList">
1760 <dt class="heading">Returns:</dt>
1762 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1776 <td class="msource">
1778 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1784 <tr class="method-row config-row-alt0 expandable">
1785 <td class="micon"><a class="exi" href="#expand"> </a></td>
1789 <a id="Roo.BoxComponent-method-getBox" name=".getBox"></a>
1790 <div class="fixedFont">
1791 <span class="attributes"></span><b class="itemname">getBox</b>
1793 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>local</i></B>)
1800 <div class="short">Gets the current box measurements of the component's underlying element.</div>
1806 Gets the current box measurements of the component's underlying element.
1813 <dl class="detailList">
1814 <dt class="heading">Parameters:</dt>
1817 <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>
1820 <dd>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</dd>
1838 <td class="msource">
1840 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
1846 <tr class="method-row config-row-alt1 expandable">
1847 <td class="micon"><a class="exi" href="#expand"> </a></td>
1851 <a id="Roo.Component-method-getEl" name=".getEl"></a>
1852 <div class="fixedFont">
1853 <span class="attributes"></span><b class="itemname">getEl</b>
1861 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1870 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
1876 Returns the underlying {<b>link</b> Roo.Element}.
1887 <dl class="detailList">
1888 <dt class="heading">Returns:</dt>
1890 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1904 <td class="msource">
1906 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1912 <tr class="method-row config-row-alt0 expandable">
1913 <td class="micon"><a class="exi" href="#expand"> </a></td>
1917 <a id="Roo.Component-method-getId" name=".getId"></a>
1918 <div class="fixedFont">
1919 <span class="attributes"></span><b class="itemname">getId</b>
1927 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1936 <div class="short">Returns the id of this component.</div>
1942 Returns the id of this component.
1953 <dl class="detailList">
1954 <dt class="heading">Returns:</dt>
1956 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1970 <td class="msource">
1972 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1978 <tr class="method-row config-row-alt1 expandable">
1979 <td class="micon"><a class="exi" href="#expand"> </a></td>
1983 <a id="Roo.form.Field-method-getName" name=".getName"></a>
1984 <div class="fixedFont">
1985 <span class="attributes"></span><b class="itemname">getName</b>
1993 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
2002 <div class="short">Returns the name attribute of the field if available</div>
2008 Returns the name attribute of the field if available
2019 <dl class="detailList">
2020 <dt class="heading">Returns:</dt>
2022 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> name The field name</dd>
2036 <td class="msource">
2038 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2044 <tr class="method-row config-row-alt0 expandable">
2045 <td class="micon"><a class="exi" href="#expand"> </a></td>
2049 <a id="Roo.BoxComponent-method-getPosition" name=".getPosition"></a>
2050 <div class="fixedFont">
2051 <span class="attributes"></span><b class="itemname">getPosition</b>
2053 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>local</i></B>)
2059 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
2068 <div class="short">Gets the current XY position of the component's underlying element.</div>
2074 Gets the current XY position of the component's underlying element.
2081 <dl class="detailList">
2082 <dt class="heading">Parameters:</dt>
2085 <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>
2088 <dd>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</dd>
2096 <dl class="detailList">
2097 <dt class="heading">Returns:</dt>
2099 <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>
2113 <td class="msource">
2115 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2121 <tr class="method-row config-row-alt1 expandable">
2122 <td class="micon"><a class="exi" href="#expand"> </a></td>
2126 <a id="Roo.form.Field-method-getRawValue" name=".getRawValue"></a>
2127 <div class="fixedFont">
2128 <span class="attributes"></span><b class="itemname">getRawValue</b>
2145 <div class="short">Returns the raw data value which may or may not be a valid, defined value.</div>
2151 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>}.
2162 <dl class="detailList">
2163 <dt class="heading">Returns:</dt>
2165 <dd><span class="fixedFont">Mixed</span> value The field value</dd>
2179 <td class="msource">
2181 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2187 <tr class="method-row config-row-alt0 expandable">
2188 <td class="micon"><a class="exi" href="#expand"> </a></td>
2192 <a id="Roo.BoxComponent-method-getSize" name=".getSize"></a>
2193 <div class="fixedFont">
2194 <span class="attributes"></span><b class="itemname">getSize</b>
2202 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
2211 <div class="short">Gets the current size of the component's underlying element.</div>
2217 Gets the current size of the component's underlying element.
2228 <dl class="detailList">
2229 <dt class="heading">Returns:</dt>
2231 <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>
2245 <td class="msource">
2247 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2253 <tr class="method-row config-row-alt1 expandable">
2254 <td class="micon"><a class="exi" href="#expand"> </a></td>
2258 <a id="Roo.form.Field-method-getValue" name=".getValue"></a>
2259 <div class="fixedFont">
2260 <span class="attributes"></span><b class="itemname">getValue</b>
2277 <div class="short">Returns the normalized data value (undefined or emptyText will be returned as '').</div>
2283 Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {<b>link</b> <b>getRawValue</b>}.
2294 <dl class="detailList">
2295 <dt class="heading">Returns:</dt>
2297 <dd><span class="fixedFont">Mixed</span> value The field value</dd>
2311 <td class="msource">
2313 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2319 <tr class="method-row config-row-alt0 expandable">
2320 <td class="micon"><a class="exi" href="#expand"> </a></td>
2324 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
2325 <div class="fixedFont">
2326 <span class="attributes"></span><b class="itemname">hasListener</b>
2328 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
2334 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2343 <div class="short">Checks to see if this object has any listeners for a specified event</div>
2349 Checks to see if this object has any listeners for a specified event
2356 <dl class="detailList">
2357 <dt class="heading">Parameters:</dt>
2360 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2363 <dd>The name of the event to check for</dd>
2371 <dl class="detailList">
2372 <dt class="heading">Returns:</dt>
2374 <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>
2388 <td class="msource">
2390 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2396 <tr class="method-row config-row-alt1 expandable">
2397 <td class="micon"><a class="exi" href="#expand"> </a></td>
2401 <a id="Roo.Component-method-hide" name=".hide"></a>
2402 <div class="fixedFont">
2403 <span class="attributes"></span><b class="itemname">hide</b>
2411 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2420 <div class="short">Hide this component.</div>
2426 Hide this component.
2437 <dl class="detailList">
2438 <dt class="heading">Returns:</dt>
2440 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
2454 <td class="msource">
2456 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2462 <tr class="method-row config-row-alt0 expandable">
2463 <td class="micon"><a class="exi" href="#expand"> </a></td>
2467 <a id="Roo.form.Field-method-isDirty" name=".isDirty"></a>
2468 <div class="fixedFont">
2469 <span class="attributes"></span><b class="itemname">isDirty</b>
2478 <div class="short">Returns true if this field has been changed since it was originally loaded and is not disabled.</div>
2484 Returns true if this field has been changed since it was originally loaded and is not disabled.
2505 <td class="msource">
2507 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2513 <tr class="method-row config-row-alt1 expandable">
2514 <td class="micon"><a class="exi" href="#expand"> </a></td>
2518 <a id="Roo.form.Field-method-isValid" name=".isValid"></a>
2519 <div class="fixedFont">
2520 <span class="attributes"></span><b class="itemname">isValid</b>
2522 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>preventMark</i></B>)
2528 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2537 <div class="short">Returns whether or not the field value is currently valid</div>
2543 Returns whether or not the field value is currently valid
2550 <dl class="detailList">
2551 <dt class="heading">Parameters:</dt>
2554 <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>
2557 <dd>True to disable marking the field invalid</dd>
2565 <dl class="detailList">
2566 <dt class="heading">Returns:</dt>
2568 <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>
2582 <td class="msource">
2584 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2590 <tr class="method-row config-row-alt0 expandable">
2591 <td class="micon"><a class="exi" href="#expand"> </a></td>
2595 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
2596 <div class="fixedFont">
2597 <span class="attributes"></span><b class="itemname">isVisible</b>
2606 <div class="short">Returns true if this component is visible.</div>
2612 Returns true if this component is visible.
2633 <td class="msource">
2635 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2641 <tr class="method-row config-row-alt1 expandable">
2642 <td class="micon"><a class="exi" href="#expand"> </a></td>
2646 <a id="Roo.form.Field-method-markInvalid" name=".markInvalid"></a>
2647 <div class="fixedFont">
2648 <span class="attributes"></span><b class="itemname">markInvalid</b>
2650 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>msg</i></B>)
2657 <div class="short">Mark this field as invalid</div>
2663 Mark this field as invalid
2670 <dl class="detailList">
2671 <dt class="heading">Parameters:</dt>
2674 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>msg</b>
2677 <dd>The validation message</dd>
2695 <td class="msource">
2697 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2703 <tr class="method-row config-row-alt0 expandable">
2704 <td class="micon"><a class="exi" href="#expand"> </a></td>
2708 <a id="Roo.util.Observable-method-on" name=".on"></a>
2709 <div class="fixedFont">
2710 <span class="attributes"></span><b class="itemname">on</b>
2712 (<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>)
2719 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2725 Appends an event handler to this element (shorthand for addListener)
2732 <dl class="detailList">
2733 <dt class="heading">Parameters:</dt>
2736 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2739 <dd>The type of event to listen for</dd>
2742 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2745 <dd>The method the event invokes</dd>
2748 <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>
2751 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2754 <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>
2775 <td class="msource">
2777 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2783 <tr class="method-row config-row-alt1 expandable">
2784 <td class="micon"><a class="exi" href="#expand"> </a></td>
2788 <a id="Roo.BoxComponent-method-onPosition" name=".onPosition"></a>
2789 <div class="fixedFont">
2790 <span class="attributes"></span><b class="itemname">onPosition</b>
2792 (<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>)
2799 <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>
2805 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.
2812 <dl class="detailList">
2813 <dt class="heading">Parameters:</dt>
2816 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
2819 <dd>The new x position</dd>
2822 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
2825 <dd>The new y position</dd>
2843 <td class="msource">
2845 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2851 <tr class="method-row config-row-alt0 expandable">
2852 <td class="micon"><a class="exi" href="#expand"> </a></td>
2856 <a id="Roo.BoxComponent-method-onResize" name=".onResize"></a>
2857 <div class="fixedFont">
2858 <span class="attributes"></span><b class="itemname">onResize</b>
2860 (<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>)
2867 <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>
2873 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.
2880 <dl class="detailList">
2881 <dt class="heading">Parameters:</dt>
2884 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjWidth</b>
2887 <dd>The box-adjusted width that was set</dd>
2890 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjHeight</b>
2893 <dd>The box-adjusted height that was set</dd>
2896 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawWidth</b>
2899 <dd>The width that was originally specified</dd>
2902 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawHeight</b>
2905 <dd>The height that was originally specified</dd>
2923 <td class="msource">
2925 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2931 <tr class="method-row config-row-alt1 expandable">
2932 <td class="micon"><a class="exi" href="#expand"> </a></td>
2936 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2937 <div class="fixedFont">
2938 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2947 <div class="short">Removes all listeners for this object</div>
2953 Removes all listeners for this object
2974 <td class="msource">
2976 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2982 <tr class="method-row config-row-alt0 expandable">
2983 <td class="micon"><a class="exi" href="#expand"> </a></td>
2987 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2988 <div class="fixedFont">
2989 <span class="attributes"></span><b class="itemname">removeListener</b>
2991 (<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>)
2998 <div class="short">Removes a listener</div>
3011 <dl class="detailList">
3012 <dt class="heading">Parameters:</dt>
3015 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3018 <dd>The type of event to listen for</dd>
3021 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3024 <dd>The handler to remove</dd>
3027 <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>
3030 <dd>(optional) The scope (this object) for the handler</dd>
3048 <td class="msource">
3050 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3056 <tr class="method-row config-row-alt1 expandable">
3057 <td class="micon"><a class="exi" href="#expand"> </a></td>
3061 <a id="Roo.Component-method-render" name=".render"></a>
3062 <div class="fixedFont">
3063 <span class="attributes"></span><b class="itemname">render</b>
3065 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
3072 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
3078 If this is a lazy rendering component, render it to its container element.
3085 <dl class="detailList">
3086 <dt class="heading">Parameters:</dt>
3089 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
3092 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
3110 <td class="msource">
3112 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3118 <tr class="method-row config-row-alt0 expandable">
3119 <td class="micon"><a class="exi" href="#expand"> </a></td>
3123 <a id="Roo.form.Field-method-reset" name=".reset"></a>
3124 <div class="fixedFont">
3125 <span class="attributes"></span><b class="itemname">reset</b>
3134 <div class="short">Resets the current field value to the originally loaded value and clears any validation messages</div>
3140 Resets the current field value to the originally loaded value and clears any validation messages
3161 <td class="msource">
3163 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
3169 <tr class="method-row config-row-alt1 expandable">
3170 <td class="micon"><a class="exi" href="#expand"> </a></td>
3174 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
3175 <div class="fixedFont">
3176 <span class="attributes"></span><b class="itemname">setDisabled</b>
3178 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
3185 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
3191 Convenience function for setting disabled/enabled by boolean.
3198 <dl class="detailList">
3199 <dt class="heading">Parameters:</dt>
3202 <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>
3223 <td class="msource">
3225 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3231 <tr class="method-row config-row-alt0 expandable">
3232 <td class="micon"><a class="exi" href="#expand"> </a></td>
3236 <a id="Roo.BoxComponent-method-setPagePosition" name=".setPagePosition"></a>
3237 <div class="fixedFont">
3238 <span class="attributes"></span><b class="itemname">setPagePosition</b>
3240 (<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>)
3247 <div class="short">Sets the page XY position of the component.</div>
3253 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.
3260 <dl class="detailList">
3261 <dt class="heading">Parameters:</dt>
3264 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
3267 <dd>The new x position</dd>
3270 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
3273 <dd>The new y position</dd>
3291 <td class="msource">
3293 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3299 <tr class="method-row config-row-alt1 expandable">
3300 <td class="micon"><a class="exi" href="#expand"> </a></td>
3304 <a id="Roo.BoxComponent-method-setPosition" name=".setPosition"></a>
3305 <div class="fixedFont">
3306 <span class="attributes"></span><b class="itemname">setPosition</b>
3308 (<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>)
3315 <div class="short">Sets the left and top of the component.</div>
3321 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.
3328 <dl class="detailList">
3329 <dt class="heading">Parameters:</dt>
3332 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>left</b>
3335 <dd>The new left</dd>
3338 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>top</b>
3341 <dd>The new top</dd>
3359 <td class="msource">
3361 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3367 <tr class="method-row config-row-alt0 expandable">
3368 <td class="micon"><a class="exi" href="#expand"> </a></td>
3372 <a id="Roo.form.Field-method-setRawValue" name=".setRawValue"></a>
3373 <div class="fixedFont">
3374 <span class="attributes"></span><b class="itemname">setRawValue</b>
3376 (Mixed <B><i>value</i></B>)
3383 <div class="short">Sets the underlying DOM field's value directly, bypassing validation.</div>
3389 Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {<b>link</b> <b>setValue</b>}.
3396 <dl class="detailList">
3397 <dt class="heading">Parameters:</dt>
3400 <span class="fixedFont">Mixed</span> <b>value</b>
3403 <dd>The value to set</dd>
3421 <td class="msource">
3423 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
3429 <tr class="method-row config-row-alt1 expandable">
3430 <td class="micon"><a class="exi" href="#expand"> </a></td>
3434 <a id="Roo.BoxComponent-method-setSize" name=".setSize"></a>
3435 <div class="fixedFont">
3436 <span class="attributes"></span><b class="itemname">setSize</b>
3438 (<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>)
3444 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3453 <div class="short">Sets the width and height of the component.</div>
3459 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}.
3466 <dl class="detailList">
3467 <dt class="heading">Parameters:</dt>
3470 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/Object</span> <b>width</b>
3473 <dd>The new width to set, or a size object in the format {width, height}</dd>
3476 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>height</b>
3479 <dd>The new height to set (not required if a size object is passed as the first arg)</dd>
3487 <dl class="detailList">
3488 <dt class="heading">Returns:</dt>
3490 <dd><span class="fixedFont"><a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a></span> this</dd>
3504 <td class="msource">
3506 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3512 <tr class="method-row config-row-alt0 expandable notInherited">
3513 <td class="micon"><a class="exi" href="#expand"> </a></td>
3517 <a id="Roo.form.GridField-method-setValue" name=".setValue"></a>
3518 <div class="fixedFont">
3519 <span class="attributes"></span><b class="itemname">setValue</b>
3521 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>either</i></B>)
3528 <div class="short">Sets the value of the item.</div>
3534 Sets the value of the item.
3541 <dl class="detailList">
3542 <dt class="heading">Parameters:</dt>
3545 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>either</b>
3548 <dd>an object or a string..</dd>
3566 <td class="msource">
3574 <tr class="method-row config-row-alt1 expandable">
3575 <td class="micon"><a class="exi" href="#expand"> </a></td>
3579 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
3580 <div class="fixedFont">
3581 <span class="attributes"></span><b class="itemname">setVisible</b>
3583 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
3589 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3598 <div class="short">Convenience function to hide or show this component by boolean.</div>
3604 Convenience function to hide or show this component by boolean.
3611 <dl class="detailList">
3612 <dt class="heading">Parameters:</dt>
3615 <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>
3618 <dd>True to show, false to hide</dd>
3626 <dl class="detailList">
3627 <dt class="heading">Returns:</dt>
3629 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
3643 <td class="msource">
3645 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3651 <tr class="method-row config-row-alt0 expandable">
3652 <td class="micon"><a class="exi" href="#expand"> </a></td>
3656 <a id="Roo.Component-method-show" name=".show"></a>
3657 <div class="fixedFont">
3658 <span class="attributes"></span><b class="itemname">show</b>
3666 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3675 <div class="short">Show this component.</div>
3681 Show this component.
3692 <dl class="detailList">
3693 <dt class="heading">Returns:</dt>
3695 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
3709 <td class="msource">
3711 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3717 <tr class="method-row config-row-alt1 expandable">
3718 <td class="micon"><a class="exi" href="#expand"> </a></td>
3722 <a id="Roo.BoxComponent-method-syncSize" name=".syncSize"></a>
3723 <div class="fixedFont">
3724 <span class="attributes"></span><b class="itemname">syncSize</b>
3733 <div class="short">Force the component's size to recalculate based on the underlying element's current height and width.</div>
3739 Force the component's size to recalculate based on the underlying element's current height and width.
3760 <td class="msource">
3762 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3768 <tr class="method-row config-row-alt0 expandable">
3769 <td class="micon"><a class="exi" href="#expand"> </a></td>
3773 <a id="Roo.util.Observable-method-un" name=".un"></a>
3774 <div class="fixedFont">
3775 <span class="attributes"></span><b class="itemname">un</b>
3777 (<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>)
3784 <div class="short">Removes a listener (shorthand for removeListener)</div>
3790 Removes a listener (shorthand for removeListener)
3797 <dl class="detailList">
3798 <dt class="heading">Parameters:</dt>
3801 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3804 <dd>The type of event to listen for</dd>
3807 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3810 <dd>The handler to remove</dd>
3813 <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>
3816 <dd>(optional) The scope (this object) for the handler</dd>
3834 <td class="msource">
3836 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3842 <tr class="method-row config-row-alt1 expandable">
3843 <td class="micon"><a class="exi" href="#expand"> </a></td>
3847 <a id="Roo.BoxComponent-method-updateBox" name=".updateBox"></a>
3848 <div class="fixedFont">
3849 <span class="attributes"></span><b class="itemname">updateBox</b>
3851 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>box</i></B>)
3858 <div class="short">Sets the current box measurements of the component's underlying element.</div>
3864 Sets the current box measurements of the component's underlying element.
3871 <dl class="detailList">
3872 <dt class="heading">Parameters:</dt>
3875 <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>
3878 <dd>An object in the format {x, y, width, height}</dd>
3896 <td class="msource">
3898 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3904 <tr class="method-row config-row-alt0 expandable">
3905 <td class="micon"><a class="exi" href="#expand"> </a></td>
3909 <a id="Roo.form.Field-method-validate" name=".validate"></a>
3910 <div class="fixedFont">
3911 <span class="attributes"></span><b class="itemname">validate</b>
3919 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
3928 <div class="short">Validates the field value</div>
3934 Validates the field value
3945 <dl class="detailList">
3946 <dt class="heading">Returns:</dt>
3948 <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>
3962 <td class="msource">
3964 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
3973 <!-- ============================== events summary / details ======================== -->
3976 <a id="Roo.form.GridField-events"></a>
3985 <table cellspacing="0" class="member-table">
3986 <caption>Events</caption>
3989 <th class="sig-header" colspan="2">Event</th>
3990 <th class="msource-header">Defined By</th>
3999 <tr class="method-row expandable config-row-alt0">
4000 <td class="micon"><a class="exi" href="#expand"> </a></td>
4003 <a id="Roo.Component-event-*beforedestroy"></a>
4005 <div class="fixedFont">
4006 <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>)
4012 <div class="short">Fires before the component is destroyed.
4018 Fires before the component is destroyed. Return false to stop the destroy.
4024 <dl class="detailList">
4025 <dt class="heading">Parameters:</dt>
4028 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4049 <td class="msource">
4050 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4054 <tr class="method-row expandable config-row-alt1">
4055 <td class="micon"><a class="exi" href="#expand"> </a></td>
4058 <a id="Roo.Component-event-*beforehide"></a>
4060 <div class="fixedFont">
4061 <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>)
4067 <div class="short">Fires before the component is hidden.
4073 Fires before the component is hidden. Return false to stop the hide.
4079 <dl class="detailList">
4080 <dt class="heading">Parameters:</dt>
4083 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4104 <td class="msource">
4105 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4109 <tr class="method-row expandable config-row-alt0">
4110 <td class="micon"><a class="exi" href="#expand"> </a></td>
4113 <a id="Roo.Component-event-*beforerender"></a>
4115 <div class="fixedFont">
4116 <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>)
4122 <div class="short">Fires before the component is rendered.
4128 Fires before the component is rendered. Return false to stop the render.
4134 <dl class="detailList">
4135 <dt class="heading">Parameters:</dt>
4138 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4159 <td class="msource">
4160 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4164 <tr class="method-row expandable config-row-alt1">
4165 <td class="micon"><a class="exi" href="#expand"> </a></td>
4168 <a id="Roo.Component-event-*beforeshow"></a>
4170 <div class="fixedFont">
4171 <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>)
4177 <div class="short">Fires before the component is shown.
4183 Fires before the component is shown. Return false to stop the show.
4189 <dl class="detailList">
4190 <dt class="heading">Parameters:</dt>
4193 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4214 <td class="msource">
4215 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4219 <tr class="method-row expandable config-row-alt0">
4220 <td class="micon"><a class="exi" href="#expand"> </a></td>
4223 <a id="Roo.form.Field-event-*blur"></a>
4225 <div class="fixedFont">
4226 <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>)
4232 <div class="short">Fires when this field loses input focus.
4238 Fires when this field loses input focus.
4244 <dl class="detailList">
4245 <dt class="heading">Parameters:</dt>
4248 <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>
4269 <td class="msource">
4270 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
4274 <tr class="method-row expandable config-row-alt1">
4275 <td class="micon"><a class="exi" href="#expand"> </a></td>
4278 <a id="Roo.form.Field-event-*change"></a>
4280 <div class="fixedFont">
4281 <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>)
4287 <div class="short">Fires just before the field blurs if the field value has changed.
4293 Fires just before the field blurs if the field value has changed.
4299 <dl class="detailList">
4300 <dt class="heading">Parameters:</dt>
4303 <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>
4309 <span class="fixedFont">Mixed</span> <b>newValue</b>
4312 <dd>The new value</dd>
4315 <span class="fixedFont">Mixed</span> <b>oldValue</b>
4318 <dd>The original value</dd>
4336 <td class="msource">
4337 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
4341 <tr class="method-row expandable config-row-alt0">
4342 <td class="micon"><a class="exi" href="#expand"> </a></td>
4345 <a id="Roo.Component-event-*destroy"></a>
4347 <div class="fixedFont">
4348 <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>)
4354 <div class="short">Fires after the component is destroyed.
4360 Fires after the component is destroyed.
4366 <dl class="detailList">
4367 <dt class="heading">Parameters:</dt>
4370 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4391 <td class="msource">
4392 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4396 <tr class="method-row expandable config-row-alt1">
4397 <td class="micon"><a class="exi" href="#expand"> </a></td>
4400 <a id="Roo.Component-event-*disable"></a>
4402 <div class="fixedFont">
4403 <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>)
4409 <div class="short">Fires after the component is disabled.
4415 Fires after the component is disabled.
4421 <dl class="detailList">
4422 <dt class="heading">Parameters:</dt>
4425 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4446 <td class="msource">
4447 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4451 <tr class="method-row expandable config-row-alt0">
4452 <td class="micon"><a class="exi" href="#expand"> </a></td>
4455 <a id="Roo.Component-event-*enable"></a>
4457 <div class="fixedFont">
4458 <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>)
4464 <div class="short">Fires after the component is enabled.
4470 Fires after the component is enabled.
4476 <dl class="detailList">
4477 <dt class="heading">Parameters:</dt>
4480 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4501 <td class="msource">
4502 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4506 <tr class="method-row expandable config-row-alt1">
4507 <td class="micon"><a class="exi" href="#expand"> </a></td>
4510 <a id="Roo.form.Field-event-*focus"></a>
4512 <div class="fixedFont">
4513 <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>)
4519 <div class="short">Fires when this field receives input focus.
4525 Fires when this field receives input focus.
4531 <dl class="detailList">
4532 <dt class="heading">Parameters:</dt>
4535 <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>
4556 <td class="msource">
4557 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
4561 <tr class="method-row expandable config-row-alt0">
4562 <td class="micon"><a class="exi" href="#expand"> </a></td>
4565 <a id="Roo.Component-event-*hide"></a>
4567 <div class="fixedFont">
4568 <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>)
4574 <div class="short">Fires after the component is hidden.
4580 Fires after the component is hidden.
4586 <dl class="detailList">
4587 <dt class="heading">Parameters:</dt>
4590 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4611 <td class="msource">
4612 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4616 <tr class="method-row expandable config-row-alt1">
4617 <td class="micon"><a class="exi" href="#expand"> </a></td>
4620 <a id="Roo.form.Field-event-*invalid"></a>
4622 <div class="fixedFont">
4623 <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>)
4629 <div class="short">Fires after the field has been marked as invalid.
4635 Fires after the field has been marked as invalid.
4641 <dl class="detailList">
4642 <dt class="heading">Parameters:</dt>
4645 <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>
4651 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>msg</b>
4654 <dd>The validation message</dd>
4672 <td class="msource">
4673 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
4677 <tr class="method-row expandable config-row-alt0">
4678 <td class="micon"><a class="exi" href="#expand"> </a></td>
4681 <a id="Roo.form.Field-event-*keyup"></a>
4683 <div class="fixedFont">
4684 <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>)
4690 <div class="short">Fires after the key up
4696 Fires after the key up
4702 <dl class="detailList">
4703 <dt class="heading">Parameters:</dt>
4706 <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>
4712 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
4715 <dd>The event Object</dd>
4733 <td class="msource">
4734 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
4738 <tr class="method-row expandable config-row-alt1">
4739 <td class="micon"><a class="exi" href="#expand"> </a></td>
4742 <a id="Roo.BoxComponent-event-*move"></a>
4744 <div class="fixedFont">
4745 <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>)
4751 <div class="short">Fires after the component is moved.
4757 Fires after the component is moved.
4763 <dl class="detailList">
4764 <dt class="heading">Parameters:</dt>
4767 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4773 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
4776 <dd>The new x position</dd>
4779 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
4782 <dd>The new y position</dd>
4800 <td class="msource">
4801 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
4805 <tr class="method-row expandable config-row-alt0">
4806 <td class="micon"><a class="exi" href="#expand"> </a></td>
4809 <a id="Roo.Component-event-*render"></a>
4811 <div class="fixedFont">
4812 <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>)
4818 <div class="short">Fires after the component is rendered.
4824 Fires after the component is rendered.
4830 <dl class="detailList">
4831 <dt class="heading">Parameters:</dt>
4834 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4855 <td class="msource">
4856 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4860 <tr class="method-row expandable config-row-alt1">
4861 <td class="micon"><a class="exi" href="#expand"> </a></td>
4864 <a id="Roo.BoxComponent-event-*resize"></a>
4866 <div class="fixedFont">
4867 <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>)
4873 <div class="short">Fires after the component is resized.
4879 Fires after the component is resized.
4885 <dl class="detailList">
4886 <dt class="heading">Parameters:</dt>
4889 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4895 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjWidth</b>
4898 <dd>The box-adjusted width that was set</dd>
4901 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjHeight</b>
4904 <dd>The box-adjusted height that was set</dd>
4907 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawWidth</b>
4910 <dd>The width that was originally specified</dd>
4913 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawHeight</b>
4916 <dd>The height that was originally specified</dd>
4934 <td class="msource">
4935 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
4939 <tr class="method-row expandable config-row-alt0">
4940 <td class="micon"><a class="exi" href="#expand"> </a></td>
4943 <a id="Roo.Component-event-*show"></a>
4945 <div class="fixedFont">
4946 <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>)
4952 <div class="short">Fires after the component is shown.
4958 Fires after the component is shown.
4964 <dl class="detailList">
4965 <dt class="heading">Parameters:</dt>
4968 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4989 <td class="msource">
4990 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4994 <tr class="method-row expandable config-row-alt1">
4995 <td class="micon"><a class="exi" href="#expand"> </a></td>
4998 <a id="Roo.form.Field-event-*specialkey"></a>
5000 <div class="fixedFont">
5001 <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>)
5007 <div class="short">Fires when any key related to navigation (arrows, tab, enter, esc, etc.
5013 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.
5019 <dl class="detailList">
5020 <dt class="heading">Parameters:</dt>
5023 <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>
5029 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
5032 <dd>The event object</dd>
5050 <td class="msource">
5051 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
5055 <tr class="method-row expandable config-row-alt0">
5056 <td class="micon"><a class="exi" href="#expand"> </a></td>
5059 <a id="Roo.form.Field-event-*valid"></a>
5061 <div class="fixedFont">
5062 <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>)
5068 <div class="short">Fires after the field has been validated with no errors.
5074 Fires after the field has been validated with no errors.
5080 <dl class="detailList">
5081 <dt class="heading">Parameters:</dt>
5084 <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>
5105 <td class="msource">
5106 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
5117 <!-- ============================== footer ================================= -->
5118 <div class="fineprint" style="clear:both">
5120 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Apr 15 2016 15:47:51 GMT+0800 (HKT)
5122 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>