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>
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 notInherited">
161 <td class="micon"><a class="exi" href="#expand"> </a></td>
164 <a id="Roo.form.GridField-cfg-addTitle" name=".addTitle"></a>
165 <div class="fixedFont">
166 <b class="itemname">addTitle</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
172 <div class="short">Text to include for adding a title.</div>
176 <div class="long">Text to include for adding a title.</div>
190 <tr class="config-row expandable config-row-alt0">
191 <td class="micon"><a class="exi" href="#expand"> </a></td>
194 <a id="Roo.Component-cfg-allowDomMove" name=".allowDomMove"></a>
195 <div class="fixedFont">
196 <b class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
202 <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
206 <div class="long">Whether the component can move the Dom node when rendering (defaults to true).</div>
214 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
220 <tr class="config-row expandable config-row-alt1 notInherited">
221 <td class="micon"><a class="exi" href="#expand"> </a></td>
224 <a id="Roo.form.GridField-cfg-autoCreate" name=".autoCreate"></a>
225 <div class="fixedFont">
226 <b class="itemname">autoCreate</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object
232 <div class="short">A DomHelper element spec, or true for a default element spec (defaults to<br/>{tag: "input", type: "checkbox", autocomplete: "off"})</div>
236 <div class="long">A DomHelper element spec, or true for a default element spec (defaults to<br/>{tag: "input", type: "checkbox", autocomplete: "off"})</div>
250 <tr class="config-row expandable config-row-alt0">
251 <td class="micon"><a class="exi" href="#expand"> </a></td>
254 <a id="Roo.form.Field-cfg-cls" name=".cls"></a>
255 <div class="fixedFont">
256 <b class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
262 <div class="short">A CSS class to apply to the field's underlying element.</div>
266 <div class="long">A CSS class to apply to the field's underlying element.</div>
274 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</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.Component-cfg-disableClass" name=".disableClass"></a>
285 <div class="fixedFont">
286 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
292 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
296 <div class="long">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
304 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
310 <tr class="config-row expandable config-row-alt0">
311 <td class="micon"><a class="exi" href="#expand"> </a></td>
314 <a id="Roo.form.Field-cfg-disabled" name=".disabled"></a>
315 <div class="fixedFont">
316 <b class="itemname">disabled</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
322 <div class="short">True to disable the field (defaults to false).</div>
326 <div class="long">True to disable the field (defaults to false).</div>
334 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
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-fieldClass" name=".fieldClass"></a>
345 <div class="fixedFont">
346 <b class="itemname">fieldClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
352 <div class="short">The default CSS class for the field (defaults to "x-form-field")</div>
356 <div class="long">The default CSS class for the field (defaults to "x-form-field")</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">
371 <td class="micon"><a class="exi" href="#expand"> </a></td>
374 <a id="Roo.form.Field-cfg-fieldLabel" name=".fieldLabel"></a>
375 <div class="fixedFont">
376 <b class="itemname">fieldLabel</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
382 <div class="short">Label to use when rendering a form.</div>
386 <div class="long">Label to use when rendering a form.</div>
394 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
400 <tr class="config-row expandable config-row-alt1">
401 <td class="micon"><a class="exi" href="#expand"> </a></td>
404 <a id="Roo.form.Field-cfg-focusClass" name=".focusClass"></a>
405 <div class="fixedFont">
406 <b class="itemname">focusClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
412 <div class="short">The CSS class to use when the field receives focus (defaults to "x-form-focus")</div>
416 <div class="long">The CSS class to use when the field receives focus (defaults to "x-form-focus")</div>
424 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
430 <tr class="config-row expandable config-row-alt0 notInherited">
431 <td class="micon"><a class="exi" href="#expand"> </a></td>
434 <a id="Roo.form.GridField-cfg-height" name=".height"></a>
435 <div class="fixedFont">
436 <b class="itemname">height</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
442 <div class="short">- used to restrict height of grid.</div>
446 <div class="long">- used to restrict height of grid..</div>
460 <tr class="config-row expandable config-row-alt1">
461 <td class="micon"><a class="exi" href="#expand"> </a></td>
464 <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
465 <div class="fixedFont">
466 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
472 <div class="short">How this component should hidden.</div>
476 <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>
484 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</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-inputType" name=".inputType"></a>
495 <div class="fixedFont">
496 <b class="itemname">inputType</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
502 <div class="short">The type attribute for input fields -- e.g.</div>
506 <div class="long">The type attribute for input fields -- e.g. radio, text, password (defaults to "text").</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-invalidClass" name=".invalidClass"></a>
525 <div class="fixedFont">
526 <b class="itemname">invalidClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
532 <div class="short">The CSS class to use when marking a field invalid (defaults to "x-form-invalid")</div>
536 <div class="long">The CSS class to use when marking a field invalid (defaults to "x-form-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.form.Field-cfg-invalidText" name=".invalidText"></a>
555 <div class="fixedFont">
556 <b class="itemname">invalidText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
562 <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>
566 <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>
574 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</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.util.Observable-cfg-listeners" name=".listeners"></a>
585 <div class="fixedFont">
586 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
592 <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>
596 <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>
604 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</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-msgFx" name=".msgFx"></a>
615 <div class="fixedFont">
616 <b class="itemname">msgFx</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
622 <div class="short"><b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').</div>
626 <div class="long"><b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').</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-msgTarget" name=".msgTarget"></a>
645 <div class="fixedFont">
646 <b class="itemname">msgTarget</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
652 <div class="short">The location where error text should display.</div>
656 <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>
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-name" name=".name"></a>
675 <div class="fixedFont">
676 <b class="itemname">name</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
682 <div class="short">The field's HTML name attribute.</div>
686 <div class="long">The field's HTML name attribute.</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-qtip" name=".qtip"></a>
705 <div class="fixedFont">
706 <b class="itemname">qtip</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
712 <div class="short">Mouse over tip</div>
716 <div class="long">Mouse over tip</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-readOnly" name=".readOnly"></a>
735 <div class="fixedFont">
736 <b class="itemname">readOnly</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
742 <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>
746 <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>
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-tabIndex" name=".tabIndex"></a>
765 <div class="fixedFont">
766 <b class="itemname">tabIndex</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
772 <div class="short">The tabIndex for this field.</div>
776 <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>
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-validateOnBlur" name=".validateOnBlur"></a>
795 <div class="fixedFont">
796 <b class="itemname">validateOnBlur</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
802 <div class="short">Whether the field should validate when it loses focus (defaults to true).</div>
806 <div class="long">Whether the field should validate when it loses focus (defaults to true).</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-validationDelay" name=".validationDelay"></a>
825 <div class="fixedFont">
826 <b class="itemname">validationDelay</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
832 <div class="short">The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)</div>
836 <div class="long">The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)</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-validationEvent" name=".validationEvent"></a>
855 <div class="fixedFont">
856 <b class="itemname">validationEvent</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Boolean
862 <div class="short">The event that should initiate field validation.</div>
866 <div class="long">The event that should initiate field validation. Set to false to disable<br/> automatic validation (defaults to "keyup").</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">
881 <td class="micon"><a class="exi" href="#expand"> </a></td>
884 <a id="Roo.form.Field-cfg-value" name=".value"></a>
885 <div class="fixedFont">
886 <b class="itemname">value</b> : Mixed
892 <div class="short">A value to initialize this field with.</div>
896 <div class="long">A value to initialize this field with.</div>
904 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
910 <tr class="config-row expandable config-row-alt0 notInherited">
911 <td class="micon"><a class="exi" href="#expand"> </a></td>
914 <a id="Roo.form.GridField-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">- used to restrict width of grid.</div>
926 <div class="long">- used to restrict width of grid..</div>
940 <tr class="config-row expandable config-row-alt1 notInherited">
941 <td class="micon"><a class="exi" href="#expand"> </a></td>
944 <a id="Roo.form.GridField-cfg-xgrid" name=".xgrid"></a>
945 <div class="fixedFont">
946 <b class="itemname">xgrid</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
952 <div class="short">(xtype'd description of grid) { xtype : 'Grid', dataSource: .</div>
956 <div class="long">(xtype'd description of grid) { xtype : 'Grid', dataSource: .... }<br/><br/>}</div>
980 <!-- ============================== public properties ==================== -->
984 <a id="Roo.form.GridField-props"></a>
990 <table cellspacing="0" class="member-table">
991 <caption class="Empty">Public Properties - Has None</caption>
997 <!-- ============================== methods summary / details ======================== -->
1000 <a id="Roo.form.GridField-methods"></a>
1001 <!-- constructor?? -->
1008 <!-- then dynamics first -->
1015 <table cellspacing="0" class="member-table">
1016 <caption>Public Methods</caption>
1018 <th class="sig-header" colspan="2">Method</th>
1019 <th class="msource-header">Defined By</th>
1029 <tr class="method-row config-row-alt0 expandable notInherited">
1030 <td class="micon"><a class="exi" href="#expand"> </a></td>
1034 <a id="Roo.form-method-GridField" name=".GridField"></a>
1035 <div class="fixedFont">
1036 <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">GridField</b>
1038 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
1046 <div class="short">Create a new Roo.form.GridField</div>
1053 Create a new Roo.form.GridField
1056 <dl class="detailList">
1057 <dt class="heading">Parameters:</dt>
1060 <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>
1063 <dd>Configuration options</dd>
1081 <td class="msource">
1087 <tr class="method-row config-row-alt1 expandable">
1088 <td class="micon"><a class="exi" href="#expand"> </a></td>
1092 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
1093 <div class="fixedFont">
1094 <span class="attributes"></span><b class="itemname">addEvents</b>
1096 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
1103 <div class="short">Used to define events on this Observable</div>
1109 Used to define events on this Observable
1116 <dl class="detailList">
1117 <dt class="heading">Parameters:</dt>
1120 <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>
1123 <dd>The object with the events defined</dd>
1141 <td class="msource">
1143 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1149 <tr class="method-row config-row-alt0 expandable">
1150 <td class="micon"><a class="exi" href="#expand"> </a></td>
1154 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
1155 <div class="fixedFont">
1156 <span class="attributes"></span><b class="itemname">addListener</b>
1158 (<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>)
1165 <div class="short">Appends an event handler to this component</div>
1171 Appends an event handler to this component
1178 <dl class="detailList">
1179 <dt class="heading">Parameters:</dt>
1182 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1185 <dd>The type of event to listen for</dd>
1188 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1191 <dd>The method the event invokes</dd>
1194 <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>
1197 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1200 <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>
1203 <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>
1221 <td class="msource">
1223 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1229 <tr class="method-row config-row-alt1 expandable">
1230 <td class="micon"><a class="exi" href="#expand"> </a></td>
1234 <a id="Roo.form.Field-method-applyTo" name=".applyTo"></a>
1235 <div class="fixedFont">
1236 <span class="attributes"></span><b class="itemname">applyTo</b>
1238 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>)
1244 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
1253 <div class="short">Apply the behaviors of this component to an existing element.</div>
1259 Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>
1266 <dl class="detailList">
1267 <dt class="heading">Parameters:</dt>
1270 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
1273 <dd>The id of the node, a DOM node or an existing Element</dd>
1281 <dl class="detailList">
1282 <dt class="heading">Returns:</dt>
1284 <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>
1298 <td class="msource">
1300 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
1306 <tr class="method-row config-row-alt0 expandable">
1307 <td class="micon"><a class="exi" href="#expand"> </a></td>
1311 <a id="Roo.form.Field-method-clearInvalid" name=".clearInvalid"></a>
1312 <div class="fixedFont">
1313 <span class="attributes"></span><b class="itemname">clearInvalid</b>
1322 <div class="short">Clear any invalid styles/messages for this field</div>
1328 Clear any invalid styles/messages for this field
1349 <td class="msource">
1351 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
1357 <tr class="method-row config-row-alt1 expandable">
1358 <td class="micon"><a class="exi" href="#expand"> </a></td>
1362 <a id="Roo.Component-method-destroy" name=".destroy"></a>
1363 <div class="fixedFont">
1364 <span class="attributes"></span><b class="itemname">destroy</b>
1373 <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>
1379 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}.
1400 <td class="msource">
1402 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1408 <tr class="method-row config-row-alt0 expandable">
1409 <td class="micon"><a class="exi" href="#expand"> </a></td>
1413 <a id="Roo.Component-method-disable" name=".disable"></a>
1414 <div class="fixedFont">
1415 <span class="attributes"></span><b class="itemname">disable</b>
1423 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1432 <div class="short">Disable this component.</div>
1438 Disable this component.
1449 <dl class="detailList">
1450 <dt class="heading">Returns:</dt>
1452 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1466 <td class="msource">
1468 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1474 <tr class="method-row config-row-alt1 expandable">
1475 <td class="micon"><a class="exi" href="#expand"> </a></td>
1479 <a id="Roo.Component-method-enable" name=".enable"></a>
1480 <div class="fixedFont">
1481 <span class="attributes"></span><b class="itemname">enable</b>
1489 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1498 <div class="short">Enable this component.</div>
1504 Enable this component.
1515 <dl class="detailList">
1516 <dt class="heading">Returns:</dt>
1518 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1532 <td class="msource">
1534 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1540 <tr class="method-row config-row-alt0 expandable">
1541 <td class="micon"><a class="exi" href="#expand"> </a></td>
1545 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1546 <div class="fixedFont">
1547 <span class="attributes"></span><b class="itemname">fireEvent</b>
1549 (<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>)
1555 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1564 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1570 Fires the specified event with the passed parameters (minus the event name).
1577 <dl class="detailList">
1578 <dt class="heading">Parameters:</dt>
1581 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1587 <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>
1590 <dd>Variable number of parameters are passed to handlers</dd>
1598 <dl class="detailList">
1599 <dt class="heading">Returns:</dt>
1601 <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>
1615 <td class="msource">
1617 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1623 <tr class="method-row config-row-alt1 expandable">
1624 <td class="micon"><a class="exi" href="#expand"> </a></td>
1628 <a id="Roo.Component-method-focus" name=".focus"></a>
1629 <div class="fixedFont">
1630 <span class="attributes"></span><b class="itemname">focus</b>
1632 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
1638 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1647 <div class="short">Try to focus this component.</div>
1653 Try to focus this component.
1660 <dl class="detailList">
1661 <dt class="heading">Parameters:</dt>
1664 <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>
1667 <dd>True to also select the text in this component (if applicable)</dd>
1675 <dl class="detailList">
1676 <dt class="heading">Returns:</dt>
1678 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1692 <td class="msource">
1694 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1700 <tr class="method-row config-row-alt0 expandable">
1701 <td class="micon"><a class="exi" href="#expand"> </a></td>
1705 <a id="Roo.BoxComponent-method-getBox" name=".getBox"></a>
1706 <div class="fixedFont">
1707 <span class="attributes"></span><b class="itemname">getBox</b>
1709 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>local</i></B>)
1716 <div class="short">Gets the current box measurements of the component's underlying element.</div>
1722 Gets the current box measurements of the component's underlying element.
1729 <dl class="detailList">
1730 <dt class="heading">Parameters:</dt>
1733 <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>
1736 <dd>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</dd>
1754 <td class="msource">
1756 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
1762 <tr class="method-row config-row-alt1 expandable">
1763 <td class="micon"><a class="exi" href="#expand"> </a></td>
1767 <a id="Roo.Component-method-getEl" name=".getEl"></a>
1768 <div class="fixedFont">
1769 <span class="attributes"></span><b class="itemname">getEl</b>
1777 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1786 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
1792 Returns the underlying {<b>link</b> Roo.Element}.
1803 <dl class="detailList">
1804 <dt class="heading">Returns:</dt>
1806 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1820 <td class="msource">
1822 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1828 <tr class="method-row config-row-alt0 expandable">
1829 <td class="micon"><a class="exi" href="#expand"> </a></td>
1833 <a id="Roo.Component-method-getId" name=".getId"></a>
1834 <div class="fixedFont">
1835 <span class="attributes"></span><b class="itemname">getId</b>
1843 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1852 <div class="short">Returns the id of this component.</div>
1858 Returns the id of this component.
1869 <dl class="detailList">
1870 <dt class="heading">Returns:</dt>
1872 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1886 <td class="msource">
1888 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1894 <tr class="method-row config-row-alt1 expandable">
1895 <td class="micon"><a class="exi" href="#expand"> </a></td>
1899 <a id="Roo.form.Field-method-getName" name=".getName"></a>
1900 <div class="fixedFont">
1901 <span class="attributes"></span><b class="itemname">getName</b>
1909 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1918 <div class="short">Returns the name attribute of the field if available</div>
1924 Returns the name attribute of the field if available
1935 <dl class="detailList">
1936 <dt class="heading">Returns:</dt>
1938 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> name The field name</dd>
1952 <td class="msource">
1954 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
1960 <tr class="method-row config-row-alt0 expandable">
1961 <td class="micon"><a class="exi" href="#expand"> </a></td>
1965 <a id="Roo.BoxComponent-method-getPosition" name=".getPosition"></a>
1966 <div class="fixedFont">
1967 <span class="attributes"></span><b class="itemname">getPosition</b>
1969 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>local</i></B>)
1975 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
1984 <div class="short">Gets the current XY position of the component's underlying element.</div>
1990 Gets the current XY position of the component's underlying element.
1997 <dl class="detailList">
1998 <dt class="heading">Parameters:</dt>
2001 <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>
2004 <dd>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</dd>
2012 <dl class="detailList">
2013 <dt class="heading">Returns:</dt>
2015 <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>
2029 <td class="msource">
2031 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2037 <tr class="method-row config-row-alt1 expandable">
2038 <td class="micon"><a class="exi" href="#expand"> </a></td>
2042 <a id="Roo.form.Field-method-getRawValue" name=".getRawValue"></a>
2043 <div class="fixedFont">
2044 <span class="attributes"></span><b class="itemname">getRawValue</b>
2061 <div class="short">Returns the raw data value which may or may not be a valid, defined value.</div>
2067 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>}.
2078 <dl class="detailList">
2079 <dt class="heading">Returns:</dt>
2081 <dd><span class="fixedFont">Mixed</span> value The field value</dd>
2095 <td class="msource">
2097 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2103 <tr class="method-row config-row-alt0 expandable">
2104 <td class="micon"><a class="exi" href="#expand"> </a></td>
2108 <a id="Roo.BoxComponent-method-getSize" name=".getSize"></a>
2109 <div class="fixedFont">
2110 <span class="attributes"></span><b class="itemname">getSize</b>
2118 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
2127 <div class="short">Gets the current size of the component's underlying element.</div>
2133 Gets the current size of the component's underlying element.
2144 <dl class="detailList">
2145 <dt class="heading">Returns:</dt>
2147 <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>
2161 <td class="msource">
2163 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2169 <tr class="method-row config-row-alt1 expandable">
2170 <td class="micon"><a class="exi" href="#expand"> </a></td>
2174 <a id="Roo.form.Field-method-getValue" name=".getValue"></a>
2175 <div class="fixedFont">
2176 <span class="attributes"></span><b class="itemname">getValue</b>
2193 <div class="short">Returns the normalized data value (undefined or emptyText will be returned as '').</div>
2199 Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {<b>link</b> <b>getRawValue</b>}.
2210 <dl class="detailList">
2211 <dt class="heading">Returns:</dt>
2213 <dd><span class="fixedFont">Mixed</span> value The field value</dd>
2227 <td class="msource">
2229 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2235 <tr class="method-row config-row-alt0 expandable">
2236 <td class="micon"><a class="exi" href="#expand"> </a></td>
2240 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
2241 <div class="fixedFont">
2242 <span class="attributes"></span><b class="itemname">hasListener</b>
2244 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
2250 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2259 <div class="short">Checks to see if this object has any listeners for a specified event</div>
2265 Checks to see if this object has any listeners for a specified event
2272 <dl class="detailList">
2273 <dt class="heading">Parameters:</dt>
2276 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2279 <dd>The name of the event to check for</dd>
2287 <dl class="detailList">
2288 <dt class="heading">Returns:</dt>
2290 <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>
2304 <td class="msource">
2306 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2312 <tr class="method-row config-row-alt1 expandable">
2313 <td class="micon"><a class="exi" href="#expand"> </a></td>
2317 <a id="Roo.Component-method-hide" name=".hide"></a>
2318 <div class="fixedFont">
2319 <span class="attributes"></span><b class="itemname">hide</b>
2327 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2336 <div class="short">Hide this component.</div>
2342 Hide this component.
2353 <dl class="detailList">
2354 <dt class="heading">Returns:</dt>
2356 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
2370 <td class="msource">
2372 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2378 <tr class="method-row config-row-alt0 expandable">
2379 <td class="micon"><a class="exi" href="#expand"> </a></td>
2383 <a id="Roo.form.Field-method-isDirty" name=".isDirty"></a>
2384 <div class="fixedFont">
2385 <span class="attributes"></span><b class="itemname">isDirty</b>
2394 <div class="short">Returns true if this field has been changed since it was originally loaded and is not disabled.</div>
2400 Returns true if this field has been changed since it was originally loaded and is not disabled.
2421 <td class="msource">
2423 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2429 <tr class="method-row config-row-alt1 expandable">
2430 <td class="micon"><a class="exi" href="#expand"> </a></td>
2434 <a id="Roo.form.Field-method-isValid" name=".isValid"></a>
2435 <div class="fixedFont">
2436 <span class="attributes"></span><b class="itemname">isValid</b>
2438 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>preventMark</i></B>)
2444 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2453 <div class="short">Returns whether or not the field value is currently valid</div>
2459 Returns whether or not the field value is currently valid
2466 <dl class="detailList">
2467 <dt class="heading">Parameters:</dt>
2470 <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>
2473 <dd>True to disable marking the field invalid</dd>
2481 <dl class="detailList">
2482 <dt class="heading">Returns:</dt>
2484 <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>
2498 <td class="msource">
2500 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2506 <tr class="method-row config-row-alt0 expandable">
2507 <td class="micon"><a class="exi" href="#expand"> </a></td>
2511 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
2512 <div class="fixedFont">
2513 <span class="attributes"></span><b class="itemname">isVisible</b>
2522 <div class="short">Returns true if this component is visible.</div>
2528 Returns true if this component is visible.
2549 <td class="msource">
2551 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2557 <tr class="method-row config-row-alt1 expandable">
2558 <td class="micon"><a class="exi" href="#expand"> </a></td>
2562 <a id="Roo.form.Field-method-markInvalid" name=".markInvalid"></a>
2563 <div class="fixedFont">
2564 <span class="attributes"></span><b class="itemname">markInvalid</b>
2566 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>msg</i></B>)
2573 <div class="short">Mark this field as invalid</div>
2579 Mark this field as invalid
2586 <dl class="detailList">
2587 <dt class="heading">Parameters:</dt>
2590 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>msg</b>
2593 <dd>The validation message</dd>
2611 <td class="msource">
2613 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2619 <tr class="method-row config-row-alt0 expandable">
2620 <td class="micon"><a class="exi" href="#expand"> </a></td>
2624 <a id="Roo.util.Observable-method-on" name=".on"></a>
2625 <div class="fixedFont">
2626 <span class="attributes"></span><b class="itemname">on</b>
2628 (<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>)
2635 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2641 Appends an event handler to this element (shorthand for addListener)
2648 <dl class="detailList">
2649 <dt class="heading">Parameters:</dt>
2652 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2655 <dd>The type of event to listen for</dd>
2658 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2661 <dd>The method the event invokes</dd>
2664 <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>
2667 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2670 <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>
2691 <td class="msource">
2693 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2699 <tr class="method-row config-row-alt1 expandable">
2700 <td class="micon"><a class="exi" href="#expand"> </a></td>
2704 <a id="Roo.BoxComponent-method-onPosition" name=".onPosition"></a>
2705 <div class="fixedFont">
2706 <span class="attributes"></span><b class="itemname">onPosition</b>
2708 (<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>)
2715 <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>
2721 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.
2728 <dl class="detailList">
2729 <dt class="heading">Parameters:</dt>
2732 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
2735 <dd>The new x position</dd>
2738 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
2741 <dd>The new y position</dd>
2759 <td class="msource">
2761 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2767 <tr class="method-row config-row-alt0 expandable">
2768 <td class="micon"><a class="exi" href="#expand"> </a></td>
2772 <a id="Roo.BoxComponent-method-onResize" name=".onResize"></a>
2773 <div class="fixedFont">
2774 <span class="attributes"></span><b class="itemname">onResize</b>
2776 (<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>)
2783 <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>
2789 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.
2796 <dl class="detailList">
2797 <dt class="heading">Parameters:</dt>
2800 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjWidth</b>
2803 <dd>The box-adjusted width that was set</dd>
2806 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjHeight</b>
2809 <dd>The box-adjusted height that was set</dd>
2812 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawWidth</b>
2815 <dd>The width that was originally specified</dd>
2818 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawHeight</b>
2821 <dd>The height that was originally specified</dd>
2839 <td class="msource">
2841 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2847 <tr class="method-row config-row-alt1 expandable">
2848 <td class="micon"><a class="exi" href="#expand"> </a></td>
2852 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2853 <div class="fixedFont">
2854 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2863 <div class="short">Removes all listeners for this object</div>
2869 Removes all listeners for this object
2890 <td class="msource">
2892 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2898 <tr class="method-row config-row-alt0 expandable">
2899 <td class="micon"><a class="exi" href="#expand"> </a></td>
2903 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2904 <div class="fixedFont">
2905 <span class="attributes"></span><b class="itemname">removeListener</b>
2907 (<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>)
2914 <div class="short">Removes a listener</div>
2927 <dl class="detailList">
2928 <dt class="heading">Parameters:</dt>
2931 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2934 <dd>The type of event to listen for</dd>
2937 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2940 <dd>The handler to remove</dd>
2943 <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>
2946 <dd>(optional) The scope (this object) for the handler</dd>
2964 <td class="msource">
2966 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2972 <tr class="method-row config-row-alt1 expandable">
2973 <td class="micon"><a class="exi" href="#expand"> </a></td>
2977 <a id="Roo.Component-method-render" name=".render"></a>
2978 <div class="fixedFont">
2979 <span class="attributes"></span><b class="itemname">render</b>
2981 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
2988 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
2994 If this is a lazy rendering component, render it to its container element.
3001 <dl class="detailList">
3002 <dt class="heading">Parameters:</dt>
3005 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
3008 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
3026 <td class="msource">
3028 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3034 <tr class="method-row config-row-alt0 expandable">
3035 <td class="micon"><a class="exi" href="#expand"> </a></td>
3039 <a id="Roo.form.Field-method-reset" name=".reset"></a>
3040 <div class="fixedFont">
3041 <span class="attributes"></span><b class="itemname">reset</b>
3050 <div class="short">Resets the current field value to the originally loaded value and clears any validation messages</div>
3056 Resets the current field value to the originally loaded value and clears any validation messages
3077 <td class="msource">
3079 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
3085 <tr class="method-row config-row-alt1 expandable">
3086 <td class="micon"><a class="exi" href="#expand"> </a></td>
3090 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
3091 <div class="fixedFont">
3092 <span class="attributes"></span><b class="itemname">setDisabled</b>
3094 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
3101 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
3107 Convenience function for setting disabled/enabled by boolean.
3114 <dl class="detailList">
3115 <dt class="heading">Parameters:</dt>
3118 <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>
3139 <td class="msource">
3141 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3147 <tr class="method-row config-row-alt0 expandable">
3148 <td class="micon"><a class="exi" href="#expand"> </a></td>
3152 <a id="Roo.BoxComponent-method-setPagePosition" name=".setPagePosition"></a>
3153 <div class="fixedFont">
3154 <span class="attributes"></span><b class="itemname">setPagePosition</b>
3156 (<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>)
3163 <div class="short">Sets the page XY position of the component.</div>
3169 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.
3176 <dl class="detailList">
3177 <dt class="heading">Parameters:</dt>
3180 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
3183 <dd>The new x position</dd>
3186 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
3189 <dd>The new y position</dd>
3207 <td class="msource">
3209 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3215 <tr class="method-row config-row-alt1 expandable">
3216 <td class="micon"><a class="exi" href="#expand"> </a></td>
3220 <a id="Roo.BoxComponent-method-setPosition" name=".setPosition"></a>
3221 <div class="fixedFont">
3222 <span class="attributes"></span><b class="itemname">setPosition</b>
3224 (<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>)
3231 <div class="short">Sets the left and top of the component.</div>
3237 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.
3244 <dl class="detailList">
3245 <dt class="heading">Parameters:</dt>
3248 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>left</b>
3251 <dd>The new left</dd>
3254 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>top</b>
3257 <dd>The new top</dd>
3275 <td class="msource">
3277 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3283 <tr class="method-row config-row-alt0 expandable">
3284 <td class="micon"><a class="exi" href="#expand"> </a></td>
3288 <a id="Roo.form.Field-method-setRawValue" name=".setRawValue"></a>
3289 <div class="fixedFont">
3290 <span class="attributes"></span><b class="itemname">setRawValue</b>
3292 (Mixed <B><i>value</i></B>)
3299 <div class="short">Sets the underlying DOM field's value directly, bypassing validation.</div>
3305 Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {<b>link</b> <b>setValue</b>}.
3312 <dl class="detailList">
3313 <dt class="heading">Parameters:</dt>
3316 <span class="fixedFont">Mixed</span> <b>value</b>
3319 <dd>The value to set</dd>
3337 <td class="msource">
3339 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
3345 <tr class="method-row config-row-alt1 expandable">
3346 <td class="micon"><a class="exi" href="#expand"> </a></td>
3350 <a id="Roo.BoxComponent-method-setSize" name=".setSize"></a>
3351 <div class="fixedFont">
3352 <span class="attributes"></span><b class="itemname">setSize</b>
3354 (<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>)
3360 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3369 <div class="short">Sets the width and height of the component.</div>
3375 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}.
3382 <dl class="detailList">
3383 <dt class="heading">Parameters:</dt>
3386 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/Object</span> <b>width</b>
3389 <dd>The new width to set, or a size object in the format {width, height}</dd>
3392 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>height</b>
3395 <dd>The new height to set (not required if a size object is passed as the first arg)</dd>
3403 <dl class="detailList">
3404 <dt class="heading">Returns:</dt>
3406 <dd><span class="fixedFont"><a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a></span> this</dd>
3420 <td class="msource">
3422 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3428 <tr class="method-row config-row-alt0 expandable notInherited">
3429 <td class="micon"><a class="exi" href="#expand"> </a></td>
3433 <a id="Roo.form.GridField-method-setValue" name=".setValue"></a>
3434 <div class="fixedFont">
3435 <span class="attributes"></span><b class="itemname">setValue</b>
3437 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>either</i></B>)
3444 <div class="short">Sets the value of the item.</div>
3450 Sets the value of the item.
3457 <dl class="detailList">
3458 <dt class="heading">Parameters:</dt>
3461 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>either</b>
3464 <dd>an object or a string..</dd>
3482 <td class="msource">
3490 <tr class="method-row config-row-alt1 expandable">
3491 <td class="micon"><a class="exi" href="#expand"> </a></td>
3495 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
3496 <div class="fixedFont">
3497 <span class="attributes"></span><b class="itemname">setVisible</b>
3499 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
3505 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3514 <div class="short">Convenience function to hide or show this component by boolean.</div>
3520 Convenience function to hide or show this component by boolean.
3527 <dl class="detailList">
3528 <dt class="heading">Parameters:</dt>
3531 <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>
3534 <dd>True to show, false to hide</dd>
3542 <dl class="detailList">
3543 <dt class="heading">Returns:</dt>
3545 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
3559 <td class="msource">
3561 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3567 <tr class="method-row config-row-alt0 expandable">
3568 <td class="micon"><a class="exi" href="#expand"> </a></td>
3572 <a id="Roo.Component-method-show" name=".show"></a>
3573 <div class="fixedFont">
3574 <span class="attributes"></span><b class="itemname">show</b>
3582 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3591 <div class="short">Show this component.</div>
3597 Show this component.
3608 <dl class="detailList">
3609 <dt class="heading">Returns:</dt>
3611 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
3625 <td class="msource">
3627 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3633 <tr class="method-row config-row-alt1 expandable">
3634 <td class="micon"><a class="exi" href="#expand"> </a></td>
3638 <a id="Roo.BoxComponent-method-syncSize" name=".syncSize"></a>
3639 <div class="fixedFont">
3640 <span class="attributes"></span><b class="itemname">syncSize</b>
3649 <div class="short">Force the component's size to recalculate based on the underlying element's current height and width.</div>
3655 Force the component's size to recalculate based on the underlying element's current height and width.
3676 <td class="msource">
3678 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3684 <tr class="method-row config-row-alt0 expandable">
3685 <td class="micon"><a class="exi" href="#expand"> </a></td>
3689 <a id="Roo.util.Observable-method-un" name=".un"></a>
3690 <div class="fixedFont">
3691 <span class="attributes"></span><b class="itemname">un</b>
3693 (<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>)
3700 <div class="short">Removes a listener (shorthand for removeListener)</div>
3706 Removes a listener (shorthand for removeListener)
3713 <dl class="detailList">
3714 <dt class="heading">Parameters:</dt>
3717 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3720 <dd>The type of event to listen for</dd>
3723 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3726 <dd>The handler to remove</dd>
3729 <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>
3732 <dd>(optional) The scope (this object) for the handler</dd>
3750 <td class="msource">
3752 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3758 <tr class="method-row config-row-alt1 expandable">
3759 <td class="micon"><a class="exi" href="#expand"> </a></td>
3763 <a id="Roo.BoxComponent-method-updateBox" name=".updateBox"></a>
3764 <div class="fixedFont">
3765 <span class="attributes"></span><b class="itemname">updateBox</b>
3767 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>box</i></B>)
3774 <div class="short">Sets the current box measurements of the component's underlying element.</div>
3780 Sets the current box measurements of the component's underlying element.
3787 <dl class="detailList">
3788 <dt class="heading">Parameters:</dt>
3791 <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>
3794 <dd>An object in the format {x, y, width, height}</dd>
3812 <td class="msource">
3814 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3820 <tr class="method-row config-row-alt0 expandable">
3821 <td class="micon"><a class="exi" href="#expand"> </a></td>
3825 <a id="Roo.form.Field-method-validate" name=".validate"></a>
3826 <div class="fixedFont">
3827 <span class="attributes"></span><b class="itemname">validate</b>
3835 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
3844 <div class="short">Validates the field value</div>
3850 Validates the field value
3861 <dl class="detailList">
3862 <dt class="heading">Returns:</dt>
3864 <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>
3878 <td class="msource">
3880 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
3889 <!-- ============================== events summary / details ======================== -->
3892 <a id="Roo.form.GridField-events"></a>
3901 <table cellspacing="0" class="member-table">
3902 <caption>Events</caption>
3905 <th class="sig-header" colspan="2">Event</th>
3906 <th class="msource-header">Defined By</th>
3915 <tr class="method-row expandable config-row-alt0">
3916 <td class="micon"><a class="exi" href="#expand"> </a></td>
3919 <a id="Roo.Component-event-*beforedestroy"></a>
3921 <div class="fixedFont">
3922 <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>)
3928 <div class="short">Fires before the component is destroyed.
3934 Fires before the component is destroyed. Return false to stop the destroy.
3940 <dl class="detailList">
3941 <dt class="heading">Parameters:</dt>
3944 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3965 <td class="msource">
3966 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3970 <tr class="method-row expandable config-row-alt1">
3971 <td class="micon"><a class="exi" href="#expand"> </a></td>
3974 <a id="Roo.Component-event-*beforehide"></a>
3976 <div class="fixedFont">
3977 <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>)
3983 <div class="short">Fires before the component is hidden.
3989 Fires before the component is hidden. Return false to stop the hide.
3995 <dl class="detailList">
3996 <dt class="heading">Parameters:</dt>
3999 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4020 <td class="msource">
4021 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4025 <tr class="method-row expandable config-row-alt0">
4026 <td class="micon"><a class="exi" href="#expand"> </a></td>
4029 <a id="Roo.Component-event-*beforerender"></a>
4031 <div class="fixedFont">
4032 <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>)
4038 <div class="short">Fires before the component is rendered.
4044 Fires before the component is rendered. Return false to stop the render.
4050 <dl class="detailList">
4051 <dt class="heading">Parameters:</dt>
4054 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4075 <td class="msource">
4076 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4080 <tr class="method-row expandable config-row-alt1">
4081 <td class="micon"><a class="exi" href="#expand"> </a></td>
4084 <a id="Roo.Component-event-*beforeshow"></a>
4086 <div class="fixedFont">
4087 <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>)
4093 <div class="short">Fires before the component is shown.
4099 Fires before the component is shown. Return false to stop the show.
4105 <dl class="detailList">
4106 <dt class="heading">Parameters:</dt>
4109 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4130 <td class="msource">
4131 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4135 <tr class="method-row expandable config-row-alt0">
4136 <td class="micon"><a class="exi" href="#expand"> </a></td>
4139 <a id="Roo.form.Field-event-*blur"></a>
4141 <div class="fixedFont">
4142 <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>)
4148 <div class="short">Fires when this field loses input focus.
4154 Fires when this field loses input focus.
4160 <dl class="detailList">
4161 <dt class="heading">Parameters:</dt>
4164 <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>
4185 <td class="msource">
4186 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
4190 <tr class="method-row expandable config-row-alt1">
4191 <td class="micon"><a class="exi" href="#expand"> </a></td>
4194 <a id="Roo.form.Field-event-*change"></a>
4196 <div class="fixedFont">
4197 <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>)
4203 <div class="short">Fires just before the field blurs if the field value has changed.
4209 Fires just before the field blurs if the field value has changed.
4215 <dl class="detailList">
4216 <dt class="heading">Parameters:</dt>
4219 <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>
4225 <span class="fixedFont">Mixed</span> <b>newValue</b>
4228 <dd>The new value</dd>
4231 <span class="fixedFont">Mixed</span> <b>oldValue</b>
4234 <dd>The original value</dd>
4252 <td class="msource">
4253 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
4257 <tr class="method-row expandable config-row-alt0">
4258 <td class="micon"><a class="exi" href="#expand"> </a></td>
4261 <a id="Roo.Component-event-*destroy"></a>
4263 <div class="fixedFont">
4264 <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>)
4270 <div class="short">Fires after the component is destroyed.
4276 Fires after the component is destroyed.
4282 <dl class="detailList">
4283 <dt class="heading">Parameters:</dt>
4286 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4307 <td class="msource">
4308 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4312 <tr class="method-row expandable config-row-alt1">
4313 <td class="micon"><a class="exi" href="#expand"> </a></td>
4316 <a id="Roo.Component-event-*disable"></a>
4318 <div class="fixedFont">
4319 <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>)
4325 <div class="short">Fires after the component is disabled.
4331 Fires after the component is disabled.
4337 <dl class="detailList">
4338 <dt class="heading">Parameters:</dt>
4341 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4362 <td class="msource">
4363 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4367 <tr class="method-row expandable config-row-alt0">
4368 <td class="micon"><a class="exi" href="#expand"> </a></td>
4371 <a id="Roo.Component-event-*enable"></a>
4373 <div class="fixedFont">
4374 <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>)
4380 <div class="short">Fires after the component is enabled.
4386 Fires after the component is enabled.
4392 <dl class="detailList">
4393 <dt class="heading">Parameters:</dt>
4396 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4417 <td class="msource">
4418 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4422 <tr class="method-row expandable config-row-alt1">
4423 <td class="micon"><a class="exi" href="#expand"> </a></td>
4426 <a id="Roo.form.Field-event-*focus"></a>
4428 <div class="fixedFont">
4429 <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>)
4435 <div class="short">Fires when this field receives input focus.
4441 Fires when this field receives input focus.
4447 <dl class="detailList">
4448 <dt class="heading">Parameters:</dt>
4451 <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>
4472 <td class="msource">
4473 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
4477 <tr class="method-row expandable config-row-alt0">
4478 <td class="micon"><a class="exi" href="#expand"> </a></td>
4481 <a id="Roo.Component-event-*hide"></a>
4483 <div class="fixedFont">
4484 <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>)
4490 <div class="short">Fires after the component is hidden.
4496 Fires after the component is hidden.
4502 <dl class="detailList">
4503 <dt class="heading">Parameters:</dt>
4506 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4527 <td class="msource">
4528 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4532 <tr class="method-row expandable config-row-alt1">
4533 <td class="micon"><a class="exi" href="#expand"> </a></td>
4536 <a id="Roo.form.Field-event-*invalid"></a>
4538 <div class="fixedFont">
4539 <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>)
4545 <div class="short">Fires after the field has been marked as invalid.
4551 Fires after the field has been marked as invalid.
4557 <dl class="detailList">
4558 <dt class="heading">Parameters:</dt>
4561 <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>
4567 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>msg</b>
4570 <dd>The validation message</dd>
4588 <td class="msource">
4589 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
4593 <tr class="method-row expandable config-row-alt0">
4594 <td class="micon"><a class="exi" href="#expand"> </a></td>
4597 <a id="Roo.form.Field-event-*keyup"></a>
4599 <div class="fixedFont">
4600 <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>)
4606 <div class="short">Fires after the key up
4612 Fires after the key up
4618 <dl class="detailList">
4619 <dt class="heading">Parameters:</dt>
4622 <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>
4628 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
4631 <dd>The event Object</dd>
4649 <td class="msource">
4650 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
4654 <tr class="method-row expandable config-row-alt1">
4655 <td class="micon"><a class="exi" href="#expand"> </a></td>
4658 <a id="Roo.BoxComponent-event-*move"></a>
4660 <div class="fixedFont">
4661 <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>)
4667 <div class="short">Fires after the component is moved.
4673 Fires after the component is moved.
4679 <dl class="detailList">
4680 <dt class="heading">Parameters:</dt>
4683 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4689 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
4692 <dd>The new x position</dd>
4695 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
4698 <dd>The new y position</dd>
4716 <td class="msource">
4717 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
4721 <tr class="method-row expandable config-row-alt0">
4722 <td class="micon"><a class="exi" href="#expand"> </a></td>
4725 <a id="Roo.Component-event-*render"></a>
4727 <div class="fixedFont">
4728 <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>)
4734 <div class="short">Fires after the component is rendered.
4740 Fires after the component is rendered.
4746 <dl class="detailList">
4747 <dt class="heading">Parameters:</dt>
4750 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4771 <td class="msource">
4772 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4776 <tr class="method-row expandable config-row-alt1">
4777 <td class="micon"><a class="exi" href="#expand"> </a></td>
4780 <a id="Roo.BoxComponent-event-*resize"></a>
4782 <div class="fixedFont">
4783 <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>)
4789 <div class="short">Fires after the component is resized.
4795 Fires after the component is resized.
4801 <dl class="detailList">
4802 <dt class="heading">Parameters:</dt>
4805 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4811 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjWidth</b>
4814 <dd>The box-adjusted width that was set</dd>
4817 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjHeight</b>
4820 <dd>The box-adjusted height that was set</dd>
4823 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawWidth</b>
4826 <dd>The width that was originally specified</dd>
4829 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawHeight</b>
4832 <dd>The height that was originally specified</dd>
4850 <td class="msource">
4851 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
4855 <tr class="method-row expandable config-row-alt0">
4856 <td class="micon"><a class="exi" href="#expand"> </a></td>
4859 <a id="Roo.Component-event-*show"></a>
4861 <div class="fixedFont">
4862 <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>)
4868 <div class="short">Fires after the component is shown.
4874 Fires after the component is shown.
4880 <dl class="detailList">
4881 <dt class="heading">Parameters:</dt>
4884 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4905 <td class="msource">
4906 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4910 <tr class="method-row expandable config-row-alt1">
4911 <td class="micon"><a class="exi" href="#expand"> </a></td>
4914 <a id="Roo.form.Field-event-*specialkey"></a>
4916 <div class="fixedFont">
4917 <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>)
4923 <div class="short">Fires when any key related to navigation (arrows, tab, enter, esc, etc.
4929 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.
4935 <dl class="detailList">
4936 <dt class="heading">Parameters:</dt>
4939 <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>
4945 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
4948 <dd>The event object</dd>
4966 <td class="msource">
4967 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
4971 <tr class="method-row expandable config-row-alt0">
4972 <td class="micon"><a class="exi" href="#expand"> </a></td>
4975 <a id="Roo.form.Field-event-*valid"></a>
4977 <div class="fixedFont">
4978 <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>)
4984 <div class="short">Fires after the field has been validated with no errors.
4990 Fires after the field has been validated with no errors.
4996 <dl class="detailList">
4997 <dt class="heading">Parameters:</dt>
5000 <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>
5021 <td class="msource">
5022 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
5033 <!-- ============================== footer ================================= -->
5034 <div class="fineprint" style="clear:both">
5036 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Apr 01 2011 15:13:00 GMT+0800 (HKT)
5038 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>