1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.form.Field</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.form.Field-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.form.Field-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.form.Field-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.form.Field-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.form.Field
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.form</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_form_Field.js.html">Roo/form/Field.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">Field</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 Base class for form fields that provides default event handling, sizing, value handling and other functionality.
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.form.Field';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo.form" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.form.Field.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.form.Field-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0 notInherited">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
131 <a id="Roo.form.Field-cfg-autoCreate" name=".autoCreate"></a>
132 <div class="fixedFont">
133 <b class="itemname">autoCreate</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object
139 <div class="short">A DomHelper element spec, or true for a default element spec (defaults to<br/>{tag: "input", type: "text", size: "20", autocomplete: "off"})</div>
143 <div class="long">A DomHelper element spec, or true for a default element spec (defaults to<br/>{tag: "input", type: "text", size: "20", autocomplete: "off"})</div>
157 <tr class="config-row expandable config-row-alt1 notInherited">
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
161 <a id="Roo.form.Field-cfg-cls" name=".cls"></a>
162 <div class="fixedFont">
163 <b class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
169 <div class="short">A CSS class to apply to the field's underlying element.</div>
173 <div class="long">A CSS class to apply to the field's underlying element.</div>
187 <tr class="config-row expandable config-row-alt0 notInherited">
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
191 <a id="Roo.form.Field-cfg-disabled" name=".disabled"></a>
192 <div class="fixedFont">
193 <b class="itemname">disabled</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
199 <div class="short">True to disable the field (defaults to false).</div>
203 <div class="long">True to disable the field (defaults to false).</div>
217 <tr class="config-row expandable config-row-alt1 notInherited">
218 <td class="micon"><a class="exi" href="#expand"> </a></td>
221 <a id="Roo.form.Field-cfg-fieldClass" name=".fieldClass"></a>
222 <div class="fixedFont">
223 <b class="itemname">fieldClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
229 <div class="short">The default CSS class for the field (defaults to "x-form-field")</div>
233 <div class="long">The default CSS class for the field (defaults to "x-form-field")</div>
247 <tr class="config-row expandable config-row-alt0 notInherited">
248 <td class="micon"><a class="exi" href="#expand"> </a></td>
251 <a id="Roo.form.Field-cfg-fieldLabel" name=".fieldLabel"></a>
252 <div class="fixedFont">
253 <b class="itemname">fieldLabel</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
259 <div class="short">Label to use when rendering a form.</div>
263 <div class="long">Label to use when rendering a form.</div>
277 <tr class="config-row expandable config-row-alt1 notInherited">
278 <td class="micon"><a class="exi" href="#expand"> </a></td>
281 <a id="Roo.form.Field-cfg-focusClass" name=".focusClass"></a>
282 <div class="fixedFont">
283 <b class="itemname">focusClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
289 <div class="short">The CSS class to use when the field receives focus (defaults to "x-form-focus")</div>
293 <div class="long">The CSS class to use when the field receives focus (defaults to "x-form-focus")</div>
307 <tr class="config-row expandable config-row-alt0 notInherited">
308 <td class="micon"><a class="exi" href="#expand"> </a></td>
311 <a id="Roo.form.Field-cfg-inputType" name=".inputType"></a>
312 <div class="fixedFont">
313 <b class="itemname">inputType</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
319 <div class="short">The type attribute for input fields -- e.g.</div>
323 <div class="long">The type attribute for input fields -- e.g. radio, text, password (defaults to "text").</div>
337 <tr class="config-row expandable config-row-alt1 notInherited">
338 <td class="micon"><a class="exi" href="#expand"> </a></td>
341 <a id="Roo.form.Field-cfg-invalidClass" name=".invalidClass"></a>
342 <div class="fixedFont">
343 <b class="itemname">invalidClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
349 <div class="short">The CSS class to use when marking a field invalid (defaults to "x-form-invalid")</div>
353 <div class="long">The CSS class to use when marking a field invalid (defaults to "x-form-invalid")</div>
367 <tr class="config-row expandable config-row-alt0 notInherited">
368 <td class="micon"><a class="exi" href="#expand"> </a></td>
371 <a id="Roo.form.Field-cfg-invalidText" name=".invalidText"></a>
372 <div class="fixedFont">
373 <b class="itemname">invalidText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
379 <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>
383 <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>
397 <tr class="config-row expandable config-row-alt1 notInherited">
398 <td class="micon"><a class="exi" href="#expand"> </a></td>
401 <a id="Roo.form.Field-cfg-msgFx" name=".msgFx"></a>
402 <div class="fixedFont">
403 <b class="itemname">msgFx</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
409 <div class="short"><b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').</div>
413 <div class="long"><b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').</div>
427 <tr class="config-row expandable config-row-alt0 notInherited">
428 <td class="micon"><a class="exi" href="#expand"> </a></td>
431 <a id="Roo.form.Field-cfg-msgTarget" name=".msgTarget"></a>
432 <div class="fixedFont">
433 <b class="itemname">msgTarget</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
439 <div class="short">The location where error text should display.</div>
443 <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>
457 <tr class="config-row expandable config-row-alt1 notInherited">
458 <td class="micon"><a class="exi" href="#expand"> </a></td>
461 <a id="Roo.form.Field-cfg-name" name=".name"></a>
462 <div class="fixedFont">
463 <b class="itemname">name</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
469 <div class="short">The field's HTML name attribute.</div>
473 <div class="long">The field's HTML name attribute.</div>
487 <tr class="config-row expandable config-row-alt0 notInherited">
488 <td class="micon"><a class="exi" href="#expand"> </a></td>
491 <a id="Roo.form.Field-cfg-qtip" name=".qtip"></a>
492 <div class="fixedFont">
493 <b class="itemname">qtip</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
499 <div class="short">Mouse over tip</div>
503 <div class="long">Mouse over tip</div>
517 <tr class="config-row expandable config-row-alt1 notInherited">
518 <td class="micon"><a class="exi" href="#expand"> </a></td>
521 <a id="Roo.form.Field-cfg-readOnly" name=".readOnly"></a>
522 <div class="fixedFont">
523 <b class="itemname">readOnly</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
529 <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>
533 <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>
547 <tr class="config-row expandable config-row-alt0 notInherited">
548 <td class="micon"><a class="exi" href="#expand"> </a></td>
551 <a id="Roo.form.Field-cfg-tabIndex" name=".tabIndex"></a>
552 <div class="fixedFont">
553 <b class="itemname">tabIndex</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
559 <div class="short">The tabIndex for this field.</div>
563 <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>
577 <tr class="config-row expandable config-row-alt1 notInherited">
578 <td class="micon"><a class="exi" href="#expand"> </a></td>
581 <a id="Roo.form.Field-cfg-validateOnBlur" name=".validateOnBlur"></a>
582 <div class="fixedFont">
583 <b class="itemname">validateOnBlur</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
589 <div class="short">Whether the field should validate when it loses focus (defaults to true).</div>
593 <div class="long">Whether the field should validate when it loses focus (defaults to true).</div>
607 <tr class="config-row expandable config-row-alt0 notInherited">
608 <td class="micon"><a class="exi" href="#expand"> </a></td>
611 <a id="Roo.form.Field-cfg-validationDelay" name=".validationDelay"></a>
612 <div class="fixedFont">
613 <b class="itemname">validationDelay</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
619 <div class="short">The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)</div>
623 <div class="long">The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)</div>
637 <tr class="config-row expandable config-row-alt1 notInherited">
638 <td class="micon"><a class="exi" href="#expand"> </a></td>
641 <a id="Roo.form.Field-cfg-validationEvent" name=".validationEvent"></a>
642 <div class="fixedFont">
643 <b class="itemname">validationEvent</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Boolean
649 <div class="short">The event that should initiate field validation.</div>
653 <div class="long">The event that should initiate field validation. Set to false to disable<br/> automatic validation (defaults to "keyup").</div>
667 <tr class="config-row expandable config-row-alt0 notInherited">
668 <td class="micon"><a class="exi" href="#expand"> </a></td>
671 <a id="Roo.form.Field-cfg-value" name=".value"></a>
672 <div class="fixedFont">
673 <b class="itemname">value</b> : Mixed
679 <div class="short">A value to initialize this field with.</div>
683 <div class="long">A value to initialize this field with.</div>
707 <!-- ============================== public properties ==================== -->
711 <a id="Roo.form.Field-props"></a>
717 <table cellspacing="0" class="member-table">
718 <caption class="Empty">Public Properties - Has None</caption>
724 <!-- ============================== methods summary / details ======================== -->
727 <a id="Roo.form.Field-methods"></a>
728 <!-- constructor?? -->
735 <!-- then dynamics first -->
742 <table cellspacing="0" class="member-table">
743 <caption>Public Methods</caption>
745 <th class="sig-header" colspan="2">Method</th>
746 <th class="msource-header">Defined By</th>
756 <tr class="method-row config-row-alt0 expandable notInherited">
757 <td class="micon"><a class="exi" href="#expand"> </a></td>
761 <a id="Roo.form-method-Field" name=".Field"></a>
762 <div class="fixedFont">
763 <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">Field</b>
765 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
773 <div class="short">Create a new Roo.form.Field</div>
780 Create a new Roo.form.Field
783 <dl class="detailList">
784 <dt class="heading">Parameters:</dt>
787 <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>
790 <dd>Configuration options</dd>
814 <tr class="method-row config-row-alt1 expandable notInherited">
815 <td class="micon"><a class="exi" href="#expand"> </a></td>
819 <a id="Roo.form.Field-method-applyTo" name=".applyTo"></a>
820 <div class="fixedFont">
821 <span class="attributes"></span><b class="itemname">applyTo</b>
823 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>)
829 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
838 <div class="short">Apply the behaviors of this component to an existing element.</div>
844 Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>
851 <dl class="detailList">
852 <dt class="heading">Parameters:</dt>
855 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
858 <dd>The id of the node, a DOM node or an existing Element</dd>
866 <dl class="detailList">
867 <dt class="heading">Returns:</dt>
869 <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>
891 <tr class="method-row config-row-alt0 expandable notInherited">
892 <td class="micon"><a class="exi" href="#expand"> </a></td>
896 <a id="Roo.form.Field-method-clearInvalid" name=".clearInvalid"></a>
897 <div class="fixedFont">
898 <span class="attributes"></span><b class="itemname">clearInvalid</b>
907 <div class="short">Clear any invalid styles/messages for this field</div>
913 Clear any invalid styles/messages for this field
942 <tr class="method-row config-row-alt1 expandable notInherited">
943 <td class="micon"><a class="exi" href="#expand"> </a></td>
947 <a id="Roo.form.Field-method-getName" name=".getName"></a>
948 <div class="fixedFont">
949 <span class="attributes"></span><b class="itemname">getName</b>
957 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
966 <div class="short">Returns the name attribute of the field if available</div>
972 Returns the name attribute of the field if available
983 <dl class="detailList">
984 <dt class="heading">Returns:</dt>
986 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> name The field name</dd>
1000 <td class="msource">
1008 <tr class="method-row config-row-alt0 expandable notInherited">
1009 <td class="micon"><a class="exi" href="#expand"> </a></td>
1013 <a id="Roo.form.Field-method-getRawValue" name=".getRawValue"></a>
1014 <div class="fixedFont">
1015 <span class="attributes"></span><b class="itemname">getRawValue</b>
1032 <div class="short">Returns the raw data value which may or may not be a valid, defined value.</div>
1038 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>}.
1049 <dl class="detailList">
1050 <dt class="heading">Returns:</dt>
1052 <dd><span class="fixedFont">Mixed</span> value The field value</dd>
1066 <td class="msource">
1074 <tr class="method-row config-row-alt1 expandable notInherited">
1075 <td class="micon"><a class="exi" href="#expand"> </a></td>
1079 <a id="Roo.form.Field-method-getValue" name=".getValue"></a>
1080 <div class="fixedFont">
1081 <span class="attributes"></span><b class="itemname">getValue</b>
1098 <div class="short">Returns the normalized data value (undefined or emptyText will be returned as '').</div>
1104 Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {<b>link</b> <b>getRawValue</b>}.
1115 <dl class="detailList">
1116 <dt class="heading">Returns:</dt>
1118 <dd><span class="fixedFont">Mixed</span> value The field value</dd>
1132 <td class="msource">
1140 <tr class="method-row config-row-alt0 expandable notInherited">
1141 <td class="micon"><a class="exi" href="#expand"> </a></td>
1145 <a id="Roo.form.Field-method-isDirty" name=".isDirty"></a>
1146 <div class="fixedFont">
1147 <span class="attributes"></span><b class="itemname">isDirty</b>
1156 <div class="short">Returns true if this field has been changed since it was originally loaded and is not disabled.</div>
1162 Returns true if this field has been changed since it was originally loaded and is not disabled.
1183 <td class="msource">
1191 <tr class="method-row config-row-alt1 expandable notInherited">
1192 <td class="micon"><a class="exi" href="#expand"> </a></td>
1196 <a id="Roo.form.Field-method-isValid" name=".isValid"></a>
1197 <div class="fixedFont">
1198 <span class="attributes"></span><b class="itemname">isValid</b>
1200 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>preventMark</i></B>)
1206 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1215 <div class="short">Returns whether or not the field value is currently valid</div>
1221 Returns whether or not the field value is currently valid
1228 <dl class="detailList">
1229 <dt class="heading">Parameters:</dt>
1232 <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>
1235 <dd>True to disable marking the field invalid</dd>
1243 <dl class="detailList">
1244 <dt class="heading">Returns:</dt>
1246 <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>
1260 <td class="msource">
1268 <tr class="method-row config-row-alt0 expandable notInherited">
1269 <td class="micon"><a class="exi" href="#expand"> </a></td>
1273 <a id="Roo.form.Field-method-markInvalid" name=".markInvalid"></a>
1274 <div class="fixedFont">
1275 <span class="attributes"></span><b class="itemname">markInvalid</b>
1277 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>msg</i></B>)
1284 <div class="short">Mark this field as invalid</div>
1290 Mark this field as invalid
1297 <dl class="detailList">
1298 <dt class="heading">Parameters:</dt>
1301 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>msg</b>
1304 <dd>The validation message</dd>
1322 <td class="msource">
1330 <tr class="method-row config-row-alt1 expandable notInherited">
1331 <td class="micon"><a class="exi" href="#expand"> </a></td>
1335 <a id="Roo.form.Field-method-reset" name=".reset"></a>
1336 <div class="fixedFont">
1337 <span class="attributes"></span><b class="itemname">reset</b>
1346 <div class="short">Resets the current field value to the originally loaded value and clears any validation messages</div>
1352 Resets the current field value to the originally loaded value and clears any validation messages
1373 <td class="msource">
1381 <tr class="method-row config-row-alt0 expandable notInherited">
1382 <td class="micon"><a class="exi" href="#expand"> </a></td>
1386 <a id="Roo.form.Field-method-setRawValue" name=".setRawValue"></a>
1387 <div class="fixedFont">
1388 <span class="attributes"></span><b class="itemname">setRawValue</b>
1390 (Mixed <B><i>value</i></B>)
1397 <div class="short">Sets the underlying DOM field's value directly, bypassing validation.</div>
1403 Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {<b>link</b> <b>setValue</b>}.
1410 <dl class="detailList">
1411 <dt class="heading">Parameters:</dt>
1414 <span class="fixedFont">Mixed</span> <b>value</b>
1417 <dd>The value to set</dd>
1435 <td class="msource">
1443 <tr class="method-row config-row-alt1 expandable notInherited">
1444 <td class="micon"><a class="exi" href="#expand"> </a></td>
1448 <a id="Roo.form.Field-method-setValue" name=".setValue"></a>
1449 <div class="fixedFont">
1450 <span class="attributes"></span><b class="itemname">setValue</b>
1452 (Mixed <B><i>value</i></B>)
1459 <div class="short">Sets a data value into the field and validates it.</div>
1465 Sets a data value into the field and validates it. To set the value directly without validation see {<b>link</b> <b>setRawValue</b>}.
1472 <dl class="detailList">
1473 <dt class="heading">Parameters:</dt>
1476 <span class="fixedFont">Mixed</span> <b>value</b>
1479 <dd>The value to set</dd>
1497 <td class="msource">
1505 <tr class="method-row config-row-alt0 expandable notInherited">
1506 <td class="micon"><a class="exi" href="#expand"> </a></td>
1510 <a id="Roo.form.Field-method-validate" name=".validate"></a>
1511 <div class="fixedFont">
1512 <span class="attributes"></span><b class="itemname">validate</b>
1520 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1529 <div class="short">Validates the field value</div>
1535 Validates the field value
1546 <dl class="detailList">
1547 <dt class="heading">Returns:</dt>
1549 <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>
1563 <td class="msource">
1574 <!-- ============================== events summary / details ======================== -->
1577 <a id="Roo.form.Field-events"></a>
1586 <table cellspacing="0" class="member-table">
1587 <caption>Events</caption>
1590 <th class="sig-header" colspan="2">Event</th>
1591 <th class="msource-header">Defined By</th>
1600 <tr class="method-row expandable config-row-alt0 notInherited">
1601 <td class="micon"><a class="exi" href="#expand"> </a></td>
1604 <a id="Roo.form.Field-event-*blur"></a>
1606 <div class="fixedFont">
1607 <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>)
1613 <div class="short">Fires when this field loses input focus.
1619 Fires when this field loses input focus.
1625 <dl class="detailList">
1626 <dt class="heading">Parameters:</dt>
1629 <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>
1650 <td class="msource">
1655 <tr class="method-row expandable config-row-alt1 notInherited">
1656 <td class="micon"><a class="exi" href="#expand"> </a></td>
1659 <a id="Roo.form.Field-event-*change"></a>
1661 <div class="fixedFont">
1662 <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>)
1668 <div class="short">Fires just before the field blurs if the field value has changed.
1674 Fires just before the field blurs if the field value has changed.
1680 <dl class="detailList">
1681 <dt class="heading">Parameters:</dt>
1684 <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>
1690 <span class="fixedFont">Mixed</span> <b>newValue</b>
1693 <dd>The new value</dd>
1696 <span class="fixedFont">Mixed</span> <b>oldValue</b>
1699 <dd>The original value</dd>
1717 <td class="msource">
1722 <tr class="method-row expandable config-row-alt0 notInherited">
1723 <td class="micon"><a class="exi" href="#expand"> </a></td>
1726 <a id="Roo.form.Field-event-*focus"></a>
1728 <div class="fixedFont">
1729 <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>)
1735 <div class="short">Fires when this field receives input focus.
1741 Fires when this field receives input focus.
1747 <dl class="detailList">
1748 <dt class="heading">Parameters:</dt>
1751 <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>
1772 <td class="msource">
1777 <tr class="method-row expandable config-row-alt1 notInherited">
1778 <td class="micon"><a class="exi" href="#expand"> </a></td>
1781 <a id="Roo.form.Field-event-*invalid"></a>
1783 <div class="fixedFont">
1784 <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>)
1790 <div class="short">Fires after the field has been marked as invalid.
1796 Fires after the field has been marked as invalid.
1802 <dl class="detailList">
1803 <dt class="heading">Parameters:</dt>
1806 <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>
1812 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>msg</b>
1815 <dd>The validation message</dd>
1833 <td class="msource">
1838 <tr class="method-row expandable config-row-alt0 notInherited">
1839 <td class="micon"><a class="exi" href="#expand"> </a></td>
1842 <a id="Roo.form.Field-event-*specialkey"></a>
1844 <div class="fixedFont">
1845 <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>)
1851 <div class="short">Fires when any key related to navigation (arrows, tab, enter, esc, etc.
1857 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.
1863 <dl class="detailList">
1864 <dt class="heading">Parameters:</dt>
1867 <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>
1873 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
1876 <dd>The event object</dd>
1894 <td class="msource">
1899 <tr class="method-row expandable config-row-alt1 notInherited">
1900 <td class="micon"><a class="exi" href="#expand"> </a></td>
1903 <a id="Roo.form.Field-event-*valid"></a>
1905 <div class="fixedFont">
1906 <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>)
1912 <div class="short">Fires after the field has been validated with no errors.
1918 Fires after the field has been validated with no errors.
1924 <dl class="detailList">
1925 <dt class="heading">Parameters:</dt>
1928 <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>
1949 <td class="msource">
1961 <!-- ============================== footer ================================= -->
1962 <div class="fineprint" style="clear:both">
1964 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 15:55:27 GMT+0800 (HKT)
1966 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>