Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.form.field.Base.html
1 <!DOCTYPE html><html><head><title>Ext.form.field.Base | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
2 <style type="text/css">.head-band { display: none; }
3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
4 .doc-tab .members .member a.more { background-color: #efefef; }
5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit 
7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
8
9     req = {
10         liveURL: '.',
11         standAloneMode: true,
12         origDocClass: 'Ext.form.field.Base',
13         docClass: 'Ext.form.field.Base',
14         docReq: 'Ext.form.field.Base',
15         version: '4.0',
16         baseURL: '.',
17         baseDocURL: '.',
18         baseProdURL: '.'
19     };
20
21     clsInfo = {};
22
23
24
25 </script>
26
27 <script type="text/javascript" src="../search.js"></script>
28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
29 <script type="text/javascript" src="../class_tree.js"></script>
30 <script type="text/javascript" src="../class_doc.js"></script>
31 <script type="text/javascript">
32     req.source = 'Base.html#Ext-form.field.Base';
33     clsInfo = {"methods":["Base","addClass","addCls","addClsWithUI","addEvents","addListener","addManagedListener","addStateEvents","afterComponentLayout","alignTo","animate","applyState","batchChanges","beforeComponentLayout","bubble","capture","center","checkChange","checkDirty","clearInvalid","clearListeners","clearManagedListeners","cloneConfig","destroy","disable","doAutoRender","doComponentLayout","doConstrain","enable","enableBubble","extractFileInput","findLayoutController","findParentBy","findParentByType","fireEvent","focus","getActiveAnimation","getActiveError","getActiveErrors","getBox","getBubbleTarget","getEl","getErrors","getFieldLabel","getHeight","getId","getInputId","getInsertPosition","getLoader","getModelData","getName","getPlugin","getPosition","getRawValue","getSize","getState","getStateId","getSubmitData","getSubmitValue","getValue","getWidth","getXType","getXTypes","hasActiveError","hasListener","hasUICls","hide","initField","initLabelable","is","isDescendantOf","isDirty","isDisabled","isDraggable","isDroppable","isEqual","isFileUpload","isFloating","isHidden","isValid","isVisible","isXType","markInvalid","nextNode","nextSibling","observe","on","previousNode","previousSibling","processRawValue","rawToValue","relayEvents","releaseCapture","removeCls","removeClsWithUI","removeListener","removeManagedListener","reset","resetOriginalValue","resumeEvents","sequenceFx","setActive","setActiveError","setActiveErrors","setAutoScroll","setDisabled","setDocked","setFieldDefaults","setFieldStyle","setHeight","setLoading","setPagePosition","setPosition","setRawValue","setReadOnly","setSize","setUI","setValue","setVisible","setWidth","show","stopAnimation","suspendEvents","syncFx","toBack","toFront","un","unsetActiveError","up","update","updateBox","validate","validateValue","valueToRaw"],"cfgs":["activeError","activeErrorsTpl","autoEl","autoFitErrors","autoRender","autoScroll","autoShow","baseBodyCls","baseCls","border","checkChangeBuffer","checkChangeEvents","clearCls","cls","componentCls","componentLayout","contentEl","data","dirtyCls","disabled","disabledCls","draggable","errorMsgCls","fieldBodyCls","fieldCls","fieldLabel","fieldStyle","floating","focusCls","focusOnToFront","formItemCls","frame","height","hidden","hideEmptyLabel","hideLabel","hideMode","html","id","inputId","inputType","invalidCls","invalidText","itemId","labelAlign","labelCls","labelPad","labelSeparator","labelStyle","labelWidth","labelableRenderTpl","listeners","loader","maintainFlex","margin","maxHeight","maxWidth","minHeight","minWidth","msgTarget","name","overCls","padding","plugins","preventMark","readOnly","readOnlyCls","renderSelectors","renderTo","renderTpl","resizable","resizeHandles","saveBuffer","shadow","stateEvents","stateId","stateful","style","styleHtmlCls","styleHtmlContent","submitValue","tabIndex","toFrontOnShow","tpl","tplWriteMode","ui","validateOnBlur","validateOnChange","value","width"],"properties":["bodyEl","clearInvalid","draggable","errorEl","floatParent","frameSize","hasActiveFx","inputEl","isFieldLabelable","isFormField","labelEl","markInvalid","maskOnDisable","originalValue","ownerCt","rendered","stopFx","zIndexManager"],"events":["activate","added","afterrender","beforeactivate","beforedeactivate","beforedestroy","beforehide","beforerender","beforeshow","beforestaterestore","beforestatesave","blur","change","deactivate","destroy","dirtychange","disable","enable","errorchange","focus","hide","move","removed","render","resize","show","specialkey","staterestore","statesave","validitychange"],"subclasses":["Ext.form.field.Checkbox","Ext.form.field.Display","Ext.form.field.Hidden","Ext.form.field.Text","Ext.slider.Multi"]};
34     Ext.onReady(function() {
35         Ext.create('Docs.classPanel');
36     });
37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="comp"><a href="../source/Base.html#Ext-form.field.Base" target="_blank">Ext.form.field.Base</a><span>xtype: field</span></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Hierarchy</h4><div class="subclass f"><a href="Ext.AbstractComponent.html" rel="Ext.AbstractComponent" class="cls docClass">Ext.AbstractComponent</a><div class="subclass"><a href="Ext.Component.html" rel="Ext.Component" class="cls docClass">Ext.Component</a><div class="subclass"><strong>Ext.form.field.Base</strong></div></div></div><h4>Mixins</h4><div class="mixin"><a href="Ext.util.Observable.html" rel="Ext.util.Observable" class="cls docClass">Ext.util.Observable</a></div><div class="mixin"><a href="Ext.util.Animate.html" rel="Ext.util.Animate" class="cls docClass">Ext.util.Animate</a></div><div class="mixin"><a href="Ext.state.Stateful.html" rel="Ext.state.Stateful" class="cls docClass">Ext.state.Stateful</a></div><div class="mixin"><a href="Ext.util.Floating.html" rel="Ext.util.Floating" class="cls docClass">Ext.util.Floating</a></div><div class="mixin"><a href="Ext.form.Labelable.html" rel="Ext.form.Labelable" class="cls docClass">Ext.form.Labelable</a></div><div class="mixin"><a href="Ext.form.field.Field.html" rel="Ext.form.field.Field" class="cls docClass">Ext.form.field.Field</a></div></pre><p>Base class for form fields that provides default event handling, rendering, and other common functionality
38 needed by all form field types. Utilizes the <a href="Ext.form.field.Field.html" rel="Ext.form.field.Field" class="docClass">Ext.form.field.Field</a> mixin for value handling and validation,
39 and the <a href="Ext.form.Labelable.html" rel="Ext.form.Labelable" class="docClass">Ext.form.Labelable</a> mixin to provide label and error message display.</p>
40
41 <p>In most cases you will want to use a subclass, such as <a href="Ext.form.field.Text.html" rel="Ext.form.field.Text" class="docClass">Ext.form.field.Text</a> or <a href="Ext.form.field.Checkbox.html" rel="Ext.form.field.Checkbox" class="docClass">Ext.form.field.Checkbox</a>,
42 rather than creating instances of this class directly. However if you are implementing a custom form field,
43 using this as the parent class is recommended.</p>
44
45 <p><strong>Values and Conversions</strong></p>
46
47 <p>Because BaseField implements the Field mixin, it has a main value that can be initialized with the
48 <a href="Ext.form.field.Base.html#value" rel="Ext.form.field.Base#value" class="docClass">value</a> config and manipulated via the <a href="Ext.form.field.Base.html#getValue" rel="Ext.form.field.Base#getValue" class="docClass">getValue</a> and <a href="Ext.form.field.Base.html#setValue" rel="Ext.form.field.Base#setValue" class="docClass">setValue</a> methods. This main
49 value can be one of many data types appropriate to the current field, for instance a <a href="Ext.form.field.Date.html" rel="Ext.form.field.Date" class="docClass">Date</a>
50 field would use a JavaScript Date object as its value type. However, because the field is rendered as a HTML
51 input, this value data type can not always be directly used in the rendered field.</p>
52
53 <p>Therefore BaseField introduces the concept of a "raw value". This is the value of the rendered HTML input field,
54 and is normally a String. The <a href="Ext.form.field.Base.html#getRawValue" rel="Ext.form.field.Base#getRawValue" class="docClass">getRawValue</a> and <a href="Ext.form.field.Base.html#setRawValue" rel="Ext.form.field.Base#setRawValue" class="docClass">setRawValue</a> methods can be used to directly
55 work with the raw value, though it is recommended to use getValue and setValue in most cases.</p>
56
57 <p>Conversion back and forth between the main value and the raw value is handled by the <a href="Ext.form.field.Base.html#valueToRaw" rel="Ext.form.field.Base#valueToRaw" class="docClass">valueToRaw</a> and
58 <a href="Ext.form.field.Base.html#rawToValue" rel="Ext.form.field.Base#rawToValue" class="docClass">rawToValue</a> methods. If you are implementing a subclass that uses a non-String value data type, you
59 should override these methods to handle the conversion.</p>
60
61 <p><strong>Rendering</strong></p>
62
63 <p>The content of the field body is defined by the <a href="Ext.form.field.Base.html#fieldSubTpl" rel="Ext.form.field.Base#fieldSubTpl" class="docClass">fieldSubTpl</a> XTemplate, with its argument data
64 created by the <a href="Ext.form.field.Base.html#getSubTplData" rel="Ext.form.field.Base#getSubTplData" class="docClass">getSubTplData</a> method. Override this template and/or method to create custom
65 field renderings.
66 <img class="screenshot" src="../Ext.form.BaseField.png" alt="Ext.form.BaseField BaseField component" />
67 <strong>Example usage:</strong></p>
68
69 <pre class="prettyprint"><code>// A simple subclass of BaseField that creates a HTML5 search field. Redirects to the
70 // searchUrl when the Enter key is pressed.
71 Ext.define('Ext.form.SearchField', {
72     extend: 'Ext.form.field.Base',
73     alias: 'widget.searchfield',
74
75     inputType: 'search',
76
77     // Config defining the search URL
78     searchUrl: 'http://www.google.com/search?q={0}',
79
80     // Add specialkey listener
81     initComponent: function() {
82         this.callParent();
83         this.on('specialkey', this.checkEnterKey, this);
84     },
85
86     // Handle enter key presses, execute the search if the field has a value
87     checkEnterKey: function(field, e) {
88         var value = this.getValue();
89         if (e.getKey() === e.ENTER &amp;&amp; !Ext.isEmpty(value)) {
90             location.href = Ext.String.format(this.searchUrl, value);
91         }
92     }
93 });
94
95 Ext.create('Ext.form.Panel', {
96     title: 'BaseField Example',
97     bodyPadding: 5,
98     width: 250,
99
100     // Fields will be arranged vertically, stretched to full width
101     layout: 'anchor',
102     defaults: {
103         anchor: '100%'
104     },
105     items: [{
106         xtype: 'searchfield',
107         fieldLabel: 'Search',
108         name: 'query'
109     }]
110     renderTo: Ext.getBody()
111 });
112 </code></pre>
113 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">CSS Class configs</h4><div id="config-baseBodyCls" class="member f inherited"><a href="Ext.form.field.Base.html#config-baseBodyCls" rel="config-baseBodyCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-baseBodyCls" class="viewSource">view source</a></div><a name="baseBodyCls"></a><a name="config-baseBodyCls"></a><a href="Ext.form.field.Base.html#" rel="config-baseBodyCls" class="cls expand">baseBodyCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to be applied to the body content element. Defaults to 'x-form-item-body'.</p>
114 </div><div class="long"><p>The CSS class to be applied to the body content element. Defaults to 'x-form-item-body'.</p>
115 </div></div></div><div id="config-baseCls" class="member inherited"><a href="Ext.form.field.Base.html#config-baseCls" rel="config-baseCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-baseCls" class="viewSource">view source</a></div><a name="baseCls"></a><a name="config-baseCls"></a><a href="Ext.form.field.Base.html#" rel="config-baseCls" class="cls expand">baseCls</a><span> : String</span></div><div class="description"><div class="short">The base CSS class to apply to this components's element. This will also be prepended to
116 elements within this compone...</div><div class="long"><p>The base CSS class to apply to this components's element. This will also be prepended to
117 elements within this component like Panel's body will get a class x-panel-body. This means
118 that if you create a subclass of Panel, and you want it to get all the Panels styling for the
119 element and the body, you leave the baseCls x-panel and use componentCls to add specific styling for this
120 component.</p>
121 </div></div></div><div id="config-clearCls" class="member inherited"><a href="Ext.form.field.Base.html#config-clearCls" rel="config-clearCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-clearCls" class="viewSource">view source</a></div><a name="clearCls"></a><a name="config-clearCls"></a><a href="Ext.form.field.Base.html#" rel="config-clearCls" class="cls expand">clearCls</a><span> : String</span></div><div class="description"><div class="short">The CSS class to be applied to the special clearing div rendered directly after the field
122 contents wrapper to provide...</div><div class="long"><p>The CSS class to be applied to the special clearing div rendered directly after the field
123 contents wrapper to provide field clearing (defaults to <tt>'x-clear'</tt>).</p>
124 </div></div></div><div id="config-cls" class="member inherited"><a href="Ext.form.field.Base.html#config-cls" rel="config-cls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-cls" class="viewSource">view source</a></div><a name="cls"></a><a name="config-cls"></a><a href="Ext.form.field.Base.html#" rel="config-cls" class="cls expand">cls</a><span> : String</span></div><div class="description"><div class="short">An optional extra CSS class that will be added to this component's Element (defaults to '').  This can be
125 useful for ...</div><div class="long"><p>An optional extra CSS class that will be added to this component's Element (defaults to '').  This can be
126 useful for adding customized styles to the component or any of its children using standard CSS rules.</p>
127 </div></div></div><div id="config-componentCls" class="member inherited"><a href="Ext.form.field.Base.html#config-componentCls" rel="config-componentCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-componentCls" class="viewSource">view source</a></div><a name="componentCls"></a><a name="config-componentCls"></a><a href="Ext.form.field.Base.html#" rel="config-componentCls" class="cls expand">componentCls</a><span> : String</span></div><div class="description"><div class="short"><p>CSS Class to be added to a components root level element to give distinction to it
128 via styling.</p>
129 </div><div class="long"><p>CSS Class to be added to a components root level element to give distinction to it
130 via styling.</p>
131 </div></div></div><div id="config-dirtyCls" class="member ni"><a href="Ext.form.field.Base.html#config-dirtyCls" rel="config-dirtyCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-dirtyCls" class="viewSource">view source</a></div><a name="dirtyCls"></a><a name="config-dirtyCls"></a><a href="Ext.form.field.Base.html#" rel="config-dirtyCls" class="cls expand">dirtyCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to use when the field value <a href="Ext.form.field.Base.html#isDirty" rel="Ext.form.field.Base#isDirty" class="docClass">is dirty</a>.</p>
132 </div><div class="long"><p>The CSS class to use when the field value <a href="Ext.form.field.Base.html#isDirty" rel="Ext.form.field.Base#isDirty" class="docClass">is dirty</a>.</p>
133 </div></div></div><div id="config-disabledCls" class="member inherited"><a href="Ext.form.field.Base.html#config-disabledCls" rel="config-disabledCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-disabledCls" class="viewSource">view source</a></div><a name="disabledCls"></a><a name="config-disabledCls"></a><a href="Ext.form.field.Base.html#" rel="config-disabledCls" class="cls expand">disabledCls</a><span> : String</span></div><div class="description"><div class="short"><p>CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.</p>
134 </div><div class="long"><p>CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.</p>
135 </div></div></div><div id="config-errorMsgCls" class="member inherited"><a href="Ext.form.field.Base.html#config-errorMsgCls" rel="config-errorMsgCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-errorMsgCls" class="viewSource">view source</a></div><a name="errorMsgCls"></a><a name="config-errorMsgCls"></a><a href="Ext.form.field.Base.html#" rel="config-errorMsgCls" class="cls expand">errorMsgCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to be applied to the error message element. Defaults to 'x-form-error-msg'.</p>
136 </div><div class="long"><p>The CSS class to be applied to the error message element. Defaults to 'x-form-error-msg'.</p>
137 </div></div></div><div id="config-fieldBodyCls" class="member inherited"><a href="Ext.form.field.Base.html#config-fieldBodyCls" rel="config-fieldBodyCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-fieldBodyCls" class="viewSource">view source</a></div><a name="fieldBodyCls"></a><a name="config-fieldBodyCls"></a><a href="Ext.form.field.Base.html#" rel="config-fieldBodyCls" class="cls expand">fieldBodyCls</a><span> : String</span></div><div class="description"><div class="short"><p>An extra CSS class to be applied to the body content element in addition to <a href="Ext.form.field.Base.html#fieldBodyCls" rel="Ext.form.field.Base#fieldBodyCls" class="docClass">fieldBodyCls</a>.
138 Defaults to empty.</p>
139 </div><div class="long"><p>An extra CSS class to be applied to the body content element in addition to <a href="Ext.form.field.Base.html#fieldBodyCls" rel="Ext.form.field.Base#fieldBodyCls" class="docClass">fieldBodyCls</a>.
140 Defaults to empty.</p>
141 </div></div></div><div id="config-fieldCls" class="member ni"><a href="Ext.form.field.Base.html#config-fieldCls" rel="config-fieldCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-fieldCls" class="viewSource">view source</a></div><a name="fieldCls"></a><a name="config-fieldCls"></a><a href="Ext.form.field.Base.html#" rel="config-fieldCls" class="cls expand">fieldCls</a><span> : String</span></div><div class="description"><div class="short"><p>The default CSS class for the field input (defaults to 'x-form-field')</p>
142 </div><div class="long"><p>The default CSS class for the field input (defaults to 'x-form-field')</p>
143 </div></div></div><div id="config-focusCls" class="member ni"><a href="Ext.form.field.Base.html#config-focusCls" rel="config-focusCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-focusCls" class="viewSource">view source</a></div><a name="focusCls"></a><a name="config-focusCls"></a><a href="Ext.form.field.Base.html#" rel="config-focusCls" class="cls expand">focusCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to use when the field receives focus (defaults to 'x-form-focus')</p>
144 </div><div class="long"><p>The CSS class to use when the field receives focus (defaults to 'x-form-focus')</p>
145 </div></div></div><div id="config-formItemCls" class="member inherited"><a href="Ext.form.field.Base.html#config-formItemCls" rel="config-formItemCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-formItemCls" class="viewSource">view source</a></div><a name="formItemCls"></a><a name="config-formItemCls"></a><a href="Ext.form.field.Base.html#" rel="config-formItemCls" class="cls expand">formItemCls</a><span> : String</span></div><div class="description"><div class="short">A CSS class to be applied to the outermost element to denote that it is participating in the form
146 field layout. Defau...</div><div class="long"><p>A CSS class to be applied to the outermost element to denote that it is participating in the form
147 field layout. Defaults to 'x-form-item'.</p>
148 </div></div></div><div id="config-invalidCls" class="member inherited"><a href="Ext.form.field.Base.html#config-invalidCls" rel="config-invalidCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-invalidCls" class="viewSource">view source</a></div><a name="invalidCls"></a><a name="config-invalidCls"></a><a href="Ext.form.field.Base.html#" rel="config-invalidCls" class="cls expand">invalidCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to use when marking the component invalid (defaults to 'x-form-invalid')</p>
149 </div><div class="long"><p>The CSS class to use when marking the component invalid (defaults to 'x-form-invalid')</p>
150 </div></div></div><div id="config-labelCls" class="member inherited"><a href="Ext.form.field.Base.html#config-labelCls" rel="config-labelCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-labelCls" class="viewSource">view source</a></div><a name="labelCls"></a><a name="config-labelCls"></a><a href="Ext.form.field.Base.html#" rel="config-labelCls" class="cls expand">labelCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to be applied to the label element. Defaults to 'x-form-item-label'.</p>
151 </div><div class="long"><p>The CSS class to be applied to the label element. Defaults to 'x-form-item-label'.</p>
152 </div></div></div><div id="config-overCls" class="member inherited"><a href="Ext.form.field.Base.html#config-overCls" rel="config-overCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-overCls" class="viewSource">view source</a></div><a name="overCls"></a><a name="config-overCls"></a><a href="Ext.form.field.Base.html#" rel="config-overCls" class="cls expand">overCls</a><span> : String</span></div><div class="description"><div class="short">An optional extra CSS class that will be added to this component's Element when the mouse moves
153 over the Element, and...</div><div class="long"><p>An optional extra CSS class that will be added to this component's Element when the mouse moves
154 over the Element, and removed when the mouse moves out. (defaults to '').  This can be
155 useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.</p>
156 </div></div></div><div id="config-readOnlyCls" class="member ni"><a href="Ext.form.field.Base.html#config-readOnlyCls" rel="config-readOnlyCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-readOnlyCls" class="viewSource">view source</a></div><a name="readOnlyCls"></a><a name="config-readOnlyCls"></a><a href="Ext.form.field.Base.html#" rel="config-readOnlyCls" class="cls expand">readOnlyCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class applied to the component's main element when it is <a href="Ext.form.field.Base.html#readOnly" rel="Ext.form.field.Base#readOnly" class="docClass">readOnly</a>.</p>
157 </div><div class="long"><p>The CSS class applied to the component's main element when it is <a href="Ext.form.field.Base.html#readOnly" rel="Ext.form.field.Base#readOnly" class="docClass">readOnly</a>.</p>
158 </div></div></div><div id="config-styleHtmlCls" class="member inherited"><a href="Ext.form.field.Base.html#config-styleHtmlCls" rel="config-styleHtmlCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-styleHtmlCls" class="viewSource">view source</a></div><a name="styleHtmlCls"></a><a name="config-styleHtmlCls"></a><a href="Ext.form.field.Base.html#" rel="config-styleHtmlCls" class="cls expand">styleHtmlCls</a><span> : String</span></div><div class="description"><div class="short"><p>The class that is added to the content target when you set styleHtmlContent to true.
159 Defaults to 'x-html'</p>
160 </div><div class="long"><p>The class that is added to the content target when you set styleHtmlContent to true.
161 Defaults to 'x-html'</p>
162 </div></div></div><h4 class="cfgGroup">Other Configs</h4><div id="config-activeError" class="member f inherited"><a href="Ext.form.field.Base.html#config-activeError" rel="config-activeError" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-activeError" class="viewSource">view source</a></div><a name="activeError"></a><a name="config-activeError"></a><a href="Ext.form.field.Base.html#" rel="config-activeError" class="cls expand">activeError</a><span> : String</span></div><div class="description"><div class="short">If specified, then the component will be displayed with this value as its active error when
163 first rendered. Defaults ...</div><div class="long"><p>If specified, then the component will be displayed with this value as its active error when
164 first rendered. Defaults to undefined. Use <a href="Ext.form.field.Base.html#setActiveError" rel="Ext.form.field.Base#setActiveError" class="docClass">setActiveError</a> or <a href="Ext.form.field.Base.html#unsetActiveError" rel="Ext.form.field.Base#unsetActiveError" class="docClass">unsetActiveError</a> to
165 change it after component creation.</p>
166 </div></div></div><div id="config-activeErrorsTpl" class="member inherited"><a href="Ext.form.field.Base.html#config-activeErrorsTpl" rel="config-activeErrorsTpl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-activeErrorsTpl" class="viewSource">view source</a></div><a name="activeErrorsTpl"></a><a name="config-activeErrorsTpl"></a><a href="Ext.form.field.Base.html#" rel="config-activeErrorsTpl" class="cls expand">activeErrorsTpl</a><span> : Ext.XTemplate</span></div><div class="description"><div class="short">The template used to format the Array of error messages passed to setActiveErrors
167 into a single HTML string. By defau...</div><div class="long"><p>The template used to format the Array of error messages passed to <a href="Ext.form.field.Base.html#setActiveErrors" rel="Ext.form.field.Base#setActiveErrors" class="docClass">setActiveErrors</a>
168 into a single HTML string. By default this renders each message as an item in an unordered list.</p>
169 </div></div></div><div id="config-autoEl" class="member inherited"><a href="Ext.form.field.Base.html#config-autoEl" rel="config-autoEl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-autoEl" class="viewSource">view source</a></div><a name="autoEl"></a><a name="config-autoEl"></a><a href="Ext.form.field.Base.html#" rel="config-autoEl" class="cls expand">autoEl</a><span> : Mixed</span></div><div class="description"><div class="short">A tag name or DomHelper spec used to create the Element which will
170 encapsulate this Component.
171
172
173 You do not normally ...</div><div class="long"><p>A tag name or <a href="Ext.core.DomHelper.html" rel="Ext.core.DomHelper" class="docClass">DomHelper</a> spec used to create the <a href="Ext.form.field.Base.html#getEl" rel="Ext.form.field.Base#getEl" class="docClass">Element</a> which will
174 encapsulate this Component.</p>
175
176
177 <p>You do not normally need to specify this. For the base classes <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> and <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Ext.container.Container</a>,
178 this defaults to <b><tt>'div'</tt></b>. The more complex Sencha classes use a more complex
179 DOM structure specified by their own <a href="Ext.form.field.Base.html#renderTpl" rel="Ext.form.field.Base#renderTpl" class="docClass">renderTpl</a>s.</p>
180
181
182 <p>This is intended to allow the developer to create application-specific utility Components encapsulated by
183 different DOM elements. Example usage:</p>
184
185
186 <pre><code>{
187     xtype: 'component',
188     autoEl: {
189         tag: 'img',
190         src: 'http://www.example.com/example.jpg'
191     }
192 }, {
193     xtype: 'component',
194     autoEl: {
195         tag: 'blockquote',
196         html: 'autoEl is cool!'
197     }
198 }, {
199     xtype: 'container',
200     autoEl: 'ul',
201     cls: 'ux-unordered-list',
202     items: {
203         xtype: 'component',
204         autoEl: 'li',
205         html: 'First list item'
206     }
207 }
208 </code></pre>
209
210 </div></div></div><div id="config-autoFitErrors" class="member inherited"><a href="Ext.form.field.Base.html#config-autoFitErrors" rel="config-autoFitErrors" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-autoFitErrors" class="viewSource">view source</a></div><a name="autoFitErrors"></a><a name="config-autoFitErrors"></a><a href="Ext.form.field.Base.html#" rel="config-autoFitErrors" class="cls expand">autoFitErrors</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Whether to adjust the component's body area to make room for 'side' or 'under'
211 <a href="Ext.form.field.Base.html#msgTarget" rel="Ext.form.field.Base#msgTarget" class="docClass">error messages</a>. Defaults to <tt>true</tt>.</p>
212 </div><div class="long"><p>Whether to adjust the component's body area to make room for 'side' or 'under'
213 <a href="Ext.form.field.Base.html#msgTarget" rel="Ext.form.field.Base#msgTarget" class="docClass">error messages</a>. Defaults to <tt>true</tt>.</p>
214 </div></div></div><div id="config-autoRender" class="member inherited"><a href="Ext.form.field.Base.html#config-autoRender" rel="config-autoRender" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-autoRender" class="viewSource">view source</a></div><a name="autoRender"></a><a name="config-autoRender"></a><a href="Ext.form.field.Base.html#" rel="config-autoRender" class="cls expand">autoRender</a><span> : Mixed</span></div><div class="description"><div class="short">This config is intended mainly for floating Components which may or may not be shown. Instead
215 of using renderTo in th...</div><div class="long"><p>This config is intended mainly for <a href="Ext.form.field.Base.html#floating" rel="Ext.form.field.Base#floating" class="docClass">floating</a> Components which may or may not be shown. Instead
216 of using <a href="Ext.form.field.Base.html#renderTo" rel="Ext.form.field.Base#renderTo" class="docClass">renderTo</a> in the configuration, and rendering upon construction, this allows a Component
217 to render itself upon first <i><a href="Ext.form.field.Base.html#show" rel="Ext.form.field.Base#show" class="docClass">show</a></i>.</p>
218
219
220 <p>Specify as <code>true</code> to have this Component render to the document body upon first show.</p>
221
222
223 <p>Specify as an element, or the ID of an element to have this Component render to a specific element upon first show.</p>
224
225
226 <p><b>This defaults to <code>true</code> for the <a href="Ext.window.Window.html" rel="Ext.window.Window" class="docClass">Window</a> class.</b></p>
227
228 </div></div></div><div id="config-autoScroll" class="member inherited"><a href="Ext.form.field.Base.html#config-autoScroll" rel="config-autoScroll" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-autoScroll" class="viewSource">view source</a></div><a name="autoScroll"></a><a name="config-autoScroll"></a><a href="Ext.form.field.Base.html#" rel="config-autoScroll" class="cls expand">autoScroll</a><span> : Boolean</span></div><div class="description"><div class="short">true to use overflow:'auto' on the components layout element and show scroll bars automatically when
229 necessary, false...</div><div class="long"><p><code>true</code> to use overflow:'auto' on the components layout element and show scroll bars automatically when
230 necessary, <code>false</code> to clip any overflowing content (defaults to <code>false</code>).</p>
231 </div></div></div><div id="config-autoShow" class="member inherited"><a href="Ext.form.field.Base.html#config-autoShow" rel="config-autoShow" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-autoShow" class="viewSource">view source</a></div><a name="autoShow"></a><a name="config-autoShow"></a><a href="Ext.form.field.Base.html#" rel="config-autoShow" class="cls expand">autoShow</a><span> : Boolean</span></div><div class="description"><div class="short">True to automatically show the component upon creation.
232 This config option may only be used for floating components o...</div><div class="long"><p>True to automatically show the component upon creation.
233 This config option may only be used for <a href="Ext.form.field.Base.html#floating" rel="Ext.form.field.Base#floating" class="docClass">floating</a> components or components
234 that use <a href="Ext.form.field.Base.html#autoRender" rel="Ext.form.field.Base#autoRender" class="docClass">autoRender</a>. Defaults to <tt>false</tt>.</p>
235 </div></div></div><div id="config-baseBodyCls" class="member inherited"><a href="Ext.form.field.Base.html#config-baseBodyCls" rel="config-baseBodyCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-baseBodyCls" class="viewSource">view source</a></div><a name="baseBodyCls"></a><a name="config-baseBodyCls"></a><a href="Ext.form.field.Base.html#" rel="config-baseBodyCls" class="cls expand">baseBodyCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to be applied to the body content element. Defaults to 'x-form-item-body'.</p>
236 </div><div class="long"><p>The CSS class to be applied to the body content element. Defaults to 'x-form-item-body'.</p>
237 </div></div></div><div id="config-baseCls" class="member inherited"><a href="Ext.form.field.Base.html#config-baseCls" rel="config-baseCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-baseCls" class="viewSource">view source</a></div><a name="baseCls"></a><a name="config-baseCls"></a><a href="Ext.form.field.Base.html#" rel="config-baseCls" class="cls expand">baseCls</a><span> : String</span></div><div class="description"><div class="short">The base CSS class to apply to this components's element. This will also be prepended to
238 elements within this compone...</div><div class="long"><p>The base CSS class to apply to this components's element. This will also be prepended to
239 elements within this component like Panel's body will get a class x-panel-body. This means
240 that if you create a subclass of Panel, and you want it to get all the Panels styling for the
241 element and the body, you leave the baseCls x-panel and use componentCls to add specific styling for this
242 component.</p>
243 </div></div></div><div id="config-border" class="member inherited"><a href="Ext.form.field.Base.html#config-border" rel="config-border" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-border" class="viewSource">view source</a></div><a name="border"></a><a name="config-border"></a><a href="Ext.form.field.Base.html#" rel="config-border" class="cls expand">border</a><span> : Number/String</span></div><div class="description"><div class="short">Specifies the border for this component. The border can be a single numeric value to apply to all sides or
244 it can be ...</div><div class="long"><p>Specifies the border for this component. The border can be a single numeric value to apply to all sides or
245 it can be a CSS style specification for each style, for example: '10 5 3 10'.</p>
246 </div></div></div><div id="config-checkChangeBuffer" class="member ni"><a href="Ext.form.field.Base.html#config-checkChangeBuffer" rel="config-checkChangeBuffer" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-checkChangeBuffer" class="viewSource">view source</a></div><a name="checkChangeBuffer"></a><a name="config-checkChangeBuffer"></a><a href="Ext.form.field.Base.html#" rel="config-checkChangeBuffer" class="cls expand">checkChangeBuffer</a><span> : Number</span></div><div class="description"><div class="short">Defines a timeout in milliseconds for buffering checkChangeEvents that fire in rapid succession.
247 Defaults to 50 milli...</div><div class="long"><p>Defines a timeout in milliseconds for buffering <a href="Ext.form.field.Base.html#checkChangeEvents" rel="Ext.form.field.Base#checkChangeEvents" class="docClass">checkChangeEvents</a> that fire in rapid succession.
248 Defaults to 50 milliseconds.</p>
249 </div></div></div><div id="config-checkChangeEvents" class="member ni"><a href="Ext.form.field.Base.html#config-checkChangeEvents" rel="config-checkChangeEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-checkChangeEvents" class="viewSource">view source</a></div><a name="checkChangeEvents"></a><a name="config-checkChangeEvents"></a><a href="Ext.form.field.Base.html#" rel="config-checkChangeEvents" class="cls expand">checkChangeEvents</a><span> : Array</span></div><div class="description"><div class="short">A list of event names that will be listened for on the field's input element, which
250 will cause the field's value to b...</div><div class="long"><p>A list of event names that will be listened for on the field's <a href="Ext.form.field.Base.html#inputEl" rel="Ext.form.field.Base#inputEl" class="docClass">input element</a>, which
251 will cause the field's value to be checked for changes. If a change is detected, the
252 <a href="Ext.form.field.Base.html#change" rel="Ext.form.field.Base#change" class="docClass">change event</a> will be fired, followed by validation if the <a href="Ext.form.field.Base.html#validateOnChange" rel="Ext.form.field.Base#validateOnChange" class="docClass">validateOnChange</a>
253 option is enabled.</p>
254
255
256 <p>Defaults to <tt>['change', 'propertychange']</tt> in Internet Explorer, and <tt>['change', 'input',
257 'textInput', 'keyup', 'dragdrop']</tt> in other browsers. This catches all the ways that field values
258 can be changed in most supported browsers; the only known exceptions at the time of writing are:</p>
259
260
261 <ul>
262 <li>Safari 3.2 and older: cut/paste in textareas via the context menu, and dragging text into textareas</li>
263 <li>Opera 10 and 11: dragging text into text fields and textareas, and cut via the context menu in text
264 fields and textareas</li>
265 <li>Opera 9: Same as Opera 10 and 11, plus paste from context menu in text fields and textareas</li>
266 </ul>
267
268
269 <p>If you need to guarantee on-the-fly change notifications including these edge cases, you can call the
270 <a href="Ext.form.field.Base.html#checkChange" rel="Ext.form.field.Base#checkChange" class="docClass">checkChange</a> method on a repeating interval, e.g. using <a href="Ext.TaskManager.html" rel="Ext.TaskManager" class="docClass">Ext.TaskManager</a>, or if the field is
271 within a <a href="Ext.form.Panel.html" rel="Ext.form.Panel" class="docClass">Ext.form.Panel</a>, you can use the FormPanel's <a href="Ext.form.Panel.html#pollForChanges" rel="Ext.form.Panel#pollForChanges" class="docClass">Ext.form.Panel.pollForChanges</a>
272 configuration to set up such a task automatically.</p>
273
274 </div></div></div><div id="config-clearCls" class="member inherited"><a href="Ext.form.field.Base.html#config-clearCls" rel="config-clearCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-clearCls" class="viewSource">view source</a></div><a name="clearCls"></a><a name="config-clearCls"></a><a href="Ext.form.field.Base.html#" rel="config-clearCls" class="cls expand">clearCls</a><span> : String</span></div><div class="description"><div class="short">The CSS class to be applied to the special clearing div rendered directly after the field
275 contents wrapper to provide...</div><div class="long"><p>The CSS class to be applied to the special clearing div rendered directly after the field
276 contents wrapper to provide field clearing (defaults to <tt>'x-clear'</tt>).</p>
277 </div></div></div><div id="config-cls" class="member inherited"><a href="Ext.form.field.Base.html#config-cls" rel="config-cls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-cls" class="viewSource">view source</a></div><a name="cls"></a><a name="config-cls"></a><a href="Ext.form.field.Base.html#" rel="config-cls" class="cls expand">cls</a><span> : String</span></div><div class="description"><div class="short">An optional extra CSS class that will be added to this component's Element (defaults to '').  This can be
278 useful for ...</div><div class="long"><p>An optional extra CSS class that will be added to this component's Element (defaults to '').  This can be
279 useful for adding customized styles to the component or any of its children using standard CSS rules.</p>
280 </div></div></div><div id="config-componentCls" class="member inherited"><a href="Ext.form.field.Base.html#config-componentCls" rel="config-componentCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-componentCls" class="viewSource">view source</a></div><a name="componentCls"></a><a name="config-componentCls"></a><a href="Ext.form.field.Base.html#" rel="config-componentCls" class="cls expand">componentCls</a><span> : String</span></div><div class="description"><div class="short"><p>CSS Class to be added to a components root level element to give distinction to it
281 via styling.</p>
282 </div><div class="long"><p>CSS Class to be added to a components root level element to give distinction to it
283 via styling.</p>
284 </div></div></div><div id="config-componentLayout" class="member inherited"><a href="Ext.form.field.Base.html#config-componentLayout" rel="config-componentLayout" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-componentLayout" class="viewSource">view source</a></div><a name="componentLayout"></a><a name="config-componentLayout"></a><a href="Ext.form.field.Base.html#" rel="config-componentLayout" class="cls expand">componentLayout</a><span> : String/Object</span></div><div class="description"><div class="short">The sizing and positioning of a Component's internal Elements is the responsibility of
285 the Component's layout manager...</div><div class="long"><p>The sizing and positioning of a Component's internal Elements is the responsibility of
286 the Component's layout manager which sizes a Component's internal structure in response to the Component being sized.</p>
287
288
289 <p>Generally, developers will not use this configuration as all provided Components which need their internal
290 elements sizing (Such as <a href="Ext.form.field.Base.html" rel="Ext.form.field.Base" class="docClass">input fields</a>) come with their own componentLayout managers.</p>
291
292
293 <p>The <a href="Ext.layout.container.Auto.html" rel="Ext.layout.container.Auto" class="docClass">default layout manager</a> will be used on instances of the base <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> class
294 which simply sizes the Component's encapsulating element to the height and width specified in the <a href="Ext.form.field.Base.html#setSize" rel="Ext.form.field.Base#setSize" class="docClass">setSize</a> method.</p>
295
296 </div></div></div><div id="config-contentEl" class="member inherited"><a href="Ext.form.field.Base.html#config-contentEl" rel="config-contentEl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-contentEl" class="viewSource">view source</a></div><a name="contentEl"></a><a name="config-contentEl"></a><a href="Ext.form.field.Base.html#" rel="config-contentEl" class="cls expand">contentEl</a><span> : String</span></div><div class="description"><div class="short">Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
297 for this comp...</div><div class="long"><p>Optional. Specify an existing HTML element, or the <code>id</code> of an existing HTML element to use as the content
298 for this component.</p>
299
300
301 <ul>
302 <li><b>Description</b> :
303 <div class="sub-desc">This config option is used to take an existing HTML element and place it in the layout element
304 of a new component (it simply moves the specified DOM element <i>after the Component is rendered</i> to use as the content.</div></li>
305 <li><b>Notes</b> :
306 <div class="sub-desc">The specified HTML element is appended to the layout element of the component <i>after any configured
307 <a href="Ext.form.field.Base.html#html" rel="Ext.form.field.Base#html" class="docClass">HTML</a> has been inserted</i>, and so the document will not contain this element at the time the <a href="Ext.form.field.Base.html#render" rel="Ext.form.field.Base#render" class="docClass">render</a> event is fired.</div>
308 <div class="sub-desc">The specified HTML element used will not participate in any <code><b><a href="Ext.container.Container.html#layout" rel="Ext.container.Container#layout" class="docClass">layout</a></b></code>
309 scheme that the Component may use. It is just HTML. Layouts operate on child <code><b><a href="Ext.container.Container.html#items" rel="Ext.container.Container#items" class="docClass">items</a></b></code>.</div>
310 <div class="sub-desc">Add either the <code>x-hidden</code> or the <code>x-hide-display</code> CSS class to
311 prevent a brief flicker of the content before it is rendered to the panel.</div></li>
312 </ul>
313
314 </div></div></div><div id="config-data" class="member inherited"><a href="Ext.form.field.Base.html#config-data" rel="config-data" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-data" class="viewSource">view source</a></div><a name="data"></a><a name="config-data"></a><a href="Ext.form.field.Base.html#" rel="config-data" class="cls expand">data</a><span> : Mixed</span></div><div class="description"><div class="short"><p>The initial set of data to apply to the <code><a href="Ext.form.field.Base.html#tpl" rel="Ext.form.field.Base#tpl" class="docClass">tpl</a></code> to
315 update the content area of the Component.</p>
316 </div><div class="long"><p>The initial set of data to apply to the <code><a href="Ext.form.field.Base.html#tpl" rel="Ext.form.field.Base#tpl" class="docClass">tpl</a></code> to
317 update the content area of the Component.</p>
318 </div></div></div><div id="config-dirtyCls" class="member ni"><a href="Ext.form.field.Base.html#config-dirtyCls" rel="config-dirtyCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-dirtyCls" class="viewSource">view source</a></div><a name="dirtyCls"></a><a name="config-dirtyCls"></a><a href="Ext.form.field.Base.html#" rel="config-dirtyCls" class="cls expand">dirtyCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to use when the field value <a href="Ext.form.field.Base.html#isDirty" rel="Ext.form.field.Base#isDirty" class="docClass">is dirty</a>.</p>
319 </div><div class="long"><p>The CSS class to use when the field value <a href="Ext.form.field.Base.html#isDirty" rel="Ext.form.field.Base#isDirty" class="docClass">is dirty</a>.</p>
320 </div></div></div><div id="config-disabled" class="member inherited"><a href="Ext.form.field.Base.html#config-disabled" rel="config-disabled" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-cfg-disabled" class="viewSource">view source</a></div><a name="disabled"></a><a name="config-disabled"></a><a href="Ext.form.field.Base.html#" rel="config-disabled" class="cls expand">disabled</a><span> : Boolean</span></div><div class="description"><div class="short"><p>True to disable the field (defaults to false). Disabled Fields will not be
321 <a href="Ext.form.Basic.html#submit" rel="Ext.form.Basic#submit" class="docClass">submitted</a>.</p></p>
322 </div><div class="long"><p>True to disable the field (defaults to false). Disabled Fields will not be
323 <a href="Ext.form.Basic.html#submit" rel="Ext.form.Basic#submit" class="docClass">submitted</a>.</p></p>
324 </div></div></div><div id="config-disabledCls" class="member inherited"><a href="Ext.form.field.Base.html#config-disabledCls" rel="config-disabledCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-disabledCls" class="viewSource">view source</a></div><a name="disabledCls"></a><a name="config-disabledCls"></a><a href="Ext.form.field.Base.html#" rel="config-disabledCls" class="cls expand">disabledCls</a><span> : String</span></div><div class="description"><div class="short"><p>CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.</p>
325 </div><div class="long"><p>CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.</p>
326 </div></div></div><div id="config-draggable" class="member inherited"><a href="Ext.form.field.Base.html#config-draggable" rel="config-draggable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-draggable" class="viewSource">view source</a></div><a name="draggable"></a><a name="config-draggable"></a><a href="Ext.form.field.Base.html#" rel="config-draggable" class="cls expand">draggable</a><span> : Mixed</span></div><div class="description"><div class="short">Specify as true to make a floating Component draggable using the Component's encapsulating element as the drag handle...</div><div class="long"><p>Specify as true to make a <a href="Ext.form.field.Base.html#floating" rel="Ext.form.field.Base#floating" class="docClass">floating</a> Component draggable using the Component's encapsulating element as the drag handle.</p>
327
328
329 <p>This may also be specified as a config object for the <a href="Ext.util.ComponentDragger.html" rel="Ext.util.ComponentDragger" class="docClass">ComponentDragger</a> which is instantiated to perform dragging.</p>
330
331
332 <p>For example to create a Component which may only be dragged around using a certain internal element as the drag handle,
333 use the delegate option:</p>
334
335
336 <p><code></p>
337
338 <pre>new Ext.Component({
339     constrain: true,
340     floating:true,
341     style: {
342         backgroundColor: '#fff',
343         border: '1px solid black'
344     },
345     html: '&lt;h1 style="cursor:move"&gt;The title&lt;/h1&gt;&lt;p&gt;The content&lt;/p&gt;',
346     draggable: {
347         delegate: 'h1'
348     }
349 }).show();
350 </pre>
351
352
353 <p></code></p>
354 </div></div></div><div id="config-errorMsgCls" class="member inherited"><a href="Ext.form.field.Base.html#config-errorMsgCls" rel="config-errorMsgCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-errorMsgCls" class="viewSource">view source</a></div><a name="errorMsgCls"></a><a name="config-errorMsgCls"></a><a href="Ext.form.field.Base.html#" rel="config-errorMsgCls" class="cls expand">errorMsgCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to be applied to the error message element. Defaults to 'x-form-error-msg'.</p>
355 </div><div class="long"><p>The CSS class to be applied to the error message element. Defaults to 'x-form-error-msg'.</p>
356 </div></div></div><div id="config-fieldBodyCls" class="member inherited"><a href="Ext.form.field.Base.html#config-fieldBodyCls" rel="config-fieldBodyCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-fieldBodyCls" class="viewSource">view source</a></div><a name="fieldBodyCls"></a><a name="config-fieldBodyCls"></a><a href="Ext.form.field.Base.html#" rel="config-fieldBodyCls" class="cls expand">fieldBodyCls</a><span> : String</span></div><div class="description"><div class="short"><p>An extra CSS class to be applied to the body content element in addition to <a href="Ext.form.field.Base.html#fieldBodyCls" rel="Ext.form.field.Base#fieldBodyCls" class="docClass">fieldBodyCls</a>.
357 Defaults to empty.</p>
358 </div><div class="long"><p>An extra CSS class to be applied to the body content element in addition to <a href="Ext.form.field.Base.html#fieldBodyCls" rel="Ext.form.field.Base#fieldBodyCls" class="docClass">fieldBodyCls</a>.
359 Defaults to empty.</p>
360 </div></div></div><div id="config-fieldCls" class="member ni"><a href="Ext.form.field.Base.html#config-fieldCls" rel="config-fieldCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-fieldCls" class="viewSource">view source</a></div><a name="fieldCls"></a><a name="config-fieldCls"></a><a href="Ext.form.field.Base.html#" rel="config-fieldCls" class="cls expand">fieldCls</a><span> : String</span></div><div class="description"><div class="short"><p>The default CSS class for the field input (defaults to 'x-form-field')</p>
361 </div><div class="long"><p>The default CSS class for the field input (defaults to 'x-form-field')</p>
362 </div></div></div><div id="config-fieldLabel" class="member inherited"><a href="Ext.form.field.Base.html#config-fieldLabel" rel="config-fieldLabel" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-fieldLabel" class="viewSource">view source</a></div><a name="fieldLabel"></a><a name="config-fieldLabel"></a><a href="Ext.form.field.Base.html#" rel="config-fieldLabel" class="cls expand">fieldLabel</a><span> : String</span></div><div class="description"><div class="short">The label for the field. It gets appended with the labelSeparator, and its position
363 and sizing is determined by the l...</div><div class="long"><p>The label for the field. It gets appended with the <a href="Ext.form.field.Base.html#labelSeparator" rel="Ext.form.field.Base#labelSeparator" class="docClass">labelSeparator</a>, and its position
364 and sizing is determined by the <a href="Ext.form.field.Base.html#labelAlign" rel="Ext.form.field.Base#labelAlign" class="docClass">labelAlign</a>, <a href="Ext.form.field.Base.html#labelWidth" rel="Ext.form.field.Base#labelWidth" class="docClass">labelWidth</a>, and <a href="Ext.form.field.Base.html#labelPad" rel="Ext.form.field.Base#labelPad" class="docClass">labelPad</a>
365 configs. Defaults to undefined.</p>
366 </div></div></div><div id="config-fieldStyle" class="member ni"><a href="Ext.form.field.Base.html#config-fieldStyle" rel="config-fieldStyle" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-fieldStyle" class="viewSource">view source</a></div><a name="fieldStyle"></a><a name="config-fieldStyle"></a><a href="Ext.form.field.Base.html#" rel="config-fieldStyle" class="cls expand">fieldStyle</a><span> : String</span></div><div class="description"><div class="short">Optional CSS style(s) to be applied to the field input element.
367 Should be a valid argument to Ext.core.Element.applyS...</div><div class="long"><p>Optional CSS style(s) to be applied to the <a href="Ext.form.field.Base.html#inputEl" rel="Ext.form.field.Base#inputEl" class="docClass">field input element</a>.
368 Should be a valid argument to <a href="Ext.core.Element.html#applyStyles" rel="Ext.core.Element#applyStyles" class="docClass">Ext.core.Element.applyStyles</a>. Defaults to undefined. See also the
369 <a href="Ext.form.field.Base.html#setFieldStyle" rel="Ext.form.field.Base#setFieldStyle" class="docClass">setFieldStyle</a> method for changing the style after initialization.</p>
370 </div></div></div><div id="config-floating" class="member inherited"><a href="Ext.form.field.Base.html#config-floating" rel="config-floating" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-floating" class="viewSource">view source</a></div><a name="floating"></a><a name="config-floating"></a><a href="Ext.form.field.Base.html#" rel="config-floating" class="cls expand">floating</a><span> : Boolean</span></div><div class="description"><div class="short">Specify as true to float the Component outside of the document flow using CSS absolute positioning.
371
372
373 Components such...</div><div class="long"><p>Specify as true to float the Component outside of the document flow using CSS absolute positioning.</p>
374
375
376 <p>Components such as <a href="Ext.window.Window.html" rel="Ext.window.Window" class="docClass">Window</a>s and <a href="Ext.menu.Menu.html" rel="Ext.menu.Menu" class="docClass">Menu</a>s are floating
377 by default.</p>
378
379
380 <p>Floating Components that are programatically <a href="Ext.Component.html#render" rel="Ext.Component#render" class="docClass">rendered</a> will register themselves with the global
381 <a href="Ext.WindowManager.html" rel="Ext.WindowManager" class="docClass">ZIndexManager</a></p>
382
383
384 <h3 class="pa">Floating Components as child items of a Container</h3>
385
386
387 <p>A floating Component may be used as a child item of a Container. This just allows the floating Component to seek a ZIndexManager by
388 examining the ownerCt chain.</p>
389
390
391 <p>When configured as floating, Components acquire, at render time, a <a href="Ext.ZIndexManager.html" rel="Ext.ZIndexManager" class="docClass">ZIndexManager</a> which manages a stack
392 of related floating Components. The ZIndexManager brings a single floating Component to the top of its stack when
393 the Component's <a href="Ext.form.field.Base.html#toFront" rel="Ext.form.field.Base#toFront" class="docClass">toFront</a> method is called.</p>
394
395
396 <p>The ZIndexManager is found by traversing up the <a href="Ext.form.field.Base.html#ownerCt" rel="Ext.form.field.Base#ownerCt" class="docClass">ownerCt</a> chain to find an ancestor which itself is floating. This is so that
397 descendant floating Components of floating <i>Containers</i> (Such as a ComboBox dropdown within a Window) can have its zIndex managed relative
398 to any siblings, but always <b>above</b> that floating ancestor Container.</p>
399
400
401 <p>If no floating ancestor is found, a floating Component registers itself with the default <a href="Ext.WindowManager.html" rel="Ext.WindowManager" class="docClass">ZIndexManager</a>.</p>
402
403
404 <p>Floating components <i>do not participate in the Container's layout</i>. Because of this, they are not rendered until you explicitly
405 <a href="Ext.form.field.Base.html#show" rel="Ext.form.field.Base#show" class="docClass">show</a> them.</p>
406
407
408 <p>After rendering, the ownerCt reference is deleted, and the <a href="Ext.form.field.Base.html#floatParent" rel="Ext.form.field.Base#floatParent" class="docClass">floatParent</a> property is set to the found floating ancestor Container.
409 If no floating ancestor Container was found the <a href="Ext.form.field.Base.html#floatParent" rel="Ext.form.field.Base#floatParent" class="docClass">floatParent</a> property will not be set.</p>
410
411 </div></div></div><div id="config-focusCls" class="member ni"><a href="Ext.form.field.Base.html#config-focusCls" rel="config-focusCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-focusCls" class="viewSource">view source</a></div><a name="focusCls"></a><a name="config-focusCls"></a><a href="Ext.form.field.Base.html#" rel="config-focusCls" class="cls expand">focusCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to use when the field receives focus (defaults to 'x-form-focus')</p>
412 </div><div class="long"><p>The CSS class to use when the field receives focus (defaults to 'x-form-focus')</p>
413 </div></div></div><div id="config-focusOnToFront" class="member inherited"><a href="Ext.form.field.Base.html#config-focusOnToFront" rel="config-focusOnToFront" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-cfg-focusOnToFront" class="viewSource">view source</a></div><a name="focusOnToFront"></a><a name="config-focusOnToFront"></a><a href="Ext.form.field.Base.html#" rel="config-focusOnToFront" class="cls expand">focusOnToFront</a><span> : Boolean</span></div><div class="description"><div class="short">Specifies whether the floated component should be automatically focused when it is
414 brought to the front. Defaults to ...</div><div class="long"><p>Specifies whether the floated component should be automatically <a href="Ext.form.field.Base.html#focus" rel="Ext.form.field.Base#focus" class="docClass">focused</a> when it is
415 <a href="Ext.form.field.Base.html#toFront" rel="Ext.form.field.Base#toFront" class="docClass">brought to the front</a>. Defaults to true.</p>
416 </div></div></div><div id="config-formItemCls" class="member inherited"><a href="Ext.form.field.Base.html#config-formItemCls" rel="config-formItemCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-formItemCls" class="viewSource">view source</a></div><a name="formItemCls"></a><a name="config-formItemCls"></a><a href="Ext.form.field.Base.html#" rel="config-formItemCls" class="cls expand">formItemCls</a><span> : String</span></div><div class="description"><div class="short">A CSS class to be applied to the outermost element to denote that it is participating in the form
417 field layout. Defau...</div><div class="long"><p>A CSS class to be applied to the outermost element to denote that it is participating in the form
418 field layout. Defaults to 'x-form-item'.</p>
419 </div></div></div><div id="config-frame" class="member inherited"><a href="Ext.form.field.Base.html#config-frame" rel="config-frame" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-frame" class="viewSource">view source</a></div><a name="frame"></a><a name="config-frame"></a><a href="Ext.form.field.Base.html#" rel="config-frame" class="cls expand">frame</a><span> : Boolean</span></div><div class="description"><div class="short">Specify as true to have the Component inject framing elements within the Component at render time to
420 provide a graphi...</div><div class="long"><p>Specify as <code>true</code> to have the Component inject framing elements within the Component at render time to
421 provide a graphical rounded frame around the Component content.</p>
422
423
424 <p>This is only necessary when running on outdated, or non standard-compliant browsers such as Microsoft's Internet Explorer
425 prior to version 9 which do not support rounded corners natively.</p>
426
427
428 <p>The extra space taken up by this framing is available from the read only property <a href="Ext.form.field.Base.html#frameSize" rel="Ext.form.field.Base#frameSize" class="docClass">frameSize</a>.</p>
429
430 </div></div></div><div id="config-height" class="member inherited"><a href="Ext.form.field.Base.html#config-height" rel="config-height" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-height" class="viewSource">view source</a></div><a name="height"></a><a name="config-height"></a><a href="Ext.form.field.Base.html#" rel="config-height" class="cls expand">height</a><span> : Number</span></div><div class="description"><div class="short"><p>The height of this component in pixels.</p>
431 </div><div class="long"><p>The height of this component in pixels.</p>
432 </div></div></div><div id="config-hidden" class="member inherited"><a href="Ext.form.field.Base.html#config-hidden" rel="config-hidden" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-hidden" class="viewSource">view source</a></div><a name="hidden"></a><a name="config-hidden"></a><a href="Ext.form.field.Base.html#" rel="config-hidden" class="cls expand">hidden</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Defaults to false.</p>
433 </div><div class="long"><p>Defaults to false.</p>
434 </div></div></div><div id="config-hideEmptyLabel" class="member inherited"><a href="Ext.form.field.Base.html#config-hideEmptyLabel" rel="config-hideEmptyLabel" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-hideEmptyLabel" class="viewSource">view source</a></div><a name="hideEmptyLabel"></a><a name="config-hideEmptyLabel"></a><a href="Ext.form.field.Base.html#" rel="config-hideEmptyLabel" class="cls expand">hideEmptyLabel</a><span> : Boolean</span></div><div class="description"><div class="short">When set to true, the label element (fieldLabel and labelSeparator) will be
435 automatically hidden if the fieldLabel is...</div><div class="long"><p>When set to <tt>true</tt>, the label element (<a href="Ext.form.field.Base.html#fieldLabel" rel="Ext.form.field.Base#fieldLabel" class="docClass">fieldLabel</a> and <a href="Ext.form.field.Base.html#labelSeparator" rel="Ext.form.field.Base#labelSeparator" class="docClass">labelSeparator</a>) will be
436 automatically hidden if the <a href="Ext.form.field.Base.html#fieldLabel" rel="Ext.form.field.Base#fieldLabel" class="docClass">fieldLabel</a> is empty. Setting this to <tt>false</tt> will cause the empty
437 label element to be rendered and space to be reserved for it; this is useful if you want a field without a label
438 to line up with other labeled fields in the same form. Defaults to <tt>true</tt>.</p>
439
440
441 <p>If you wish to unconditionall hide the label even if a non-empty fieldLabel is configured, then set
442 the <a href="Ext.form.field.Base.html#hideLabel" rel="Ext.form.field.Base#hideLabel" class="docClass">hideLabel</a> config to <tt>true</tt>.</p>
443
444 </div></div></div><div id="config-hideLabel" class="member inherited"><a href="Ext.form.field.Base.html#config-hideLabel" rel="config-hideLabel" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-hideLabel" class="viewSource">view source</a></div><a name="hideLabel"></a><a name="config-hideLabel"></a><a href="Ext.form.field.Base.html#" rel="config-hideLabel" class="cls expand">hideLabel</a><span> : Boolean</span></div><div class="description"><div class="short">Set to true to completely hide the label element (fieldLabel and labelSeparator).
445 Defaults to false.
446
447
448 Also see hideE...</div><div class="long"><p>Set to <tt>true</tt> to completely hide the label element (<a href="Ext.form.field.Base.html#fieldLabel" rel="Ext.form.field.Base#fieldLabel" class="docClass">fieldLabel</a> and <a href="Ext.form.field.Base.html#labelSeparator" rel="Ext.form.field.Base#labelSeparator" class="docClass">labelSeparator</a>).
449 Defaults to <tt>false</tt>.</p>
450
451
452 <p>Also see <a href="Ext.form.field.Base.html#hideEmptyLabel" rel="Ext.form.field.Base#hideEmptyLabel" class="docClass">hideEmptyLabel</a>, which controls whether space will be reserved for an empty fieldLabel.</p>
453
454 </div></div></div><div id="config-hideMode" class="member inherited"><a href="Ext.form.field.Base.html#config-hideMode" rel="config-hideMode" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-hideMode" class="viewSource">view source</a></div><a name="hideMode"></a><a name="config-hideMode"></a><a href="Ext.form.field.Base.html#" rel="config-hideMode" class="cls expand">hideMode</a><span> : String</span></div><div class="description"><div class="short">A String which specifies how this Component's encapsulating DOM element will be hidden.
455 Values may be
456 'display' : The...</div><div class="long"><p>A String which specifies how this Component's encapsulating DOM element will be hidden.
457 Values may be<div class="mdetail-params"><ul>
458 <li><code>'display'</code> : The Component will be hidden using the <code>display: none</code> style.</li>
459 <li><code>'visibility'</code> : The Component will be hidden using the <code>visibility: hidden</code> style.</li>
460 <li><code>'offsets'</code> : The Component will be hidden by absolutely positioning it out of the visible area of the document. This
461 is useful when a hidden Component must maintain measurable dimensions. Hiding using <code>display</code> results
462 in a Component having zero dimensions.</li></ul></div>
463 Defaults to <code>'display'</code>.</p>
464 </div></div></div><div id="config-html" class="member inherited"><a href="Ext.form.field.Base.html#config-html" rel="config-html" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-html" class="viewSource">view source</a></div><a name="html"></a><a name="config-html"></a><a href="Ext.form.field.Base.html#" rel="config-html" class="cls expand">html</a><span> : String/Object</span></div><div class="description"><div class="short">An HTML fragment, or a DomHelper specification to use as the layout element
465 content (defaults to ''). The HTML conten...</div><div class="long"><p>An HTML fragment, or a <a href="Ext.core.DomHelper.html" rel="Ext.core.DomHelper" class="docClass">DomHelper</a> specification to use as the layout element
466 content (defaults to ''). The HTML content is added after the component is rendered,
467 so the document will not contain this HTML at the time the <a href="Ext.form.field.Base.html#render" rel="Ext.form.field.Base#render" class="docClass">render</a> event is fired.
468 This content is inserted into the body <i>before</i> any configured <a href="Ext.form.field.Base.html#contentEl" rel="Ext.form.field.Base#contentEl" class="docClass">contentEl</a> is appended.</p>
469 </div></div></div><div id="config-id" class="member inherited"><a href="Ext.form.field.Base.html#config-id" rel="config-id" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-id" class="viewSource">view source</a></div><a name="id"></a><a name="config-id"></a><a href="Ext.form.field.Base.html#" rel="config-id" class="cls expand">id</a><span> : String</span></div><div class="description"><div class="short">The unique id of this component instance (defaults to an auto-assigned id).
470
471
472 It should not be necessary to use this ...</div><div class="long"><p>The <b><u>unique id of this component instance</u></b> (defaults to an <a href="Ext.form.field.Base.html#getId" rel="Ext.form.field.Base#getId" class="docClass">auto-assigned id</a>).</p>
473
474
475 <p>It should not be necessary to use this configuration except for singleton objects in your application.
476 Components created with an id may be accessed globally using <a href="Ext.html#getCmp" rel="Ext#getCmp" class="docClass">Ext.getCmp</a>.</p>
477
478
479 <p>Instead of using assigned ids, use the <a href="Ext.form.field.Base.html#itemId" rel="Ext.form.field.Base#itemId" class="docClass">itemId</a> config, and <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> which
480 provides selector-based searching for Sencha Components analogous to DOM querying. The <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Container</a>
481 class contains <a href="Ext.container.Container.html#down" rel="Ext.container.Container#down" class="docClass">shortcut methods</a> to query its descendant Components by selector.</p>
482
483
484 <p>Note that this id will also be used as the element id for the containing HTML element
485 that is rendered to the page for this component. This allows you to write id-based CSS
486 rules to style the specific instance of this component uniquely, and also to select
487 sub-elements using this component's id as the parent.</p>
488
489
490 <p><b>Note</b>: to avoid complications imposed by a unique <tt>id</tt> also see <code><a href="Ext.form.field.Base.html#itemId" rel="Ext.form.field.Base#itemId" class="docClass">itemId</a></code>.</p>
491
492
493 <p><b>Note</b>: to access the container of a Component see <code><a href="Ext.form.field.Base.html#ownerCt" rel="Ext.form.field.Base#ownerCt" class="docClass">ownerCt</a></code>.</p>
494
495 </div></div></div><div id="config-inputId" class="member ni"><a href="Ext.form.field.Base.html#config-inputId" rel="config-inputId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-inputId" class="viewSource">view source</a></div><a name="inputId"></a><a name="config-inputId"></a><a href="Ext.form.field.Base.html#" rel="config-inputId" class="cls expand">inputId</a><span> : String</span></div><div class="description"><div class="short">The id that will be given to the generated input DOM element. Defaults to an automatically generated id.
496 If you confi...</div><div class="long"><p>The id that will be given to the generated input DOM element. Defaults to an automatically generated id.
497 If you configure this manually, you must make sure it is unique in the document.</p>
498 </div></div></div><div id="config-inputType" class="member ni"><a href="Ext.form.field.Base.html#config-inputType" rel="config-inputType" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-inputType" class="viewSource">view source</a></div><a name="inputType"></a><a name="config-inputType"></a><a href="Ext.form.field.Base.html#" rel="config-inputType" class="cls expand">inputType</a><span> : String</span></div><div class="description"><div class="short">The type attribute for input fields -- e.g. radio, text, password, file (defaults to 'text').
499 The extended types supp...</div><div class="long"><p>The type attribute for input fields -- e.g. radio, text, password, file (defaults to <tt>'text'</tt>).
500 The extended types supported by HTML5 inputs (url, email, etc.) may also be used, though using them
501 will cause older browsers to fall back to 'text'.</p>
502
503
504 <p>The type 'password' must be used to render that field type currently -- there is no separate <a href="Ext.html" rel="Ext" class="docClass">Ext</a>
505 component for that. You can use <a href="Ext.form.field.File.html" rel="Ext.form.field.File" class="docClass">Ext.form.field.File</a> which creates a custom-rendered file upload
506 field, but if you want a plain unstyled file input you can use a BaseField with inputType:'file'.</p>
507
508 </div></div></div><div id="config-invalidCls" class="member inherited"><a href="Ext.form.field.Base.html#config-invalidCls" rel="config-invalidCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-invalidCls" class="viewSource">view source</a></div><a name="invalidCls"></a><a name="config-invalidCls"></a><a href="Ext.form.field.Base.html#" rel="config-invalidCls" class="cls expand">invalidCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to use when marking the component invalid (defaults to 'x-form-invalid')</p>
509 </div><div class="long"><p>The CSS class to use when marking the component invalid (defaults to 'x-form-invalid')</p>
510 </div></div></div><div id="config-invalidText" class="member ni"><a href="Ext.form.field.Base.html#config-invalidText" rel="config-invalidText" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-invalidText" class="viewSource">view source</a></div><a name="invalidText"></a><a name="config-invalidText"></a><a href="Ext.form.field.Base.html#" rel="config-invalidText" class="cls expand">invalidText</a><span> : String</span></div><div class="description"><div class="short">The error text to use when marking a field invalid and no message is provided
511 (defaults to 'The value in this field i...</div><div class="long"><p>The error text to use when marking a field invalid and no message is provided
512 (defaults to 'The value in this field is invalid')</p>
513 </div></div></div><div id="config-itemId" class="member inherited"><a href="Ext.form.field.Base.html#config-itemId" rel="config-itemId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-itemId" class="viewSource">view source</a></div><a name="itemId"></a><a name="config-itemId"></a><a href="Ext.form.field.Base.html#" rel="config-itemId" class="cls expand">itemId</a><span> : String</span></div><div class="description"><div class="short">An itemId can be used as an alternative way to get a reference to a component
514 when no object reference is available. ...</div><div class="long"><p>An <tt>itemId</tt> can be used as an alternative way to get a reference to a component
515 when no object reference is available.  Instead of using an <code><a href="Ext.form.field.Base.html#id" rel="Ext.form.field.Base#id" class="docClass">id</a></code> with
516 <a href="Ext.html" rel="Ext" class="docClass">Ext</a>.<a href="Ext.html#getCmp" rel="Ext#getCmp" class="docClass">getCmp</a>, use <code>itemId</code> with
517 <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Ext.container.Container</a>.<a href="Ext.container.Container.html#getComponent" rel="Ext.container.Container#getComponent" class="docClass">getComponent</a> which will retrieve
518 <code>itemId</code>'s or <tt><a href="Ext.form.field.Base.html#id" rel="Ext.form.field.Base#id" class="docClass">id</a></tt>'s. Since <code>itemId</code>'s are an index to the
519 container's internal MixedCollection, the <code>itemId</code> is scoped locally to the container --
520 avoiding potential conflicts with <a href="Ext.ComponentManager.html" rel="Ext.ComponentManager" class="docClass">Ext.ComponentManager</a> which requires a <b>unique</b>
521 <code><a href="Ext.form.field.Base.html#id" rel="Ext.form.field.Base#id" class="docClass">id</a></code>.</p>
522
523
524 <pre><code>var c = new Ext.panel.Panel({ //
525     <a href="Ext.Component.html#height" rel="Ext.Component#height" class="docClass">height</a>: 300,
526     <a href="Ext.form.field.Base.html#renderTo" rel="Ext.form.field.Base#renderTo" class="docClass">renderTo</a>: document.body,
527     <a href="Ext.container.Container.html#layout" rel="Ext.container.Container#layout" class="docClass">layout</a>: 'auto',
528     <a href="Ext.container.Container.html#items" rel="Ext.container.Container#items" class="docClass">items</a>: [
529         {
530             itemId: 'p1',
531             <a href="Ext.panel.Panel.html#title" rel="Ext.panel.Panel#title" class="docClass">title</a>: 'Panel 1',
532             <a href="Ext.Component.html#height" rel="Ext.Component#height" class="docClass">height</a>: 150
533         },
534         {
535             itemId: 'p2',
536             <a href="Ext.panel.Panel.html#title" rel="Ext.panel.Panel#title" class="docClass">title</a>: 'Panel 2',
537             <a href="Ext.Component.html#height" rel="Ext.Component#height" class="docClass">height</a>: 150
538         }
539     ]
540 })
541 p1 = c.<a href="Ext.container.Container.html#getComponent" rel="Ext.container.Container#getComponent" class="docClass">getComponent</a>('p1'); // not the same as <a href="Ext.html#getCmp" rel="Ext#getCmp" class="docClass">Ext.getCmp()</a>
542 p2 = p1.<a href="Ext.form.field.Base.html#ownerCt" rel="Ext.form.field.Base#ownerCt" class="docClass">ownerCt</a>.<a href="Ext.container.Container.html#getComponent" rel="Ext.container.Container#getComponent" class="docClass">getComponent</a>('p2'); // reference via a sibling
543 </code></pre>
544
545
546 <p>Also see <tt><a href="Ext.form.field.Base.html#id" rel="Ext.form.field.Base#id" class="docClass">id</a></tt>, <code><a href="Ext.form.field.Base.html#query" rel="Ext.form.field.Base#query" class="docClass">query</a></code>, <code><a href="Ext.form.field.Base.html#down" rel="Ext.form.field.Base#down" class="docClass">down</a></code> and <code><a href="Ext.form.field.Base.html#child" rel="Ext.form.field.Base#child" class="docClass">child</a></code>.</p>
547
548
549 <p><b>Note</b>: to access the container of an item see <tt><a href="Ext.form.field.Base.html#ownerCt" rel="Ext.form.field.Base#ownerCt" class="docClass">ownerCt</a></tt>.</p>
550
551 </div></div></div><div id="config-labelAlign" class="member inherited"><a href="Ext.form.field.Base.html#config-labelAlign" rel="config-labelAlign" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-labelAlign" class="viewSource">view source</a></div><a name="labelAlign"></a><a name="config-labelAlign"></a><a href="Ext.form.field.Base.html#" rel="config-labelAlign" class="cls expand">labelAlign</a><span> : String</span></div><div class="description"><div class="short">Controls the position and alignment of the fieldLabel. Valid values are:
552
553
554
555 "left" (the default) - The label is posit...</div><div class="long"><p>Controls the position and alignment of the <a href="Ext.form.field.Base.html#fieldLabel" rel="Ext.form.field.Base#fieldLabel" class="docClass">fieldLabel</a>. Valid values are:</p>
556
557
558 <ul>
559 <li><tt>"left"</tt> (the default) - The label is positioned to the left of the field, with its text
560 aligned to the left. Its width is determined by the <a href="Ext.form.field.Base.html#labelWidth" rel="Ext.form.field.Base#labelWidth" class="docClass">labelWidth</a> config.</li>
561 <li><tt>"top"</tt> - The label is positioned above the field.</li>
562 <li><tt>"right"</tt> - The label is positioned to the left of the field, with its text aligned
563 to the right. Its width is determined by the <a href="Ext.form.field.Base.html#labelWidth" rel="Ext.form.field.Base#labelWidth" class="docClass">labelWidth</a> config.</li>
564 </ul>
565
566 </div></div></div><div id="config-labelCls" class="member inherited"><a href="Ext.form.field.Base.html#config-labelCls" rel="config-labelCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-labelCls" class="viewSource">view source</a></div><a name="labelCls"></a><a name="config-labelCls"></a><a href="Ext.form.field.Base.html#" rel="config-labelCls" class="cls expand">labelCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class to be applied to the label element. Defaults to 'x-form-item-label'.</p>
567 </div><div class="long"><p>The CSS class to be applied to the label element. Defaults to 'x-form-item-label'.</p>
568 </div></div></div><div id="config-labelPad" class="member inherited"><a href="Ext.form.field.Base.html#config-labelPad" rel="config-labelPad" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-labelPad" class="viewSource">view source</a></div><a name="labelPad"></a><a name="config-labelPad"></a><a href="Ext.form.field.Base.html#" rel="config-labelPad" class="cls expand">labelPad</a><span> : Number</span></div><div class="description"><div class="short"><p>The amount of space in pixels between the <a href="Ext.form.field.Base.html#fieldLabel" rel="Ext.form.field.Base#fieldLabel" class="docClass">fieldLabel</a> and the input field. Defaults to <tt>5</tt>.</p>
569 </div><div class="long"><p>The amount of space in pixels between the <a href="Ext.form.field.Base.html#fieldLabel" rel="Ext.form.field.Base#fieldLabel" class="docClass">fieldLabel</a> and the input field. Defaults to <tt>5</tt>.</p>
570 </div></div></div><div id="config-labelSeparator" class="member inherited"><a href="Ext.form.field.Base.html#config-labelSeparator" rel="config-labelSeparator" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-labelSeparator" class="viewSource">view source</a></div><a name="labelSeparator"></a><a name="config-labelSeparator"></a><a href="Ext.form.field.Base.html#" rel="config-labelSeparator" class="cls expand">labelSeparator</a><span> : String</span></div><div class="description"><div class="short"><p>Character(s) to be inserted at the end of the <a href="Ext.form.field.Base.html#fieldLabel" rel="Ext.form.field.Base#fieldLabel" class="docClass">label text</a>.</p>
571 </div><div class="long"><p>Character(s) to be inserted at the end of the <a href="Ext.form.field.Base.html#fieldLabel" rel="Ext.form.field.Base#fieldLabel" class="docClass">label text</a>.</p>
572 </div></div></div><div id="config-labelStyle" class="member inherited"><a href="Ext.form.field.Base.html#config-labelStyle" rel="config-labelStyle" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-labelStyle" class="viewSource">view source</a></div><a name="labelStyle"></a><a name="config-labelStyle"></a><a href="Ext.form.field.Base.html#" rel="config-labelStyle" class="cls expand">labelStyle</a><span> : String</span></div><div class="description"><div class="short"><p>A CSS style specification string to apply directly to this field's label. Defaults to undefined.</p>
573
574 </div><div class="long"><p>A CSS style specification string to apply directly to this field's label. Defaults to undefined.</p>
575
576 </div></div></div><div id="config-labelWidth" class="member inherited"><a href="Ext.form.field.Base.html#config-labelWidth" rel="config-labelWidth" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-labelWidth" class="viewSource">view source</a></div><a name="labelWidth"></a><a name="config-labelWidth"></a><a href="Ext.form.field.Base.html#" rel="config-labelWidth" class="cls expand">labelWidth</a><span> : Number</span></div><div class="description"><div class="short"><p>The width of the <a href="Ext.form.field.Base.html#fieldLabel" rel="Ext.form.field.Base#fieldLabel" class="docClass">fieldLabel</a> in pixels. Only applicable if the <a href="Ext.form.field.Base.html#labelAlign" rel="Ext.form.field.Base#labelAlign" class="docClass">labelAlign</a> is set
577 to "left" or "right". Defaults to <tt>100</tt>.</p>
578 </div><div class="long"><p>The width of the <a href="Ext.form.field.Base.html#fieldLabel" rel="Ext.form.field.Base#fieldLabel" class="docClass">fieldLabel</a> in pixels. Only applicable if the <a href="Ext.form.field.Base.html#labelAlign" rel="Ext.form.field.Base#labelAlign" class="docClass">labelAlign</a> is set
579 to "left" or "right". Defaults to <tt>100</tt>.</p>
580 </div></div></div><div id="config-labelableRenderTpl" class="member inherited"><a href="Ext.form.field.Base.html#config-labelableRenderTpl" rel="config-labelableRenderTpl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-labelableRenderTpl" class="viewSource">view source</a></div><a name="labelableRenderTpl"></a><a name="config-labelableRenderTpl"></a><a href="Ext.form.field.Base.html#" rel="config-labelableRenderTpl" class="cls expand">labelableRenderTpl</a><span> : Array/String/Ext.XTemplate</span></div><div class="description"><div class="short">The rendering template for the field decorations. Component classes using this mixin should include
581 logic to use this...</div><div class="long"><p>The rendering template for the field decorations. Component classes using this mixin should include
582 logic to use this as their <a href="Ext.AbstractComponent.html#renderTpl" rel="Ext.AbstractComponent#renderTpl" class="docClass">renderTpl</a>, and implement the
583 <a href="Ext.form.field.Base.html#getSubTplMarkup" rel="Ext.form.field.Base#getSubTplMarkup" class="docClass">getSubTplMarkup</a> method to generate the field body content.</p>
584 </div></div></div><div id="config-listeners" class="member inherited"><a href="Ext.form.field.Base.html#config-listeners" rel="config-listeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-cfg-listeners" class="viewSource">view source</a></div><a name="listeners"></a><a name="config-listeners"></a><a href="Ext.form.field.Base.html#" rel="config-listeners" class="cls expand">listeners</a><span> : Object</span></div><div class="description"><div class="short">(optional) A config object containing one or more event handlers to be added to this
585 object during initialization.  T...</div><div class="long"><p>(optional) <p>A config object containing one or more event handlers to be added to this
586 object during initialization.  This should be a valid listeners config object as specified in the
587 <a href="Ext.form.field.Base.html#addListener" rel="Ext.form.field.Base#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
588
589 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
590
591
592 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
593
594
595 <p>is usually only done when extra value can be added. For example the <a href="Ext.view.View.html" rel="Ext.view.View" class="docClass">DataView</a>'s
596 <b><code><a href="Ext.view.View.html#click" rel="Ext.view.View#click" class="docClass">click</a></code></b> event passing the node clicked on. To access DOM
597 events directly from a child element of a Component, we need to specify the <code>element</code> option to
598 identify the Component property to add a DOM listener to:</p>
599
600 <pre><code>new Ext.panel.Panel({
601     width: 400,
602     height: 200,
603     dockedItems: [{
604         xtype: 'toolbar'
605     }],
606     listeners: {
607         click: {
608             element: 'el', //bind to the underlying el property on the panel
609             fn: function(){ console.log('click el'); }
610         },
611         dblclick: {
612             element: 'body', //bind to the underlying body property on the panel
613             fn: function(){ console.log('dblclick body'); }
614         }
615     }
616 });
617 </code></pre>
618
619
620 <p></p></p>
621 </div></div></div><div id="config-loader" class="member inherited"><a href="Ext.form.field.Base.html#config-loader" rel="config-loader" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-loader" class="viewSource">view source</a></div><a name="loader"></a><a name="config-loader"></a><a href="Ext.form.field.Base.html#" rel="config-loader" class="cls expand">loader</a><span> : Ext.ComponentLoader/Object</span></div><div class="description"><div class="short"><p>A configuration object or an instance of a <a href="Ext.ComponentLoader.html" rel="Ext.ComponentLoader" class="docClass">Ext.ComponentLoader</a> to load remote
622 content for this Component.</p>
623 </div><div class="long"><p>A configuration object or an instance of a <a href="Ext.ComponentLoader.html" rel="Ext.ComponentLoader" class="docClass">Ext.ComponentLoader</a> to load remote
624 content for this Component.</p>
625 </div></div></div><div id="config-maintainFlex" class="member inherited"><a href="Ext.form.field.Base.html#config-maintainFlex" rel="config-maintainFlex" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-maintainFlex" class="viewSource">view source</a></div><a name="maintainFlex"></a><a name="config-maintainFlex"></a><a href="Ext.form.field.Base.html#" rel="config-maintainFlex" class="cls expand">maintainFlex</a><span> : Boolean</span></div><div class="description"><div class="short">Only valid when a sibling element of a Splitter within a VBox or
626 HBox layout.
627
628
629 Specifies that if an immediate siblin...</div><div class="long"><p><b>Only valid when a sibling element of a <a href="Ext.resizer.Splitter.html" rel="Ext.resizer.Splitter" class="docClass">Splitter</a> within a <a href="Ext.layout.container.VBox.html" rel="Ext.layout.container.VBox" class="docClass">VBox</a> or
630 <a href="Ext.layout.container.HBox.html" rel="Ext.layout.container.HBox" class="docClass">HBox</a> layout.</b></p>
631
632
633 <p>Specifies that if an immediate sibling Splitter is moved, the Component on the <i>other</i> side is resized, and this
634 Component maintains its configured <a href="Ext.layout.container.Box.html#flex" rel="Ext.layout.container.Box#flex" class="docClass">flex</a> value.</p>
635
636 </div></div></div><div id="config-margin" class="member inherited"><a href="Ext.form.field.Base.html#config-margin" rel="config-margin" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-margin" class="viewSource">view source</a></div><a name="margin"></a><a name="config-margin"></a><a href="Ext.form.field.Base.html#" rel="config-margin" class="cls expand">margin</a><span> : Number/String</span></div><div class="description"><div class="short">Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or
637 it can be ...</div><div class="long"><p>Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or
638 it can be a CSS style specification for each style, for example: '10 5 3 10'.</p>
639 </div></div></div><div id="config-maxHeight" class="member inherited"><a href="Ext.form.field.Base.html#config-maxHeight" rel="config-maxHeight" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-maxHeight" class="viewSource">view source</a></div><a name="maxHeight"></a><a name="config-maxHeight"></a><a href="Ext.form.field.Base.html#" rel="config-maxHeight" class="cls expand">maxHeight</a><span> : Number</span></div><div class="description"><div class="short">The maximum value in pixels which this Component will set its height to.
640
641
642 Warning: This will override any size manag...</div><div class="long"><p>The maximum value in pixels which this Component will set its height to.</p>
643
644
645 <p><b>Warning:</b> This will override any size management applied by layout managers.</p>
646
647 </div></div></div><div id="config-maxWidth" class="member inherited"><a href="Ext.form.field.Base.html#config-maxWidth" rel="config-maxWidth" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-maxWidth" class="viewSource">view source</a></div><a name="maxWidth"></a><a name="config-maxWidth"></a><a href="Ext.form.field.Base.html#" rel="config-maxWidth" class="cls expand">maxWidth</a><span> : Number</span></div><div class="description"><div class="short">The maximum value in pixels which this Component will set its width to.
648
649
650 Warning: This will override any size manage...</div><div class="long"><p>The maximum value in pixels which this Component will set its width to.</p>
651
652
653 <p><b>Warning:</b> This will override any size management applied by layout managers.</p>
654
655 </div></div></div><div id="config-minHeight" class="member inherited"><a href="Ext.form.field.Base.html#config-minHeight" rel="config-minHeight" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-minHeight" class="viewSource">view source</a></div><a name="minHeight"></a><a name="config-minHeight"></a><a href="Ext.form.field.Base.html#" rel="config-minHeight" class="cls expand">minHeight</a><span> : Number</span></div><div class="description"><div class="short">The minimum value in pixels which this Component will set its height to.
656
657
658 Warning: This will override any size manag...</div><div class="long"><p>The minimum value in pixels which this Component will set its height to.</p>
659
660
661 <p><b>Warning:</b> This will override any size management applied by layout managers.</p>
662
663 </div></div></div><div id="config-minWidth" class="member inherited"><a href="Ext.form.field.Base.html#config-minWidth" rel="config-minWidth" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-minWidth" class="viewSource">view source</a></div><a name="minWidth"></a><a name="config-minWidth"></a><a href="Ext.form.field.Base.html#" rel="config-minWidth" class="cls expand">minWidth</a><span> : Number</span></div><div class="description"><div class="short">The minimum value in pixels which this Component will set its width to.
664
665
666 Warning: This will override any size manage...</div><div class="long"><p>The minimum value in pixels which this Component will set its width to.</p>
667
668
669 <p><b>Warning:</b> This will override any size management applied by layout managers.</p>
670
671 </div></div></div><div id="config-msgTarget" class="member inherited"><a href="Ext.form.field.Base.html#config-msgTarget" rel="config-msgTarget" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-msgTarget" class="viewSource">view source</a></div><a name="msgTarget"></a><a name="config-msgTarget"></a><a href="Ext.form.field.Base.html#" rel="config-msgTarget" class="cls expand">msgTarget</a><span> : String</span></div><div class="description"><div class="short">The location where the error message text should display.
672 Must be one of the following values:
673
674
675
676 qtip Display a quic...</div><div class="long"><p>The location where the error message text should display.
677 Must be one of the following values:</p>
678
679
680 <div class="mdetail-params"><ul>
681 <li><code>qtip</code> Display a quick tip containing the message when the user hovers over the field. This is the default.
682 <div class="subdesc"><b><a href="Ext.tip.QuickTipManager.html#init" rel="Ext.tip.QuickTipManager#init" class="docClass">Ext.tip.QuickTipManager.init</a> must have been called for this setting to work.</b></div></li>
683 <li><code>title</code> Display the message in a default browser title attribute popup.</li>
684 <li><code>under</code> Add a block div beneath the field containing the error message.</li>
685 <li><code>side</code> Add an error icon to the right of the field, displaying the message in a popup on hover.</li>
686 <li><code>none</code> Don't display any error message. This might be useful if you are implementing custom error display.</li>
687 <li><code>[element id]</code> Add the error message directly to the innerHTML of the specified element.</li>
688 </ul></div>
689
690 </div></div></div><div id="config-name" class="member ni"><a href="Ext.form.field.Base.html#config-name" rel="config-name" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-name" class="viewSource">view source</a></div><a name="name"></a><a name="config-name"></a><a href="Ext.form.field.Base.html#" rel="config-name" class="cls expand">name</a><span> : String</span></div><div class="description"><div class="short">The name of the field (defaults to undefined). This is used as the parameter
691 name when including the field value in a...</div><div class="long"><p>The name of the field (defaults to undefined). This is used as the parameter
692 name when including the field value in a <a href="Ext.form.Basic.html#submit" rel="Ext.form.Basic#submit" class="docClass">form submit()</a>. If no name is
693 configured, it falls back to the <a href="Ext.form.field.Base.html#inputId" rel="Ext.form.field.Base#inputId" class="docClass">inputId</a>. To prevent the field from being included in the
694 form submit, set <a href="Ext.form.field.Base.html#submitValue" rel="Ext.form.field.Base#submitValue" class="docClass">submitValue</a> to <tt>false</tt>.</p>
695 </div></div></div><div id="config-overCls" class="member inherited"><a href="Ext.form.field.Base.html#config-overCls" rel="config-overCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-overCls" class="viewSource">view source</a></div><a name="overCls"></a><a name="config-overCls"></a><a href="Ext.form.field.Base.html#" rel="config-overCls" class="cls expand">overCls</a><span> : String</span></div><div class="description"><div class="short">An optional extra CSS class that will be added to this component's Element when the mouse moves
696 over the Element, and...</div><div class="long"><p>An optional extra CSS class that will be added to this component's Element when the mouse moves
697 over the Element, and removed when the mouse moves out. (defaults to '').  This can be
698 useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.</p>
699 </div></div></div><div id="config-padding" class="member inherited"><a href="Ext.form.field.Base.html#config-padding" rel="config-padding" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-padding" class="viewSource">view source</a></div><a name="padding"></a><a name="config-padding"></a><a href="Ext.form.field.Base.html#" rel="config-padding" class="cls expand">padding</a><span> : Number/String</span></div><div class="description"><div class="short">Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or
700 it can b...</div><div class="long"><p>Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or
701 it can be a CSS style specification for each style, for example: '10 5 3 10'.</p>
702 </div></div></div><div id="config-plugins" class="member inherited"><a href="Ext.form.field.Base.html#config-plugins" rel="config-plugins" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-plugins" class="viewSource">view source</a></div><a name="plugins"></a><a name="config-plugins"></a><a href="Ext.form.field.Base.html#" rel="config-plugins" class="cls expand">plugins</a><span> : Object/Array</span></div><div class="description"><div class="short">An object or array of objects that will provide custom functionality for this component.  The only
703 requirement for a ...</div><div class="long"><p>An object or array of objects that will provide custom functionality for this component.  The only
704 requirement for a valid plugin is that it contain an init method that accepts a reference of type <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a>.
705 When a component is created, if any plugins are available, the component will call the init method on each
706 plugin, passing a reference to itself.  Each plugin can then call methods or respond to events on the
707 component as needed to provide its functionality.</p>
708 </div></div></div><div id="config-preventMark" class="member inherited"><a href="Ext.form.field.Base.html#config-preventMark" rel="config-preventMark" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-cfg-preventMark" class="viewSource">view source</a></div><a name="preventMark"></a><a name="config-preventMark"></a><a href="Ext.form.field.Base.html#" rel="config-preventMark" class="cls expand">preventMark</a><span> : Boolean</span></div><div class="description"><div class="short"><p><tt>true</tt> to disable displaying any <a href="Ext.form.field.Base.html#setActiveError" rel="Ext.form.field.Base#setActiveError" class="docClass">error message</a> set on this object.
709 Defaults to <tt>false</tt>.</p>
710 </div><div class="long"><p><tt>true</tt> to disable displaying any <a href="Ext.form.field.Base.html#setActiveError" rel="Ext.form.field.Base#setActiveError" class="docClass">error message</a> set on this object.
711 Defaults to <tt>false</tt>.</p>
712 </div></div></div><div id="config-readOnly" class="member ni"><a href="Ext.form.field.Base.html#config-readOnly" rel="config-readOnly" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-readOnly" class="viewSource">view source</a></div><a name="readOnly"></a><a name="config-readOnly"></a><a href="Ext.form.field.Base.html#" rel="config-readOnly" class="cls expand">readOnly</a><span> : Boolean</span></div><div class="description"><div class="short">true to mark the field as readOnly in HTML
713 (defaults to false).
714
715 Note: this only sets the element's readOnly DOM attr...</div><div class="long"><p><tt>true</tt> to mark the field as readOnly in HTML
716 (defaults to <tt>false</tt>).</p>
717
718 <br><p><b>Note</b>: this only sets the element's readOnly DOM attribute.
719
720
721 <p>Setting <code>readOnly=true</code>, for example, will not disable triggering a
722 ComboBox or Date; it gives you the option of forcing the user to choose
723 via the trigger without typing in the text box. To hide the trigger use
724 <code><a href="Ext.form.field.Trigger.html#hideTrigger" rel="Ext.form.field.Trigger#hideTrigger" class="docClass">hideTrigger</a></code>.</p></p>
725 </div></div></div><div id="config-readOnlyCls" class="member ni"><a href="Ext.form.field.Base.html#config-readOnlyCls" rel="config-readOnlyCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-readOnlyCls" class="viewSource">view source</a></div><a name="readOnlyCls"></a><a name="config-readOnlyCls"></a><a href="Ext.form.field.Base.html#" rel="config-readOnlyCls" class="cls expand">readOnlyCls</a><span> : String</span></div><div class="description"><div class="short"><p>The CSS class applied to the component's main element when it is <a href="Ext.form.field.Base.html#readOnly" rel="Ext.form.field.Base#readOnly" class="docClass">readOnly</a>.</p>
726 </div><div class="long"><p>The CSS class applied to the component's main element when it is <a href="Ext.form.field.Base.html#readOnly" rel="Ext.form.field.Base#readOnly" class="docClass">readOnly</a>.</p>
727 </div></div></div><div id="config-renderSelectors" class="member inherited"><a href="Ext.form.field.Base.html#config-renderSelectors" rel="config-renderSelectors" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-renderSelectors" class="viewSource">view source</a></div><a name="renderSelectors"></a><a name="config-renderSelectors"></a><a href="Ext.form.field.Base.html#" rel="config-renderSelectors" class="cls expand">renderSelectors</a><span> : Object</span></div><div class="description"><div class="short">An object containing properties specifying DomQuery selectors which identify child elements
728 created by the render pro...</div><div class="long"><p>An object containing properties specifying <a href="Ext.DomQuery.html" rel="Ext.DomQuery" class="docClass">DomQuery</a> selectors which identify child elements
729 created by the render process.</p>
730
731 <p>After the Component's internal structure is rendered according to the <a href="Ext.form.field.Base.html#renderTpl" rel="Ext.form.field.Base#renderTpl" class="docClass">renderTpl</a>, this object is iterated through,
732 and the found Elements are added as properties to the Component using the <code>renderSelector</code> property name.</p>
733
734 <p>For example, a Component which rendered an image, and description into its element might use the following properties
735 coded into its prototype:</p>
736
737 <pre><code>renderTpl: '&amp;lt;img src="{imageUrl}" class="x-image-component-img"&gt;&amp;lt;div class="x-image-component-desc"&gt;{description}&amp;gt;/div&amp;lt;',
738
739 renderSelectors: {
740     image: 'img.x-image-component-img',
741     descEl: 'div.x-image-component-desc'
742 }
743 </code></pre>
744
745 <p>After rendering, the Component would have a property <code>image</code> referencing its child <code>img</code> Element,
746 and a property <code>descEl</code> referencing the <code>div</code> Element which contains the description.</p>
747 </div></div></div><div id="config-renderTo" class="member inherited"><a href="Ext.form.field.Base.html#config-renderTo" rel="config-renderTo" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-renderTo" class="viewSource">view source</a></div><a name="renderTo"></a><a name="config-renderTo"></a><a href="Ext.form.field.Base.html#" rel="config-renderTo" class="cls expand">renderTo</a><span> : Mixed</span></div><div class="description"><div class="short">Specify the id of the element, a DOM element or an existing Element that this component
748 will be rendered into.
749
750
751
752 Not...</div><div class="long"><p>Specify the id of the element, a DOM element or an existing Element that this component
753 will be rendered into.</p>
754
755
756 <div><ul>
757 <li><b>Notes</b> : <ul>
758 <div class="sub-desc">Do <u>not</u> use this option if the Component is to be a child item of
759 a <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Container</a>. It is the responsibility of the
760 <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Container</a>'s <a href="Ext.container.Container.html#layout" rel="Ext.container.Container#layout" class="docClass">layout manager</a>
761 to render and manage its child items.</div>
762 <div class="sub-desc">When using this config, a call to render() is not required.</div>
763 </ul></li>
764 </ul></div>
765
766
767 <p>See <code><a href="Ext.form.field.Base.html#render" rel="Ext.form.field.Base#render" class="docClass">render</a></code> also.</p>
768
769 </div></div></div><div id="config-renderTpl" class="member inherited"><a href="Ext.form.field.Base.html#config-renderTpl" rel="config-renderTpl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-renderTpl" class="viewSource">view source</a></div><a name="renderTpl"></a><a name="config-renderTpl"></a><a href="Ext.form.field.Base.html#" rel="config-renderTpl" class="cls expand">renderTpl</a><span> : Mixed</span></div><div class="description"><div class="short">An XTemplate used to create the internal structure inside this Component's
770 encapsulating Element.
771
772
773 You do not normal...</div><div class="long"><p>An <a href="Ext.XTemplate.html" rel="Ext.XTemplate" class="docClass">XTemplate</a> used to create the internal structure inside this Component's
774 encapsulating <a href="Ext.form.field.Base.html#getEl" rel="Ext.form.field.Base#getEl" class="docClass">Element</a>.</p>
775
776
777 <p>You do not normally need to specify this. For the base classes <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a>
778 and <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Ext.container.Container</a>, this defaults to <b><code>null</code></b> which means that they will be initially rendered
779 with no internal structure; they render their <a href="Ext.form.field.Base.html#getEl" rel="Ext.form.field.Base#getEl" class="docClass">Element</a> empty. The more specialized ExtJS and Touch classes
780 which use a more complex DOM structure, provide their own template definitions.</p>
781
782
783 <p>This is intended to allow the developer to create application-specific utility Components with customized
784 internal structure.</p>
785
786
787 <p>Upon rendering, any created child elements may be automatically imported into object properties using the
788 <a href="Ext.form.field.Base.html#renderSelectors" rel="Ext.form.field.Base#renderSelectors" class="docClass">renderSelectors</a> option.</p>
789
790 </div></div></div><div id="config-resizable" class="member inherited"><a href="Ext.form.field.Base.html#config-resizable" rel="config-resizable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-resizable" class="viewSource">view source</a></div><a name="resizable"></a><a name="config-resizable"></a><a href="Ext.form.field.Base.html#" rel="config-resizable" class="cls expand">resizable</a><span> : Mixed</span></div><div class="description"><div class="short">Specify as true to apply a Resizer to this Component
791 after rendering.
792
793
794 May also be specified as a config object to b...</div><div class="long"><p>Specify as <code>true</code> to apply a <a href="Ext.resizer.Resizer.html" rel="Ext.resizer.Resizer" class="docClass">Resizer</a> to this Component
795 after rendering.</p>
796
797
798 <p>May also be specified as a config object to be passed to the constructor of <a href="Ext.resizer.Resizer.html" rel="Ext.resizer.Resizer" class="docClass">Resizer</a>
799 to override any defaults. By default the Component passes its minimum and maximum size, and uses
800 <code><a href="Ext.resizer.Resizer.html#dynamic" rel="Ext.resizer.Resizer#dynamic" class="docClass">Ext.resizer.Resizer.dynamic</a>: false</code></p>
801
802 </div></div></div><div id="config-resizeHandles" class="member inherited"><a href="Ext.form.field.Base.html#config-resizeHandles" rel="config-resizeHandles" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-resizeHandles" class="viewSource">view source</a></div><a name="resizeHandles"></a><a name="config-resizeHandles"></a><a href="Ext.form.field.Base.html#" rel="config-resizeHandles" class="cls expand">resizeHandles</a><span> : String</span></div><div class="description"><div class="short"><p>A valid <a href="Ext.resizer.Resizer.html" rel="Ext.resizer.Resizer" class="docClass">Ext.resizer.Resizer</a> handles config string (defaults to 'all').  Only applies when resizable = true.</p>
803 </div><div class="long"><p>A valid <a href="Ext.resizer.Resizer.html" rel="Ext.resizer.Resizer" class="docClass">Ext.resizer.Resizer</a> handles config string (defaults to 'all').  Only applies when resizable = true.</p>
804 </div></div></div><div id="config-saveBuffer" class="member inherited"><a href="Ext.form.field.Base.html#config-saveBuffer" rel="config-saveBuffer" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-cfg-saveBuffer" class="viewSource">view source</a></div><a name="saveBuffer"></a><a name="config-saveBuffer"></a><a href="Ext.form.field.Base.html#" rel="config-saveBuffer" class="cls expand">saveBuffer</a><span> : Number</span></div><div class="description"><div class="short"><p>A buffer to be applied if many state events are fired within
805 a short period. Defaults to 100.</p>
806 </div><div class="long"><p>A buffer to be applied if many state events are fired within
807 a short period. Defaults to 100.</p>
808 </div></div></div><div id="config-shadow" class="member inherited"><a href="Ext.form.field.Base.html#config-shadow" rel="config-shadow" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-cfg-shadow" class="viewSource">view source</a></div><a name="shadow"></a><a name="config-shadow"></a><a href="Ext.form.field.Base.html#" rel="config-shadow" class="cls expand">shadow</a><span> : String/Boolean</span></div><div class="description"><div class="short">Specifies whether the floating component should be given a shadow. Set to
809 true to automatically create an Ext.Shadow,...</div><div class="long"><p>Specifies whether the floating component should be given a shadow. Set to
810 <tt>true</tt> to automatically create an <a href="Ext.Shadow.html" rel="Ext.Shadow" class="docClass">Ext.Shadow</a>, or a string indicating the
811 shadow's display <a href="Ext.Shadow.html#mode" rel="Ext.Shadow#mode" class="docClass">Ext.Shadow.mode</a>. Set to <tt>false</tt> to disable the shadow.
812 (Defaults to <tt>'sides'</tt>.)</p>
813 </div></div></div><div id="config-stateEvents" class="member inherited"><a href="Ext.form.field.Base.html#config-stateEvents" rel="config-stateEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-cfg-stateEvents" class="viewSource">view source</a></div><a name="stateEvents"></a><a name="config-stateEvents"></a><a href="Ext.form.field.Base.html#" rel="config-stateEvents" class="cls expand">stateEvents</a><span> : Array</span></div><div class="description"><div class="short">An array of events that, when fired, should trigger this object to
814 save its state (defaults to none). stateEvents may...</div><div class="long"><p>An array of events that, when fired, should trigger this object to
815 save its state (defaults to none). <code>stateEvents</code> may be any type
816 of event supported by this object, including browser or custom events
817 (e.g., <tt>['click', 'customerchange']</tt>).</p>
818
819
820 <p>See <code><a href="Ext.form.field.Base.html#stateful" rel="Ext.form.field.Base#stateful" class="docClass">stateful</a></code> for an explanation of saving and
821 restoring object state.</p>
822
823 </div></div></div><div id="config-stateId" class="member inherited"><a href="Ext.form.field.Base.html#config-stateId" rel="config-stateId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-cfg-stateId" class="viewSource">view source</a></div><a name="stateId"></a><a name="config-stateId"></a><a href="Ext.form.field.Base.html#" rel="config-stateId" class="cls expand">stateId</a><span> : String</span></div><div class="description"><div class="short">The unique id for this object to use for state management purposes.
824
825 See stateful for an explanation of saving and re...</div><div class="long"><p>The unique id for this object to use for state management purposes.</p>
826
827 <p>See <a href="Ext.form.field.Base.html#stateful" rel="Ext.form.field.Base#stateful" class="docClass">stateful</a> for an explanation of saving and restoring state.</p>
828
829 </div></div></div><div id="config-stateful" class="member inherited"><a href="Ext.form.field.Base.html#config-stateful" rel="config-stateful" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-cfg-stateful" class="viewSource">view source</a></div><a name="stateful"></a><a name="config-stateful"></a><a href="Ext.form.field.Base.html#" rel="config-stateful" class="cls expand">stateful</a><span> : Boolean</span></div><div class="description"><div class="short">A flag which causes the object to attempt to restore the state of
830 internal properties from a saved state on startup. ...</div><div class="long"><p>A flag which causes the object to attempt to restore the state of
831 internal properties from a saved state on startup. The object must have
832 a <code><a href="Ext.form.field.Base.html#stateId" rel="Ext.form.field.Base#stateId" class="docClass">stateId</a></code> for state to be managed. 
833 Auto-generated ids are not guaranteed to be stable across page loads and 
834 cannot be relied upon to save and restore the same state for a object.<p>
835 <p>For state saving to work, the state manager's provider must have been
836 set to an implementation of <a href="Ext.state.Provider.html" rel="Ext.state.Provider" class="docClass">Ext.state.Provider</a> which overrides the
837 <a href="Ext.state.Provider.html#set" rel="Ext.state.Provider#set" class="docClass">set</a> and <a href="Ext.state.Provider.html#get" rel="Ext.state.Provider#get" class="docClass">get</a>
838 methods to save and recall name/value pairs. A built-in implementation,
839 <a href="Ext.state.CookieProvider.html" rel="Ext.state.CookieProvider" class="docClass">Ext.state.CookieProvider</a> is available.</p>
840 <p>To set the state provider for the current page:</p>
841 <pre><code>Ext.state.Manager.setProvider(new Ext.state.CookieProvider({
842     expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now
843 }));
844 </code></pre>
845 <p>A stateful object attempts to save state when one of the events
846 listed in the <code><a href="Ext.form.field.Base.html#stateEvents" rel="Ext.form.field.Base#stateEvents" class="docClass">stateEvents</a></code> configuration fires.</p>
847 <p>To save state, a stateful object first serializes its state by
848 calling <b><code><a href="Ext.form.field.Base.html#getState" rel="Ext.form.field.Base#getState" class="docClass">getState</a></code></b>. By default, this function does
849 nothing. The developer must provide an implementation which returns an
850 object hash which represents the restorable state of the object.</p>
851 <p>The value yielded by getState is passed to <a href="Ext.state.Manager.html#set" rel="Ext.state.Manager#set" class="docClass">Ext.state.Manager.set</a>
852 which uses the configured <a href="Ext.state.Provider.html" rel="Ext.state.Provider" class="docClass">Ext.state.Provider</a> to save the object
853 keyed by the <code><a href="stateId.html" rel="stateId" class="docClass">stateId</a></code></p>.
854 <p>During construction, a stateful object attempts to <i>restore</i>
855 its state by calling <a href="Ext.state.Manager.html#get" rel="Ext.state.Manager#get" class="docClass">Ext.state.Manager.get</a> passing the
856 <code><a href="Ext.form.field.Base.html#stateId" rel="Ext.form.field.Base#stateId" class="docClass">stateId</a></code></p>
857 <p>The resulting object is passed to <b><code><a href="Ext.form.field.Base.html#applyState" rel="Ext.form.field.Base#applyState" class="docClass">applyState</a></code></b>.
858 The default implementation of <code><a href="Ext.form.field.Base.html#applyState" rel="Ext.form.field.Base#applyState" class="docClass">applyState</a></code> simply copies
859 properties into the object, but a developer may override this to support
860 more behaviour.</p>
861 <p>You can perform extra processing on state save and restore by attaching
862 handlers to the <a href="Ext.form.field.Base.html#beforestaterestore" rel="Ext.form.field.Base#beforestaterestore" class="docClass">beforestaterestore</a>, <a href="Ext.form.field.Base.html#staterestore" rel="Ext.form.field.Base#staterestore" class="docClass">staterestore</a>,
863 <a href="Ext.form.field.Base.html#beforestatesave" rel="Ext.form.field.Base#beforestatesave" class="docClass">beforestatesave</a> and <a href="Ext.form.field.Base.html#statesave" rel="Ext.form.field.Base#statesave" class="docClass">statesave</a> events.</p>
864
865 </div></div></div><div id="config-style" class="member inherited"><a href="Ext.form.field.Base.html#config-style" rel="config-style" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-style" class="viewSource">view source</a></div><a name="style"></a><a name="config-style"></a><a href="Ext.form.field.Base.html#" rel="config-style" class="cls expand">style</a><span> : String</span></div><div class="description"><div class="short">A custom style specification to be applied to this component's Element.  Should be a valid argument to
866 Ext.core.Eleme...</div><div class="long"><p>A custom style specification to be applied to this component's Element.  Should be a valid argument to
867 <a href="Ext.core.Element.html#applyStyles" rel="Ext.core.Element#applyStyles" class="docClass">Ext.core.Element.applyStyles</a>.</p>
868
869 <pre><code>        new Ext.panel.Panel({
870             title: 'Some Title',
871             renderTo: Ext.getBody(),
872             width: 400, height: 300,
873             layout: 'form',
874             items: [{
875                 xtype: 'textarea',
876                 style: {
877                     width: '95%',
878                     marginBottom: '10px'
879                 }
880             },
881             new Ext.button.Button({
882                 text: 'Send',
883                 minWidth: '100',
884                 style: {
885                     marginBottom: '10px'
886                 }
887             })
888             ]
889         });
890      </code></pre>
891
892 </div></div></div><div id="config-styleHtmlCls" class="member inherited"><a href="Ext.form.field.Base.html#config-styleHtmlCls" rel="config-styleHtmlCls" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-styleHtmlCls" class="viewSource">view source</a></div><a name="styleHtmlCls"></a><a name="config-styleHtmlCls"></a><a href="Ext.form.field.Base.html#" rel="config-styleHtmlCls" class="cls expand">styleHtmlCls</a><span> : String</span></div><div class="description"><div class="short"><p>The class that is added to the content target when you set styleHtmlContent to true.
893 Defaults to 'x-html'</p>
894 </div><div class="long"><p>The class that is added to the content target when you set styleHtmlContent to true.
895 Defaults to 'x-html'</p>
896 </div></div></div><div id="config-styleHtmlContent" class="member inherited"><a href="Ext.form.field.Base.html#config-styleHtmlContent" rel="config-styleHtmlContent" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-styleHtmlContent" class="viewSource">view source</a></div><a name="styleHtmlContent"></a><a name="config-styleHtmlContent"></a><a href="Ext.form.field.Base.html#" rel="config-styleHtmlContent" class="cls expand">styleHtmlContent</a><span> : String</span></div><div class="description"><div class="short"><p>True to automatically style the html inside the content target of this component (body for panels).
897 Defaults to false.</p>
898 </div><div class="long"><p>True to automatically style the html inside the content target of this component (body for panels).
899 Defaults to false.</p>
900 </div></div></div><div id="config-submitValue" class="member inherited"><a href="Ext.form.field.Base.html#config-submitValue" rel="config-submitValue" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-cfg-submitValue" class="viewSource">view source</a></div><a name="submitValue"></a><a name="config-submitValue"></a><a href="Ext.form.field.Base.html#" rel="config-submitValue" class="cls expand">submitValue</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Setting this to <tt>false</tt> will prevent the field from being
901 <a href="Ext.form.Basic.html#submit" rel="Ext.form.Basic#submit" class="docClass">submitted</a> even when it is not disabled. Defaults to <tt>true</tt>.</p>
902 </div><div class="long"><p>Setting this to <tt>false</tt> will prevent the field from being
903 <a href="Ext.form.Basic.html#submit" rel="Ext.form.Basic#submit" class="docClass">submitted</a> even when it is not disabled. Defaults to <tt>true</tt>.</p>
904 </div></div></div><div id="config-tabIndex" class="member ni"><a href="Ext.form.field.Base.html#config-tabIndex" rel="config-tabIndex" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-tabIndex" class="viewSource">view source</a></div><a name="tabIndex"></a><a name="config-tabIndex"></a><a href="Ext.form.field.Base.html#" rel="config-tabIndex" class="cls expand">tabIndex</a><span> : Number</span></div><div class="description"><div class="short">The tabIndex for this field. Note this only applies to fields that are rendered,
905 not those which are built via applyT...</div><div class="long"><p>The tabIndex for this field. Note this only applies to fields that are rendered,
906 not those which are built via applyTo (defaults to undefined).</p>
907 </div></div></div><div id="config-toFrontOnShow" class="member inherited"><a href="Ext.form.field.Base.html#config-toFrontOnShow" rel="config-toFrontOnShow" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-cfg-toFrontOnShow" class="viewSource">view source</a></div><a name="toFrontOnShow"></a><a name="config-toFrontOnShow"></a><a href="Ext.form.field.Base.html#" rel="config-toFrontOnShow" class="cls expand">toFrontOnShow</a><span> : Boolean</span></div><div class="description"><div class="short">True to automatically call toFront when the show method is called
908 on an already visible, floating component (default ...</div><div class="long"><p>True to automatically call <a href="Ext.form.field.Base.html#toFront" rel="Ext.form.field.Base#toFront" class="docClass">toFront</a> when the <a href="Ext.form.field.Base.html#show" rel="Ext.form.field.Base#show" class="docClass">show</a> method is called
909 on an already visible, floating component (default is <code>true</code>).</p>
910
911 </div></div></div><div id="config-tpl" class="member inherited"><a href="Ext.form.field.Base.html#config-tpl" rel="config-tpl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-tpl" class="viewSource">view source</a></div><a name="tpl"></a><a name="config-tpl"></a><a href="Ext.form.field.Base.html#" rel="config-tpl" class="cls expand">tpl</a><span> : Mixed</span></div><div class="description"><div class="short">An Ext.Template, Ext.XTemplate
912 or an array of strings to form an Ext.XTemplate.
913 Used in conjunction with the data and...</div><div class="long"><p>An <bold><a href="Ext.Template.html" rel="Ext.Template" class="docClass">Ext.Template</a></bold>, <bold><a href="Ext.XTemplate.html" rel="Ext.XTemplate" class="docClass">Ext.XTemplate</a></bold>
914 or an array of strings to form an <a href="Ext.XTemplate.html" rel="Ext.XTemplate" class="docClass">Ext.XTemplate</a>.
915 Used in conjunction with the <code><a href="Ext.form.field.Base.html#data" rel="Ext.form.field.Base#data" class="docClass">data</a></code> and
916 <code><a href="Ext.form.field.Base.html#tplWriteMode" rel="Ext.form.field.Base#tplWriteMode" class="docClass">tplWriteMode</a></code> configurations.</p>
917 </div></div></div><div id="config-tplWriteMode" class="member inherited"><a href="Ext.form.field.Base.html#config-tplWriteMode" rel="config-tplWriteMode" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-tplWriteMode" class="viewSource">view source</a></div><a name="tplWriteMode"></a><a name="config-tplWriteMode"></a><a href="Ext.form.field.Base.html#" rel="config-tplWriteMode" class="cls expand">tplWriteMode</a><span> : String</span></div><div class="description"><div class="short">The Ext.(X)Template method to use when
918 updating the content area of the Component. Defaults to 'overwrite'
919 (see Ext.X...</div><div class="long"><p>The Ext.(X)Template method to use when
920 updating the content area of the Component. Defaults to <code>'overwrite'</code>
921 (see <code><a href="Ext.XTemplate.html#overwrite" rel="Ext.XTemplate#overwrite" class="docClass">Ext.XTemplate.overwrite</a></code>).</p>
922 </div></div></div><div id="config-ui" class="member inherited"><a href="Ext.form.field.Base.html#config-ui" rel="config-ui" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-ui" class="viewSource">view source</a></div><a name="ui"></a><a name="config-ui"></a><a href="Ext.form.field.Base.html#" rel="config-ui" class="cls expand">ui</a><span> : String/Array</span></div><div class="description"><div class="short"><p>A set style for a component. Can be a string or an Array of multiple strings (UIs)</p>
923 </div><div class="long"><p>A set style for a component. Can be a string or an Array of multiple strings (UIs)</p>
924 </div></div></div><div id="config-validateOnBlur" class="member ni"><a href="Ext.form.field.Base.html#config-validateOnBlur" rel="config-validateOnBlur" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-cfg-validateOnBlur" class="viewSource">view source</a></div><a name="validateOnBlur"></a><a name="config-validateOnBlur"></a><a href="Ext.form.field.Base.html#" rel="config-validateOnBlur" class="cls expand">validateOnBlur</a><span> : Boolean</span></div><div class="description"><div class="short">Whether the field should validate when it loses focus (defaults to true). This will cause fields
925 to be validated as t...</div><div class="long"><p>Whether the field should validate when it loses focus (defaults to <tt>true</tt>). This will cause fields
926 to be validated as the user steps through the fields in the form regardless of whether they are making
927 changes to those fields along the way. See also <a href="Ext.form.field.Base.html#validateOnChange" rel="Ext.form.field.Base#validateOnChange" class="docClass">validateOnChange</a>.</p>
928 </div></div></div><div id="config-validateOnChange" class="member inherited"><a href="Ext.form.field.Base.html#config-validateOnChange" rel="config-validateOnChange" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-cfg-validateOnChange" class="viewSource">view source</a></div><a name="validateOnChange"></a><a name="config-validateOnChange"></a><a href="Ext.form.field.Base.html#" rel="config-validateOnChange" class="cls expand">validateOnChange</a><span> : Boolean</span></div><div class="description"><div class="short">Specifies whether this field should be validated immediately whenever a change in its value is detected.
929 Defaults to ...</div><div class="long"><p>Specifies whether this field should be validated immediately whenever a change in its value is detected.
930 Defaults to <tt>true</tt>. If the validation results in a change in the field's validity, a
931 <a href="Ext.form.field.Base.html#validitychange" rel="Ext.form.field.Base#validitychange" class="docClass">validitychange</a> event will be fired. This allows the field to show feedback about the
932 validity of its contents immediately as the user is typing.</p>
933
934
935 <p>When set to <tt>false</tt>, feedback will not be immediate. However the form will still be validated
936 before submitting if the <tt>clientValidation</tt> option to <a href="Ext.form.Basic.html#doAction" rel="Ext.form.Basic#doAction" class="docClass">Ext.form.Basic.doAction</a> is
937 enabled, or if the field or form are validated manually.</p>
938
939
940 <p>See also <a href="Ext.form.field.Base.html#checkChangeEvents" rel="Ext.form.field.Base#checkChangeEvents" class="docClass">checkChangeEvents</a>for controlling how changes to the field's value are detected.</p>
941
942 </div></div></div><div id="config-value" class="member inherited"><a href="Ext.form.field.Base.html#config-value" rel="config-value" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-cfg-value" class="viewSource">view source</a></div><a name="value"></a><a name="config-value"></a><a href="Ext.form.field.Base.html#" rel="config-value" class="cls expand">value</a><span> : Mixed</span></div><div class="description"><div class="short"><p>A value to initialize this field with (defaults to undefined).</p>
943 </div><div class="long"><p>A value to initialize this field with (defaults to undefined).</p>
944 </div></div></div><div id="config-width" class="member inherited"><a href="Ext.form.field.Base.html#config-width" rel="config-width" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-cfg-width" class="viewSource">view source</a></div><a name="width"></a><a name="config-width"></a><a href="Ext.form.field.Base.html#" rel="config-width" class="cls expand">width</a><span> : Number</span></div><div class="description"><div class="short"><p>The width of this component in pixels.</p>
945 </div><div class="long"><p>The width of this component in pixels.</p>
946 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-bodyEl" class="member f inherited"><a href="Ext.form.field.Base.html#property-bodyEl" rel="property-bodyEl" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-property-bodyEl" class="viewSource">view source</a></div><a name="bodyEl"></a><a name="property-bodyEl"></a><a href="Ext.form.field.Base.html#" rel="property-bodyEl" class="cls expand">bodyEl</a><span> : Ext.core.Element</span></div><div class="description"><div class="short"><p>The div Element wrapping the component's contents. Only available after the component has been rendered.</p>
947 </div><div class="long"><p>The div Element wrapping the component's contents. Only available after the component has been rendered.</p>
948 </div></div></div><div id="property-clearInvalid" class="member inherited"><a href="Ext.form.field.Base.html#property-clearInvalid" rel="property-clearInvalid" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-property-clearInvalid" class="viewSource">view source</a></div><a name="clearInvalid"></a><a name="property-clearInvalid"></a><a href="Ext.form.field.Base.html#" rel="property-clearInvalid" class="cls expand">clearInvalid</a><span> : Object</span></div><div class="description"><div class="short">Clear any invalid styles/messages for this field. Components using this mixin should implement
949 this method to update ...</div><div class="long"><p>Clear any invalid styles/messages for this field. Components using this mixin should implement
950 this method to update the components rendering to clear any existing messages.</p>
951
952
953 <p><b>Note</b>: this method does not cause the Field's <a href="Ext.form.field.Base.html#validate" rel="Ext.form.field.Base#validate" class="docClass">validate</a> or <a href="Ext.form.field.Base.html#isValid" rel="Ext.form.field.Base#isValid" class="docClass">isValid</a> methods to
954 return <code>true</code> if the value does not <i>pass</i> validation. So simply clearing a field's errors
955 will not necessarily allow submission of forms submitted with the <a href="Ext.form.action.Submit.html#clientValidation" rel="Ext.form.action.Submit#clientValidation" class="docClass">Ext.form.action.Submit.clientValidation</a>
956 option set.</p>
957
958 </div></div></div><div id="property-draggable" class="member inherited"><a href="Ext.form.field.Base.html#property-draggable" rel="property-draggable" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-property-draggable" class="viewSource">view source</a></div><a name="draggable"></a><a name="property-draggable"></a><a href="Ext.form.field.Base.html#" rel="property-draggable" class="cls expand">draggable</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Read-only property indicating whether or not the component can be dragged</p>
959 </div><div class="long"><p>Read-only property indicating whether or not the component can be dragged</p>
960 </div></div></div><div id="property-errorEl" class="member inherited"><a href="Ext.form.field.Base.html#property-errorEl" rel="property-errorEl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-property-errorEl" class="viewSource">view source</a></div><a name="errorEl"></a><a name="property-errorEl"></a><a href="Ext.form.field.Base.html#" rel="property-errorEl" class="cls expand">errorEl</a><span> : Ext.core.Element</span></div><div class="description"><div class="short">The div Element that will contain the component's error message(s). Note that depending on the
961 configured msgTarget, ...</div><div class="long"><p>The div Element that will contain the component's error message(s). Note that depending on the
962 configured <a href="Ext.form.field.Base.html#msgTarget" rel="Ext.form.field.Base#msgTarget" class="docClass">msgTarget</a>, this element may be hidden in favor of some other form of
963 presentation, but will always be present in the DOM for use by assistive technologies.</p>
964 </div></div></div><div id="property-floatParent" class="member inherited"><a href="Ext.form.field.Base.html#property-floatParent" rel="property-floatParent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-property-floatParent" class="viewSource">view source</a></div><a name="floatParent"></a><a name="property-floatParent"></a><a href="Ext.form.field.Base.html#" rel="property-floatParent" class="cls expand">floatParent</a><span> : Ext.Container</span></div><div class="description"><div class="short">Optional. Only present for floating Components which were inserted as descendant items of floating Containers.
965
966
967 Floa...</div><div class="long"><p>Optional. Only present for <a href="Ext.form.field.Base.html#floating" rel="Ext.form.field.Base#floating" class="docClass">floating</a> Components which were inserted as descendant items of floating Containers.</p>
968
969
970 <p>Floating Components that are programatically <a href="Ext.Component.html#render" rel="Ext.Component#render" class="docClass">rendered</a> will not have a <code>floatParent</code> property.</p>
971
972
973 <p>For <a href="Ext.form.field.Base.html#floating" rel="Ext.form.field.Base#floating" class="docClass">floating</a> Components which are child items of a Container, the floatParent will be the floating ancestor Container which is
974 responsible for the base z-index value of all its floating descendants. It provides a <a href="Ext.ZIndexManager.html" rel="Ext.ZIndexManager" class="docClass">ZIndexManager</a> which provides
975 z-indexing services for all its descendant floating Components.</p>
976
977
978 <p>For example, the dropdown <a href="Ext.view.BoundList.html" rel="Ext.view.BoundList" class="docClass">BoundList</a> of a ComboBox which is in a Window will have the Window as its
979 <code>floatParent</code></p>
980
981
982 <p>See <a href="Ext.form.field.Base.html#floating" rel="Ext.form.field.Base#floating" class="docClass">floating</a> and <a href="Ext.form.field.Base.html#zIndexManager" rel="Ext.form.field.Base#zIndexManager" class="docClass">zIndexManager</a></p>
983
984 </div></div></div><div id="property-frameSize" class="member inherited"><a href="Ext.form.field.Base.html#property-frameSize" rel="property-frameSize" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-property-frameSize" class="viewSource">view source</a></div><a name="frameSize"></a><a name="property-frameSize"></a><a href="Ext.form.field.Base.html#" rel="property-frameSize" class="cls expand">frameSize</a><span> : Object</span></div><div class="description"><div class="short">Read-only property indicating the width of any framing elements which were added within the encapsulating element
985 to ...</div><div class="long"><p>Read-only property indicating the width of any framing elements which were added within the encapsulating element
986 to provide graphical, rounded borders. See the <a href="Ext.form.field.Base.html#frame" rel="Ext.form.field.Base#frame" class="docClass">frame</a> config.</p>
987
988
989 <p> This is an object containing the frame width in pixels for all four sides of the Component containing
990 the following properties:</p>
991
992
993 <div class="mdetail-params"><ul>
994 <li><code>top</code> The width of the top framing element in pixels.</li>
995 <li><code>right</code> The width of the right framing element in pixels.</li>
996 <li><code>bottom</code> The width of the bottom framing element in pixels.</li>
997 <li><code>left</code> The width of the left framing element in pixels.</li>
998 </ul></div>
999
1000 </div></div></div><div id="property-hasActiveFx" class="member inherited"><a href="Ext.form.field.Base.html#property-hasActiveFx" rel="property-hasActiveFx" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-property-hasActiveFx" class="viewSource">view source</a></div><a name="hasActiveFx"></a><a name="property-hasActiveFx"></a><a href="Ext.form.field.Base.html#" rel="property-hasActiveFx" class="cls expand">hasActiveFx</a><span> : Object</span></div><div class="description"><div class="short">@deprecated 4.0 Replaced by getActiveAnimation
1001 Returns thq current animation if this object has any effects actively ...</div><div class="long"><p>@deprecated 4.0 Replaced by <a href="Ext.form.field.Base.html#getActiveAnimation" rel="Ext.form.field.Base#getActiveAnimation" class="docClass">getActiveAnimation</a>
1002 Returns thq current animation if this object has any effects actively running or queued, else returns false.</p>
1003 </div></div></div><div id="property-inputEl" class="member ni"><a href="Ext.form.field.Base.html#property-inputEl" rel="property-inputEl" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-property-inputEl" class="viewSource">view source</a></div><a name="inputEl"></a><a name="property-inputEl"></a><a href="Ext.form.field.Base.html#" rel="property-inputEl" class="cls expand">inputEl</a><span> : Ext.core.Element</span></div><div class="description"><div class="short"><p>The input Element for this Field. Only available after the field has been rendered.</p>
1004 </div><div class="long"><p>The input Element for this Field. Only available after the field has been rendered.</p>
1005 </div></div></div><div id="property-isFieldLabelable" class="member inherited"><a href="Ext.form.field.Base.html#property-isFieldLabelable" rel="property-isFieldLabelable" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-property-isFieldLabelable" class="viewSource">view source</a></div><a name="isFieldLabelable"></a><a name="property-isFieldLabelable"></a><a href="Ext.form.field.Base.html#" rel="property-isFieldLabelable" class="cls expand">isFieldLabelable</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Flag denoting that this object is labelable as a field. Always true.</p>
1006 </div><div class="long"><p>Flag denoting that this object is labelable as a field. Always true.</p>
1007 </div></div></div><div id="property-isFormField" class="member inherited"><a href="Ext.form.field.Base.html#property-isFormField" rel="property-isFormField" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-property-isFormField" class="viewSource">view source</a></div><a name="isFormField"></a><a name="property-isFormField"></a><a href="Ext.form.field.Base.html#" rel="property-isFormField" class="cls expand">isFormField</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Flag denoting that this component is a Field. Always true.</p>
1008 </div><div class="long"><p>Flag denoting that this component is a Field. Always true.</p>
1009 </div></div></div><div id="property-labelEl" class="member inherited"><a href="Ext.form.field.Base.html#property-labelEl" rel="property-labelEl" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-property-labelEl" class="viewSource">view source</a></div><a name="labelEl"></a><a name="property-labelEl"></a><a href="Ext.form.field.Base.html#" rel="property-labelEl" class="cls expand">labelEl</a><span> : Ext.core.Element</span></div><div class="description"><div class="short"><p>The label Element for this component. Only available after the component has been rendered.</p>
1010 </div><div class="long"><p>The label Element for this component. Only available after the component has been rendered.</p>
1011 </div></div></div><div id="property-markInvalid" class="member inherited"><a href="Ext.form.field.Base.html#property-markInvalid" rel="property-markInvalid" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-property-markInvalid" class="viewSource">view source</a></div><a name="markInvalid"></a><a name="property-markInvalid"></a><a href="Ext.form.field.Base.html#" rel="property-markInvalid" class="cls expand">markInvalid</a><span> : Object</span></div><div class="description"><div class="short">Associate one or more error messages with this field. Components using this mixin should implement
1012 this method to upd...</div><div class="long"><p>Associate one or more error messages with this field. Components using this mixin should implement
1013 this method to update the component's rendering to display the messages.</p>
1014
1015
1016 <p><b>Note</b>: this method does not cause the Field's <a href="Ext.form.field.Base.html#validate" rel="Ext.form.field.Base#validate" class="docClass">validate</a> or <a href="Ext.form.field.Base.html#isValid" rel="Ext.form.field.Base#isValid" class="docClass">isValid</a> methods to
1017 return <code>false</code> if the value does <i>pass</i> validation. So simply marking a Field as invalid
1018 will not prevent submission of forms submitted with the <a href="Ext.form.action.Submit.html#clientValidation" rel="Ext.form.action.Submit#clientValidation" class="docClass">Ext.form.action.Submit.clientValidation</a>
1019 option set.</p>
1020
1021 </div></div></div><div id="property-maskOnDisable" class="member inherited"><a href="Ext.form.field.Base.html#property-maskOnDisable" rel="property-maskOnDisable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-property-maskOnDisable" class="viewSource">view source</a></div><a name="maskOnDisable"></a><a name="property-maskOnDisable"></a><a href="Ext.form.field.Base.html#" rel="property-maskOnDisable" class="cls expand">maskOnDisable</a><span> : Boolean</span></div><div class="description"><div class="short">This is an internal flag that you use when creating custom components.
1022 By default this is set to true which means tha...</div><div class="long"><p>This is an internal flag that you use when creating custom components.
1023 By default this is set to true which means that every component gets a mask when its disabled.
1024 Components like FieldContainer, FieldSet, Field, Button, Tab override this property to false
1025 since they want to implement custom disable logic.</p>
1026 </div></div></div><div id="property-originalValue" class="member inherited"><a href="Ext.form.field.Base.html#property-originalValue" rel="property-originalValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-property-originalValue" class="viewSource">view source</a></div><a name="originalValue"></a><a name="property-originalValue"></a><a href="Ext.form.field.Base.html#" rel="property-originalValue" class="cls expand">originalValue</a><span> : Mixed</span></div><div class="description"><div class="short">The original value of the field as configured in the value configuration, or as loaded by
1027 the last form load operatio...</div><div class="long"><p>The original value of the field as configured in the <a href="Ext.form.field.Base.html#value" rel="Ext.form.field.Base#value" class="docClass">value</a> configuration, or as loaded by
1028 the last form load operation if the form's <a href="Ext.form.Basic.html#trackResetOnLoad" rel="Ext.form.Basic#trackResetOnLoad" class="docClass">trackResetOnLoad</a>
1029 setting is <code>true</code>.</p>
1030 </div></div></div><div id="property-ownerCt" class="member inherited"><a href="Ext.form.field.Base.html#property-ownerCt" rel="property-ownerCt" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-property-ownerCt" class="viewSource">view source</a></div><a name="ownerCt"></a><a name="property-ownerCt"></a><a href="Ext.form.field.Base.html#" rel="property-ownerCt" class="cls expand">ownerCt</a><span> : Ext.Container</span></div><div class="description"><div class="short">This Component's owner Container (defaults to undefined, and is set automatically when
1031 this Component is added to a C...</div><div class="long"><p>This Component's owner <a href="Ext.container.Container.html" rel="Ext.container.Container" class="docClass">Container</a> (defaults to undefined, and is set automatically when
1032 this Component is added to a Container).  Read-only.</p>
1033
1034 <p><b>Note</b>: to access items within the Container see <tt><a href="Ext.form.field.Base.html#itemId" rel="Ext.form.field.Base#itemId" class="docClass">itemId</a></tt>.</p>
1035
1036 </div></div></div><div id="property-rendered" class="member inherited"><a href="Ext.form.field.Base.html#property-rendered" rel="property-rendered" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-property-rendered" class="viewSource">view source</a></div><a name="rendered"></a><a name="property-rendered"></a><a href="Ext.form.field.Base.html#" rel="property-rendered" class="cls expand">rendered</a><span> : Boolean</span></div><div class="description"><div class="short"><p>Read-only property indicating whether or not the component has been rendered.</p>
1037 </div><div class="long"><p>Read-only property indicating whether or not the component has been rendered.</p>
1038 </div></div></div><div id="property-stopFx" class="member inherited"><a href="Ext.form.field.Base.html#property-stopFx" rel="property-stopFx" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-property-stopFx" class="viewSource">view source</a></div><a name="stopFx"></a><a name="property-stopFx"></a><a href="Ext.form.field.Base.html#" rel="property-stopFx" class="cls expand">stopFx</a><span> : Object</span></div><div class="description"><div class="short">Stops any running effects and clears this object's internal effects queue if it contains
1039 any additional effects that ...</div><div class="long"><p>Stops any running effects and clears this object's internal effects queue if it contains
1040 any additional effects that haven't started yet.</p>
1041 </div></div></div><div id="property-zIndexManager" class="member inherited"><a href="Ext.form.field.Base.html#property-zIndexManager" rel="property-zIndexManager" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-property-zIndexManager" class="viewSource">view source</a></div><a name="zIndexManager"></a><a name="property-zIndexManager"></a><a href="Ext.form.field.Base.html#" rel="property-zIndexManager" class="cls expand">zIndexManager</a><span> : Ext.ZIndexManager</span></div><div class="description"><div class="short">Optional. Only present for floating Components after they have been rendered.
1042
1043
1044 A reference to the ZIndexManager whic...</div><div class="long"><p>Optional. Only present for <a href="Ext.form.field.Base.html#floating" rel="Ext.form.field.Base#floating" class="docClass">floating</a> Components after they have been rendered.</p>
1045
1046
1047 <p>A reference to the ZIndexManager which is managing this Component's z-index.</p>
1048
1049
1050 <p>The <a href="Ext.ZIndexManager.html" rel="Ext.ZIndexManager" class="docClass">ZIndexManager</a> maintains a stack of floating Component z-indices, and also provides a single modal
1051 mask which is insert just beneath the topmost visible modal floating Component.</p>
1052
1053
1054 <p>Floating Components may be <a href="Ext.form.field.Base.html#toFront" rel="Ext.form.field.Base#toFront" class="docClass">brought to the front</a> or <a href="Ext.form.field.Base.html#toBack" rel="Ext.form.field.Base#toBack" class="docClass">sent to the back</a> of the z-index stack.</p>
1055
1056
1057 <p>This defaults to the global <a href="Ext.WindowManager.html" rel="Ext.WindowManager" class="docClass">ZIndexManager</a> for floating Components that are programatically
1058 <a href="Ext.Component.html#render" rel="Ext.Component#render" class="docClass">rendered</a>.</p>
1059
1060
1061 <p>For <a href="Ext.form.field.Base.html#floating" rel="Ext.form.field.Base#floating" class="docClass">floating</a> Components which are added to a Container, the ZIndexManager is acquired from the first ancestor Container found
1062 which is floating, or if not found the global <a href="Ext.WindowManager.html" rel="Ext.WindowManager" class="docClass">ZIndexManager</a> is used.</p>
1063
1064
1065 <p>See <a href="Ext.form.field.Base.html#floating" rel="Ext.form.field.Base#floating" class="docClass">floating</a> and <a href="Ext.form.field.Base.html#floatParent" rel="Ext.form.field.Base#floatParent" class="docClass">floatParent</a></p>
1066
1067 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-Base" class="member f ni"><a href="Ext.form.field.Base.html#method-Base" rel="method-Base" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-constructor" class="viewSource">view source</a></div><a name="Base"></a><a name="method-Base"></a><a href="Ext.form.field.Base.html#" rel="method-Base" class="cls expand">Base</a>(
1068 <span class="pre">Object config</span>)
1069  : void</div><div class="description"><div class="short"><p>Creates a new Field</p>
1070 </div><div class="long"><p>Creates a new Field</p>
1071 <h3 class="pa">Parameters</h3><ul><li><span class="pre">config</span> : Object<div class="sub-desc"><p>Configuration options</p>
1072 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1073 </li></ul></div></div></div><div id="method-addClass" class="member inherited"><a href="Ext.form.field.Base.html#method-addClass" rel="method-addClass" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-addClass" class="viewSource">view source</a></div><a name="addClass"></a><a name="method-addClass"></a><a href="Ext.form.field.Base.html#" rel="method-addClass" class="cls expand">addClass</a>(
1074 <span class="pre">String cls</span>)
1075  : Ext.Component</div><div class="description"><div class="short"><p>@deprecated 4.0 Replaced by {link:#addCls}
1076 Adds a CSS class to the top level element representing this component.</p>
1077 </div><div class="long"><p>@deprecated 4.0 Replaced by {link:#addCls}
1078 Adds a CSS class to the top level element representing this component.</p>
1079 <h3 class="pa">Parameters</h3><ul><li><span class="pre">cls</span> : String<div class="sub-desc"><p>The CSS class name to add</p>
1080 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>Returns the Component to allow method chaining.</p>
1081 </li></ul></div></div></div><div id="method-addCls" class="member inherited"><a href="Ext.form.field.Base.html#method-addCls" rel="method-addCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-addCls" class="viewSource">view source</a></div><a name="addCls"></a><a name="method-addCls"></a><a href="Ext.form.field.Base.html#" rel="method-addCls" class="cls expand">addCls</a>(
1082 <span class="pre">String cls</span>)
1083  : Ext.Component</div><div class="description"><div class="short"><p>Adds a CSS class to the top level element representing this component.</p>
1084 </div><div class="long"><p>Adds a CSS class to the top level element representing this component.</p>
1085 <h3 class="pa">Parameters</h3><ul><li><span class="pre">cls</span> : String<div class="sub-desc"><p>The CSS class name to add</p>
1086 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>Returns the Component to allow method chaining.</p>
1087 </li></ul></div></div></div><div id="method-addClsWithUI" class="member inherited"><a href="Ext.form.field.Base.html#method-addClsWithUI" rel="method-addClsWithUI" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-addClsWithUI" class="viewSource">view source</a></div><a name="addClsWithUI"></a><a name="method-addClsWithUI"></a><a href="Ext.form.field.Base.html#" rel="method-addClsWithUI" class="cls expand">addClsWithUI</a>(
1088 <span class="pre">String/Array cls</span>)
1089  : void</div><div class="description"><div class="short"><p>Adds a cls to the uiCls array, which will also call <a href="Ext.form.field.Base.html#addUIClsToElement" rel="Ext.form.field.Base#addUIClsToElement" class="docClass">addUIClsToElement</a> and adds
1090 to all elements of this component.</p>
1091 </div><div class="long"><p>Adds a cls to the uiCls array, which will also call <a href="Ext.form.field.Base.html#addUIClsToElement" rel="Ext.form.field.Base#addUIClsToElement" class="docClass">addUIClsToElement</a> and adds
1092 to all elements of this component.</p>
1093 <h3 class="pa">Parameters</h3><ul><li><span class="pre">cls</span> : String/Array<div class="sub-desc"><p>A string or an array of strings to add to the uiCls</p>
1094 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1095 </li></ul></div></div></div><div id="method-addEvents" class="member inherited"><a href="Ext.form.field.Base.html#method-addEvents" rel="method-addEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addEvents" class="viewSource">view source</a></div><a name="addEvents"></a><a name="method-addEvents"></a><a href="Ext.form.field.Base.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
1096 <span class="pre">Object/String o, String </span>)
1097  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
1098 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
1099 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object/String<div class="sub-desc"><p>Either an object with event names as properties with a value of <code>true</code>
1100 or the first event name string if multiple event names are being passed as separate parameters.</p>
1101 </div></li><li><span class="pre"></span> : String<div class="sub-desc"><p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.
1102 Usage:</p>
1103
1104 <pre><code>this.addEvents('storeloaded', 'storecleared');
1105 </code></pre>
1106
1107 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1108 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.form.field.Base.html#method-addListener" rel="method-addListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addListener" class="viewSource">view source</a></div><a name="addListener"></a><a name="method-addListener"></a><a href="Ext.form.field.Base.html#" rel="method-addListener" class="cls expand">addListener</a>(
1109 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
1110  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
1111 </div><div class="long"><p>Appends an event handler to this object.</p>
1112 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to listen for. May also be an object who's property names are event names. See</p>
1113 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
1114 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
1115 <b>If omitted, defaults to the object which fired the event.</b></p>
1116 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
1117 properties. This may contain any of the following properties:<ul>
1118 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
1119 <b>If omitted, defaults to the object which fired the event.</b></div></li>
1120 <li><b>delay</b> : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>
1121 <li><b>single</b> : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>
1122 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html" rel="Ext.util.DelayedTask" class="docClass">Ext.util.DelayedTask</a> delayed
1123 by the specified number of milliseconds. If the event fires again within that time, the original
1124 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
1125 <li><b>target</b> : Observable<div class="sub-desc">Only call the handler if the event was fired on the target Observable, <i>not</i>
1126 if the event was bubbled up from a child Observable.</div></li>
1127 <li><b>element</b> : String<div class="sub-desc"><b>This option is only valid for listeners bound to <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a>.</b>
1128 The name of a Component property which references an element to add a listener to.</p>
1129
1130 <p>This option is useful during Component construction to add DOM event listeners to elements of <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a> which
1131 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
1132 <pre><code>new Ext.panel.Panel({
1133     title: 'The title',
1134     listeners: {
1135         click: this.handlePanelClick,
1136         element: 'body'
1137     }
1138 });
1139 </code></pre></p>
1140
1141
1142 <p>When added in this way, the options available are the options applicable to <a href="Ext.core.Element.html#addListener" rel="Ext.core.Element#addListener" class="docClass">Ext.core.Element.addListener</a></p>
1143
1144
1145 <p></div></li>
1146 </ul><br></p>
1147
1148 <p>
1149 <b>Combining Options</b><br>
1150 Using the options argument, it is possible to combine different types of listeners:<br>
1151 <br>
1152 A delayed, one-time listener.
1153 <pre><code>myPanel.on('hide', this.handleClick, this, {
1154 single: true,
1155 delay: 100
1156 });</code></pre>
1157 <p>
1158 <b>Attaching multiple handlers in 1 call</b><br>
1159 The method also allows for a single argument to be passed which is a config object containing properties
1160 which specify multiple events. For example:
1161 <pre><code>myGridPanel.on({
1162     cellClick: this.onCellClick,
1163     mouseover: this.onMouseOver,
1164     mouseout: this.onMouseOut,
1165     scope: this // Important. Ensure "this" is correct during handler execution
1166 });
1167 </code></pre>.
1168 <p>
1169
1170 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1171 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.form.field.Base.html#method-addManagedListener" rel="method-addManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addManagedListener" class="viewSource">view source</a></div><a name="addManagedListener"></a><a name="method-addManagedListener"></a><a href="Ext.form.field.Base.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
1172 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
1173  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
1174 is destroyed.
1175
1176 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
1177 is destroyed.
1178
1179 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable/Element<div class="sub-desc"><p>The item to which to add a listener/listeners.</p>
1180 </div></li><li><span class="pre">ename</span> : Object/String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
1181 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
1182 is the handler function.</p>
1183 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
1184 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
1185 </div></li><li><span class="pre">opt</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
1186 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
1187 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1188 </li></ul></div></div></div><div id="method-addStateEvents" class="member inherited"><a href="Ext.form.field.Base.html#method-addStateEvents" rel="method-addStateEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-method-addStateEvents" class="viewSource">view source</a></div><a name="addStateEvents"></a><a name="method-addStateEvents"></a><a href="Ext.form.field.Base.html#" rel="method-addStateEvents" class="cls expand">addStateEvents</a>(
1189 <span class="pre">String/Array events</span>)
1190  : void</div><div class="description"><div class="short"><p>Add events that will trigger the state to be saved.</p>
1191 </div><div class="long"><p>Add events that will trigger the state to be saved.</p>
1192 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name or an array of event names.</p>
1193 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1194 </li></ul></div></div></div><div id="method-afterComponentLayout" class="member inherited"><a href="Ext.form.field.Base.html#method-afterComponentLayout" rel="method-afterComponentLayout" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-afterComponentLayout" class="viewSource">view source</a></div><a name="afterComponentLayout"></a><a name="method-afterComponentLayout"></a><a href="Ext.form.field.Base.html#" rel="method-afterComponentLayout" class="cls expand">afterComponentLayout</a>(
1195 <span class="pre">Number adjWidth, Number adjHeight, Boolean isSetSize, Ext.Component layoutOwner</span>)
1196  : void</div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
1197 <h3 class="pa">Parameters</h3><ul><li><span class="pre">adjWidth</span> : Number<div class="sub-desc"><p>The box-adjusted width that was set</p>
1198 </div></li><li><span class="pre">adjHeight</span> : Number<div class="sub-desc"><p>The box-adjusted height that was set</p>
1199 </div></li><li><span class="pre">isSetSize</span> : Boolean<div class="sub-desc"><p>Whether or not the height/width are stored on the component permanently</p>
1200 </div></li><li><span class="pre">layoutOwner</span> : Ext.Component<div class="sub-desc"><p>Component which sent the layout. Only used when isSetSize is false.</p>
1201 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1202 </li></ul></div></div></div><div id="method-alignTo" class="member inherited"><a href="Ext.form.field.Base.html#method-alignTo" rel="method-alignTo" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-method-alignTo" class="viewSource">view source</a></div><a name="alignTo"></a><a name="method-alignTo"></a><a href="Ext.form.field.Base.html#" rel="method-alignTo" class="cls expand">alignTo</a>(
1203 <span class="pre">Mixed element, String position, [Array offsets]</span>)
1204  : Component</div><div class="description"><div class="short"><p>Aligns this floating Component to the specified element</p>
1205 </div><div class="long"><p>Aligns this floating Component to the specified element</p>
1206 <h3 class="pa">Parameters</h3><ul><li><span class="pre">element</span> : Mixed<div class="sub-desc"><p>The element or <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> to align to. If passing a component, it must
1207 be a omponent instance. If a string id is passed, it will be used as an element id.</p>
1208 </div></li><li><span class="pre">position</span> : String<div class="sub-desc"><p>(optional, defaults to "tl-bl?") The position to align to (see <a href="Ext.core.Element.html#alignTo" rel="Ext.core.Element#alignTo" class="docClass">Ext.core.Element.alignTo</a> for more details).</p>
1209 </div></li><li><span class="pre">offsets</span> : Array<div class="sub-desc"><p>(optional) Offset the positioning by [x, y]</p>
1210 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Component</span>&nbsp; &nbsp;<p>this</p>
1211 </li></ul></div></div></div><div id="method-animate" class="member inherited"><a href="Ext.form.field.Base.html#method-animate" rel="method-animate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-method-animate" class="viewSource">view source</a></div><a name="animate"></a><a name="method-animate"></a><a href="Ext.form.field.Base.html#" rel="method-animate" class="cls expand">animate</a>(
1212 <span class="pre">Object config</span>)
1213  : Object</div><div class="description"><div class="short">Perform custom animation on this object.
1214 This method is applicable to both the the Component class and the Element cl...</div><div class="long"><p>Perform custom animation on this object.<p>
1215 <p>This method is applicable to both the the <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Component</a> class and the <a href="Ext.core.Element.html" rel="Ext.core.Element" class="docClass">Element</a> class.
1216 It performs animated transitions of certain properties of this object over a specified timeline.</p>
1217 <p>The sole parameter is an object which specifies start property values, end property values, and properties which
1218 describe the timeline. Of the properties listed below, only <b><code>to</code></b> is mandatory.</p>
1219 <p>Properties include<ul>
1220 <li><code>from</code> <div class="sub-desc">An object which specifies start values for the properties being animated.
1221 If not supplied, properties are animated from current settings. The actual properties which may be animated depend upon
1222 ths object being animated. See the sections below on Element and Component animation.<div></li>
1223 <li><code>to</code> <div class="sub-desc">An object which specifies end values for the properties being animated.</div></li>
1224 <li><code>duration</code><div class="sub-desc">The duration <b>in milliseconds</b> for which the animation will run.</div></li>
1225 <li><code>easing</code> <div class="sub-desc">A string value describing an easing type to modify the rate of change from the default linear to non-linear. Values may be one of:<code><ul>
1226 <li>ease</li>
1227 <li>easeIn</li>
1228 <li>easeOut</li>
1229 <li>easeInOut</li>
1230 <li>backIn</li>
1231 <li>backOut</li>
1232 <li>elasticIn</li>
1233 <li>elasticOut</li>
1234 <li>bounceIn</li>
1235 <li>bounceOut</li>
1236 </ul></code></div></li>
1237 <li><code>keyframes</code> <div class="sub-desc">This is an object which describes the state of animated properties at certain points along the timeline.
1238 it is an object containing properties who's names are the percentage along the timeline being described and who's values specify the animation state at that point.</div></li>
1239 <li><code>listeners</code> <div class="sub-desc">This is a standard <a href="Ext.util.Observable.html#listeners" rel="Ext.util.Observable#listeners" class="docClass">listeners</a> configuration object which may be used
1240 to inject behaviour at either the <code>beforeanimate</code> event or the <code>afteranimate</code> event.</div></li>
1241 </ul></p>
1242 <h3>Animating an <a href="Ext.core.Element.html" rel="Ext.core.Element" class="docClass">Element</a></h3>
1243 When animating an Element, the following properties may be specified in <code>from</code>, <code>to</code>, and <code>keyframe</code> objects:<ul>
1244 <li><code>x</code> <div class="sub-desc">The page X position in pixels.</div></li>
1245 <li><code>y</code> <div class="sub-desc">The page Y position in pixels</div></li>
1246 <li><code>left</code> <div class="sub-desc">The element's CSS <code>left</code> value. Units must be supplied.</div></li>
1247 <li><code>top</code> <div class="sub-desc">The element's CSS <code>top</code> value. Units must be supplied.</div></li>
1248 <li><code>width</code> <div class="sub-desc">The element's CSS <code>width</code> value. Units must be supplied.</div></li>
1249 <li><code>height</code> <div class="sub-desc">The element's CSS <code>height</code> value. Units must be supplied.</div></li>
1250 <li><code>scrollLeft</code> <div class="sub-desc">The element's <code>scrollLeft</code> value.</div></li>
1251 <li><code>scrollTop</code> <div class="sub-desc">The element's <code>scrollLeft</code> value.</div></li>
1252 <li><code>opacity</code> <div class="sub-desc">The element's <code>opacity</code> value. This must be a value between <code>0</code> and <code>1</code>.</div></li>
1253 </ul>
1254 <p><b>Be aware than animating an Element which is being used by an <a href="Ext.html" rel="Ext" class="docClass">Ext</a> Component without in some way informing the Component about the changed element state
1255 will result in incorrect Component behaviour. This is because the Component will be using the old state of the element. To avoid this problem, it is now possible to
1256 directly animate certain properties of Components.</b></p>
1257 <h3>Animating a <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Component</a></h3>
1258 When animating an Element, the following properties may be specified in <code>from</code>, <code>to</code>, and <code>keyframe</code> objects:<ul>
1259 <li><code>x</code> <div class="sub-desc">The Component's page X position in pixels.</div></li>
1260 <li><code>y</code> <div class="sub-desc">The Component's page Y position in pixels</div></li>
1261 <li><code>left</code> <div class="sub-desc">The Component's <code>left</code> value in pixels.</div></li>
1262 <li><code>top</code> <div class="sub-desc">The Component's <code>top</code> value in pixels.</div></li>
1263 <li><code>width</code> <div class="sub-desc">The Component's <code>width</code> value in pixels.</div></li>
1264 <li><code>width</code> <div class="sub-desc">The Component's <code>width</code> value in pixels.</div></li>
1265 <li><code>dynamic</code> <div class="sub-desc">Specify as true to update the Component's layout (if it is a Container) at every frame
1266 of the animation. <i>Use sparingly as laying out on every intermediate size change is an expensive operation</i>.</div></li>
1267 </ul>
1268 <p>For example, to animate a Window to a new size, ensuring that its internal layout, and any shadow is correct:</p>
1269 <pre><code>myWindow = Ext.create('Ext.window.Window', {
1270     title: 'Test Component animation',
1271     width: 500,
1272     height: 300,
1273     layout: {
1274         type: 'hbox',
1275         align: 'stretch'
1276     },
1277     items: [{
1278         title: 'Left: 33%',
1279         margins: '5 0 5 5',
1280         flex: 1
1281     }, {
1282         title: 'Left: 66%',
1283         margins: '5 5 5 5',
1284         flex: 2
1285     }]
1286 });
1287 myWindow.show();
1288 myWindow.header.el.on('click', function() {
1289     myWindow.animate({
1290         to: {
1291             width: (myWindow.getWidth() == 500) ? 700 : 500,
1292             height: (myWindow.getHeight() == 300) ? 400 : 300,
1293         }
1294     });
1295 });
1296 </code></pre>
1297 <p>For performance reasons, by default, the internal layout is only updated when the Window reaches its final <code>"to"</code> size. If dynamic updating of the Window's child
1298 Components is required, then configure the animation with <code>dynamic: true</code> and the two child items will maintain their proportions during the animation.</p>
1299
1300 <h3 class="pa">Parameters</h3><ul><li><span class="pre">config</span> : Object<div class="sub-desc"><p>An object containing properties which describe the animation's start and end states, and the timeline of the animation.</p>
1301 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>this</p>
1302 </li></ul></div></div></div><div id="method-applyState" class="member inherited"><a href="Ext.form.field.Base.html#method-applyState" rel="method-applyState" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-method-applyState" class="viewSource">view source</a></div><a name="applyState"></a><a name="method-applyState"></a><a href="Ext.form.field.Base.html#" rel="method-applyState" class="cls expand">applyState</a>(
1303 <span class="pre">Object state</span>)
1304  : void</div><div class="description"><div class="short">Applies the state to the object. This should be overridden in subclasses to do
1305 more complex state operations. By defa...</div><div class="long"><p>Applies the state to the object. This should be overridden in subclasses to do
1306 more complex state operations. By default it applies the state properties onto
1307 the current object.</p>
1308 <h3 class="pa">Parameters</h3><ul><li><span class="pre">state</span> : Object<div class="sub-desc"><p>The state</p>
1309 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1310 </li></ul></div></div></div><div id="method-batchChanges" class="member inherited"><a href="Ext.form.field.Base.html#method-batchChanges" rel="method-batchChanges" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-batchChanges" class="viewSource">view source</a></div><a name="batchChanges"></a><a name="method-batchChanges"></a><a href="Ext.form.field.Base.html#" rel="method-batchChanges" class="cls expand">batchChanges</a>(
1311 <span class="pre">Object fn</span>)
1312  : void</div><div class="description"><div class="short">A utility for grouping a set of modifications which may trigger value changes into a single
1313 transaction, to prevent e...</div><div class="long"><p>A utility for grouping a set of modifications which may trigger value changes into a single
1314 transaction, to prevent excessive firing of <a href="Ext.form.field.Base.html#change" rel="Ext.form.field.Base#change" class="docClass">change</a> events. This is useful for instance
1315 if the field has sub-fields which are being updated as a group; you don't want the container
1316 field to check its own changed state for each subfield change.</p>
1317 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fn</span> : Object<div class="sub-desc"><p>A function containing the transaction code</p>
1318 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1319 </li></ul></div></div></div><div id="method-beforeComponentLayout" class="member inherited"><a href="Ext.form.field.Base.html#method-beforeComponentLayout" rel="method-beforeComponentLayout" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-beforeComponentLayout" class="viewSource">view source</a></div><a name="beforeComponentLayout"></a><a name="method-beforeComponentLayout"></a><a href="Ext.form.field.Base.html#" rel="method-beforeComponentLayout" class="cls expand">beforeComponentLayout</a>(
1320 <span class="pre">Number adjWidth, Number adjHeight, Boolean isSetSize, Ext.Component layoutOwner</span>)
1321  : void</div><div class="description"><div class="short">Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout
1322 from being ex...</div><div class="long"><p>Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout
1323 from being executed.</p>
1324 <h3 class="pa">Parameters</h3><ul><li><span class="pre">adjWidth</span> : Number<div class="sub-desc"><p>The box-adjusted width that was set</p>
1325 </div></li><li><span class="pre">adjHeight</span> : Number<div class="sub-desc"><p>The box-adjusted height that was set</p>
1326 </div></li><li><span class="pre">isSetSize</span> : Boolean<div class="sub-desc"><p>Whether or not the height/width are stored on the component permanently</p>
1327 </div></li><li><span class="pre">layoutOwner</span> : Ext.Component<div class="sub-desc"><p>Component which sent the layout. Only used when isSetSize is false.</p>
1328 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1329 </li></ul></div></div></div><div id="method-bubble" class="member inherited"><a href="Ext.form.field.Base.html#method-bubble" rel="method-bubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-bubble" class="viewSource">view source</a></div><a name="bubble"></a><a name="method-bubble"></a><a href="Ext.form.field.Base.html#" rel="method-bubble" class="cls expand">bubble</a>(
1330 <span class="pre">Function fn, [Object scope], [Array args]</span>)
1331  : Ext.Component</div><div class="description"><div class="short">Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of...</div><div class="long"><p>Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (<i>this</i>) of
1332 function call will be the scope provided or the current component. The arguments to the function
1333 will be the args provided or the current component. If the function returns false at any point,
1334 the bubble is stopped.</p>
1335 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call</p>
1336 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope of the function (defaults to current node)</p>
1337 </div></li><li><span class="pre">args</span> : Array<div class="sub-desc"><p>(optional) The args to call the function with (default to passing the current component)</p>
1338 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1339 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.form.field.Base.html#method-capture" rel="method-capture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-capture" class="viewSource">view source</a></div><a name="capture"></a><a name="method-capture"></a><a href="Ext.form.field.Base.html#" rel="method-capture" class="cls expand">capture</a>(
1340 <span class="pre">Observable o, Function fn, [Object scope]</span>)
1341  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
1342 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
1343 to the supplied function with the event name + standard signature of the event
1344 <b>before</b> the event is fired. If the supplied function returns false,
1345 the event will not fire.</p>
1346 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to capture events from.</p>
1347 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
1348 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>
1349 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1350 </li></ul></div></div></div><div id="method-center" class="member inherited"><a href="Ext.form.field.Base.html#method-center" rel="method-center" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-method-center" class="viewSource">view source</a></div><a name="center"></a><a name="method-center"></a><a href="Ext.form.field.Base.html#" rel="method-center" class="cls expand">center</a> : Component</div><div class="description"><div class="short"><p>Center this Component in its container.</p>
1351 </div><div class="long"><p>Center this Component in its container.</p>
1352 <h3 class="pa">Returns</h3><ul><li><span class="pre">Component</span>&nbsp; &nbsp;<p>this</p>
1353 </li></ul></div></div></div><div id="method-checkChange" class="member inherited"><a href="Ext.form.field.Base.html#method-checkChange" rel="method-checkChange" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-checkChange" class="viewSource">view source</a></div><a name="checkChange"></a><a name="method-checkChange"></a><a href="Ext.form.field.Base.html#" rel="method-checkChange" class="cls expand">checkChange</a> : void</div><div class="description"><div class="short">Checks whether the value of the field has changed since the last time it was checked. If the value
1354 has changed, it:
1355
1356 ...</div><div class="long"><p>Checks whether the value of the field has changed since the last time it was checked. If the value
1357 has changed, it:</p>
1358
1359
1360 <ol>
1361 <li>Fires the <a href="Ext.form.field.Base.html#change" rel="Ext.form.field.Base#change" class="docClass">change event</a>,</li>
1362 <li>Performs validation if the <a href="Ext.form.field.Base.html#validateOnChange" rel="Ext.form.field.Base#validateOnChange" class="docClass">validateOnChange</a> config is enabled, firing the
1363 <a href="Ext.form.field.Base.html#validationchange" rel="Ext.form.field.Base#validationchange" class="docClass">validationchange event</a> if the validity has changed, and</li>
1364 <li>Checks the <a href="Ext.form.field.Base.html#isDirty" rel="Ext.form.field.Base#isDirty" class="docClass">dirty state</a> of the field and fires the <a href="Ext.form.field.Base.html#dirtychange" rel="Ext.form.field.Base#dirtychange" class="docClass">dirtychange event</a>
1365 if it has changed.</li>
1366 </ol>
1367
1368 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1369 </li></ul></div></div></div><div id="method-checkDirty" class="member inherited"><a href="Ext.form.field.Base.html#method-checkDirty" rel="method-checkDirty" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-checkDirty" class="viewSource">view source</a></div><a name="checkDirty"></a><a name="method-checkDirty"></a><a href="Ext.form.field.Base.html#" rel="method-checkDirty" class="cls expand">checkDirty</a> : void</div><div class="description"><div class="short">Checks the isDirty state of the field and if it has changed since the last time
1370 it was checked, fires the dirtychange...</div><div class="long"><p>Checks the <a href="Ext.form.field.Base.html#isDirty" rel="Ext.form.field.Base#isDirty" class="docClass">isDirty</a> state of the field and if it has changed since the last time
1371 it was checked, fires the <a href="Ext.form.field.Base.html#dirtychange" rel="Ext.form.field.Base#dirtychange" class="docClass">dirtychange</a> event.</p>
1372 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1373 </li></ul></div></div></div><div id="method-clearInvalid" class="member ni"><a href="Ext.form.field.Base.html#method-clearInvalid" rel="method-clearInvalid" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-clearInvalid" class="viewSource">view source</a></div><a name="clearInvalid"></a><a name="method-clearInvalid"></a><a href="Ext.form.field.Base.html#" rel="method-clearInvalid" class="cls expand">clearInvalid</a> : void</div><div class="description"><div class="short">Clear any invalid styles/messages for this field.
1374
1375
1376 Note: this method does not cause the Field's validate or isValid ...</div><div class="long"><p>Clear any invalid styles/messages for this field.</p>
1377
1378
1379 <p><b>Note</b>: this method does not cause the Field's <a href="Ext.form.field.Base.html#validate" rel="Ext.form.field.Base#validate" class="docClass">validate</a> or <a href="Ext.form.field.Base.html#isValid" rel="Ext.form.field.Base#isValid" class="docClass">isValid</a> methods to
1380 return <code>true</code> if the value does not <i>pass</i> validation. So simply clearing a field's errors
1381 will not necessarily allow submission of forms submitted with the <a href="Ext.form.action.Submit.html#clientValidation" rel="Ext.form.action.Submit#clientValidation" class="docClass">Ext.form.action.Submit.clientValidation</a>
1382 option set.</p>
1383
1384 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1385 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.form.field.Base.html#method-clearListeners" rel="method-clearListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearListeners" class="viewSource">view source</a></div><a name="clearListeners"></a><a name="method-clearListeners"></a><a href="Ext.form.field.Base.html#" rel="method-clearListeners" class="cls expand">clearListeners</a> : void</div><div class="description"><div class="short"><p>Removes all listeners for this object including the managed listeners</p>
1386 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
1387 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1388 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.form.field.Base.html#method-clearManagedListeners" rel="method-clearManagedListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearManagedListeners" class="viewSource">view source</a></div><a name="clearManagedListeners"></a><a name="method-clearManagedListeners"></a><a href="Ext.form.field.Base.html#" rel="method-clearManagedListeners" class="cls expand">clearManagedListeners</a> : void</div><div class="description"><div class="short"><p>Removes all managed listeners for this object.</p>
1389 </div><div class="long"><p>Removes all managed listeners for this object.</p>
1390 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1391 </li></ul></div></div></div><div id="method-cloneConfig" class="member inherited"><a href="Ext.form.field.Base.html#method-cloneConfig" rel="method-cloneConfig" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-cloneConfig" class="viewSource">view source</a></div><a name="cloneConfig"></a><a name="method-cloneConfig"></a><a href="Ext.form.field.Base.html#" rel="method-cloneConfig" class="cls expand">cloneConfig</a>(
1392 <span class="pre">Object overrides</span>)
1393  : Ext.Component</div><div class="description"><div class="short"><p>Clone the current component using the original config values passed into this instance by default.</p>
1394 </div><div class="long"><p>Clone the current component using the original config values passed into this instance by default.</p>
1395 <h3 class="pa">Parameters</h3><ul><li><span class="pre">overrides</span> : Object<div class="sub-desc"><p>A new config containing any properties to override in the cloned version.
1396 An id property can be passed on this object, otherwise one will be generated to avoid duplicates.</p>
1397 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>clone The cloned copy of this component</p>
1398 </li></ul></div></div></div><div id="method-destroy" class="member inherited"><a href="Ext.form.field.Base.html#method-destroy" rel="method-destroy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-method-destroy" class="viewSource">view source</a></div><a name="destroy"></a><a name="method-destroy"></a><a href="Ext.form.field.Base.html#" rel="method-destroy" class="cls expand">destroy</a> : void</div><div class="description"><div class="short"><p>Destroys this stateful object.</p>
1399 </div><div class="long"><p>Destroys this stateful object.</p>
1400 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1401 </li></ul></div></div></div><div id="method-disable" class="member inherited"><a href="Ext.form.field.Base.html#method-disable" rel="method-disable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-disable" class="viewSource">view source</a></div><a name="disable"></a><a name="method-disable"></a><a href="Ext.form.field.Base.html#" rel="method-disable" class="cls expand">disable</a>(
1402 <span class="pre">Boolean silent</span>)
1403  : void</div><div class="description"><div class="short"><p>Disable the component.</p>
1404 </div><div class="long"><p>Disable the component.</p>
1405 <h3 class="pa">Parameters</h3><ul><li><span class="pre">silent</span> : Boolean<div class="sub-desc"><p>Passing true, will supress the 'disable' event from being fired.</p>
1406 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1407 </li></ul></div></div></div><div id="method-doAutoRender" class="member inherited"><a href="Ext.form.field.Base.html#method-doAutoRender" rel="method-doAutoRender" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-doAutoRender" class="viewSource">view source</a></div><a name="doAutoRender"></a><a name="method-doAutoRender"></a><a href="Ext.form.field.Base.html#" rel="method-doAutoRender" class="cls expand">doAutoRender</a> : void</div><div class="description"><div class="short">Handles autoRender.
1408 Floating Components may have an ownerCt. If they are asking to be constrained, constrain them wit...</div><div class="long"><p>Handles autoRender.
1409 Floating Components may have an ownerCt. If they are asking to be constrained, constrain them within that
1410 ownerCt, and have their z-index managed locally. Floating Components are always rendered to document.body</p>
1411 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1412 </li></ul></div></div></div><div id="method-doComponentLayout" class="member inherited"><a href="Ext.form.field.Base.html#method-doComponentLayout" rel="method-doComponentLayout" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-doComponentLayout" class="viewSource">view source</a></div><a name="doComponentLayout"></a><a name="method-doComponentLayout"></a><a href="Ext.form.field.Base.html#" rel="method-doComponentLayout" class="cls expand">doComponentLayout</a>(
1413 <span class="pre">Object width, Object height, Object isSetSize, Object ownerCt</span>)
1414  : Ext.container.Container</div><div class="description"><div class="short">This method needs to be called whenever you change something on this component that requires the Component's
1415 layout t...</div><div class="long"><p>This method needs to be called whenever you change something on this component that requires the Component's
1416 layout to be recalculated.</p>
1417 <h3 class="pa">Parameters</h3><ul><li><span class="pre">width</span> : Object<div class="sub-desc">
1418 </div></li><li><span class="pre">height</span> : Object<div class="sub-desc">
1419 </div></li><li><span class="pre">isSetSize</span> : Object<div class="sub-desc">
1420 </div></li><li><span class="pre">ownerCt</span> : Object<div class="sub-desc">
1421 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.container.Container</span>&nbsp; &nbsp;<p>this</p>
1422 </li></ul></div></div></div><div id="method-doConstrain" class="member inherited"><a href="Ext.form.field.Base.html#method-doConstrain" rel="method-doConstrain" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-method-doConstrain" class="viewSource">view source</a></div><a name="doConstrain"></a><a name="method-doConstrain"></a><a href="Ext.form.field.Base.html#" rel="method-doConstrain" class="cls expand">doConstrain</a>(
1423 <span class="pre">Mixed constrainTo</span>)
1424  : void</div><div class="description"><div class="short">Moves this floating Component into a constrain region.
1425
1426
1427 By default, this Component is constrained to be within the c...</div><div class="long"><p>Moves this floating Component into a constrain region.</p>
1428
1429
1430 <p>By default, this Component is constrained to be within the container it was added to, or the element
1431 it was rendered to.</p>
1432
1433
1434 <p>An alternative constraint may be passed.</p>
1435
1436 <h3 class="pa">Parameters</h3><ul><li><span class="pre">constrainTo</span> : Mixed<div class="sub-desc"><p>Optional. The Element or <a href="Ext.util.Region.html" rel="Ext.util.Region" class="docClass">Region</a> into which this Component is to be constrained.</p>
1437 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1438 </li></ul></div></div></div><div id="method-enable" class="member inherited"><a href="Ext.form.field.Base.html#method-enable" rel="method-enable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-enable" class="viewSource">view source</a></div><a name="enable"></a><a name="method-enable"></a><a href="Ext.form.field.Base.html#" rel="method-enable" class="cls expand">enable</a>(
1439 <span class="pre">Boolean silent</span>)
1440  : void</div><div class="description"><div class="short"><p>Enable the component</p>
1441 </div><div class="long"><p>Enable the component</p>
1442 <h3 class="pa">Parameters</h3><ul><li><span class="pre">silent</span> : Boolean<div class="sub-desc"><p>Passing false will supress the 'enable' event from being fired.</p>
1443 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1444 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.form.field.Base.html#method-enableBubble" rel="method-enableBubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-enableBubble" class="viewSource">view source</a></div><a name="enableBubble"></a><a name="method-enableBubble"></a><a href="Ext.form.field.Base.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
1445 <span class="pre">String/Array events</span>)
1446  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
1447 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
1448 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
1449
1450
1451 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>. The default
1452 implementation in <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to
1453 access the required target more quickly.</p>
1454
1455
1456 <p>Example:</p>
1457
1458
1459 <pre><code>Ext.override(Ext.form.field.Base, {
1460 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
1461 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
1462     this.enableBubble('change');
1463 }),
1464
1465 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
1466 getBubbleTarget : function() {
1467     if (!this.formPanel) {
1468         this.formPanel = this.findParentByType('form');
1469     }
1470     return this.formPanel;
1471 }
1472 });
1473
1474 var myForm = new Ext.formPanel({
1475 title: 'User Details',
1476 items: [{
1477     ...
1478 }],
1479 listeners: {
1480     change: function() {
1481         // Title goes red if form has been modified.
1482         myForm.header.setStyle('color', 'red');
1483     }
1484 }
1485 });
1486 </code></pre>
1487
1488 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name to bubble, or an Array of event names.</p>
1489 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1490 </li></ul></div></div></div><div id="method-extractFileInput" class="member inherited"><a href="Ext.form.field.Base.html#method-extractFileInput" rel="method-extractFileInput" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-extractFileInput" class="viewSource">view source</a></div><a name="extractFileInput"></a><a name="method-extractFileInput"></a><a href="Ext.form.field.Base.html#" rel="method-extractFileInput" class="cls expand">extractFileInput</a> : HTMLInputElement</div><div class="description"><div class="short">Only relevant if the instance's isFileUpload method returns true. Returns a reference
1491 to the file input DOM element h...</div><div class="long"><p>Only relevant if the instance's <a href="Ext.form.field.Base.html#isFileUpload" rel="Ext.form.field.Base#isFileUpload" class="docClass">isFileUpload</a> method returns true. Returns a reference
1492 to the file input DOM element holding the user's selected file. The input will be appended into
1493 the submission form and will not be returned, so this method should also create a replacement.</p>
1494 <h3 class="pa">Returns</h3><ul><li><span class="pre">HTMLInputElement</span>&nbsp; &nbsp;
1495 </li></ul></div></div></div><div id="method-findLayoutController" class="member inherited"><a href="Ext.form.field.Base.html#method-findLayoutController" rel="method-findLayoutController" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-findLayoutController" class="viewSource">view source</a></div><a name="findLayoutController"></a><a name="method-findLayoutController"></a><a href="Ext.form.field.Base.html#" rel="method-findLayoutController" class="cls expand">findLayoutController</a> : void</div><div class="description"><div class="short">This method finds the topmost active layout who's processing will eventually determine the size and position of this
1496 ...</div><div class="long"><p>This method finds the topmost active layout who's processing will eventually determine the size and position of this
1497 Component.<p>
1498 <p>This method is useful when dynamically adding Components into Containers, and some processing must take place after the
1499 final sizing and positioning of the Component has been performed.</p>
1500
1501 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1502 </li></ul></div></div></div><div id="method-findParentBy" class="member inherited"><a href="Ext.form.field.Base.html#method-findParentBy" rel="method-findParentBy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-findParentBy" class="viewSource">view source</a></div><a name="findParentBy"></a><a name="method-findParentBy"></a><a href="Ext.form.field.Base.html#" rel="method-findParentBy" class="cls expand">findParentBy</a>(
1503 <span class="pre">Function fn</span>)
1504  : Ext.container.Container</div><div class="description"><div class="short">Find a container above this component at any level by a custom function. If the passed function returns
1505 true, the con...</div><div class="long"><p>Find a container above this component at any level by a custom function. If the passed function returns
1506 true, the container will be returned.</p>
1507 <h3 class="pa">Parameters</h3><ul><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The custom function to call with the arguments (container, this component).</p>
1508 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.container.Container</span>&nbsp; &nbsp;<p>The first Container for which the custom function returns true</p>
1509 </li></ul></div></div></div><div id="method-findParentByType" class="member inherited"><a href="Ext.form.field.Base.html#method-findParentByType" rel="method-findParentByType" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-findParentByType" class="viewSource">view source</a></div><a name="findParentByType"></a><a name="method-findParentByType"></a><a href="Ext.form.field.Base.html#" rel="method-findParentByType" class="cls expand">findParentByType</a>(
1510 <span class="pre">String/Class xtype</span>)
1511  : Ext.container.Container</div><div class="description"><div class="short"><p>Find a container above this component at any level by xtype or class</p>
1512
1513
1514 <p>See also the <a href="Ext.Component.html#up" rel="Ext.Component#up" class="docClass">up</a> method.</p>
1515
1516 </div><div class="long"><p>Find a container above this component at any level by xtype or class</p>
1517
1518
1519 <p>See also the <a href="Ext.Component.html#up" rel="Ext.Component#up" class="docClass">up</a> method.</p>
1520
1521 <h3 class="pa">Parameters</h3><ul><li><span class="pre">xtype</span> : String/Class<div class="sub-desc"><p>The xtype string for a component, or the class of the component directly</p>
1522 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.container.Container</span>&nbsp; &nbsp;<p>The first Container which matches the given xtype or class</p>
1523 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.form.field.Base.html#method-fireEvent" rel="method-fireEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-fireEvent" class="viewSource">view source</a></div><a name="fireEvent"></a><a name="method-fireEvent"></a><a href="Ext.form.field.Base.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
1524 <span class="pre">String eventName, Object... args</span>)
1525  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
1526
1527
1528 An event may be set to bubble up an Ob...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
1529
1530
1531 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>)
1532 by calling <a href="Ext.form.field.Base.html#enableBubble" rel="Ext.form.field.Base#enableBubble" class="docClass">enableBubble</a>.</p>
1533
1534 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to fire.</p>
1535 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
1536 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>returns false if any of the handlers return false otherwise it returns true.</p>
1537 </li></ul></div></div></div><div id="method-focus" class="member inherited"><a href="Ext.form.field.Base.html#method-focus" rel="method-focus" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-focus" class="viewSource">view source</a></div><a name="focus"></a><a name="method-focus"></a><a href="Ext.form.field.Base.html#" rel="method-focus" class="cls expand">focus</a>(
1538 <span class="pre">[Boolean selectText], [Boolean/Number delay]</span>)
1539  : Ext.Component</div><div class="description"><div class="short"><p>Try to focus this component.</p>
1540 </div><div class="long"><p>Try to focus this component.</p>
1541 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selectText</span> : Boolean<div class="sub-desc"><p>(optional) If applicable, true to also select the text in this component</p>
1542 </div></li><li><span class="pre">delay</span> : Boolean/Number<div class="sub-desc"><p>(optional) Delay the focus this number of milliseconds (true for 10 milliseconds).</p>
1543 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1544 </li></ul></div></div></div><div id="method-getActiveAnimation" class="member inherited"><a href="Ext.form.field.Base.html#method-getActiveAnimation" rel="method-getActiveAnimation" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-method-getActiveAnimation" class="viewSource">view source</a></div><a name="getActiveAnimation"></a><a name="method-getActiveAnimation"></a><a href="Ext.form.field.Base.html#" rel="method-getActiveAnimation" class="cls expand">getActiveAnimation</a> : Mixed</div><div class="description"><div class="short"><p>Returns thq current animation if this object has any effects actively running or queued, else returns false.</p>
1545 </div><div class="long"><p>Returns thq current animation if this object has any effects actively running or queued, else returns false.</p>
1546 <h3 class="pa">Returns</h3><ul><li><span class="pre">Mixed</span>&nbsp; &nbsp;<p>anim if element has active effects, else false</p>
1547 </li></ul></div></div></div><div id="method-getActiveError" class="member inherited"><a href="Ext.form.field.Base.html#method-getActiveError" rel="method-getActiveError" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-method-getActiveError" class="viewSource">view source</a></div><a name="getActiveError"></a><a name="method-getActiveError"></a><a href="Ext.form.field.Base.html#" rel="method-getActiveError" class="cls expand">getActiveError</a> : String</div><div class="description"><div class="short">Gets the active error message for this component, if any. This does not trigger
1548 validation on its own, it merely retu...</div><div class="long"><p>Gets the active error message for this component, if any. This does not trigger
1549 validation on its own, it merely returns any message that the component may already hold.</p>
1550 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The active error message on the component; if there is no error, an empty string is returned.</p>
1551 </li></ul></div></div></div><div id="method-getActiveErrors" class="member inherited"><a href="Ext.form.field.Base.html#method-getActiveErrors" rel="method-getActiveErrors" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-method-getActiveErrors" class="viewSource">view source</a></div><a name="getActiveErrors"></a><a name="method-getActiveErrors"></a><a href="Ext.form.field.Base.html#" rel="method-getActiveErrors" class="cls expand">getActiveErrors</a> : Array</div><div class="description"><div class="short">Gets an Array of any active error messages currently applied to the field. This does not trigger
1552 validation on its ow...</div><div class="long"><p>Gets an Array of any active error messages currently applied to the field. This does not trigger
1553 validation on its own, it merely returns any messages that the component may already hold.</p>
1554 <h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>The active error messages on the component; if there are no errors, an empty Array is returned.</p>
1555 </li></ul></div></div></div><div id="method-getBox" class="member inherited"><a href="Ext.form.field.Base.html#method-getBox" rel="method-getBox" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-getBox" class="viewSource">view source</a></div><a name="getBox"></a><a name="method-getBox"></a><a href="Ext.form.field.Base.html#" rel="method-getBox" class="cls expand">getBox</a>(
1556 <span class="pre">[Boolean local]</span>)
1557  : Object</div><div class="description"><div class="short"><p>Gets the current box measurements of the component's underlying element.</p>
1558 </div><div class="long"><p>Gets the current box measurements of the component's underlying element.</p>
1559 <h3 class="pa">Parameters</h3><ul><li><span class="pre">local</span> : Boolean<div class="sub-desc"><p>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</p>
1560 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>box An object in the format {x, y, width, height}</p>
1561 </li></ul></div></div></div><div id="method-getBubbleTarget" class="member inherited"><a href="Ext.form.field.Base.html#method-getBubbleTarget" rel="method-getBubbleTarget" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getBubbleTarget" class="viewSource">view source</a></div><a name="getBubbleTarget"></a><a name="method-getBubbleTarget"></a><a href="Ext.form.field.Base.html#" rel="method-getBubbleTarget" class="cls expand">getBubbleTarget</a> : Ext.container.Container</div><div class="description"><div class="short"><p>Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.</p>
1562 </div><div class="long"><p>Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.</p>
1563 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.container.Container</span>&nbsp; &nbsp;<p>the Container which owns this Component.</p>
1564 </li></ul></div></div></div><div id="method-getEl" class="member inherited"><a href="Ext.form.field.Base.html#method-getEl" rel="method-getEl" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getEl" class="viewSource">view source</a></div><a name="getEl"></a><a name="method-getEl"></a><a href="Ext.form.field.Base.html#" rel="method-getEl" class="cls expand">getEl</a> : void</div><div class="description"><div class="short"><p>Retrieves the top level element representing this component.</p>
1565 </div><div class="long"><p>Retrieves the top level element representing this component.</p>
1566 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1567 </li></ul></div></div></div><div id="method-getErrors" class="member inherited"><a href="Ext.form.field.Base.html#method-getErrors" rel="method-getErrors" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-getErrors" class="viewSource">view source</a></div><a name="getErrors"></a><a name="method-getErrors"></a><a href="Ext.form.field.Base.html#" rel="method-getErrors" class="cls expand">getErrors</a>(
1568 <span class="pre">Mixed value</span>)
1569  : Array</div><div class="description"><div class="short">Runs this field's validators and returns an array of error messages for any validation failures.
1570 This is called inter...</div><div class="long"><p>Runs this field's validators and returns an array of error messages for any validation failures.
1571 This is called internally during validation and would not usually need to be used manually.</p>
1572
1573
1574 <p>Each subclass should override or augment the return value to provide their own errors.</p>
1575
1576 <h3 class="pa">Parameters</h3><ul><li><span class="pre">value</span> : Mixed<div class="sub-desc"><p>The value to get errors for (defaults to the current field value)</p>
1577 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>All error messages for this field; an empty Array if none.</p>
1578 </li></ul></div></div></div><div id="method-getFieldLabel" class="member inherited"><a href="Ext.form.field.Base.html#method-getFieldLabel" rel="method-getFieldLabel" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-method-getFieldLabel" class="viewSource">view source</a></div><a name="getFieldLabel"></a><a name="method-getFieldLabel"></a><a href="Ext.form.field.Base.html#" rel="method-getFieldLabel" class="cls expand">getFieldLabel</a> : String</div><div class="description"><div class="short"><p>Returns the label for the field. Defaults to simply returning the <a href="Ext.form.field.Base.html#fieldLabel" rel="Ext.form.field.Base#fieldLabel" class="docClass">fieldLabel</a> config. Can be
1579 overridden to provide</p>
1580 </div><div class="long"><p>Returns the label for the field. Defaults to simply returning the <a href="Ext.form.field.Base.html#fieldLabel" rel="Ext.form.field.Base#fieldLabel" class="docClass">fieldLabel</a> config. Can be
1581 overridden to provide</p>
1582 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The configured field label, or empty string if not defined</p>
1583 </li></ul></div></div></div><div id="method-getHeight" class="member inherited"><a href="Ext.form.field.Base.html#method-getHeight" rel="method-getHeight" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getHeight" class="viewSource">view source</a></div><a name="getHeight"></a><a name="method-getHeight"></a><a href="Ext.form.field.Base.html#" rel="method-getHeight" class="cls expand">getHeight</a> : Number</div><div class="description"><div class="short"><p>Gets the current height of the component's underlying element.</p>
1584 </div><div class="long"><p>Gets the current height of the component's underlying element.</p>
1585 <h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;
1586 </li></ul></div></div></div><div id="method-getId" class="member inherited"><a href="Ext.form.field.Base.html#method-getId" rel="method-getId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getId" class="viewSource">view source</a></div><a name="getId"></a><a name="method-getId"></a><a href="Ext.form.field.Base.html#" rel="method-getId" class="cls expand">getId</a> : void</div><div class="description"><div class="short"><p>Retrieves the id of this component.
1587 Will autogenerate an id if one has not already been set.</p>
1588 </div><div class="long"><p>Retrieves the id of this component.
1589 Will autogenerate an id if one has not already been set.</p>
1590 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1591 </li></ul></div></div></div><div id="method-getInputId" class="member ni"><a href="Ext.form.field.Base.html#method-getInputId" rel="method-getInputId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-getInputId" class="viewSource">view source</a></div><a name="getInputId"></a><a name="method-getInputId"></a><a href="Ext.form.field.Base.html#" rel="method-getInputId" class="cls expand">getInputId</a> : void</div><div class="description"><div class="short">Returns the input id for this field. If none was specified via the inputId config,
1592 then an id will be automatically g...</div><div class="long"><p>Returns the input id for this field. If none was specified via the <a href="Ext.form.field.Base.html#inputId" rel="Ext.form.field.Base#inputId" class="docClass">inputId</a> config,
1593 then an id will be automatically generated.</p>
1594 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1595 </li></ul></div></div></div><div id="method-getInsertPosition" class="member inherited"><a href="Ext.form.field.Base.html#method-getInsertPosition" rel="method-getInsertPosition" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getInsertPosition" class="viewSource">view source</a></div><a name="getInsertPosition"></a><a name="method-getInsertPosition"></a><a href="Ext.form.field.Base.html#" rel="method-getInsertPosition" class="cls expand">getInsertPosition</a>(
1596 <span class="pre">String/Number/Element/HTMLElement position</span>)
1597  : HTMLElement</div><div class="description"><div class="short">This function takes the position argument passed to onRender and returns a
1598 DOM element that you can use in the insert...</div><div class="long"><p>This function takes the position argument passed to onRender and returns a
1599 DOM element that you can use in the insertBefore.</p>
1600 <h3 class="pa">Parameters</h3><ul><li><span class="pre">position</span> : String/Number/Element/HTMLElement<div class="sub-desc"><p>Index, element id or element you want
1601 to put this component before.</p>
1602 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">HTMLElement</span>&nbsp; &nbsp;<p>DOM element that you can use in the insertBefore</p>
1603 </li></ul></div></div></div><div id="method-getLoader" class="member inherited"><a href="Ext.form.field.Base.html#method-getLoader" rel="method-getLoader" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getLoader" class="viewSource">view source</a></div><a name="getLoader"></a><a name="method-getLoader"></a><a href="Ext.form.field.Base.html#" rel="method-getLoader" class="cls expand">getLoader</a> : Ext.ComponentLoader</div><div class="description"><div class="short"><p>Gets the <a href="Ext.ComponentLoader.html" rel="Ext.ComponentLoader" class="docClass">Ext.ComponentLoader</a> for this Component.</p>
1604 </div><div class="long"><p>Gets the <a href="Ext.ComponentLoader.html" rel="Ext.ComponentLoader" class="docClass">Ext.ComponentLoader</a> for this Component.</p>
1605 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.ComponentLoader</span>&nbsp; &nbsp;<p>The loader instance, null if it doesn't exist.</p>
1606 </li></ul></div></div></div><div id="method-getModelData" class="member inherited"><a href="Ext.form.field.Base.html#method-getModelData" rel="method-getModelData" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-getModelData" class="viewSource">view source</a></div><a name="getModelData"></a><a name="method-getModelData"></a><a href="Ext.form.field.Base.html#" rel="method-getModelData" class="cls expand">getModelData</a> : Object</div><div class="description"><div class="short">Returns the value(s) that should be saved to the Ext.data.Model instance for this field, when
1607 Ext.form.Basic.updateRe...</div><div class="long"><p>Returns the value(s) that should be saved to the <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Ext.data.Model</a> instance for this field, when
1608 <a href="Ext.form.Basic.html#updateRecord" rel="Ext.form.Basic#updateRecord" class="docClass">Ext.form.Basic.updateRecord</a> is called. Typically this will be an object with a single name-value
1609 pair, the name being this field's <a href="Ext.form.field.Base.html#getName" rel="Ext.form.field.Base#getName" class="docClass">name</a> and the value being its current data value. More
1610 advanced field implementations may return more than one name-value pair. The returned values will be
1611 saved to the corresponding field names in the Model.</p>
1612
1613
1614 <p>Note that the values returned from this method are not guaranteed to have been successfully
1615 <a href="Ext.form.field.Base.html#validate" rel="Ext.form.field.Base#validate" class="docClass">validated</a>.</p>
1616
1617 <h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>A mapping of submit parameter names to values; each value should be a string, or an array
1618 of strings if that particular name has multiple values. It can also return <tt>null</tt> if there are no
1619 parameters to be submitted.</p>
1620 </li></ul></div></div></div><div id="method-getName" class="member inherited"><a href="Ext.form.field.Base.html#method-getName" rel="method-getName" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-getName" class="viewSource">view source</a></div><a name="getName"></a><a name="method-getName"></a><a href="Ext.form.field.Base.html#" rel="method-getName" class="cls expand">getName</a> : String</div><div class="description"><div class="short">Returns the name attribute of the field. This is used as the parameter
1621 name when including the field value in a form ...</div><div class="long"><p>Returns the <a href="Ext.form.field.Field.html#name" rel="Ext.form.field.Field#name" class="docClass">name</a> attribute of the field. This is used as the parameter
1622 name when including the field value in a <a href="Ext.form.Basic.html#submit" rel="Ext.form.Basic#submit" class="docClass">form submit()</a>.</p>
1623 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>name The field <a href="Ext.form.field.Field.html#name" rel="Ext.form.field.Field#name" class="docClass">name</a></p>
1624 </li></ul></div></div></div><div id="method-getPlugin" class="member inherited"><a href="Ext.form.field.Base.html#method-getPlugin" rel="method-getPlugin" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getPlugin" class="viewSource">view source</a></div><a name="getPlugin"></a><a name="method-getPlugin"></a><a href="Ext.form.field.Base.html#" rel="method-getPlugin" class="cls expand">getPlugin</a>(
1625 <span class="pre">Object pluginId</span>)
1626  : Ext.AbstractPlugin</div><div class="description"><div class="short"><p>Retrieves a plugin by its pluginId which has been bound to this
1627 component.</p>
1628 </div><div class="long"><p>Retrieves a plugin by its pluginId which has been bound to this
1629 component.</p>
1630 <h3 class="pa">Parameters</h3><ul><li><span class="pre">pluginId</span> : Object<div class="sub-desc">
1631 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.AbstractPlugin</span>&nbsp; &nbsp;<p>pluginInstance</p>
1632 </li></ul></div></div></div><div id="method-getPosition" class="member inherited"><a href="Ext.form.field.Base.html#method-getPosition" rel="method-getPosition" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-getPosition" class="viewSource">view source</a></div><a name="getPosition"></a><a name="method-getPosition"></a><a href="Ext.form.field.Base.html#" rel="method-getPosition" class="cls expand">getPosition</a>(
1633 <span class="pre">[Boolean local]</span>)
1634  : Array</div><div class="description"><div class="short"><p>Gets the current XY position of the component's underlying element.</p>
1635 </div><div class="long"><p>Gets the current XY position of the component's underlying element.</p>
1636 <h3 class="pa">Parameters</h3><ul><li><span class="pre">local</span> : Boolean<div class="sub-desc"><p>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</p>
1637 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Array</span>&nbsp; &nbsp;<p>The XY position of the element (e.g., [100, 200])</p>
1638 </li></ul></div></div></div><div id="method-getRawValue" class="member ni"><a href="Ext.form.field.Base.html#method-getRawValue" rel="method-getRawValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-getRawValue" class="viewSource">view source</a></div><a name="getRawValue"></a><a name="method-getRawValue"></a><a href="Ext.form.field.Base.html#" rel="method-getRawValue" class="cls expand">getRawValue</a> : String</div><div class="description"><div class="short">Returns the raw value of the field, without performing any normalization, conversion, or validation.
1639 To get a normali...</div><div class="long"><p>Returns the raw value of the field, without performing any normalization, conversion, or validation.
1640 To get a normalized and converted value see <a href="Ext.form.field.Base.html#getValue" rel="Ext.form.field.Base#getValue" class="docClass">getValue</a>.</p>
1641 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>value The raw String value of the field</p>
1642 </li></ul></div></div></div><div id="method-getSize" class="member inherited"><a href="Ext.form.field.Base.html#method-getSize" rel="method-getSize" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getSize" class="viewSource">view source</a></div><a name="getSize"></a><a name="method-getSize"></a><a href="Ext.form.field.Base.html#" rel="method-getSize" class="cls expand">getSize</a> : Object</div><div class="description"><div class="short"><p>Gets the current size of the component's underlying element.</p>
1643 </div><div class="long"><p>Gets the current size of the component's underlying element.</p>
1644 <h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>An object containing the element's size {width: (element width), height: (element height)}</p>
1645 </li></ul></div></div></div><div id="method-getState" class="member inherited"><a href="Ext.form.field.Base.html#method-getState" rel="method-getState" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-method-getState" class="viewSource">view source</a></div><a name="getState"></a><a name="method-getState"></a><a href="Ext.form.field.Base.html#" rel="method-getState" class="cls expand">getState</a> : Object</div><div class="description"><div class="short">Gets the current state of the object. By default this function returns null,
1646 it should be overridden in subclasses to...</div><div class="long"><p>Gets the current state of the object. By default this function returns null,
1647 it should be overridden in subclasses to implement methods for getting the state.</p>
1648 <h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The current state</p>
1649 </li></ul></div></div></div><div id="method-getStateId" class="member inherited"><a href="Ext.form.field.Base.html#method-getStateId" rel="method-getStateId" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-method-getStateId" class="viewSource">view source</a></div><a name="getStateId"></a><a name="method-getStateId"></a><a href="Ext.form.field.Base.html#" rel="method-getStateId" class="cls expand">getStateId</a> : String</div><div class="description"><div class="short"><p>Gets the state id for this object.</p>
1650 </div><div class="long"><p>Gets the state id for this object.</p>
1651 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The state id, null if not found.</p>
1652 </li></ul></div></div></div><div id="method-getSubmitData" class="member inherited"><a href="Ext.form.field.Base.html#method-getSubmitData" rel="method-getSubmitData" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-getSubmitData" class="viewSource">view source</a></div><a name="getSubmitData"></a><a name="method-getSubmitData"></a><a href="Ext.form.field.Base.html#" rel="method-getSubmitData" class="cls expand">getSubmitData</a> : Object</div><div class="description"><div class="short">Returns the parameter(s) that would be included in a standard form submit for this field. Typically this
1653 will be an o...</div><div class="long"><p>Returns the parameter(s) that would be included in a standard form submit for this field. Typically this
1654 will be an object with a single name-value pair, the name being this field's <a href="Ext.form.field.Base.html#getName" rel="Ext.form.field.Base#getName" class="docClass">name</a> and the
1655 value being its current stringified value. More advanced field implementations may return more than one
1656 name-value pair.</p>
1657
1658
1659 <p>Note that the values returned from this method are not guaranteed to have been successfully
1660 <a href="Ext.form.field.Base.html#validate" rel="Ext.form.field.Base#validate" class="docClass">validated</a>.</p>
1661
1662 <h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>A mapping of submit parameter names to values; each value should be a string, or an array
1663 of strings if that particular name has multiple values. It can also return <tt>null</tt> if there are no
1664 parameters to be submitted.</p>
1665 </li></ul></div></div></div><div id="method-getSubmitValue" class="member ni"><a href="Ext.form.field.Base.html#method-getSubmitValue" rel="method-getSubmitValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-getSubmitValue" class="viewSource">view source</a></div><a name="getSubmitValue"></a><a name="method-getSubmitValue"></a><a href="Ext.form.field.Base.html#" rel="method-getSubmitValue" class="cls expand">getSubmitValue</a> : String</div><div class="description"><div class="short">Returns the value that would be included in a standard form submit for this field. This will be combined
1666 with the fie...</div><div class="long"><p>Returns the value that would be included in a standard form submit for this field. This will be combined
1667 with the field's name to form a <tt>name=value</tt> pair in the <a href="Ext.form.field.Base.html#getSubmitData" rel="Ext.form.field.Base#getSubmitData" class="docClass">submitted parameters</a>.
1668 If an empty string is returned then just the <tt>name=</tt> will be submitted; if <tt>null</tt> is returned
1669 then nothing will be submitted.</p>
1670
1671
1672 <p>Note that the value returned will have been <a href="Ext.form.field.Base.html#processRawValue" rel="Ext.form.field.Base#processRawValue" class="docClass">processed</a> but may or may not have
1673 been successfully <a href="Ext.form.field.Base.html#validate" rel="Ext.form.field.Base#validate" class="docClass">validated</a>.</p>
1674
1675 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The value to be submitted, or <tt>null</tt>.</p>
1676 </li></ul></div></div></div><div id="method-getValue" class="member ni"><a href="Ext.form.field.Base.html#method-getValue" rel="method-getValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-getValue" class="viewSource">view source</a></div><a name="getValue"></a><a name="method-getValue"></a><a href="Ext.form.field.Base.html#" rel="method-getValue" class="cls expand">getValue</a> : Mixed</div><div class="description"><div class="short">Returns the current data value of the field. The type of value returned is particular to the type of the
1677 particular f...</div><div class="long"><p>Returns the current data value of the field. The type of value returned is particular to the type of the
1678 particular field (e.g. a Date object for <a href="Ext.form.field.Date.html" rel="Ext.form.field.Date" class="docClass">Ext.form.field.Date</a>), as the result of calling <a href="Ext.form.field.Base.html#rawToValue" rel="Ext.form.field.Base#rawToValue" class="docClass">rawToValue</a> on
1679 the field's <a href="Ext.form.field.Base.html#processRawValue" rel="Ext.form.field.Base#processRawValue" class="docClass">processed</a> String value. To return the raw String value, see <a href="Ext.form.field.Base.html#getRawValue" rel="Ext.form.field.Base#getRawValue" class="docClass">getRawValue</a>.</p>
1680 <h3 class="pa">Returns</h3><ul><li><span class="pre">Mixed</span>&nbsp; &nbsp;<p>value The field value</p>
1681 </li></ul></div></div></div><div id="method-getWidth" class="member inherited"><a href="Ext.form.field.Base.html#method-getWidth" rel="method-getWidth" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getWidth" class="viewSource">view source</a></div><a name="getWidth"></a><a name="method-getWidth"></a><a href="Ext.form.field.Base.html#" rel="method-getWidth" class="cls expand">getWidth</a> : Number</div><div class="description"><div class="short"><p>Gets the current width of the component's underlying element.</p>
1682 </div><div class="long"><p>Gets the current width of the component's underlying element.</p>
1683 <h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;
1684 </li></ul></div></div></div><div id="method-getXType" class="member inherited"><a href="Ext.form.field.Base.html#method-getXType" rel="method-getXType" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-getXType" class="viewSource">view source</a></div><a name="getXType"></a><a name="method-getXType"></a><a href="Ext.form.field.Base.html#" rel="method-getXType" class="cls expand">getXType</a> : String</div><div class="description"><div class="short">Gets the xtype for this component as registered with Ext.ComponentManager. For a list of all
1685 available xtypes, see th...</div><div class="long"><p>Gets the xtype for this component as registered with <a href="Ext.ComponentManager.html" rel="Ext.ComponentManager" class="docClass">Ext.ComponentManager</a>. For a list of all
1686 available xtypes, see the <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> header. Example usage:</p>
1687
1688 <pre><code>var t = new Ext.form.field.Text();
1689 alert(t.getXType());  // alerts 'textfield'
1690 </code></pre>
1691
1692 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The xtype</p>
1693 </li></ul></div></div></div><div id="method-getXTypes" class="member inherited"><a href="Ext.form.field.Base.html#method-getXTypes" rel="method-getXTypes" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-getXTypes" class="viewSource">view source</a></div><a name="getXTypes"></a><a name="method-getXTypes"></a><a href="Ext.form.field.Base.html#" rel="method-getXTypes" class="cls expand">getXTypes</a> : String</div><div class="description"><div class="short">Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
1694 available xtypes, see the Ext...</div><div class="long"><p>Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
1695 available xtypes, see the <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> header.</p>
1696
1697
1698 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
1699 to participate in determination of inherited xtypes.</b></p>
1700
1701
1702 <p>Example usage:</p>
1703
1704
1705 <pre><code>var t = new Ext.form.field.Text();
1706 alert(t.getXTypes());  // alerts 'component/field/textfield'
1707 </code></pre>
1708
1709 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;<p>The xtype hierarchy string</p>
1710 </li></ul></div></div></div><div id="method-hasActiveError" class="member inherited"><a href="Ext.form.field.Base.html#method-hasActiveError" rel="method-hasActiveError" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-method-hasActiveError" class="viewSource">view source</a></div><a name="hasActiveError"></a><a name="method-hasActiveError"></a><a href="Ext.form.field.Base.html#" rel="method-hasActiveError" class="cls expand">hasActiveError</a> : Boolean</div><div class="description"><div class="short">Tells whether the field currently has an active error message. This does not trigger
1711 validation on its own, it merely...</div><div class="long"><p>Tells whether the field currently has an active error message. This does not trigger
1712 validation on its own, it merely looks for any message that the component may already hold.</p>
1713 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;
1714 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.form.field.Base.html#method-hasListener" rel="method-hasListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-hasListener" class="viewSource">view source</a></div><a name="hasListener"></a><a name="method-hasListener"></a><a href="Ext.form.field.Base.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
1715 <span class="pre">String eventName</span>)
1716  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
1717 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
1718 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to check for</p>
1719 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the event is being listened for, else false</p>
1720 </li></ul></div></div></div><div id="method-hasUICls" class="member inherited"><a href="Ext.form.field.Base.html#method-hasUICls" rel="method-hasUICls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-hasUICls" class="viewSource">view source</a></div><a name="hasUICls"></a><a name="method-hasUICls"></a><a href="Ext.form.field.Base.html#" rel="method-hasUICls" class="cls expand">hasUICls</a>(
1721 <span class="pre">String cls</span>)
1722  : void</div><div class="description"><div class="short"><p>Checks if there is currently a specified uiCls</p>
1723 </div><div class="long"><p>Checks if there is currently a specified uiCls</p>
1724 <h3 class="pa">Parameters</h3><ul><li><span class="pre">cls</span> : String<div class="sub-desc"><p>The cls to check</p>
1725 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1726 </li></ul></div></div></div><div id="method-hide" class="member inherited"><a href="Ext.form.field.Base.html#method-hide" rel="method-hide" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-hide" class="viewSource">view source</a></div><a name="hide"></a><a name="method-hide"></a><a href="Ext.form.field.Base.html#" rel="method-hide" class="cls expand">hide</a>(
1727 <span class="pre">String/Element/Component animateTarget, [Function callback], [Object scope]</span>)
1728  : Ext.Component</div><div class="description"><div class="short"><p>Hides this Component, setting it to invisible using the configured <a href="Ext.form.field.Base.html#hideMode" rel="Ext.form.field.Base#hideMode" class="docClass">hideMode</a>.</p>
1729 </div><div class="long"><p>Hides this Component, setting it to invisible using the configured <a href="Ext.form.field.Base.html#hideMode" rel="Ext.form.field.Base#hideMode" class="docClass">hideMode</a>.</p>
1730 <h3 class="pa">Parameters</h3><ul><li><span class="pre">animateTarget</span> : String/Element/Component<div class="sub-desc"><p>Optional, and <b>only valid for <a href="Ext.form.field.Base.html#floating" rel="Ext.form.field.Base#floating" class="docClass">floating</a> Components such as
1731 <a href="Ext.window.Window.html" rel="Ext.window.Window" class="docClass">Window</a>s or <a href="Ext.tip.ToolTip.html" rel="Ext.tip.ToolTip" class="docClass">ToolTip</a>s, or regular Components which have been configured
1732 with <code>floating: true</code>.</b>.
1733 The target to which the Component should animate while hiding (defaults to null with no animation)</p>
1734 </div></li><li><span class="pre">callback</span> : Function<div class="sub-desc"><p>(optional) A callback function to call after the Component is hidden.</p>
1735 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to this Component.</p>
1736 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
1737 </li></ul></div></div></div><div id="method-initField" class="member inherited"><a href="Ext.form.field.Base.html#method-initField" rel="method-initField" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-initField" class="viewSource">view source</a></div><a name="initField"></a><a name="method-initField"></a><a href="Ext.form.field.Base.html#" rel="method-initField" class="cls expand">initField</a> : void</div><div class="description"><div class="short">Initializes this Field mixin on the current instance. Components using this mixin should call
1738 this method during thei...</div><div class="long"><p>Initializes this Field mixin on the current instance. Components using this mixin should call
1739 this method during their own initialization process.</p>
1740 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1741 </li></ul></div></div></div><div id="method-initLabelable" class="member inherited"><a href="Ext.form.field.Base.html#method-initLabelable" rel="method-initLabelable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-method-initLabelable" class="viewSource">view source</a></div><a name="initLabelable"></a><a name="method-initLabelable"></a><a href="Ext.form.field.Base.html#" rel="method-initLabelable" class="cls expand">initLabelable</a> : void</div><div class="description"><div class="short">Performs initialization of this mixin. Component classes using this mixin should call this method
1742 during their own in...</div><div class="long"><p>Performs initialization of this mixin. Component classes using this mixin should call this method
1743 during their own initialization.</p>
1744 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1745 </li></ul></div></div></div><div id="method-is" class="member inherited"><a href="Ext.form.field.Base.html#method-is" rel="method-is" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-is" class="viewSource">view source</a></div><a name="is"></a><a name="method-is"></a><a href="Ext.form.field.Base.html#" rel="method-is" class="cls expand">is</a>(
1746 <span class="pre">String selector</span>)
1747  : Boolean</div><div class="description"><div class="short"><p>Tests whether this Component matches the selector string.</p>
1748 </div><div class="long"><p>Tests whether this Component matches the selector string.</p>
1749 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selector</span> : String<div class="sub-desc"><p>The selector string to test against.</p>
1750 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if this Component matches the selector.</p>
1751 </li></ul></div></div></div><div id="method-isDescendantOf" class="member inherited"><a href="Ext.form.field.Base.html#method-isDescendantOf" rel="method-isDescendantOf" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isDescendantOf" class="viewSource">view source</a></div><a name="isDescendantOf"></a><a name="method-isDescendantOf"></a><a href="Ext.form.field.Base.html#" rel="method-isDescendantOf" class="cls expand">isDescendantOf</a>(
1752 <span class="pre">Ext.Container container</span>)
1753  : Boolean</div><div class="description"><div class="short"><p>Determines whether this component is the descendant of a particular container.</p>
1754 </div><div class="long"><p>Determines whether this component is the descendant of a particular container.</p>
1755 <h3 class="pa">Parameters</h3><ul><li><span class="pre">container</span> : Ext.Container<div class="sub-desc">
1756 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>isDescendant</p>
1757 </li></ul></div></div></div><div id="method-isDirty" class="member inherited"><a href="Ext.form.field.Base.html#method-isDirty" rel="method-isDirty" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-isDirty" class="viewSource">view source</a></div><a name="isDirty"></a><a name="method-isDirty"></a><a href="Ext.form.field.Base.html#" rel="method-isDirty" class="cls expand">isDirty</a> : Boolean</div><div class="description"><div class="short">Returns true if the value of this Field has been changed from its originalValue.
1758 Will always return false if the fiel...</div><div class="long"><p>Returns true if the value of this Field has been changed from its <a href="Ext.form.field.Base.html#originalValue" rel="Ext.form.field.Base#originalValue" class="docClass">originalValue</a>.
1759 Will always return false if the field is disabled.</p>
1760
1761
1762 <p>Note that if the owning <a href="Ext.form.Basic.html" rel="Ext.form.Basic" class="docClass">form</a> was configured with
1763 <a href="Ext.form.Basic.html#trackResetOnLoad" rel="Ext.form.Basic#trackResetOnLoad" class="docClass">trackResetOnLoad</a>
1764 then the <a href="Ext.form.field.Base.html#originalValue" rel="Ext.form.field.Base#originalValue" class="docClass">originalValue</a> is updated when the values are loaded by
1765 <a href="Ext.form.Basic.html" rel="Ext.form.Basic" class="docClass">Ext.form.Basic</a>.<a href="Ext.form.Basic.html#setValues" rel="Ext.form.Basic#setValues" class="docClass">setValues</a>.</p>
1766
1767 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if this field has been changed from its original value (and
1768 is not disabled), false otherwise.</p>
1769 </li></ul></div></div></div><div id="method-isDisabled" class="member inherited"><a href="Ext.form.field.Base.html#method-isDisabled" rel="method-isDisabled" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isDisabled" class="viewSource">view source</a></div><a name="isDisabled"></a><a name="method-isDisabled"></a><a href="Ext.form.field.Base.html#" rel="method-isDisabled" class="cls expand">isDisabled</a> : Boolean</div><div class="description"><div class="short"><p>Method to determine whether this Component is currently disabled.</p>
1770 </div><div class="long"><p>Method to determine whether this Component is currently disabled.</p>
1771 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the disabled state of this Component.</p>
1772 </li></ul></div></div></div><div id="method-isDraggable" class="member inherited"><a href="Ext.form.field.Base.html#method-isDraggable" rel="method-isDraggable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isDraggable" class="viewSource">view source</a></div><a name="isDraggable"></a><a name="method-isDraggable"></a><a href="Ext.form.field.Base.html#" rel="method-isDraggable" class="cls expand">isDraggable</a> : Boolean</div><div class="description"><div class="short"><p>Method to determine whether this Component is draggable.</p>
1773 </div><div class="long"><p>Method to determine whether this Component is draggable.</p>
1774 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the draggable state of this component.</p>
1775 </li></ul></div></div></div><div id="method-isDroppable" class="member inherited"><a href="Ext.form.field.Base.html#method-isDroppable" rel="method-isDroppable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isDroppable" class="viewSource">view source</a></div><a name="isDroppable"></a><a name="method-isDroppable"></a><a href="Ext.form.field.Base.html#" rel="method-isDroppable" class="cls expand">isDroppable</a> : Boolean</div><div class="description"><div class="short"><p>Method to determine whether this Component is droppable.</p>
1776 </div><div class="long"><p>Method to determine whether this Component is droppable.</p>
1777 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the droppable state of this component.</p>
1778 </li></ul></div></div></div><div id="method-isEqual" class="member inherited"><a href="Ext.form.field.Base.html#method-isEqual" rel="method-isEqual" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-isEqual" class="viewSource">view source</a></div><a name="isEqual"></a><a name="method-isEqual"></a><a href="Ext.form.field.Base.html#" rel="method-isEqual" class="cls expand">isEqual</a>(
1779 <span class="pre">Mixed value1, Mixed value2</span>)
1780  : Boolean</div><div class="description"><div class="short">Returns whether two field values are logically equal. Field implementations may override
1781 this to provide custom compa...</div><div class="long"><p>Returns whether two field <a href="Ext.form.field.Base.html#getValue" rel="Ext.form.field.Base#getValue" class="docClass">values</a> are logically equal. Field implementations may override
1782 this to provide custom comparison logic appropriate for the particular field's data type.</p>
1783 <h3 class="pa">Parameters</h3><ul><li><span class="pre">value1</span> : Mixed<div class="sub-desc"><p>The first value to compare</p>
1784 </div></li><li><span class="pre">value2</span> : Mixed<div class="sub-desc"><p>The second value to compare</p>
1785 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the values are equal, false if inequal.</p>
1786 </li></ul></div></div></div><div id="method-isFileUpload" class="member inherited"><a href="Ext.form.field.Base.html#method-isFileUpload" rel="method-isFileUpload" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-isFileUpload" class="viewSource">view source</a></div><a name="isFileUpload"></a><a name="method-isFileUpload"></a><a href="Ext.form.field.Base.html#" rel="method-isFileUpload" class="cls expand">isFileUpload</a> : Boolean</div><div class="description"><div class="short">Returns whether this Field is a file upload field; if it returns true, forms will use
1787 special techniques for submitti...</div><div class="long"><p>Returns whether this Field is a file upload field; if it returns true, forms will use
1788 special techniques for <a href="Ext.form.Basic.html#submit" rel="Ext.form.Basic#submit" class="docClass">submitting the form</a> via AJAX. See
1789 <a href="Ext.form.Basic.html#hasUpload" rel="Ext.form.Basic#hasUpload" class="docClass">Ext.form.Basic.hasUpload</a> for details. If this returns true, the <a href="Ext.form.field.Base.html#extractFileInput" rel="Ext.form.field.Base#extractFileInput" class="docClass">extractFileInput</a>
1790 method must also be implemented to return the corresponding file input element.</p>
1791 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;
1792 </li></ul></div></div></div><div id="method-isFloating" class="member inherited"><a href="Ext.form.field.Base.html#method-isFloating" rel="method-isFloating" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isFloating" class="viewSource">view source</a></div><a name="isFloating"></a><a name="method-isFloating"></a><a href="Ext.form.field.Base.html#" rel="method-isFloating" class="cls expand">isFloating</a> : Boolean</div><div class="description"><div class="short"><p>Method to determine whether this Component is floating.</p>
1793 </div><div class="long"><p>Method to determine whether this Component is floating.</p>
1794 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the floating state of this component.</p>
1795 </li></ul></div></div></div><div id="method-isHidden" class="member inherited"><a href="Ext.form.field.Base.html#method-isHidden" rel="method-isHidden" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isHidden" class="viewSource">view source</a></div><a name="isHidden"></a><a name="method-isHidden"></a><a href="Ext.form.field.Base.html#" rel="method-isHidden" class="cls expand">isHidden</a> : Boolean</div><div class="description"><div class="short"><p>Method to determine whether this Component is currently set to hidden.</p>
1796 </div><div class="long"><p>Method to determine whether this Component is currently set to hidden.</p>
1797 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>the hidden state of this Component.</p>
1798 </li></ul></div></div></div><div id="method-isValid" class="member ni"><a href="Ext.form.field.Base.html#method-isValid" rel="method-isValid" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-isValid" class="viewSource">view source</a></div><a name="isValid"></a><a name="method-isValid"></a><a href="Ext.form.field.Base.html#" rel="method-isValid" class="cls expand">isValid</a> : Boolean</div><div class="description"><div class="short">Returns whether or not the field value is currently valid by
1799 validating the processed raw value
1800 of the field. Note: d...</div><div class="long"><p>Returns whether or not the field value is currently valid by
1801 <a href="Ext.form.field.Base.html#getErrors" rel="Ext.form.field.Base#getErrors" class="docClass">validating</a> the <a href="Ext.form.field.Base.html#processRawValue" rel="Ext.form.field.Base#processRawValue" class="docClass">processed raw value</a>
1802 of the field. <b>Note</b>: <a href="Ext.form.field.Base.html#disabled" rel="Ext.form.field.Base#disabled" class="docClass">disabled</a> fields are always treated as valid.</p>
1803 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the value is valid, else false</p>
1804 </li></ul></div></div></div><div id="method-isVisible" class="member inherited"><a href="Ext.form.field.Base.html#method-isVisible" rel="method-isVisible" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isVisible" class="viewSource">view source</a></div><a name="isVisible"></a><a name="method-isVisible"></a><a href="Ext.form.field.Base.html#" rel="method-isVisible" class="cls expand">isVisible</a>(
1805 <span class="pre">Boolean deep</span>)
1806  : Boolean</div><div class="description"><div class="short"><p>Returns true if this component is visible.</p>
1807 </div><div class="long"><p>Returns true if this component is visible.</p>
1808 <h3 class="pa">Parameters</h3><ul><li><span class="pre">deep</span> : Boolean<div class="sub-desc"><p>. <p>Optional. Pass <code>true</code> to interrogate the visibility status of all
1809 parent Containers to determine whether this Component is truly visible to the user.</p></p>
1810
1811 <p>Generally, to determine whether a Component is hidden, the no argument form is needed. For example
1812 when creating dynamically laid out UIs in a hidden Container before showing them.</p>
1813
1814 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if this component is visible, false otherwise.</p>
1815 </li></ul></div></div></div><div id="method-isXType" class="member inherited"><a href="Ext.form.field.Base.html#method-isXType" rel="method-isXType" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-isXType" class="viewSource">view source</a></div><a name="isXType"></a><a name="method-isXType"></a><a href="Ext.form.field.Base.html#" rel="method-isXType" class="cls expand">isXType</a>(
1816 <span class="pre">String xtype, [Boolean shallow]</span>)
1817  : Boolean</div><div class="description"><div class="short">Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
1818 from th...</div><div class="long"><p>Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
1819 from the xtype (default) or whether it is directly of the xtype specified (shallow = true).</p>
1820
1821
1822 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
1823 to participate in determination of inherited xtypes.</b></p>
1824
1825
1826 <p>For a list of all available xtypes, see the <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> header.</p>
1827
1828
1829 <p>Example usage:</p>
1830
1831
1832 <pre><code>var t = new Ext.form.field.Text();
1833 var isText = t.isXType('textfield');        // true
1834 var isBoxSubclass = t.isXType('field');       // true, descended from <a href="Ext.form.field.Base.html" rel="Ext.form.field.Base" class="docClass">Ext.form.field.Base</a>
1835 var isBoxInstance = t.isXType('field', true); // false, not a direct <a href="Ext.form.field.Base.html" rel="Ext.form.field.Base" class="docClass">Ext.form.field.Base</a> instance
1836 </code></pre>
1837
1838 <h3 class="pa">Parameters</h3><ul><li><span class="pre">xtype</span> : String<div class="sub-desc"><p>The xtype to check for this Component</p>
1839 </div></li><li><span class="pre">shallow</span> : Boolean<div class="sub-desc"><p>(optional) False to check whether this Component is descended from the xtype (this is
1840 the default), or true to check whether this Component is directly of the specified xtype.</p>
1841 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if this component descends from the specified xtype, false otherwise.</p>
1842 </li></ul></div></div></div><div id="method-markInvalid" class="member ni"><a href="Ext.form.field.Base.html#method-markInvalid" rel="method-markInvalid" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-markInvalid" class="viewSource">view source</a></div><a name="markInvalid"></a><a name="method-markInvalid"></a><a href="Ext.form.field.Base.html#" rel="method-markInvalid" class="cls expand">markInvalid</a>(
1843 <span class="pre">String/Array errors</span>)
1844  : void</div><div class="description"><div class="short">Display one or more error messages associated with this field, using msgTarget to determine how to
1845 display the messag...</div><div class="long"><p>Display one or more error messages associated with this field, using <a href="Ext.form.field.Base.html#msgTarget" rel="Ext.form.field.Base#msgTarget" class="docClass">msgTarget</a> to determine how to
1846 display the messages and applying <a href="Ext.form.field.Base.html#invalidCls" rel="Ext.form.field.Base#invalidCls" class="docClass">invalidCls</a> to the field's UI element.</p>
1847
1848
1849 <p><b>Note</b>: this method does not cause the Field's <a href="Ext.form.field.Base.html#validate" rel="Ext.form.field.Base#validate" class="docClass">validate</a> or <a href="Ext.form.field.Base.html#isValid" rel="Ext.form.field.Base#isValid" class="docClass">isValid</a> methods to
1850 return <code>false</code> if the value does <i>pass</i> validation. So simply marking a Field as invalid
1851 will not prevent submission of forms submitted with the <a href="Ext.form.action.Submit.html#clientValidation" rel="Ext.form.action.Submit#clientValidation" class="docClass">Ext.form.action.Submit.clientValidation</a>
1852 option set.</p>
1853
1854 <h3 class="pa">Parameters</h3><ul><li><span class="pre">errors</span> : String/Array<div class="sub-desc"><p>The validation message(s) to display.</p>
1855 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1856 </li></ul></div></div></div><div id="method-nextNode" class="member inherited"><a href="Ext.form.field.Base.html#method-nextNode" rel="method-nextNode" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-nextNode" class="viewSource">view source</a></div><a name="nextNode"></a><a name="method-nextNode"></a><a href="Ext.form.field.Base.html#" rel="method-nextNode" class="cls expand">nextNode</a>(
1857 <span class="pre">String selector, Object includeSelf</span>)
1858  : void</div><div class="description"><div class="short">Returns the next node in the Component tree in tree traversal order.
1859
1860
1861 Note that this is not limited to siblings, and...</div><div class="long"><p>Returns the next node in the Component tree in tree traversal order.</p>
1862
1863
1864 <p>Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will
1865 walk the tree to attempt to find a match. Contrast with <a href="Ext.form.field.Base.html#pnextSibling" rel="Ext.form.field.Base#pnextSibling" class="docClass">pnextSibling</a>.</p>
1866
1867 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selector</span> : String<div class="sub-desc"><p>Optional A <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector to filter the following nodes.</p>
1868 </div></li><li><span class="pre">includeSelf</span> : Object<div class="sub-desc">
1869 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;<p>The next node (or the next node which matches the selector). Returns null if there is no matching node.</p>
1870 </li></ul></div></div></div><div id="method-nextSibling" class="member inherited"><a href="Ext.form.field.Base.html#method-nextSibling" rel="method-nextSibling" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-nextSibling" class="viewSource">view source</a></div><a name="nextSibling"></a><a name="method-nextSibling"></a><a href="Ext.form.field.Base.html#" rel="method-nextSibling" class="cls expand">nextSibling</a>(
1871 <span class="pre">String selector</span>)
1872  : void</div><div class="description"><div class="short">Returns the next sibling of this Component.
1873
1874
1875 Optionally selects the next sibling which matches the passed ComponentQ...</div><div class="long"><p>Returns the next sibling of this Component.</p>
1876
1877
1878 <p>Optionally selects the next sibling which matches the passed <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector.</p>
1879
1880
1881 <p>May also be refered to as <code><b>next()</b></code></p>
1882
1883
1884 <p>Note that this is limited to siblings, and if no siblings of the item match, <code>null</code> is returned. Contrast with <a href="Ext.form.field.Base.html#nextNode" rel="Ext.form.field.Base#nextNode" class="docClass">nextNode</a></p>
1885
1886 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selector</span> : String<div class="sub-desc"><p>Optional A <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector to filter the following items.</p>
1887 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;<p>The next sibling (or the next sibling which matches the selector). Returns null if there is no matching sibling.</p>
1888 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.form.field.Base.html#method-observe" rel="method-observe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-observe" class="viewSource">view source</a></div><a name="observe"></a><a name="method-observe"></a><a href="Ext.form.field.Base.html#" rel="method-observe" class="cls expand">observe</a>(
1889 <span class="pre">Function c, Object listeners</span>)
1890  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
1891
1892 This makes any event fired on any instance of the passed class a...</div><div class="long"><p>Sets observability on the passed class constructor.</p>
1893
1894 <p>This makes any event fired on any instance of the passed class also fire a single event through
1895 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
1896
1897 <p>Usage:</p>
1898
1899 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
1900 Ext.data.Connection.on('beforerequest', function(con, options) {
1901     console.log('Ajax request made to ' + options.url);
1902 });
1903 </code></pre>
1904 <h3 class="pa">Parameters</h3><ul><li><span class="pre">c</span> : Function<div class="sub-desc"><p>The class constructor to make observable.</p>
1905 </div></li><li><span class="pre">listeners</span> : Object<div class="sub-desc"><p>An object containing a series of listeners to add. See <a href="Ext.form.field.Base.html#addListener" rel="Ext.form.field.Base#addListener" class="docClass">addListener</a>.</p>
1906 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1907 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.form.field.Base.html#method-on" rel="method-on" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-on" class="viewSource">view source</a></div><a name="on"></a><a name="method-on"></a><a href="Ext.form.field.Base.html#" rel="method-on" class="cls expand">on</a>(
1908 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
1909  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.form.field.Base.html#addListener" rel="Ext.form.field.Base#addListener" class="docClass">addListener</a>.)</p>
1910 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.form.field.Base.html#addListener" rel="Ext.form.field.Base#addListener" class="docClass">addListener</a>.)</p>
1911 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event to listen for</p>
1912 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
1913 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
1914 <b>If omitted, defaults to the object which fired the event.</b></p>
1915 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
1916 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1917 </li></ul></div></div></div><div id="method-previousNode" class="member inherited"><a href="Ext.form.field.Base.html#method-previousNode" rel="method-previousNode" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-previousNode" class="viewSource">view source</a></div><a name="previousNode"></a><a name="method-previousNode"></a><a href="Ext.form.field.Base.html#" rel="method-previousNode" class="cls expand">previousNode</a>(
1918 <span class="pre">String selector, Object includeSelf</span>)
1919  : void</div><div class="description"><div class="short">Returns the previous node in the Component tree in tree traversal order.
1920
1921
1922 Note that this is not limited to siblings,...</div><div class="long"><p>Returns the previous node in the Component tree in tree traversal order.</p>
1923
1924
1925 <p>Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will
1926 walk the tree in reverse order to attempt to find a match. Contrast with <a href="Ext.form.field.Base.html#previousSibling" rel="Ext.form.field.Base#previousSibling" class="docClass">previousSibling</a>.</p>
1927
1928 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selector</span> : String<div class="sub-desc"><p>Optional. A <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector to filter the preceding nodes.</p>
1929 </div></li><li><span class="pre">includeSelf</span> : Object<div class="sub-desc">
1930 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;<p>The previous node (or the previous node which matches the selector). Returns null if there is no matching node.</p>
1931 </li></ul></div></div></div><div id="method-previousSibling" class="member inherited"><a href="Ext.form.field.Base.html#method-previousSibling" rel="method-previousSibling" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-previousSibling" class="viewSource">view source</a></div><a name="previousSibling"></a><a name="method-previousSibling"></a><a href="Ext.form.field.Base.html#" rel="method-previousSibling" class="cls expand">previousSibling</a>(
1932 <span class="pre">String selector</span>)
1933  : void</div><div class="description"><div class="short">Returns the previous sibling of this Component.
1934
1935
1936 Optionally selects the previous sibling which matches the passed Co...</div><div class="long"><p>Returns the previous sibling of this Component.</p>
1937
1938
1939 <p>Optionally selects the previous sibling which matches the passed <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector.</p>
1940
1941
1942 <p>May also be refered to as <code><b>prev()</b></code></p>
1943
1944
1945 <p>Note that this is limited to siblings, and if no siblings of the item match, <code>null</code> is returned. Contrast with <a href="Ext.form.field.Base.html#previousNode" rel="Ext.form.field.Base#previousNode" class="docClass">previousNode</a></p>
1946
1947 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selector</span> : String<div class="sub-desc"><p>Optional. A <a href="Ext.ComponentQuery.html" rel="Ext.ComponentQuery" class="docClass">ComponentQuery</a> selector to filter the preceding items.</p>
1948 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;<p>The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling.</p>
1949 </li></ul></div></div></div><div id="method-processRawValue" class="member ni"><a href="Ext.form.field.Base.html#method-processRawValue" rel="method-processRawValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-processRawValue" class="viewSource">view source</a></div><a name="processRawValue"></a><a name="method-processRawValue"></a><a href="Ext.form.field.Base.html#" rel="method-processRawValue" class="cls expand">processRawValue</a>(
1950 <span class="pre">Mixed value</span>)
1951  : Mixed</div><div class="description"><div class="short">Performs any necessary manipulation of a raw field value to prepare it for conversion
1952 and/or validation, for instance...</div><div class="long"><p>Performs any necessary manipulation of a raw field value to prepare it for <a href="Ext.form.field.Base.html#rawToValue" rel="Ext.form.field.Base#rawToValue" class="docClass">conversion</a>
1953 and/or <a href="Ext.form.field.Base.html#validate" rel="Ext.form.field.Base#validate" class="docClass">validation</a>, for instance stripping out ignored characters. In the base implementation
1954 it does nothing; individual subclasses may override this as needed.</p>
1955 <h3 class="pa">Parameters</h3><ul><li><span class="pre">value</span> : Mixed<div class="sub-desc"><p>The unprocessed string value</p>
1956 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Mixed</span>&nbsp; &nbsp;<p>The processed string value</p>
1957 </li></ul></div></div></div><div id="method-rawToValue" class="member ni"><a href="Ext.form.field.Base.html#method-rawToValue" rel="method-rawToValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-rawToValue" class="viewSource">view source</a></div><a name="rawToValue"></a><a name="method-rawToValue"></a><a href="Ext.form.field.Base.html#" rel="method-rawToValue" class="cls expand">rawToValue</a>(
1958 <span class="pre">Mixed rawValue</span>)
1959  : Mixed</div><div class="description"><div class="short">Converts a raw input field value into a mixed-type value that is suitable for this particular field type.
1960 This allows...</div><div class="long"><p>Converts a raw input field value into a mixed-type value that is suitable for this particular field type.
1961 This allows controlling the normalization and conversion of user-entered values into field-type-appropriate
1962 values, e.g. a Date object for <a href="Ext.form.field.Date.html" rel="Ext.form.field.Date" class="docClass">Ext.form.field.Date</a>, and is invoked by <a href="Ext.form.field.Base.html#getValue" rel="Ext.form.field.Base#getValue" class="docClass">getValue</a>.</p>
1963
1964
1965 <p>It is up to individual implementations to decide how to handle raw values that cannot be successfully
1966 converted to the desired object type.</p>
1967
1968
1969 <p>See <a href="Ext.form.field.Base.html#valueToRaw" rel="Ext.form.field.Base#valueToRaw" class="docClass">valueToRaw</a> for the opposite conversion.</p>
1970
1971
1972 <p>The base implementation does no conversion, returning the raw value untouched.</p>
1973
1974 <h3 class="pa">Parameters</h3><ul><li><span class="pre">rawValue</span> : Mixed<div class="sub-desc">
1975 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Mixed</span>&nbsp; &nbsp;<p>The converted value.</p>
1976 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.form.field.Base.html#method-relayEvents" rel="method-relayEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-relayEvents" class="viewSource">view source</a></div><a name="relayEvents"></a><a name="method-relayEvents"></a><a href="Ext.form.field.Base.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
1977 <span class="pre">Object origin, Array events, Object prefix</span>)
1978  : void</div><div class="description"><div class="short"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
1979 </div><div class="long"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
1980 <h3 class="pa">Parameters</h3><ul><li><span class="pre">origin</span> : Object<div class="sub-desc"><p>The Observable whose events this object is to relay.</p>
1981 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
1982 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
1983 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1984 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.form.field.Base.html#method-releaseCapture" rel="method-releaseCapture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-releaseCapture" class="viewSource">view source</a></div><a name="releaseCapture"></a><a name="method-releaseCapture"></a><a href="Ext.form.field.Base.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
1985 <span class="pre">Observable o</span>)
1986  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
1987 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
1988 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
1989 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
1990 </li></ul></div></div></div><div id="method-removeCls" class="member inherited"><a href="Ext.form.field.Base.html#method-removeCls" rel="method-removeCls" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-removeCls" class="viewSource">view source</a></div><a name="removeCls"></a><a name="method-removeCls"></a><a href="Ext.form.field.Base.html#" rel="method-removeCls" class="cls expand">removeCls</a>(
1991 <span class="pre">Object className</span>)
1992  : Ext.Component</div><div class="description"><div class="short"><p>Removes a CSS class from the top level element representing this component.</p>
1993 </div><div class="long"><p>Removes a CSS class from the top level element representing this component.</p>
1994 <h3 class="pa">Parameters</h3><ul><li><span class="pre">className</span> : Object<div class="sub-desc">
1995 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>Returns the Component to allow method chaining.</p>
1996 </li></ul></div></div></div><div id="method-removeClsWithUI" class="member inherited"><a href="Ext.form.field.Base.html#method-removeClsWithUI" rel="method-removeClsWithUI" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-removeClsWithUI" class="viewSource">view source</a></div><a name="removeClsWithUI"></a><a name="method-removeClsWithUI"></a><a href="Ext.form.field.Base.html#" rel="method-removeClsWithUI" class="cls expand">removeClsWithUI</a>(
1997 <span class="pre">String/Array cls</span>)
1998  : void</div><div class="description"><div class="short">Removes a cls to the uiCls array, which will also call removeUIClsToElement and removes
1999 it from all elements of this ...</div><div class="long"><p>Removes a cls to the uiCls array, which will also call <a href="Ext.form.field.Base.html#removeUIClsToElement" rel="Ext.form.field.Base#removeUIClsToElement" class="docClass">removeUIClsToElement</a> and removes
2000 it from all elements of this component.</p>
2001 <h3 class="pa">Parameters</h3><ul><li><span class="pre">cls</span> : String/Array<div class="sub-desc"><p>A string or an array of strings to remove to the uiCls</p>
2002 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2003 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.form.field.Base.html#method-removeListener" rel="method-removeListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeListener" class="viewSource">view source</a></div><a name="removeListener"></a><a name="method-removeListener"></a><a href="Ext.form.field.Base.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
2004 <span class="pre">String eventName, Function handler, [Object scope]</span>)
2005  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
2006 </div><div class="long"><p>Removes an event handler.</p>
2007 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
2008 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.form.field.Base.html#addListener" rel="Ext.form.field.Base#addListener" class="docClass">addListener</a> call.</b></p>
2009 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
2010 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2011 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.form.field.Base.html#method-removeManagedListener" rel="method-removeManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeManagedListener" class="viewSource">view source</a></div><a name="removeManagedListener"></a><a name="method-removeManagedListener"></a><a href="Ext.form.field.Base.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
2012 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
2013  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.form.field.Base.html#mon" rel="Ext.form.field.Base#mon" class="docClass">mon</a> method.</p>
2014 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.form.field.Base.html#mon" rel="Ext.form.field.Base#mon" class="docClass">mon</a> method.</p>
2015 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable|Element<div class="sub-desc"><p>The item from which to remove a listener/listeners.</p>
2016 </div></li><li><span class="pre">ename</span> : Object|String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
2017 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
2018 is the handler function.</p>
2019 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
2020 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
2021 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2022 </li></ul></div></div></div><div id="method-reset" class="member inherited"><a href="Ext.form.field.Base.html#method-reset" rel="method-reset" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-reset" class="viewSource">view source</a></div><a name="reset"></a><a name="method-reset"></a><a href="Ext.form.field.Base.html#" rel="method-reset" class="cls expand">reset</a> : void</div><div class="description"><div class="short">Resets the current field value to the originally loaded value and clears any validation messages.
2023 See Ext.form.Basic....</div><div class="long"><p>Resets the current field value to the originally loaded value and clears any validation messages.
2024 See <a href="Ext.form.Basic.html" rel="Ext.form.Basic" class="docClass">Ext.form.Basic</a>.<a href="Ext.form.Basic.html#trackResetOnLoad" rel="Ext.form.Basic#trackResetOnLoad" class="docClass">trackResetOnLoad</a></p>
2025 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2026 </li></ul></div></div></div><div id="method-resetOriginalValue" class="member inherited"><a href="Ext.form.field.Base.html#method-resetOriginalValue" rel="method-resetOriginalValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-resetOriginalValue" class="viewSource">view source</a></div><a name="resetOriginalValue"></a><a name="method-resetOriginalValue"></a><a href="Ext.form.field.Base.html#" rel="method-resetOriginalValue" class="cls expand">resetOriginalValue</a> : void</div><div class="description"><div class="short">Resets the field's originalValue property so it matches the current value.
2027 This is called by Ext.form.Basic.setValues...</div><div class="long"><p>Resets the field's <a href="Ext.form.field.Base.html#originalValue" rel="Ext.form.field.Base#originalValue" class="docClass">originalValue</a> property so it matches the current <a href="Ext.form.field.Base.html#getValue" rel="Ext.form.field.Base#getValue" class="docClass">value</a>.
2028 This is called by <a href="Ext.form.Basic.html" rel="Ext.form.Basic" class="docClass">Ext.form.Basic</a>.<a href="Ext.form.Basic.html#setValues" rel="Ext.form.Basic#setValues" class="docClass">setValues</a> if the form's
2029 <a href="Ext.form.Basic.html#trackResetOnLoad" rel="Ext.form.Basic#trackResetOnLoad" class="docClass">trackResetOnLoad</a> property is set to true.</p>
2030 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2031 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.form.field.Base.html#method-resumeEvents" rel="method-resumeEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-resumeEvents" class="viewSource">view source</a></div><a name="resumeEvents"></a><a name="method-resumeEvents"></a><a href="Ext.form.field.Base.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
2032 If events were suspended using the queueSuspended parameter, then all
2033 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.form.field.Base.html#suspendEvents" rel="Ext.form.field.Base#suspendEvents" class="docClass">suspendEvents</a>)
2034 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
2035 events fired during event suspension will be sent to any listeners now.</p>
2036 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2037 </li></ul></div></div></div><div id="method-sequenceFx" class="member inherited"><a href="Ext.form.field.Base.html#method-sequenceFx" rel="method-sequenceFx" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-method-sequenceFx" class="viewSource">view source</a></div><a name="sequenceFx"></a><a name="method-sequenceFx"></a><a href="Ext.form.field.Base.html#" rel="method-sequenceFx" class="cls expand">sequenceFx</a> : Ext.core.Element</div><div class="description"><div class="short">Ensures that all effects queued after sequenceFx is called on this object are
2038 run in sequence.  This is the opposite ...</div><div class="long"><p>Ensures that all effects queued after sequenceFx is called on this object are
2039 run in sequence.  This is the opposite of <a href="Ext.form.field.Base.html#syncFx" rel="Ext.form.field.Base#syncFx" class="docClass">syncFx</a>.</p>
2040 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.core.Element</span>&nbsp; &nbsp;<p>The Element</p>
2041 </li></ul></div></div></div><div id="method-setActive" class="member inherited"><a href="Ext.form.field.Base.html#method-setActive" rel="method-setActive" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-method-setActive" class="viewSource">view source</a></div><a name="setActive"></a><a name="method-setActive"></a><a href="Ext.form.field.Base.html#" rel="method-setActive" class="cls expand">setActive</a>(
2042 <span class="pre">Boolean active, Component newActive</span>)
2043  : void</div><div class="description"><div class="short">This method is called internally by Ext.ZIndexManager to signal that a floating
2044 Component has either been moved to th...</div><div class="long"><p>This method is called internally by <a href="Ext.ZIndexManager.html" rel="Ext.ZIndexManager" class="docClass">Ext.ZIndexManager</a> to signal that a floating
2045 Component has either been moved to the top of its zIndex stack, or pushed from the top of its zIndex stack.</p>
2046
2047
2048 <p>If a <i>Window</i> is superceded by another Window, deactivating it hides its shadow.</p>
2049
2050
2051 <p>This method also fires the <a href="Ext.form.field.Base.html#activate" rel="Ext.form.field.Base#activate" class="docClass">activate</a> or <a href="Ext.form.field.Base.html#deactivate" rel="Ext.form.field.Base#deactivate" class="docClass">deactivate</a> event depending on which action occurred.</p>
2052
2053 <h3 class="pa">Parameters</h3><ul><li><span class="pre">active</span> : Boolean<div class="sub-desc"><p>True to activate the Component, false to deactivate it (defaults to false)</p>
2054 </div></li><li><span class="pre">newActive</span> : Component<div class="sub-desc"><p>The newly active Component which is taking over topmost zIndex position.</p>
2055 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2056 </li></ul></div></div></div><div id="method-setActiveError" class="member inherited"><a href="Ext.form.field.Base.html#method-setActiveError" rel="method-setActiveError" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-method-setActiveError" class="viewSource">view source</a></div><a name="setActiveError"></a><a name="method-setActiveError"></a><a href="Ext.form.field.Base.html#" rel="method-setActiveError" class="cls expand">setActiveError</a>(
2057 <span class="pre">String msg</span>)
2058  : void</div><div class="description"><div class="short">Sets the active error message to the given string. This replaces the entire error message
2059 contents with the given str...</div><div class="long"><p>Sets the active error message to the given string. This replaces the entire error message
2060 contents with the given string. Also see <a href="Ext.form.field.Base.html#setActiveErrors" rel="Ext.form.field.Base#setActiveErrors" class="docClass">setActiveErrors</a> which accepts an Array of
2061 messages and formats them according to the <a href="Ext.form.field.Base.html#activeErrorsTpl" rel="Ext.form.field.Base#activeErrorsTpl" class="docClass">activeErrorsTpl</a>.</p>
2062 <h3 class="pa">Parameters</h3><ul><li><span class="pre">msg</span> : String<div class="sub-desc"><p>The error message</p>
2063 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2064 </li></ul></div></div></div><div id="method-setActiveErrors" class="member inherited"><a href="Ext.form.field.Base.html#method-setActiveErrors" rel="method-setActiveErrors" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-method-setActiveErrors" class="viewSource">view source</a></div><a name="setActiveErrors"></a><a name="method-setActiveErrors"></a><a href="Ext.form.field.Base.html#" rel="method-setActiveErrors" class="cls expand">setActiveErrors</a>(
2065 <span class="pre">Array errors</span>)
2066  : void</div><div class="description"><div class="short">Set the active error message to an Array of error messages. The messages are formatted into
2067 a single message string u...</div><div class="long"><p>Set the active error message to an Array of error messages. The messages are formatted into
2068 a single message string using the <a href="Ext.form.field.Base.html#activeErrorsTpl" rel="Ext.form.field.Base#activeErrorsTpl" class="docClass">activeErrorsTpl</a>. Also see <a href="Ext.form.field.Base.html#setActiveError" rel="Ext.form.field.Base#setActiveError" class="docClass">setActiveError</a>
2069 which allows setting the entire error contents with a single string.</p>
2070 <h3 class="pa">Parameters</h3><ul><li><span class="pre">errors</span> : Array<div class="sub-desc"><p>The error messages</p>
2071 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2072 </li></ul></div></div></div><div id="method-setAutoScroll" class="member inherited"><a href="Ext.form.field.Base.html#method-setAutoScroll" rel="method-setAutoScroll" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-setAutoScroll" class="viewSource">view source</a></div><a name="setAutoScroll"></a><a name="method-setAutoScroll"></a><a href="Ext.form.field.Base.html#" rel="method-setAutoScroll" class="cls expand">setAutoScroll</a>(
2073 <span class="pre">Boolean scroll</span>)
2074  : Ext.Component</div><div class="description"><div class="short"><p>Sets the overflow on the content element of the component.</p>
2075 </div><div class="long"><p>Sets the overflow on the content element of the component.</p>
2076 <h3 class="pa">Parameters</h3><ul><li><span class="pre">scroll</span> : Boolean<div class="sub-desc"><p>True to allow the Component to auto scroll.</p>
2077 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
2078 </li></ul></div></div></div><div id="method-setDisabled" class="member inherited"><a href="Ext.form.field.Base.html#method-setDisabled" rel="method-setDisabled" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setDisabled" class="viewSource">view source</a></div><a name="setDisabled"></a><a name="method-setDisabled"></a><a href="Ext.form.field.Base.html#" rel="method-setDisabled" class="cls expand">setDisabled</a>(
2079 <span class="pre">Boolean disabled</span>)
2080  : void</div><div class="description"><div class="short"><p>Enable or disable the component.</p>
2081 </div><div class="long"><p>Enable or disable the component.</p>
2082 <h3 class="pa">Parameters</h3><ul><li><span class="pre">disabled</span> : Boolean<div class="sub-desc">
2083 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2084 </li></ul></div></div></div><div id="method-setDocked" class="member inherited"><a href="Ext.form.field.Base.html#method-setDocked" rel="method-setDocked" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setDocked" class="viewSource">view source</a></div><a name="setDocked"></a><a name="method-setDocked"></a><a href="Ext.form.field.Base.html#" rel="method-setDocked" class="cls expand">setDocked</a>(
2085 <span class="pre">Object dock, Object layoutParent</span>)
2086  : Component</div><div class="description"><div class="short">Sets the dock position of this component in its parent panel. Note that
2087 this only has effect if this item is part of ...</div><div class="long"><p>Sets the dock position of this component in its parent panel. Note that
2088 this only has effect if this item is part of the dockedItems collection
2089 of a parent that has a DockLayout (note that any Panel has a DockLayout
2090 by default)</p>
2091 <h3 class="pa">Parameters</h3><ul><li><span class="pre">dock</span> : Object<div class="sub-desc">
2092 </div></li><li><span class="pre">layoutParent</span> : Object<div class="sub-desc">
2093 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Component</span>&nbsp; &nbsp;<p>this</p>
2094 </li></ul></div></div></div><div id="method-setFieldDefaults" class="member inherited"><a href="Ext.form.field.Base.html#method-setFieldDefaults" rel="method-setFieldDefaults" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-method-setFieldDefaults" class="viewSource">view source</a></div><a name="setFieldDefaults"></a><a name="method-setFieldDefaults"></a><a href="Ext.form.field.Base.html#" rel="method-setFieldDefaults" class="cls expand">setFieldDefaults</a>(
2095 <span class="pre">Object defaults</span>)
2096  : void</div><div class="description"><div class="short">Applies a set of default configuration values to this Labelable instance. For each of the
2097 properties in the given obj...</div><div class="long"><p>Applies a set of default configuration values to this Labelable instance. For each of the
2098 properties in the given object, check if this component hasOwnProperty that config; if not
2099 then it's inheriting a default value from its prototype and we should apply the default value.</p>
2100 <h3 class="pa">Parameters</h3><ul><li><span class="pre">defaults</span> : Object<div class="sub-desc"><p>The defaults to apply to the object.</p>
2101 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2102 </li></ul></div></div></div><div id="method-setFieldStyle" class="member ni"><a href="Ext.form.field.Base.html#method-setFieldStyle" rel="method-setFieldStyle" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-setFieldStyle" class="viewSource">view source</a></div><a name="setFieldStyle"></a><a name="method-setFieldStyle"></a><a href="Ext.form.field.Base.html#" rel="method-setFieldStyle" class="cls expand">setFieldStyle</a>(
2103 <span class="pre">String/Object/Function style</span>)
2104  : void</div><div class="description"><div class="short"><p>Set the <a href="Ext.form.field.Base.html#fieldStyle" rel="Ext.form.field.Base#fieldStyle" class="docClass">CSS style</a> of the <a href="Ext.form.field.Base.html#inputEl" rel="Ext.form.field.Base#inputEl" class="docClass">field input element</a>.</p>
2105 </div><div class="long"><p>Set the <a href="Ext.form.field.Base.html#fieldStyle" rel="Ext.form.field.Base#fieldStyle" class="docClass">CSS style</a> of the <a href="Ext.form.field.Base.html#inputEl" rel="Ext.form.field.Base#inputEl" class="docClass">field input element</a>.</p>
2106 <h3 class="pa">Parameters</h3><ul><li><span class="pre">style</span> : String/Object/Function<div class="sub-desc"><p>The style(s) to apply. Should be a valid argument to
2107 <a href="Ext.core.Element.html#applyStyles" rel="Ext.core.Element#applyStyles" class="docClass">Ext.core.Element.applyStyles</a>.</p>
2108 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2109 </li></ul></div></div></div><div id="method-setHeight" class="member inherited"><a href="Ext.form.field.Base.html#method-setHeight" rel="method-setHeight" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setHeight" class="viewSource">view source</a></div><a name="setHeight"></a><a name="method-setHeight"></a><a href="Ext.form.field.Base.html#" rel="method-setHeight" class="cls expand">setHeight</a>(
2110 <span class="pre">Number height</span>)
2111  : Ext.Component</div><div class="description"><div class="short"><p>Sets the height of the component.  This method fires the <a href="Ext.form.field.Base.html#resize" rel="Ext.form.field.Base#resize" class="docClass">resize</a> event.</p>
2112 </div><div class="long"><p>Sets the height of the component.  This method fires the <a href="Ext.form.field.Base.html#resize" rel="Ext.form.field.Base#resize" class="docClass">resize</a> event.</p>
2113 <h3 class="pa">Parameters</h3><ul><li><span class="pre">height</span> : Number<div class="sub-desc"><p>The new height to set. This may be one of:<div class="mdetail-params"><ul>
2114 <li>A Number specifying the new height in the <a href="Ext.form.field.Base.html#getEl" rel="Ext.form.field.Base#getEl" class="docClass">Element</a>'s <a href="Ext.core.Element.html#defaultUnit" rel="Ext.core.Element#defaultUnit" class="docClass">Ext.core.Element.defaultUnit</a>s (by default, pixels).</li>
2115 <li>A String used to set the CSS height style.</li>
2116 <li><i>undefined</i> to leave the height unchanged.</li>
2117 </ul></div></p>
2118 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
2119 </li></ul></div></div></div><div id="method-setLoading" class="member inherited"><a href="Ext.form.field.Base.html#method-setLoading" rel="method-setLoading" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setLoading" class="viewSource">view source</a></div><a name="setLoading"></a><a name="method-setLoading"></a><a href="Ext.form.field.Base.html#" rel="method-setLoading" class="cls expand">setLoading</a>(
2120 <span class="pre">Boolean/Object/String load, Boolean targetEl</span>)
2121  : Ext.LoadMask</div><div class="description"><div class="short"><p>This method allows you to show or hide a LoadMask on top of this component.</p>
2122 </div><div class="long"><p>This method allows you to show or hide a LoadMask on top of this component.</p>
2123 <h3 class="pa">Parameters</h3><ul><li><span class="pre">load</span> : Boolean/Object/String<div class="sub-desc"><p>True to show the default LoadMask, a config object
2124 that will be passed to the LoadMask constructor, or a message String to show. False to
2125 hide the current LoadMask.</p>
2126 </div></li><li><span class="pre">targetEl</span> : Boolean<div class="sub-desc"><p>True to mask the targetEl of this Component instead of the this.el.
2127 For example, setting this to true on a Panel will cause only the body to be masked. (defaults to false)</p>
2128 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.LoadMask</span>&nbsp; &nbsp;<p>The LoadMask instance that has just been shown.</p>
2129 </li></ul></div></div></div><div id="method-setPagePosition" class="member inherited"><a href="Ext.form.field.Base.html#method-setPagePosition" rel="method-setPagePosition" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-setPagePosition" class="viewSource">view source</a></div><a name="setPagePosition"></a><a name="method-setPagePosition"></a><a href="Ext.form.field.Base.html#" rel="method-setPagePosition" class="cls expand">setPagePosition</a>(
2130 <span class="pre">Number x, Number y, Mixed animate</span>)
2131  : Ext.Component</div><div class="description"><div class="short">Sets the page XY position of the component.  To set the left and top instead, use setPosition.
2132 This method fires the ...</div><div class="long"><p>Sets the page XY position of the component.  To set the left and top instead, use <a href="Ext.form.field.Base.html#setPosition" rel="Ext.form.field.Base#setPosition" class="docClass">setPosition</a>.
2133 This method fires the <a href="Ext.form.field.Base.html#move" rel="Ext.form.field.Base#move" class="docClass">move</a> event.</p>
2134 <h3 class="pa">Parameters</h3><ul><li><span class="pre">x</span> : Number<div class="sub-desc"><p>The new x position</p>
2135 </div></li><li><span class="pre">y</span> : Number<div class="sub-desc"><p>The new y position</p>
2136 </div></li><li><span class="pre">animate</span> : Mixed<div class="sub-desc"><p>If passed, the Component is <i>animated</i> into its new position. If this parameter
2137 is a number, it is used as the animation duration in milliseconds.</p>
2138 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
2139 </li></ul></div></div></div><div id="method-setPosition" class="member inherited"><a href="Ext.form.field.Base.html#method-setPosition" rel="method-setPosition" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-setPosition" class="viewSource">view source</a></div><a name="setPosition"></a><a name="method-setPosition"></a><a href="Ext.form.field.Base.html#" rel="method-setPosition" class="cls expand">setPosition</a>(
2140 <span class="pre">Number left, Number top, Mixed animate</span>)
2141  : Ext.Component</div><div class="description"><div class="short">Sets the left and top of the component.  To set the page XY position instead, use setPagePosition.
2142 This method fires ...</div><div class="long"><p>Sets the left and top of the component.  To set the page XY position instead, use <a href="Ext.form.field.Base.html#setPagePosition" rel="Ext.form.field.Base#setPagePosition" class="docClass">setPagePosition</a>.
2143 This method fires the <a href="Ext.form.field.Base.html#move" rel="Ext.form.field.Base#move" class="docClass">move</a> event.</p>
2144 <h3 class="pa">Parameters</h3><ul><li><span class="pre">left</span> : Number<div class="sub-desc"><p>The new left</p>
2145 </div></li><li><span class="pre">top</span> : Number<div class="sub-desc"><p>The new top</p>
2146 </div></li><li><span class="pre">animate</span> : Mixed<div class="sub-desc"><p>If true, the Component is <i>animated</i> into its new position. You may also pass an animation configuration.</p>
2147 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
2148 </li></ul></div></div></div><div id="method-setRawValue" class="member ni"><a href="Ext.form.field.Base.html#method-setRawValue" rel="method-setRawValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-setRawValue" class="viewSource">view source</a></div><a name="setRawValue"></a><a name="method-setRawValue"></a><a href="Ext.form.field.Base.html#" rel="method-setRawValue" class="cls expand">setRawValue</a>(
2149 <span class="pre">Mixed value</span>)
2150  : Mixed</div><div class="description"><div class="short">Sets the field's raw value directly, bypassing value conversion, change detection, and
2151 validation. To set the value w...</div><div class="long"><p>Sets the field's raw value directly, bypassing <a href="Ext.form.field.Base.html#valueToRaw" rel="Ext.form.field.Base#valueToRaw" class="docClass">value conversion</a>, change detection, and
2152 validation. To set the value with these additional inspections see <a href="Ext.form.field.Base.html#setValue" rel="Ext.form.field.Base#setValue" class="docClass">setValue</a>.</p>
2153 <h3 class="pa">Parameters</h3><ul><li><span class="pre">value</span> : Mixed<div class="sub-desc"><p>The value to set</p>
2154 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Mixed</span>&nbsp; &nbsp;<p>value The field value that is set</p>
2155 </li></ul></div></div></div><div id="method-setReadOnly" class="member ni"><a href="Ext.form.field.Base.html#method-setReadOnly" rel="method-setReadOnly" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-setReadOnly" class="viewSource">view source</a></div><a name="setReadOnly"></a><a name="method-setReadOnly"></a><a href="Ext.form.field.Base.html#" rel="method-setReadOnly" class="cls expand">setReadOnly</a>(
2156 <span class="pre">Boolean readOnly</span>)
2157  : void</div><div class="description"><div class="short"><p>Sets the read only state of this field.</p>
2158 </div><div class="long"><p>Sets the read only state of this field.</p>
2159 <h3 class="pa">Parameters</h3><ul><li><span class="pre">readOnly</span> : Boolean<div class="sub-desc"><p>Whether the field should be read only.</p>
2160 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2161 </li></ul></div></div></div><div id="method-setSize" class="member inherited"><a href="Ext.form.field.Base.html#method-setSize" rel="method-setSize" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setSize" class="viewSource">view source</a></div><a name="setSize"></a><a name="method-setSize"></a><a href="Ext.form.field.Base.html#" rel="method-setSize" class="cls expand">setSize</a>(
2162 <span class="pre">Mixed width, Mixed height</span>)
2163  : Ext.Component</div><div class="description"><div class="short">Sets the width and height of this Component. This method fires the resize event. This method can accept
2164 either width ...</div><div class="long"><p>Sets the width and height of this Component. This method fires the <a href="Ext.form.field.Base.html#resize" rel="Ext.form.field.Base#resize" class="docClass">resize</a> event. This method can accept
2165 either width and height as separate arguments, or you can pass a size object like <code>{width:10, height:20}</code>.</p>
2166 <h3 class="pa">Parameters</h3><ul><li><span class="pre">width</span> : Mixed<div class="sub-desc"><p>The new width to set. This may be one of:<div class="mdetail-params"><ul>
2167 <li>A Number specifying the new width in the <a href="Ext.form.field.Base.html#getEl" rel="Ext.form.field.Base#getEl" class="docClass">Element</a>'s <a href="Ext.core.Element.html#defaultUnit" rel="Ext.core.Element#defaultUnit" class="docClass">Ext.core.Element.defaultUnit</a>s (by default, pixels).</li>
2168 <li>A String used to set the CSS width style.</li>
2169 <li>A size object in the format <code>{width: widthValue, height: heightValue}</code>.</li>
2170 <li><code>undefined</code> to leave the width unchanged.</li>
2171 </ul></div></p>
2172 </div></li><li><span class="pre">height</span> : Mixed<div class="sub-desc"><p>The new height to set (not required if a size object is passed as the first arg).
2173 This may be one of:<div class="mdetail-params"><ul>
2174 <li>A Number specifying the new height in the <a href="Ext.form.field.Base.html#getEl" rel="Ext.form.field.Base#getEl" class="docClass">Element</a>'s <a href="Ext.core.Element.html#defaultUnit" rel="Ext.core.Element#defaultUnit" class="docClass">Ext.core.Element.defaultUnit</a>s (by default, pixels).</li>
2175 <li>A String used to set the CSS height style. Animation may <b>not</b> be used.</li>
2176 <li><code>undefined</code> to leave the height unchanged.</li>
2177 </ul></div></p>
2178 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
2179 </li></ul></div></div></div><div id="method-setUI" class="member inherited"><a href="Ext.form.field.Base.html#method-setUI" rel="method-setUI" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setUI" class="viewSource">view source</a></div><a name="setUI"></a><a name="method-setUI"></a><a href="Ext.form.field.Base.html#" rel="method-setUI" class="cls expand">setUI</a>(
2180 <span class="pre">String ui</span>)
2181  : void</div><div class="description"><div class="short">Sets the UI for the component. This will remove any existing UIs on the component. It will also
2182 loop through any uiCl...</div><div class="long"><p>Sets the UI for the component. This will remove any existing UIs on the component. It will also
2183 loop through any uiCls set on the component and rename them so they include the new UI</p>
2184 <h3 class="pa">Parameters</h3><ul><li><span class="pre">ui</span> : String<div class="sub-desc"><p>The new UI for the component</p>
2185 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2186 </li></ul></div></div></div><div id="method-setValue" class="member ni"><a href="Ext.form.field.Base.html#method-setValue" rel="method-setValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-setValue" class="viewSource">view source</a></div><a name="setValue"></a><a name="method-setValue"></a><a href="Ext.form.field.Base.html#" rel="method-setValue" class="cls expand">setValue</a>(
2187 <span class="pre">Mixed value</span>)
2188  : Ext.form.field.Field</div><div class="description"><div class="short">Sets a data value into the field and runs the change detection and validation. To set the value directly
2189 without thes...</div><div class="long"><p>Sets a data value into the field and runs the change detection and validation. To set the value directly
2190 without these inspections see <a href="Ext.form.field.Base.html#setRawValue" rel="Ext.form.field.Base#setRawValue" class="docClass">setRawValue</a>.</p>
2191 <h3 class="pa">Parameters</h3><ul><li><span class="pre">value</span> : Mixed<div class="sub-desc"><p>The value to set</p>
2192 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.form.field.Field</span>&nbsp; &nbsp;<p>this</p>
2193 </li></ul></div></div></div><div id="method-setVisible" class="member inherited"><a href="Ext.form.field.Base.html#method-setVisible" rel="method-setVisible" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setVisible" class="viewSource">view source</a></div><a name="setVisible"></a><a name="method-setVisible"></a><a href="Ext.form.field.Base.html#" rel="method-setVisible" class="cls expand">setVisible</a>(
2194 <span class="pre">Boolean visible</span>)
2195  : Ext.Component</div><div class="description"><div class="short"><p>Convenience function to hide or show this component by boolean.</p>
2196 </div><div class="long"><p>Convenience function to hide or show this component by boolean.</p>
2197 <h3 class="pa">Parameters</h3><ul><li><span class="pre">visible</span> : Boolean<div class="sub-desc"><p>True to show, false to hide</p>
2198 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
2199 </li></ul></div></div></div><div id="method-setWidth" class="member inherited"><a href="Ext.form.field.Base.html#method-setWidth" rel="method-setWidth" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-setWidth" class="viewSource">view source</a></div><a name="setWidth"></a><a name="method-setWidth"></a><a href="Ext.form.field.Base.html#" rel="method-setWidth" class="cls expand">setWidth</a>(
2200 <span class="pre">Number width</span>)
2201  : Ext.Component</div><div class="description"><div class="short"><p>Sets the width of the component.  This method fires the <a href="Ext.form.field.Base.html#resize" rel="Ext.form.field.Base#resize" class="docClass">resize</a> event.</p>
2202 </div><div class="long"><p>Sets the width of the component.  This method fires the <a href="Ext.form.field.Base.html#resize" rel="Ext.form.field.Base#resize" class="docClass">resize</a> event.</p>
2203 <h3 class="pa">Parameters</h3><ul><li><span class="pre">width</span> : Number<div class="sub-desc"><p>The new width to setThis may be one of:<div class="mdetail-params"><ul>
2204 <li>A Number specifying the new width in the <a href="Ext.form.field.Base.html#getEl" rel="Ext.form.field.Base#getEl" class="docClass">Element</a>'s <a href="Ext.core.Element.html#defaultUnit" rel="Ext.core.Element#defaultUnit" class="docClass">Ext.core.Element.defaultUnit</a>s (by default, pixels).</li>
2205 <li>A String used to set the CSS width style.</li>
2206 </ul></div></p>
2207 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
2208 </li></ul></div></div></div><div id="method-show" class="member inherited"><a href="Ext.form.field.Base.html#method-show" rel="method-show" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-show" class="viewSource">view source</a></div><a name="show"></a><a name="method-show"></a><a href="Ext.form.field.Base.html#" rel="method-show" class="cls expand">show</a>(
2209 <span class="pre">String/Element animateTarget, [Function callback], [Object scope]</span>)
2210  : Component</div><div class="description"><div class="short">Shows this Component, rendering it first if autoRender or {&quot;floating are true.
2211
2212
2213 After being shown, a floating C...</div><div class="long"><p>Shows this Component, rendering it first if <a href="Ext.form.field.Base.html#autoRender" rel="Ext.form.field.Base#autoRender" class="docClass">autoRender</a> or {<a href="Ext.form.field.Base.html"floating" rel=""floating" class="docClass">&quot;floating</a> are <code>true</code>.</p>
2214
2215
2216 <p>After being shown, a <a href="Ext.form.field.Base.html#floating" rel="Ext.form.field.Base#floating" class="docClass">floating</a> Component (such as a <a href="Ext.window.Window.html" rel="Ext.window.Window" class="docClass">Ext.window.Window</a>), is activated it and brought to the front of
2217 its <a href="Ext.form.field.Base.html#ZIndexManager" rel="Ext.form.field.Base#ZIndexManager" class="docClass">z-index stack</a>.</p>
2218
2219 <h3 class="pa">Parameters</h3><ul><li><span class="pre">animateTarget</span> : String/Element<div class="sub-desc"><p>Optional, and <b>only valid for <a href="Ext.form.field.Base.html#floating" rel="Ext.form.field.Base#floating" class="docClass">floating</a> Components such as
2220 <a href="Ext.window.Window.html" rel="Ext.window.Window" class="docClass">Window</a>s or <a href="Ext.tip.ToolTip.html" rel="Ext.tip.ToolTip" class="docClass">ToolTip</a>s, or regular Components which have been configured
2221 with <code>floating: true</code>.</b> The target from which the Component should
2222 animate from while opening (defaults to null with no animation)</p>
2223 </div></li><li><span class="pre">callback</span> : Function<div class="sub-desc"><p>(optional) A callback function to call after the Component is displayed. Only necessary if animation was specified.</p>
2224 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to this Component.</p>
2225 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Component</span>&nbsp; &nbsp;<p>this</p>
2226 </li></ul></div></div></div><div id="method-stopAnimation" class="member inherited"><a href="Ext.form.field.Base.html#method-stopAnimation" rel="method-stopAnimation" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-method-stopAnimation" class="viewSource">view source</a></div><a name="stopAnimation"></a><a name="method-stopAnimation"></a><a href="Ext.form.field.Base.html#" rel="method-stopAnimation" class="cls expand">stopAnimation</a> : Ext.core.Element</div><div class="description"><div class="short">@deprecated 4.0 Replaced by stopAnimation
2227 Stops any running effects and clears this object's internal effects queue i...</div><div class="long"><p>@deprecated 4.0 Replaced by <a href="Ext.form.field.Base.html#stopAnimation" rel="Ext.form.field.Base#stopAnimation" class="docClass">stopAnimation</a>
2228 Stops any running effects and clears this object's internal effects queue if it contains
2229 any additional effects that haven't started yet.</p>
2230 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.core.Element</span>&nbsp; &nbsp;<p>The Element</p>
2231 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.form.field.Base.html#method-suspendEvents" rel="method-suspendEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-suspendEvents" class="viewSource">view source</a></div><a name="suspendEvents"></a><a name="method-suspendEvents"></a><a href="Ext.form.field.Base.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
2232 <span class="pre">Boolean queueSuspended</span>)
2233  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.form.field.Base.html#resumeEvents" rel="Ext.form.field.Base#resumeEvents" class="docClass">resumeEvents</a>)</p>
2234 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.form.field.Base.html#resumeEvents" rel="Ext.form.field.Base#resumeEvents" class="docClass">resumeEvents</a>)</p>
2235 <h3 class="pa">Parameters</h3><ul><li><span class="pre">queueSuspended</span> : Boolean<div class="sub-desc"><p>Pass as true to queue up suspended events to be fired
2236 after the <a href="Ext.form.field.Base.html#resumeEvents" rel="Ext.form.field.Base#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
2237 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2238 </li></ul></div></div></div><div id="method-syncFx" class="member inherited"><a href="Ext.form.field.Base.html#method-syncFx" rel="method-syncFx" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Animate.html" class="definedIn docClass">Ext.util.Animate</a><br/><a href="../source/Animate.html#Ext-util.Animate-method-syncFx" class="viewSource">view source</a></div><a name="syncFx"></a><a name="method-syncFx"></a><a href="Ext.form.field.Base.html#" rel="method-syncFx" class="cls expand">syncFx</a> : Ext.core.Element</div><div class="description"><div class="short">Ensures that all effects queued after syncFx is called on this object are
2239 run concurrently.  This is the opposite of ...</div><div class="long"><p>Ensures that all effects queued after syncFx is called on this object are
2240 run concurrently.  This is the opposite of <a href="Ext.form.field.Base.html#sequenceFx" rel="Ext.form.field.Base#sequenceFx" class="docClass">sequenceFx</a>.</p>
2241 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.core.Element</span>&nbsp; &nbsp;<p>The Element</p>
2242 </li></ul></div></div></div><div id="method-toBack" class="member inherited"><a href="Ext.form.field.Base.html#method-toBack" rel="method-toBack" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-method-toBack" class="viewSource">view source</a></div><a name="toBack"></a><a name="method-toBack"></a><a href="Ext.form.field.Base.html#" rel="method-toBack" class="cls expand">toBack</a> : Component</div><div class="description"><div class="short"><p>Sends this Component to the back of (lower z-index than) any other visible windows</p>
2243 </div><div class="long"><p>Sends this Component to the back of (lower z-index than) any other visible windows</p>
2244 <h3 class="pa">Returns</h3><ul><li><span class="pre">Component</span>&nbsp; &nbsp;<p>this</p>
2245 </li></ul></div></div></div><div id="method-toFront" class="member inherited"><a href="Ext.form.field.Base.html#method-toFront" rel="method-toFront" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Floating.html" class="definedIn docClass">Ext.util.Floating</a><br/><a href="../source/Floating.html#Ext-util.Floating-method-toFront" class="viewSource">view source</a></div><a name="toFront"></a><a name="method-toFront"></a><a href="Ext.form.field.Base.html#" rel="method-toFront" class="cls expand">toFront</a>(
2246 <span class="pre">[Boolean preventFocus]</span>)
2247  : Component</div><div class="description"><div class="short">Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManag...</div><div class="long"><p>Brings this floating Component to the front of any other visible, floating Components managed by the same <a href="Ext.ZIndexManager.html" rel="Ext.ZIndexManager" class="docClass">ZIndexManager</a></p>
2248
2249
2250 <p>If this Component is modal, inserts the modal mask just below this Component in the z-index stack.</p>
2251
2252 <h3 class="pa">Parameters</h3><ul><li><span class="pre">preventFocus</span> : Boolean<div class="sub-desc"><p>(optional) Specify <code>true</code> to prevent the Component from being focused.</p>
2253 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Component</span>&nbsp; &nbsp;<p>this</p>
2254 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.form.field.Base.html#method-un" rel="method-un" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-un" class="viewSource">view source</a></div><a name="un"></a><a name="method-un"></a><a href="Ext.form.field.Base.html#" rel="method-un" class="cls expand">un</a>(
2255 <span class="pre">String eventName, Function handler, [Object scope]</span>)
2256  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.form.field.Base.html#removeListener" rel="Ext.form.field.Base#removeListener" class="docClass">removeListener</a>.)</p>
2257 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.form.field.Base.html#removeListener" rel="Ext.form.field.Base#removeListener" class="docClass">removeListener</a>.)</p>
2258 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
2259 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.form.field.Base.html#addListener" rel="Ext.form.field.Base#addListener" class="docClass">addListener</a> call.</b></p>
2260 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
2261 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2262 </li></ul></div></div></div><div id="method-unsetActiveError" class="member inherited"><a href="Ext.form.field.Base.html#method-unsetActiveError" rel="method-unsetActiveError" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-method-unsetActiveError" class="viewSource">view source</a></div><a name="unsetActiveError"></a><a name="method-unsetActiveError"></a><a href="Ext.form.field.Base.html#" rel="method-unsetActiveError" class="cls expand">unsetActiveError</a> : void</div><div class="description"><div class="short"><p>Clears the active error.</p>
2263 </div><div class="long"><p>Clears the active error.</p>
2264 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2265 </li></ul></div></div></div><div id="method-up" class="member inherited"><a href="Ext.form.field.Base.html#method-up" rel="method-up" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-up" class="viewSource">view source</a></div><a name="up"></a><a name="method-up"></a><a href="Ext.form.field.Base.html#" rel="method-up" class="cls expand">up</a>(
2266 <span class="pre">String selector</span>)
2267  : Container</div><div class="description"><div class="short">Walks up the ownerCt axis looking for an ancestor Container which matches
2268 the passed simple selector.
2269
2270
2271 Example:
2272 var ...</div><div class="long"><p>Walks up the <code>ownerCt</code> axis looking for an ancestor Container which matches
2273 the passed simple selector.</p>
2274
2275
2276 <p>Example:
2277 <pre><code>var owningTabPanel = grid.up('tabpanel');
2278 </code></pre>
2279
2280 <h3 class="pa">Parameters</h3><ul><li><span class="pre">selector</span> : String<div class="sub-desc"><p>Optional. The simple selector to test.</p>
2281 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Container</span>&nbsp; &nbsp;<p>The matching ancestor Container (or <code>undefined</code> if no match was found).</p>
2282 </li></ul></div></div></div><div id="method-update" class="member inherited"><a href="Ext.form.field.Base.html#method-update" rel="method-update" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-method-update" class="viewSource">view source</a></div><a name="update"></a><a name="method-update"></a><a href="Ext.form.field.Base.html#" rel="method-update" class="cls expand">update</a>(
2283 <span class="pre">Mixed htmlOrData, [Boolean loadScripts], [Function callback]</span>)
2284  : void</div><div class="description"><div class="short"><p>Update the content area of a component.</p>
2285 </div><div class="long"><p>Update the content area of a component.</p>
2286 <h3 class="pa">Parameters</h3><ul><li><span class="pre">htmlOrData</span> : Mixed<div class="sub-desc"><p>If this component has been configured with a template via the tpl config
2287 then it will use this argument as data to populate the template.
2288 If this component was not configured with a template, the components
2289 content area will be updated via <a href="Ext.core.Element.html" rel="Ext.core.Element" class="docClass">Ext.core.Element</a> update</p>
2290 </div></li><li><span class="pre">loadScripts</span> : Boolean<div class="sub-desc"><p>(optional) Only legitimate when using the html configuration. Defaults to false</p>
2291 </div></li><li><span class="pre">callback</span> : Function<div class="sub-desc"><p>(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading</p>
2292 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
2293 </li></ul></div></div></div><div id="method-updateBox" class="member inherited"><a href="Ext.form.field.Base.html#method-updateBox" rel="method-updateBox" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.Component.html" class="definedIn docClass">Ext.Component</a><br/><a href="../source/Component.html#Ext-Component-method-updateBox" class="viewSource">view source</a></div><a name="updateBox"></a><a name="method-updateBox"></a><a href="Ext.form.field.Base.html#" rel="method-updateBox" class="cls expand">updateBox</a>(
2294 <span class="pre">Object box</span>)
2295  : Ext.Component</div><div class="description"><div class="short"><p>Sets the current box measurements of the component's underlying element.</p>
2296 </div><div class="long"><p>Sets the current box measurements of the component's underlying element.</p>
2297 <h3 class="pa">Parameters</h3><ul><li><span class="pre">box</span> : Object<div class="sub-desc"><p>An object in the format {x, y, width, height}</p>
2298 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.Component</span>&nbsp; &nbsp;<p>this</p>
2299 </li></ul></div></div></div><div id="method-validate" class="member inherited"><a href="Ext.form.field.Base.html#method-validate" rel="method-validate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-method-validate" class="viewSource">view source</a></div><a name="validate"></a><a name="method-validate"></a><a href="Ext.form.field.Base.html#" rel="method-validate" class="cls expand">validate</a> : Boolean</div><div class="description"><div class="short">Returns whether or not the field value is currently valid by validating the
2300 field's current value, and fires the vali...</div><div class="long"><p>Returns whether or not the field value is currently valid by <a href="Ext.form.field.Base.html#getErrors" rel="Ext.form.field.Base#getErrors" class="docClass">validating</a> the
2301 field's current value, and fires the <a href="Ext.form.field.Base.html#validitychange" rel="Ext.form.field.Base#validitychange" class="docClass">validitychange</a> event if the field's validity has
2302 changed since the last validation. <b>Note</b>: <a href="Ext.form.field.Base.html#disabled" rel="Ext.form.field.Base#disabled" class="docClass">disabled</a> fields are always treated as valid.</p>
2303
2304
2305 <p>Custom implementations of this method are allowed to have side-effects such as triggering error
2306 message display. To validate without side-effects, use <a href="Ext.form.field.Base.html#isValid" rel="Ext.form.field.Base#isValid" class="docClass">isValid</a>.</p>
2307
2308 <h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the value is valid, else false</p>
2309 </li></ul></div></div></div><div id="method-validateValue" class="member ni"><a href="Ext.form.field.Base.html#method-validateValue" rel="method-validateValue" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-validateValue" class="viewSource">view source</a></div><a name="validateValue"></a><a name="method-validateValue"></a><a href="Ext.form.field.Base.html#" rel="method-validateValue" class="cls expand">validateValue</a>(
2310 <span class="pre">Mixed value</span>)
2311  : Boolean</div><div class="description"><div class="short">Uses getErrors to build an array of validation errors. If any errors are found, they are passed
2312 to markInvalid and fa...</div><div class="long"><p>Uses <a href="Ext.form.field.Base.html#getErrors" rel="Ext.form.field.Base#getErrors" class="docClass">getErrors</a> to build an array of validation errors. If any errors are found, they are passed
2313 to <a href="Ext.form.field.Base.html#markInvalid" rel="Ext.form.field.Base#markInvalid" class="docClass">markInvalid</a> and false is returned, otherwise true is returned.</p>
2314
2315
2316 <p>Previously, subclasses were invited to provide an implementation of this to process validations - from 3.2
2317 onwards <a href="Ext.form.field.Base.html#getErrors" rel="Ext.form.field.Base#getErrors" class="docClass">getErrors</a> should be overridden instead.</p>
2318
2319 <h3 class="pa">Parameters</h3><ul><li><span class="pre">value</span> : Mixed<div class="sub-desc"><p>The value to validate</p>
2320 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if all validations passed, false if one or more failed</p>
2321 </li></ul></div></div></div><div id="method-valueToRaw" class="member ni"><a href="Ext.form.field.Base.html#method-valueToRaw" rel="method-valueToRaw" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-method-valueToRaw" class="viewSource">view source</a></div><a name="valueToRaw"></a><a name="method-valueToRaw"></a><a href="Ext.form.field.Base.html#" rel="method-valueToRaw" class="cls expand">valueToRaw</a>(
2322 <span class="pre">Mixed value</span>)
2323  : Mixed</div><div class="description"><div class="short">Converts a mixed-type value to a raw representation suitable for displaying in the field. This allows
2324 controlling how...</div><div class="long"><p>Converts a mixed-type value to a raw representation suitable for displaying in the field. This allows
2325 controlling how value objects passed to <a href="Ext.form.field.Base.html#setValue" rel="Ext.form.field.Base#setValue" class="docClass">setValue</a> are shown to the user, including localization.
2326 For instance, for a <a href="Ext.form.field.Date.html" rel="Ext.form.field.Date" class="docClass">Ext.form.field.Date</a>, this would control how a Date object passed to <a href="Ext.form.field.Base.html#setValue" rel="Ext.form.field.Base#setValue" class="docClass">setValue</a>
2327 would be converted to a String for display in the field.</p>
2328
2329
2330 <p>See <a href="Ext.form.field.Base.html#rawToValue" rel="Ext.form.field.Base#rawToValue" class="docClass">rawToValue</a> for the opposite conversion.</p>
2331
2332
2333 <p>The base implementation simply does a standard toString conversion, and converts
2334 <a href="Ext.html#isEmpty" rel="Ext#isEmpty" class="docClass">empty values</a> to an empty string.</p>
2335
2336 <h3 class="pa">Parameters</h3><ul><li><span class="pre">value</span> : Mixed<div class="sub-desc"><p>The mixed-type value to convert to the raw representation.</p>
2337 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Mixed</span>&nbsp; &nbsp;<p>The converted raw value.</p>
2338 </li></ul></div></div></div></div><div class="m-events"><a name="events"></a><div class="definedBy">Defined By</div><h3 class="evt p">Events</h3><div id="event-activate" class="member f inherited"><a href="Ext.form.field.Base.html#event-activate" rel="event-activate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-activate" class="viewSource">view source</a></div><a name="activate"></a><a name="event-activate"></a><a href="Ext.form.field.Base.html#" rel="event-activate" class="cls expand">activate</a>(
2339 <span class="pre">Ext.Component this</span>)
2340 </div><div class="description"><div class="short"><p>Fires after a Component has been visually activated.</p>
2341 </div><div class="long"><p>Fires after a Component has been visually activated.</p>
2342 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2343 </div></li></ul></div></div></div><div id="event-added" class="member inherited"><a href="Ext.form.field.Base.html#event-added" rel="event-added" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-added" class="viewSource">view source</a></div><a name="added"></a><a name="event-added"></a><a href="Ext.form.field.Base.html#" rel="event-added" class="cls expand">added</a>(
2344 <span class="pre">Ext.Component this, Ext.container.Container container, Number pos</span>)
2345 </div><div class="description"><div class="short"><p>Fires after a Component had been added to a Container.</p>
2346 </div><div class="long"><p>Fires after a Component had been added to a Container.</p>
2347 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2348 </div></li><li><span class="pre">container</span> : Ext.container.Container<div class="sub-desc"><p>Parent Container</p>
2349 </div></li><li><span class="pre">pos</span> : Number<div class="sub-desc"><p>position of Component</p>
2350 </div></li></ul></div></div></div><div id="event-afterrender" class="member inherited"><a href="Ext.form.field.Base.html#event-afterrender" rel="event-afterrender" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-afterrender" class="viewSource">view source</a></div><a name="afterrender"></a><a name="event-afterrender"></a><a href="Ext.form.field.Base.html#" rel="event-afterrender" class="cls expand">afterrender</a>(
2351 <span class="pre">Ext.Component this</span>)
2352 </div><div class="description"><div class="short">Fires after the component rendering is finished.
2353
2354
2355 The afterrender event is fired after this Component has been rende...</div><div class="long"><p>Fires after the component rendering is finished.</p>
2356
2357
2358 <p>The afterrender event is fired after this Component has been <a href="Ext.form.field.Base.html#rendered" rel="Ext.form.field.Base#rendered" class="docClass">rendered</a>, been postprocesed
2359 by any afterRender method defined for the Component.</p>
2360
2361 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2362 </div></li></ul></div></div></div><div id="event-beforeactivate" class="member inherited"><a href="Ext.form.field.Base.html#event-beforeactivate" rel="event-beforeactivate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-beforeactivate" class="viewSource">view source</a></div><a name="beforeactivate"></a><a name="event-beforeactivate"></a><a href="Ext.form.field.Base.html#" rel="event-beforeactivate" class="cls expand">beforeactivate</a>(
2363 <span class="pre">Ext.Component this</span>)
2364 </div><div class="description"><div class="short">Fires before a Component has been visually activated.
2365 Returning false from an event listener can prevent the activate...</div><div class="long"><p>Fires before a Component has been visually activated.
2366 Returning false from an event listener can prevent the activate
2367 from occurring.</p>
2368 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2369 </div></li></ul></div></div></div><div id="event-beforedeactivate" class="member inherited"><a href="Ext.form.field.Base.html#event-beforedeactivate" rel="event-beforedeactivate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-beforedeactivate" class="viewSource">view source</a></div><a name="beforedeactivate"></a><a name="event-beforedeactivate"></a><a href="Ext.form.field.Base.html#" rel="event-beforedeactivate" class="cls expand">beforedeactivate</a>(
2370 <span class="pre">Ext.Component this</span>)
2371 </div><div class="description"><div class="short">Fires before a Component has been visually deactivated.
2372 Returning false from an event listener can prevent the deacti...</div><div class="long"><p>Fires before a Component has been visually deactivated.
2373 Returning false from an event listener can prevent the deactivate
2374 from occurring.</p>
2375 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2376 </div></li></ul></div></div></div><div id="event-beforedestroy" class="member inherited"><a href="Ext.form.field.Base.html#event-beforedestroy" rel="event-beforedestroy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-beforedestroy" class="viewSource">view source</a></div><a name="beforedestroy"></a><a name="event-beforedestroy"></a><a href="Ext.form.field.Base.html#" rel="event-beforedestroy" class="cls expand">beforedestroy</a>(
2377 <span class="pre">Ext.Component this</span>)
2378 </div><div class="description"><div class="short"><p>Fires before the component is <a href="Ext.form.field.Base.html#destroy" rel="Ext.form.field.Base#destroy" class="docClass">destroy</a>ed. Return false from an event handler to stop the <a href="Ext.form.field.Base.html#destroy" rel="Ext.form.field.Base#destroy" class="docClass">destroy</a>.</p>
2379 </div><div class="long"><p>Fires before the component is <a href="Ext.form.field.Base.html#destroy" rel="Ext.form.field.Base#destroy" class="docClass">destroy</a>ed. Return false from an event handler to stop the <a href="Ext.form.field.Base.html#destroy" rel="Ext.form.field.Base#destroy" class="docClass">destroy</a>.</p>
2380 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2381 </div></li></ul></div></div></div><div id="event-beforehide" class="member inherited"><a href="Ext.form.field.Base.html#event-beforehide" rel="event-beforehide" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-beforehide" class="viewSource">view source</a></div><a name="beforehide"></a><a name="event-beforehide"></a><a href="Ext.form.field.Base.html#" rel="event-beforehide" class="cls expand">beforehide</a>(
2382 <span class="pre">Ext.Component this</span>)
2383 </div><div class="description"><div class="short"><p>Fires before the component is hidden when calling the <a href="Ext.form.field.Base.html#hide" rel="Ext.form.field.Base#hide" class="docClass">hide</a> method.
2384 Return false from an event handler to stop the hide.</p>
2385 </div><div class="long"><p>Fires before the component is hidden when calling the <a href="Ext.form.field.Base.html#hide" rel="Ext.form.field.Base#hide" class="docClass">hide</a> method.
2386 Return false from an event handler to stop the hide.</p>
2387 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2388 </div></li></ul></div></div></div><div id="event-beforerender" class="member inherited"><a href="Ext.form.field.Base.html#event-beforerender" rel="event-beforerender" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-beforerender" class="viewSource">view source</a></div><a name="beforerender"></a><a name="event-beforerender"></a><a href="Ext.form.field.Base.html#" rel="event-beforerender" class="cls expand">beforerender</a>(
2389 <span class="pre">Ext.Component this</span>)
2390 </div><div class="description"><div class="short"><p>Fires before the component is <a href="Ext.form.field.Base.html#rendered" rel="Ext.form.field.Base#rendered" class="docClass">rendered</a>. Return false from an
2391 event handler to stop the <a href="Ext.form.field.Base.html#render" rel="Ext.form.field.Base#render" class="docClass">render</a>.</p>
2392 </div><div class="long"><p>Fires before the component is <a href="Ext.form.field.Base.html#rendered" rel="Ext.form.field.Base#rendered" class="docClass">rendered</a>. Return false from an
2393 event handler to stop the <a href="Ext.form.field.Base.html#render" rel="Ext.form.field.Base#render" class="docClass">render</a>.</p>
2394 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2395 </div></li></ul></div></div></div><div id="event-beforeshow" class="member inherited"><a href="Ext.form.field.Base.html#event-beforeshow" rel="event-beforeshow" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-beforeshow" class="viewSource">view source</a></div><a name="beforeshow"></a><a name="event-beforeshow"></a><a href="Ext.form.field.Base.html#" rel="event-beforeshow" class="cls expand">beforeshow</a>(
2396 <span class="pre">Ext.Component this</span>)
2397 </div><div class="description"><div class="short"><p>Fires before the component is shown when calling the <a href="Ext.form.field.Base.html#show" rel="Ext.form.field.Base#show" class="docClass">show</a> method.
2398 Return false from an event handler to stop the show.</p>
2399 </div><div class="long"><p>Fires before the component is shown when calling the <a href="Ext.form.field.Base.html#show" rel="Ext.form.field.Base#show" class="docClass">show</a> method.
2400 Return false from an event handler to stop the show.</p>
2401 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2402 </div></li></ul></div></div></div><div id="event-beforestaterestore" class="member inherited"><a href="Ext.form.field.Base.html#event-beforestaterestore" rel="event-beforestaterestore" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-event-beforestaterestore" class="viewSource">view source</a></div><a name="beforestaterestore"></a><a name="event-beforestaterestore"></a><a href="Ext.form.field.Base.html#" rel="event-beforestaterestore" class="cls expand">beforestaterestore</a>(
2403 <span class="pre">Ext.state.Stateful this, Object state</span>)
2404 </div><div class="description"><div class="short"><p>Fires before the state of the object is restored. Return false from an event handler to stop the restore.</p>
2405 </div><div class="long"><p>Fires before the state of the object is restored. Return false from an event handler to stop the restore.</p>
2406 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.state.Stateful<div class="sub-desc">
2407 </div></li><li><span class="pre">state</span> : Object<div class="sub-desc"><p>The hash of state values returned from the StateProvider. If this
2408 event is not vetoed, then the state object is passed to <b><tt>applyState</tt></b>. By default,
2409 that simply copies property values into this object. The method maybe overriden to
2410 provide custom state restoration.</p>
2411 </div></li></ul></div></div></div><div id="event-beforestatesave" class="member inherited"><a href="Ext.form.field.Base.html#event-beforestatesave" rel="event-beforestatesave" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-event-beforestatesave" class="viewSource">view source</a></div><a name="beforestatesave"></a><a name="event-beforestatesave"></a><a href="Ext.form.field.Base.html#" rel="event-beforestatesave" class="cls expand">beforestatesave</a>(
2412 <span class="pre">Ext.state.Stateful this, Object state</span>)
2413 </div><div class="description"><div class="short"><p>Fires before the state of the object is saved to the configured state provider. Return false to stop the save.</p>
2414 </div><div class="long"><p>Fires before the state of the object is saved to the configured state provider. Return false to stop the save.</p>
2415 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.state.Stateful<div class="sub-desc">
2416 </div></li><li><span class="pre">state</span> : Object<div class="sub-desc"><p>The hash of state values. This is determined by calling
2417 <b><tt>getState()</tt></b> on the object. This method must be provided by the
2418 developer to return whetever representation of state is required, by default, <a href="Ext.state.Stateful.html" rel="Ext.state.Stateful" class="docClass">Ext.state.Stateful</a>
2419 has a null implementation.</p>
2420 </div></li></ul></div></div></div><div id="event-blur" class="member ni"><a href="Ext.form.field.Base.html#event-blur" rel="event-blur" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-event-blur" class="viewSource">view source</a></div><a name="blur"></a><a name="event-blur"></a><a href="Ext.form.field.Base.html#" rel="event-blur" class="cls expand">blur</a>(
2421 <span class="pre">Ext.form.field.Base this</span>)
2422 </div><div class="description"><div class="short"><p>Fires when this field loses input focus.</p>
2423 </div><div class="long"><p>Fires when this field loses input focus.</p>
2424 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.form.field.Base<div class="sub-desc">
2425 </div></li></ul></div></div></div><div id="event-change" class="member inherited"><a href="Ext.form.field.Base.html#event-change" rel="event-change" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-event-change" class="viewSource">view source</a></div><a name="change"></a><a name="event-change"></a><a href="Ext.form.field.Base.html#" rel="event-change" class="cls expand">change</a>(
2426 <span class="pre">Ext.form.field.Field this, Mixed newValue, Mixed oldValue</span>)
2427 </div><div class="description"><div class="short"><p>Fires when a user-initiated change is detected in the value of the field.</p>
2428 </div><div class="long"><p>Fires when a user-initiated change is detected in the value of the field.</p>
2429 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.form.field.Field<div class="sub-desc">
2430 </div></li><li><span class="pre">newValue</span> : Mixed<div class="sub-desc"><p>The new value</p>
2431 </div></li><li><span class="pre">oldValue</span> : Mixed<div class="sub-desc"><p>The original value</p>
2432 </div></li></ul></div></div></div><div id="event-deactivate" class="member inherited"><a href="Ext.form.field.Base.html#event-deactivate" rel="event-deactivate" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-deactivate" class="viewSource">view source</a></div><a name="deactivate"></a><a name="event-deactivate"></a><a href="Ext.form.field.Base.html#" rel="event-deactivate" class="cls expand">deactivate</a>(
2433 <span class="pre">Ext.Component this</span>)
2434 </div><div class="description"><div class="short"><p>Fires after a Component has been visually deactivated.</p>
2435 </div><div class="long"><p>Fires after a Component has been visually deactivated.</p>
2436 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2437 </div></li></ul></div></div></div><div id="event-destroy" class="member inherited"><a href="Ext.form.field.Base.html#event-destroy" rel="event-destroy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-destroy" class="viewSource">view source</a></div><a name="destroy"></a><a name="event-destroy"></a><a href="Ext.form.field.Base.html#" rel="event-destroy" class="cls expand">destroy</a>(
2438 <span class="pre">Ext.Component this</span>)
2439 </div><div class="description"><div class="short"><p>Fires after the component is <a href="Ext.form.field.Base.html#destroy" rel="Ext.form.field.Base#destroy" class="docClass">destroy</a>ed.</p>
2440 </div><div class="long"><p>Fires after the component is <a href="Ext.form.field.Base.html#destroy" rel="Ext.form.field.Base#destroy" class="docClass">destroy</a>ed.</p>
2441 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2442 </div></li></ul></div></div></div><div id="event-dirtychange" class="member inherited"><a href="Ext.form.field.Base.html#event-dirtychange" rel="event-dirtychange" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-event-dirtychange" class="viewSource">view source</a></div><a name="dirtychange"></a><a name="event-dirtychange"></a><a href="Ext.form.field.Base.html#" rel="event-dirtychange" class="cls expand">dirtychange</a>(
2443 <span class="pre">Ext.form.field.Field this, Boolean isDirty</span>)
2444 </div><div class="description"><div class="short"><p>Fires when a change in the field's <a href="Ext.form.field.Base.html#isDirty" rel="Ext.form.field.Base#isDirty" class="docClass">isDirty</a> state is detected.</p>
2445 </div><div class="long"><p>Fires when a change in the field's <a href="Ext.form.field.Base.html#isDirty" rel="Ext.form.field.Base#isDirty" class="docClass">isDirty</a> state is detected.</p>
2446 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.form.field.Field<div class="sub-desc">
2447 </div></li><li><span class="pre">isDirty</span> : Boolean<div class="sub-desc"><p>Whether or not the field is now dirty</p>
2448 </div></li></ul></div></div></div><div id="event-disable" class="member inherited"><a href="Ext.form.field.Base.html#event-disable" rel="event-disable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-disable" class="viewSource">view source</a></div><a name="disable"></a><a name="event-disable"></a><a href="Ext.form.field.Base.html#" rel="event-disable" class="cls expand">disable</a>(
2449 <span class="pre">Ext.Component this</span>)
2450 </div><div class="description"><div class="short"><p>Fires after the component is disabled.</p>
2451 </div><div class="long"><p>Fires after the component is disabled.</p>
2452 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2453 </div></li></ul></div></div></div><div id="event-enable" class="member inherited"><a href="Ext.form.field.Base.html#event-enable" rel="event-enable" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-enable" class="viewSource">view source</a></div><a name="enable"></a><a name="event-enable"></a><a href="Ext.form.field.Base.html#" rel="event-enable" class="cls expand">enable</a>(
2454 <span class="pre">Ext.Component this</span>)
2455 </div><div class="description"><div class="short"><p>Fires after the component is enabled.</p>
2456 </div><div class="long"><p>Fires after the component is enabled.</p>
2457 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2458 </div></li></ul></div></div></div><div id="event-errorchange" class="member inherited"><a href="Ext.form.field.Base.html#event-errorchange" rel="event-errorchange" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.Labelable.html" class="definedIn docClass">Ext.form.Labelable</a><br/><a href="../source/Labelable.html#Ext-form.Labelable-event-errorchange" class="viewSource">view source</a></div><a name="errorchange"></a><a name="event-errorchange"></a><a href="Ext.form.field.Base.html#" rel="event-errorchange" class="cls expand">errorchange</a>(
2459 <span class="pre">Ext.form.Labelable this, String error</span>)
2460 </div><div class="description"><div class="short"><p>Fires when the active error message is changed via <a href="Ext.form.field.Base.html#setActiveError" rel="Ext.form.field.Base#setActiveError" class="docClass">setActiveError</a>.</p>
2461 </div><div class="long"><p>Fires when the active error message is changed via <a href="Ext.form.field.Base.html#setActiveError" rel="Ext.form.field.Base#setActiveError" class="docClass">setActiveError</a>.</p>
2462 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.form.Labelable<div class="sub-desc">
2463 </div></li><li><span class="pre">error</span> : String<div class="sub-desc"><p>The active error message</p>
2464 </div></li></ul></div></div></div><div id="event-focus" class="member ni"><a href="Ext.form.field.Base.html#event-focus" rel="event-focus" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-event-focus" class="viewSource">view source</a></div><a name="focus"></a><a name="event-focus"></a><a href="Ext.form.field.Base.html#" rel="event-focus" class="cls expand">focus</a>(
2465 <span class="pre">Ext.form.field.Base this</span>)
2466 </div><div class="description"><div class="short"><p>Fires when this field receives input focus.</p>
2467 </div><div class="long"><p>Fires when this field receives input focus.</p>
2468 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.form.field.Base<div class="sub-desc">
2469 </div></li></ul></div></div></div><div id="event-hide" class="member inherited"><a href="Ext.form.field.Base.html#event-hide" rel="event-hide" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-hide" class="viewSource">view source</a></div><a name="hide"></a><a name="event-hide"></a><a href="Ext.form.field.Base.html#" rel="event-hide" class="cls expand">hide</a>(
2470 <span class="pre">Ext.Component this</span>)
2471 </div><div class="description"><div class="short"><p>Fires after the component is hidden.
2472 Fires after the component is hidden when calling the <a href="Ext.form.field.Base.html#hide" rel="Ext.form.field.Base#hide" class="docClass">hide</a> method.</p>
2473 </div><div class="long"><p>Fires after the component is hidden.
2474 Fires after the component is hidden when calling the <a href="Ext.form.field.Base.html#hide" rel="Ext.form.field.Base#hide" class="docClass">hide</a> method.</p>
2475 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2476 </div></li></ul></div></div></div><div id="event-move" class="member inherited"><a href="Ext.form.field.Base.html#event-move" rel="event-move" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-move" class="viewSource">view source</a></div><a name="move"></a><a name="event-move"></a><a href="Ext.form.field.Base.html#" rel="event-move" class="cls expand">move</a>(
2477 <span class="pre">Ext.Component this, Number x, Number y</span>)
2478 </div><div class="description"><div class="short"><p>Fires after the component is moved.</p>
2479 </div><div class="long"><p>Fires after the component is moved.</p>
2480 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2481 </div></li><li><span class="pre">x</span> : Number<div class="sub-desc"><p>The new x position</p>
2482 </div></li><li><span class="pre">y</span> : Number<div class="sub-desc"><p>The new y position</p>
2483 </div></li></ul></div></div></div><div id="event-removed" class="member inherited"><a href="Ext.form.field.Base.html#event-removed" rel="event-removed" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-removed" class="viewSource">view source</a></div><a name="removed"></a><a name="event-removed"></a><a href="Ext.form.field.Base.html#" rel="event-removed" class="cls expand">removed</a>(
2484 <span class="pre">Ext.Component this, Ext.container.Container ownerCt</span>)
2485 </div><div class="description"><div class="short"><p>Fires when a component is removed from an Ext.container.Container</p>
2486 </div><div class="long"><p>Fires when a component is removed from an Ext.container.Container</p>
2487 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2488 </div></li><li><span class="pre">ownerCt</span> : Ext.container.Container<div class="sub-desc"><p>Container which holds the component</p>
2489 </div></li></ul></div></div></div><div id="event-render" class="member inherited"><a href="Ext.form.field.Base.html#event-render" rel="event-render" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-render" class="viewSource">view source</a></div><a name="render"></a><a name="event-render"></a><a href="Ext.form.field.Base.html#" rel="event-render" class="cls expand">render</a>(
2490 <span class="pre">Ext.Component this</span>)
2491 </div><div class="description"><div class="short"><p>Fires after the component markup is <a href="Ext.form.field.Base.html#rendered" rel="Ext.form.field.Base#rendered" class="docClass">rendered</a>.</p>
2492 </div><div class="long"><p>Fires after the component markup is <a href="Ext.form.field.Base.html#rendered" rel="Ext.form.field.Base#rendered" class="docClass">rendered</a>.</p>
2493 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2494 </div></li></ul></div></div></div><div id="event-resize" class="member inherited"><a href="Ext.form.field.Base.html#event-resize" rel="event-resize" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-resize" class="viewSource">view source</a></div><a name="resize"></a><a name="event-resize"></a><a href="Ext.form.field.Base.html#" rel="event-resize" class="cls expand">resize</a>(
2495 <span class="pre">Ext.Component this, Number adjWidth, Number adjHeight</span>)
2496 </div><div class="description"><div class="short"><p>Fires after the component is resized.</p>
2497 </div><div class="long"><p>Fires after the component is resized.</p>
2498 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2499 </div></li><li><span class="pre">adjWidth</span> : Number<div class="sub-desc"><p>The box-adjusted width that was set</p>
2500 </div></li><li><span class="pre">adjHeight</span> : Number<div class="sub-desc"><p>The box-adjusted height that was set</p>
2501 </div></li></ul></div></div></div><div id="event-show" class="member inherited"><a href="Ext.form.field.Base.html#event-show" rel="event-show" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.AbstractComponent.html" class="definedIn docClass">Ext.AbstractComponent</a><br/><a href="../source/AbstractComponent.html#Ext-AbstractComponent-event-show" class="viewSource">view source</a></div><a name="show"></a><a name="event-show"></a><a href="Ext.form.field.Base.html#" rel="event-show" class="cls expand">show</a>(
2502 <span class="pre">Ext.Component this</span>)
2503 </div><div class="description"><div class="short"><p>Fires after the component is shown when calling the <a href="Ext.form.field.Base.html#show" rel="Ext.form.field.Base#show" class="docClass">show</a> method.</p>
2504 </div><div class="long"><p>Fires after the component is shown when calling the <a href="Ext.form.field.Base.html#show" rel="Ext.form.field.Base#show" class="docClass">show</a> method.</p>
2505 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.Component<div class="sub-desc">
2506 </div></li></ul></div></div></div><div id="event-specialkey" class="member ni"><a href="Ext.form.field.Base.html#event-specialkey" rel="event-specialkey" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Base.html" class="definedIn docClass">Ext.form.field.Base</a><br/><a href="../source/Base.html#Ext-form.field.Base-event-specialkey" class="viewSource">view source</a></div><a name="specialkey"></a><a name="event-specialkey"></a><a href="Ext.form.field.Base.html#" rel="event-specialkey" class="cls expand">specialkey</a>(
2507 <span class="pre">Ext.form.field.Base this, Ext.EventObject e</span>)
2508 </div><div class="description"><div class="short">Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.
2509 To handle other keys see Ext.pan...</div><div class="long"><p>Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.
2510 To handle other keys see <a href="Ext.panel.Panel.html#keys" rel="Ext.panel.Panel#keys" class="docClass">Ext.panel.Panel.keys</a> or <a href="Ext.util.KeyMap.html" rel="Ext.util.KeyMap" class="docClass">Ext.util.KeyMap</a>.
2511 You can check <a href="Ext.EventObject.html#getKey" rel="Ext.EventObject#getKey" class="docClass">Ext.EventObject.getKey</a> to determine which key was pressed.
2512 For example:</p>
2513
2514 <pre><code>var form = new Ext.form.Panel({
2515     ...
2516     items: [{
2517             fieldLabel: 'Field 1',
2518             name: 'field1',
2519             allowBlank: false
2520         },{
2521             fieldLabel: 'Field 2',
2522             name: 'field2',
2523             listeners: {
2524                 specialkey: function(field, e){
2525                     // e.HOME, e.END, e.PAGE_UP, e.PAGE_DOWN,
2526                     // e.TAB, e.ESC, arrow keys: e.LEFT, e.RIGHT, e.UP, e.DOWN
2527                     if (e.<a href="Ext.EventObject.html#getKey" rel="Ext.EventObject#getKey" class="docClass">getKey()</a> == e.ENTER) {
2528                         var form = field.up('form').getForm();
2529                         form.submit();
2530                     }
2531                 }
2532             }
2533         }
2534     ],
2535     ...
2536 });
2537 </code></pre>
2538
2539 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.form.field.Base<div class="sub-desc">
2540 </div></li><li><span class="pre">e</span> : Ext.EventObject<div class="sub-desc"><p>The event object</p>
2541 </div></li></ul></div></div></div><div id="event-staterestore" class="member inherited"><a href="Ext.form.field.Base.html#event-staterestore" rel="event-staterestore" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-event-staterestore" class="viewSource">view source</a></div><a name="staterestore"></a><a name="event-staterestore"></a><a href="Ext.form.field.Base.html#" rel="event-staterestore" class="cls expand">staterestore</a>(
2542 <span class="pre">Ext.state.Stateful this, Object state</span>)
2543 </div><div class="description"><div class="short"><p>Fires after the state of the object is restored.</p>
2544 </div><div class="long"><p>Fires after the state of the object is restored.</p>
2545 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.state.Stateful<div class="sub-desc">
2546 </div></li><li><span class="pre">state</span> : Object<div class="sub-desc"><p>The hash of state values returned from the StateProvider. This is passed
2547 to <b><tt>applyState</tt></b>. By default, that simply copies property values into this
2548 object. The method maybe overriden to provide custom state restoration.</p>
2549 </div></li></ul></div></div></div><div id="event-statesave" class="member inherited"><a href="Ext.form.field.Base.html#event-statesave" rel="event-statesave" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.state.Stateful.html" class="definedIn docClass">Ext.state.Stateful</a><br/><a href="../source/Stateful.html#Ext-state.Stateful-event-statesave" class="viewSource">view source</a></div><a name="statesave"></a><a name="event-statesave"></a><a href="Ext.form.field.Base.html#" rel="event-statesave" class="cls expand">statesave</a>(
2550 <span class="pre">Ext.state.Stateful this, Object state</span>)
2551 </div><div class="description"><div class="short"><p>Fires after the state of the object is saved to the configured state provider.</p>
2552 </div><div class="long"><p>Fires after the state of the object is saved to the configured state provider.</p>
2553 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.state.Stateful<div class="sub-desc">
2554 </div></li><li><span class="pre">state</span> : Object<div class="sub-desc"><p>The hash of state values. This is determined by calling
2555 <b><tt>getState()</tt></b> on the object. This method must be provided by the
2556 developer to return whetever representation of state is required, by default, <a href="Ext.state.Stateful.html" rel="Ext.state.Stateful" class="docClass">Ext.state.Stateful</a>
2557 has a null implementation.</p>
2558 </div></li></ul></div></div></div><div id="event-validitychange" class="member inherited"><a href="Ext.form.field.Base.html#event-validitychange" rel="event-validitychange" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.form.field.Field.html" class="definedIn docClass">Ext.form.field.Field</a><br/><a href="../source/Field.html#Ext-form.field.Field-event-validitychange" class="viewSource">view source</a></div><a name="validitychange"></a><a name="event-validitychange"></a><a href="Ext.form.field.Base.html#" rel="event-validitychange" class="cls expand">validitychange</a>(
2559 <span class="pre">Ext.form.field.Field this, Boolean isValid</span>)
2560 </div><div class="description"><div class="short"><p>Fires when a change in the field's validity is detected.</p>
2561 </div><div class="long"><p>Fires when a change in the field's validity is detected.</p>
2562 <h3 class="pa">Parameters</h3><ul><li><span class="pre">this</span> : Ext.form.field.Field<div class="sub-desc">
2563 </div></li><li><span class="pre">isValid</span> : Boolean<div class="sub-desc"><p>Whether or not the field is now valid</p>
2564 </div></li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>