Properties Methods Events Config Options Direct Link

    Observable
      Component
        BoxComponent
          Field
            TextField
              TriggerField
                ComboBox
                  TimeField

# Class Ext.form.TimeField

Package: | Ext.form
Defined In: | TimeField.js
Class: | TimeField
Extends: | ComboBox

Provides a time input field with a time dropdown and automatic time validation.

## Config Options

Config Options | Defined By
--- | ---
| allQuery : String The text query to send to the server to return all records for the list with no filtering (defaults to '') | ComboBox
| allowBlank : Boolean False to validate that the value length > 0 (defaults to true) | TextField
| allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component
| altFormats : String Multiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined format... Multiple date formats separated by "|" to try when parsing a user input value and it doesn't match the defined format (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d'). | TimeField
| applyTo : Mixed The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document ... The id of the node, a DOM node or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component. When applyTo is used, constituent parts of the component can also be specified by id or CSS class name within the main element, and the component being created may attempt to create its subcomponents from that markup if applicable. Using this config, a call to render() is not required. If applyTo is specified, any value passed for renderTo will be ignored and the target element's parent node will automatically be used as the component's container. | Component
| autoCreate : String/Object A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "20", au... A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "20", autocomplete: "off"}) | Field
| autoHeight : Boolean True to use height:'auto', false to use fixed height (defaults to false). | BoxComponent
| autoShow : Boolean True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render... True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render (defaults to false). | Component
| autoWidth : Boolean True to use width:'auto', false to use fixed width (defaults to false). | BoxComponent
| blankText : String Error text to display if the allow blank validation fails (defaults to "This field is required") | TextField
| clearCls : String The CSS class used to provide field clearing (defaults to 'x-form-clear-left') | Field
| cls : String An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for a... An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules. | Component
| ctCls : String An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for... An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules. | Component
| disableKeyFilter : Boolean True to disable input keystroke filtering (defaults to false) | TextField
| disabled : Boolean True to disable the field (defaults to false). | Field
| disabledClass : String CSS class added to the component when it is disabled (defaults to "x-item-disabled"). | Component
| displayField : String The underlying data field name to bind to this ComboBox (defaults to undefined if mode = 'remote' or 'text' if transf... The underlying data field name to bind to this ComboBox (defaults to undefined if mode = 'remote' or 'text' if transforming a select) | ComboBox
| editable : Boolean False to prevent the user from typing text directly into the field, just like a traditional select (defaults to true) | ComboBox
| emptyClass : String The CSS class to apply to an empty field to style the emptyText (defaults to 'x-form-empty-field'). This class is aut... The CSS class to apply to an empty field to style the emptyText (defaults to 'x-form-empty-field'). This class is automatically added and removed as needed depending on the current field value. | TextField
| emptyText : String The default text to display in an empty field (defaults to null). | TextField
| fieldClass : String The default CSS class for the field (defaults to "x-form-field") | Field
| fieldLabel : String The label text to display next to this field (defaults to '') | Field
| focusClass : String The CSS class to use when the field receives focus (defaults to "x-form-focus") | Field
| forceSelection : Boolean True to restrict the selected value to one of the values in the list, false to allow the user to set arbitrary text i... True to restrict the selected value to one of the values in the list, false to allow the user to set arbitrary text into the field (defaults to false) | ComboBox
| format : String The default date format string which can be overriden for localization support. The format must be valid according to... The default date format string which can be overriden for localization support. The format must be valid according to Date.parseDate (defaults to 'm/d/y'). | TimeField
| handleHeight : Number The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8) | ComboBox
| height : Number The height of this component in pixels (defaults to auto). | BoxComponent
| hiddenName : String If specified, a hidden form field with this name is dynamically generated to store the field's data value (defaults t... If specified, a hidden form field with this name is dynamically generated to store the field's data value (defaults to the underlying DOM element's name). Required for the combo's value to automatically post during a form submission. | ComboBox
| hideLabel : Boolean True to completely hide the label element (defaults to false) | Field
| hideMode : String How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset posi... How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display". | Component
| hideParent : Boolean True to hide and show the component's container when hide/show is called on the component, false to hide and show the... True to hide and show the component's container when hide/show is called on the component, false to hide and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide button on a window by setting hide:true on the button when adding it to its parent container. | Component
| hideTrigger : Boolean True to hide the trigger element and display only the base text field (defaults to false) | TriggerField
| id : String The unique id of this component (defaults to an auto-assigned id). | Component
| increment : Number The number of minutes between each time value in the list (defaults to 15). | TimeField
| inputType : String The type attribute for input fields -- e.g. radio, text, password (defaults to "text"). | Field
| invalidClass : String The CSS class to use when marking a field invalid (defaults to "x-form-invalid") | Field
| invalidText : String The error text to display when the time in the field is invalid (defaults to '{value} is not a valid time - it must b... The error text to display when the time in the field is invalid (defaults to '{value} is not a valid time - it must be in the format {format}'). | TimeField
| itemCls : String An additional CSS class to apply to this field (defaults to the container's itemCls value if set, or '') | Field
| labelSeparator : String The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.l... The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.labelSeparator, which is a colon ':' by default). To display no separator for this field's label specify empty string ''. | Field
| labelStyle : String A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if se... A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if set, or ''). For example, `labelStyle: 'font-weight:bold;'`. | Field
| lazyInit : Boolean True to not initialize the list for this combo until the field is focused. (defaults to true) | ComboBox
| lazyRender : Boolean True to prevent the ComboBox from rendering until requested (should always be used when rendering into an Ext.Editor,... True to prevent the ComboBox from rendering until requested (should always be used when rendering into an Ext.Editor, defaults to false) | ComboBox
| listAlign : String A valid anchor position value. See Ext.Element.alignTo for details on supported anchor positions (defaults to 'tl-bl') | ComboBox
| listClass : String CSS class to apply to the dropdown list element (defaults to '') | ComboBox
| listWidth : Number The width in pixels of the dropdown list (defaults to the width of the ComboBox field) | ComboBox
| listeners : Object A config object containing one or more event handlers to be added to this object during initialization. This should b... A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once. | Observable
| loadingText : String The text to display in the dropdown list while data is loading. Only applies when mode = 'remote' (defaults to 'Loadi... The text to display in the dropdown list while data is loading. Only applies when mode = 'remote' (defaults to 'Loading...') | ComboBox
| maskRe : RegExp An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null) | TextField
| maxHeight : Number The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300) | ComboBox
| maxLength : Number Maximum input field length allowed (defaults to Number.MAX_VALUE) | TextField
| maxLengthText : String Error text to display if the maximum length validation fails (defaults to "The maximum length for this field is {maxL... Error text to display if the maximum length validation fails (defaults to "The maximum length for this field is {maxLength}") | TextField
| maxText : String The error text to display when the time is after maxValue (defaults to 'The time in this field must be equal to or be... The error text to display when the time is after maxValue (defaults to 'The time in this field must be equal to or before {0}'). | TimeField
| maxValue : Date/String The maximum allowed time. Can be either a Javascript date object or a string date in a valid format (defaults to null). | TimeField
| minChars : Number The minimum number of characters the user must type before autocomplete and typeahead activate (defaults to 4 if remo... The minimum number of characters the user must type before autocomplete and typeahead activate (defaults to 4 if remote or 0 if local, does not apply if editable = false) | ComboBox
| minLength : Number Minimum input field length required (defaults to 0) | TextField
| minLengthText : String Error text to display if the minimum length validation fails (defaults to "The minimum length for this field is {minL... Error text to display if the minimum length validation fails (defaults to "The minimum length for this field is {minLength}") | TextField
| minListWidth : Number The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if listWidth has a higher value) | ComboBox
| minText : String The error text to display when the date in the cell is before minValue (defaults to 'The time in this field must be e... The error text to display when the date in the cell is before minValue (defaults to 'The time in this field must be equal to or after {0}'). | TimeField
| minValue : Date/String The minimum allowed time. Can be either a Javascript date object or a string date in a valid format (defaults to null). | TimeField
| mode : String Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server) | ComboBox
| msgFx : String Experimental The effect used when displaying a validation message under the field (defaults to 'normal'). | Field
| msgTarget : String The location where error text should display. Should be one of the following values (defaults to 'qtip'): Value ... The location where error text should display. Should be one of the following values (defaults to 'qtip'):
    Value         Description
    -----------   ----------------------------------------------------------------------
    qtip          Display a quick tip when the user hovers over the field
    title         Display a default browser title attribute popup
    under         Add a block div beneath the field containing the error text
    side          Add an error icon to the right of the field with a popup on hover
    [element id]  Add the error text directly to the innerHTML of the specified element
| Field
| name : String The field's HTML name attribute. | Field
| pageSize : Number If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the filter queries will execu... If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the filter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0) | ComboBox
| plugins : Object/Array An object or array of objects that will provide custom functionality for this component. The only requirement for a v... An object or array of objects that will provide custom functionality for this component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality. | Component
| queryDelay : Number The length of time in milliseconds to delay between the start of typing and sending the query to filter the dropdown ... The length of time in milliseconds to delay between the start of typing and sending the query to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local') | ComboBox
| queryParam : String Name of the query as it will be passed on the querystring (defaults to 'query') | ComboBox
| readOnly : Boolean True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM att... True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute. | Field
| regex : RegExp A JavaScript RegExp object to be tested against the field value during validation (defaults to null). If available, t... A JavaScript RegExp object to be tested against the field value during validation (defaults to null). If available, this regex will be evaluated only after the basic validators all return true, and will be passed the current field value. If the test fails, the field will be marked invalid using regexText. | TextField
| regexText : String The error text to display if regex is used and the test fails during validation (defaults to "") | TextField
| renderTo : Mixed The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using... The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required. | Component
| resizable : Boolean True to add a resize handle to the bottom of the dropdown list (defaults to false) | ComboBox
| selectOnFocus : Boolean True to automatically select any existing field text when the field receives input focus (defaults to false) | TextField
| selectedClass : String CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected') | ComboBox
| shadow : Boolean/String True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right | ComboBox
| stateEvents : Array An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be... An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be any types of events supported by this component, including browser or custom events (e.g., ['click', 'customerchange']). | Component
| stateId : String The unique id for this component to use for state management purposes (defaults to the component id). | Component
| store : Ext.data.Store The data store to which this combo is bound (defaults to undefined) | ComboBox
| style : String A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.app... A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.applyStyles. | Component
| tabIndex : Number The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyT... The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined). | Field
| title : String If supplied, a header element is created containing this text and added into the top of the dropdown list (defaults t... If supplied, a header element is created containing this text and added into the top of the dropdown list (defaults to undefined, with no header element) | ComboBox
| tpl : String/Ext.XTemplate The template string, or Ext.XTemplate instance to use to display each item in the dropdown list. Use this to create c... The template string, or Ext.XTemplate instance to use to display each item in the dropdown list. Use this to create custom UI layouts for items in the list. If you wish to preserve the default visual look of list items, add the CSS class name
    x-combo-list-item
to the template's container element. The template must contain one or more substitution parameters using field names from the Combo's Store. An example of a custom template would be adding an
    ext:qtip
attribute which might display other fields from the Store. The dropdown list is displayed in a DataView. See Ext.DataView for details. | ComboBox
| transform : Mixed The id, DOM node or element of an existing select to convert to a ComboBox | ComboBox
| triggerAction : String The action to execute when the trigger field is activated. Use 'all' to run the query specified by the allQuery confi... The action to execute when the trigger field is activated. Use 'all' to run the query specified by the allQuery config option (defaults to 'query') | ComboBox
| triggerClass : String A CSS class to apply to the trigger | TriggerField
| typeAhead : Boolean True to populate and autoselect the remainder of the text being typed after a configurable delay (typeAheadDelay) if ... True to populate and autoselect the remainder of the text being typed after a configurable delay (typeAheadDelay) if it matches a known value (defaults to false) | ComboBox
| typeAheadDelay : Number The length of time in milliseconds to wait until the typeahead text is displayed if typeAhead = true (defaults to 250) | ComboBox
| validateOnBlur : Boolean Whether the field should validate when it loses focus (defaults to true). | Field
| validationDelay : Number The length of time in milliseconds after user input begins until validation is initiated (defaults to 250) | Field
| validationEvent : String/Boolean The event that should initiate field validation. Set to false to disable automatic validation (defaults to "keyup"). | Field
| validator : Function A custom validation function to be called during field validation (defaults to null). If available, this function wil... A custom validation function to be called during field validation (defaults to null). If available, this function will be called only after the basic validators all return true, and will be passed the current field value and expected to return boolean true if the value is valid or a string error message if invalid. | TextField
| value : Mixed A value to initialize this field with. | Field
| valueField : String The underlying data value name to bind to this ComboBox (defaults to undefined if mode = 'remote' or 'value' if trans... The underlying data value name to bind to this ComboBox (defaults to undefined if mode = 'remote' or 'value' if transforming a select) Note: use of a valueField requires the user to make a selection in order for a value to be mapped. | ComboBox
| valueNotFoundText : String When using a name/value combo, if the value passed to setValue is not found in the store, valueNotFoundText will be d... When using a name/value combo, if the value passed to setValue is not found in the store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined) | ComboBox
| vtype : String A validation type name as defined in Ext.form.VTypes (defaults to null) | TextField
| vtypeText : String A custom error message to display in place of the default message provided for the vtype currently set for this field... A custom error message to display in place of the default message provided for the vtype currently set for this field (defaults to ''). Only applies if vtype is set, else ignored. | TextField
| width : Number The width of this component in pixels (defaults to auto). | BoxComponent
| xtype : String The registered xtype to create. This config option is not used when passing a config object into a constructor. This ... The registered xtype to create. This config option is not used when passing a config object into a constructor. This config option is used only when lazy instantiation is being used, and a child item of a Container is being specified not as a fully instantiated Component, but as a Component config object. The xtype will be looked up at render time up to determine what type of child Component to create. The predefined xtypes are listed here. If you subclass Components to create your own Components, you may register them using Ext.ComponentMgr.registerType in order to be able to take advantage of lazy instantiation and rendering. | Component

## Public Properties

Property | Defined By
--- | ---
| disabled : Boolean True if this component is disabled. Read-only. | Component
| hidden : Boolean True if this component is hidden. Read-only. | Component
| initialConfig : Object This Component's initial configuration specification. Read-only. | Component
| ownerCt : Ext.Container The component's owner Ext.Container (defaults to undefined, and is set automatically when the component is added to a... The component's owner Ext.Container (defaults to undefined, and is set automatically when the component is added to a container). Read-only. | Component
| rendered : Boolean True if this component has been rendered. Read-only. | Component
| view : Ext.DataView The DataView used to display the ComboBox's options. | ComboBox

## Public Methods

Method | Defined By
--- | ---
| TimeField( `Object config` ) Create a new TimeField Create a new TimeField Parameters: `config` : Object Returns: `` | TimeField
| addClass( `string cls` ) : void Adds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. Parameters: `cls` : string The CSS class name to add Returns: `void` | Component
| addEvents( `Object object` ) : void Used to define events on this Observable Used to define events on this Observable Parameters: `object` : Object The object with the events defined Returns: `void` | Observable
- | addListener( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this component Appends an event handler to this component Parameters: `eventName` : String The type of event to listen for `handler` : Function The method the event invokes `scope` : Object (optional) The scope in which to execute the handler function. The handler function's "this" context. `options` : Object (optional) An object containing handler configuration properties. This may contain any of the following properties: scope : Object The scope in which to execute the handler function. The handler function's "this" context. delay : Number The number of milliseconds to delay the invocation of the handler after the event fires. single : Boolean True to add a handler to handle just the next firing of the event, and then remove itself. buffer {Number} Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place. Combining Options Using the options argument, it is possible to combine different types of listeners: A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
      el.on('click', this.onClick, this, {
          single: true,
          delay: 100,
          forumId: 4
      });
  Attaching multiple handlers in 1 call The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers.
      foo.on({
          'click' : {
              fn: this.onClick,
              scope: this,
              delay: 100
          },
          'mouseover' : {
              fn: this.onMouseOver,
              scope: this
          },
          'mouseout' : {
              fn: this.onMouseOut,
              scope: this
          }
      });
  Or a shorthand syntax:
      foo.on({
          'click' : this.onClick,
          'mouseover' : this.onMouseOver,
          'mouseout' : this.onMouseOut,
           scope: this
      });
Returns: `void` | Observable
| applyToMarkup( `String/HTMLElement el` ) : void Apply this component to existing markup that is valid. With this function, no call to render() is required. Apply this component to existing markup that is valid. With this function, no call to render() is required. Parameters: `el` : String/HTMLElement Returns: `void` | Component
| clearInvalid() : void Clear any invalid styles/messages for this field Clear any invalid styles/messages for this field Parameters: None. Returns: `void` | Field
| clearValue() : void Clears any text/value currently set in the field Clears any text/value currently set in the field Parameters: None. Returns: `void` | ComboBox
| cloneConfig( `Object overrides` ) : Ext.Component Clone the current component using the original config values passed into this instance by default. Clone the current component using the original config values passed into this instance by default. Parameters: `overrides` : Object A new config containing any properties to override in the cloned version. An id property can be passed on this object, otherwise one will be generated to avoid duplicates. Returns: `Ext.Component` clone The cloned copy of this component | Component
| collapse() : void Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion. Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion. Parameters: None. Returns: `void` | ComboBox
| destroy() : void Destroys this component by purging any event listeners, removing the component's element from the DOM, removing the c... Destroys this component by purging any event listeners, removing the component's element from the DOM, removing the component from its Ext.Container (if applicable) and unregistering it from Ext.ComponentMgr. Destruction is generally handled automatically by the framework and this method should usually not need to be called directly. Parameters: None. Returns: `void` | Component
| disable() : Ext.Component Disable this component. Disable this component. Parameters: None. Returns: `Ext.Component` this | Component
| doQuery( `String query`, `Boolean forceAll` ) : void Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the query allowing the ... Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the query allowing the query action to be canceled if needed. Parameters: `query` : String The SQL query to execute `forceAll` : Boolean True to force the query to execute even if there are currently fewer characters in the field than the minimum specified by the minChars config option. It also clears any filter previously saved in the current store (defaults to false) Returns: `void` | ComboBox
| enable() : Ext.Component Enable this component. Enable this component. Parameters: None. Returns: `Ext.Component` this | Component
| expand() : void Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion. Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion. Parameters: None. Returns: `void` | ComboBox
| fireEvent( `String eventName`, `Object... args` ) : Boolean Fires the specified event with the passed parameters (minus the event name). Fires the specified event with the passed parameters (minus the event name). Parameters: `eventName` : String `args` : Object... Variable number of parameters are passed to handlers Returns: `Boolean` returns false if any of the handlers return false otherwise it returns true | Observable
| focus( [`Boolean selectText`], [`Boolean/Number delay`] ) : Ext.Component Try to focus this component. Try to focus this component. Parameters: `selectText` : Boolean (optional) If applicable, true to also select the text in this component `delay` : Boolean/Number (optional) Delay the focus this number of milliseconds (true for 10 milliseconds) Returns: `Ext.Component` this | Component
| getBox( [`Boolean local`] ) : Object Gets the current box measurements of the component's underlying element. Gets the current box measurements of the component's underlying element. Parameters: `local` : Boolean (optional) If true the element's left and top are returned instead of page XY (defaults to false) Returns: `Object` box An object in the format {x, y, width, height} | BoxComponent
| getEl() : Ext.Element Returns the underlying Ext.Element. Returns the underlying Ext.Element. Parameters: None. Returns: `Ext.Element` The element | Component
| getId() : String Returns the id of this component. Returns the id of this component. Parameters: None. Returns: `String` | Component
| getItemId() : String Returns the item id of this component. Returns the item id of this component. Parameters: None. Returns: `String` | Component
| getName() : String Returns the name attribute of the field if available Returns the name attribute of the field if available Parameters: None. Returns: `String` name The field name | Field
| getPosition( [`Boolean local`] ) : Array Gets the current XY position of the component's underlying element. Gets the current XY position of the component's underlying element. Parameters: `local` : Boolean (optional) If true the element's left and top are returned instead of page XY (defaults to false) Returns: `Array` The XY position of the element (e.g., [100, 200]) | BoxComponent
| getRawValue() : Mixed Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue. Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue. Parameters: None. Returns: `Mixed` value The field value | Field
| getSize() : Object Gets the current size of the component's underlying element. Gets the current size of the component's underlying element. Parameters: None. Returns: `Object` An object containing the element's size {width: (element width), height: (element height)} | BoxComponent
| getValue() : Mixed Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see getRa... Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see getRawValue. Parameters: None. Returns: `Mixed` value The field value | Field
| getXType() : String Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all available xtypes, see the Ex... Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all available xtypes, see the Ext.Component header. Example usage:
    var t = new Ext.form.TextField();
    alert(t.getXType());  // alerts 'textfield'
Parameters: None. Returns: `String` The xtype | Component
| getXTypes() : String Returns this component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the Ext... Returns this component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the Ext.Component header. Example usage:
    var t = new Ext.form.TextField();
    alert(t.getXTypes());  // alerts 'component/box/field/textfield'
Parameters: None. Returns: `String` The xtype hierarchy string | Component
| hasListener( `String eventName` ) : Boolean Checks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters: `eventName` : String The name of the event to check for Returns: `Boolean` True if the event is being listened for, else false | Observable
| hide() : Ext.Component Hide this component. Hide this component. Parameters: None. Returns: `Ext.Component` this | Component
| initComponent() : void Parameters: None. Returns: `void` | BoxComponent
| isDirty() : void Returns true if this field has been changed since it was originally loaded and is not disabled. Returns true if this field has been changed since it was originally loaded and is not disabled. Parameters: None. Returns: `void` | Field
| isExpanded() : void Returns true if the dropdown list is expanded, else false. Returns true if the dropdown list is expanded, else false. Parameters: None. Returns: `void` | ComboBox
| isValid( `Boolean preventMark` ) : Boolean Returns whether or not the field value is currently valid Returns whether or not the field value is currently valid Parameters: `preventMark` : Boolean True to disable marking the field invalid Returns: `Boolean` True if the value is valid, else false | Field
| isVisible() : void Returns true if this component is visible. Returns true if this component is visible. Parameters: None. Returns: `void` | Component
| isXType( `String xtype`, [`Boolean shallow`] ) : void Tests whether or not this component is of a specific xtype. This can test whether this component is descended from th... Tests whether or not this component is of a specific xtype. This can test whether this component is descended from the xtype (default) or whether it is directly of the xtype specified (shallow = true). For a list of all available xtypes, see the Ext.Component header. Example usage:
    var t = new Ext.form.TextField();
    var isText = t.isXType('textfield');        // true
    var isBoxSubclass = t.isXType('box');       // true, descended from BoxComponent
    var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instance
Parameters: `xtype` : String The xtype to check for this component `shallow` : Boolean (optional) False to check whether this component is descended from the xtype (this is the default), or true to check whether this component is directly of the specified xtype. Returns: `void` | Component
| markInvalid( `String msg` ) : void Mark this field as invalid Mark this field as invalid Parameters: `msg` : String The validation message Returns: `void` | Field
| on( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this element (shorthand for addListener) Appends an event handler to this element (shorthand for addListener) Parameters: `eventName` : String The type of event to listen for `handler` : Function The method the event invokes `scope` : Object (optional) The scope in which to execute the handler function. The handler function's "this" context. `options` : Object (optional) Returns: `void` | Observable
| onTriggerClick( `EventObject e` ) : void The function that should handle the trigger's click event. This method does nothing by default until overridden by a... The function that should handle the trigger's click event. This method does nothing by default until overridden by an implementing function. Parameters: `e` : EventObject Returns: `void` | TriggerField
| purgeListeners() : void Removes all listeners for this object Removes all listeners for this object Parameters: None. Returns: `void` | Observable
| removeClass( `string cls` ) : void Removes a CSS class from the component's underlying element. Removes a CSS class from the component's underlying element. Parameters: `cls` : string The CSS class name to remove Returns: `void` | Component
| removeListener( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes a listener Removes a listener Parameters: `eventName` : String The type of event to listen for `handler` : Function The handler to remove `scope` : Object (optional) The scope (this object) for the handler Returns: `void` | Observable
| render( [`Mixed container`], [`String/Number position`] ) : void If this is a lazy rendering component, render it to its container element. If this is a lazy rendering component, render it to its container element. Parameters: `container` : Mixed (optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off. `position` : String/Number (optional) The element ID or DOM node index within the container before which this component will be inserted (defaults to appending to the end of the container) Returns: `void` | Component
| reset() : void Resets the current field value to the originally loaded value and clears any validation messages Resets the current field value to the originally loaded value and clears any validation messages Parameters: None. Returns: `void` | Field
| resumeEvents() : void Resume firing events. (see suspendEvents) Resume firing events. (see suspendEvents) Parameters: None. Returns: `void` | Observable
| select( `Number index`, `Boolean scrollIntoView` ) : void Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event t... Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire. The store must be loaded and the list expanded for this function to work, otherwise use setValue. Parameters: `index` : Number The zero-based index of the list item to select `scrollIntoView` : Boolean False to prevent the dropdown list from autoscrolling to display the selected item if it is not currently in view (defaults to true) Returns: `void` | ComboBox
| selectByValue( `String value`, `Boolean scrollIntoView` ) : Boolean Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire. The sto... Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire. The store must be loaded and the list expanded for this function to work, otherwise use setValue. Parameters: `value` : String The data value of the item to select `scrollIntoView` : Boolean False to prevent the dropdown list from autoscrolling to display the selected item if it is not currently in view (defaults to true) Returns: `Boolean` True if the value matched an item in the list, else false | ComboBox
| selectText( [`Number start`], [`Number end`] ) : void Selects text in this field Selects text in this field Parameters: `start` : Number (optional) The index where the selection should start (defaults to 0) `end` : Number (optional) The index where the selection should end (defaults to the text length) Returns: `void` | TextField
| setDisabled( `Boolean disabled` ) : void Convenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. Parameters: `disabled` : Boolean Returns: `void` | Component
| setEditable( `Boolean value` ) : void Allow or prevent the user from directly editing the field text. If false is passed, the user will only be able to se... Allow or prevent the user from directly editing the field text. If false is passed, the user will only be able to select from the items defined in the dropdown list. This method is the runtime equivalent of setting the 'editable' config option at config time. Parameters: `value` : Boolean True to allow the user to directly edit the field text Returns: `void` | ComboBox
| setHeight( `Number height` ) : Ext.BoxComponent Sets the height of the component. This method fires the resize event. Sets the height of the component. This method fires the resize event. Parameters: `height` : Number The new height to set Returns: `Ext.BoxComponent` this | BoxComponent
| setPagePosition( `Number x`, `Number y` ) : Ext.BoxComponent Sets the page XY position of the component. To set the left and top instead, use setPosition. This method fires the ... Sets the page XY position of the component. To set the left and top instead, use setPosition. This method fires the move event. Parameters: `x` : Number The new x position `y` : Number The new y position Returns: `Ext.BoxComponent` this | BoxComponent
| setPosition( `Number left`, `Number top` ) : Ext.BoxComponent Sets the left and top of the component. To set the page XY position instead, use setPagePosition. This method fires ... Sets the left and top of the component. To set the page XY position instead, use setPagePosition. This method fires the move event. Parameters: `left` : Number The new left `top` : Number The new top Returns: `Ext.BoxComponent` this | BoxComponent
| setRawValue( `Mixed value` ) : void Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue. Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue. Parameters: `value` : Mixed The value to set Returns: `void` | Field
| setSize( `Number/Object width`, `Number height` ) : Ext.BoxComponent Sets the width and height of the component. This method fires the resize event. This method can accept either width... Sets the width and height of the component. This method fires the resize event. This method can accept either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}. Parameters: `width` : Number/Object The new width to set, or a size object in the format {width, height} `height` : Number The new height to set (not required if a size object is passed as the first arg) Returns: `Ext.BoxComponent` this | BoxComponent
| setValue( `Mixed value` ) : void Sets a data value into the field and validates it. To set the value directly without validation see setRawValue. Sets a data value into the field and validates it. To set the value directly without validation see setRawValue. Parameters: `value` : Mixed The value to set Returns: `void` | Field
| setVisible( `Boolean visible` ) : Ext.Component Convenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters: `visible` : Boolean True to show, false to hide Returns: `Ext.Component` this | Component
| setWidth( `Number width` ) : Ext.BoxComponent Sets the width of the component. This method fires the resize event. Sets the width of the component. This method fires the resize event. Parameters: `width` : Number The new width to set Returns: `Ext.BoxComponent` this | BoxComponent
| show() : Ext.Component Show this component. Show this component. Parameters: None. Returns: `Ext.Component` this | Component
| suspendEvents() : void Suspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters: None. Returns: `void` | Observable
| syncSize() : Ext.BoxComponent Force the component's size to recalculate based on the underlying element's current height and width. Force the component's size to recalculate based on the underlying element's current height and width. Parameters: None. Returns: `Ext.BoxComponent` this | BoxComponent
| un( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes a listener (shorthand for removeListener) Removes a listener (shorthand for removeListener) Parameters: `eventName` : String The type of event to listen for `handler` : Function The handler to remove `scope` : Object (optional) The scope (this object) for the handler Returns: `void` | Observable
| updateBox( `Object box` ) : Ext.BoxComponent Sets the current box measurements of the component's underlying element. Sets the current box measurements of the component's underlying element. Parameters: `box` : Object An object in the format {x, y, width, height} Returns: `Ext.BoxComponent` this | BoxComponent
| validate() : Boolean Validates the field value Validates the field value Parameters: None. Returns: `Boolean` True if the value is valid, else false | Field
| validateValue( `Mixed value` ) : Boolean Validates a value according to the field's validation rules and marks the field as invalid if the validation fails Validates a value according to the field's validation rules and marks the field as invalid if the validation fails Parameters: `value` : Mixed The value to validate Returns: `Boolean` True if the value is valid, else false | TextField

## Public Events

Event | Defined By
--- | ---
| autosize : ( `Ext.form.Field this`, `Number width` ) Fires when the autosize function is triggered. The field may or may not have actually changed size according to the ... Fires when the autosize function is triggered. The field may or may not have actually changed size according to the default logic, but this event provides a hook for the developer to apply additional logic at runtime to resize the field if needed. Listeners will be called with the following arguments: `this` : Ext.form.Field This text field `width` : Number The new field width | TextField
| beforedestroy : ( `Ext.Component this` ) Fires before the component is destroyed. Return false to stop the destroy. Fires before the component is destroyed. Return false to stop the destroy. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| beforehide : ( `Ext.Component this` ) Fires before the component is hidden. Return false to stop the hide. Fires before the component is hidden. Return false to stop the hide. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| beforequery : ( `Object queryEvent` ) Fires before all queries are processed. Return false to cancel the query or set the queryEvent's cancel property to t... Fires before all queries are processed. Return false to cancel the query or set the queryEvent's cancel property to true. Listeners will be called with the following arguments: `queryEvent` : Object An object that has these properties: `combo` : Ext.form.ComboBox This combo box `query` : String The query `forceAll` : Boolean True to force "all" query `cancel` : Boolean Set to true to cancel the query | ComboBox
| beforerender : ( `Ext.Component this` ) Fires before the component is rendered. Return false to stop the render. Fires before the component is rendered. Return false to stop the render. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| beforeselect : ( `Ext.form.ComboBox combo`, `Ext.data.Record record`, `Number index` ) Fires before a list item is selected. Return false to cancel the selection. Fires before a list item is selected. Return false to cancel the selection. Listeners will be called with the following arguments: `combo` : Ext.form.ComboBox This combo box `record` : Ext.data.Record The data record returned from the underlying store `index` : Number The index of the selected item in the dropdown list | ComboBox
| beforeshow : ( `Ext.Component this` ) Fires before the component is shown. Return false to stop the show. Fires before the component is shown. Return false to stop the show. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| beforestaterestore : ( `Ext.Component this`, `Object state` ) Fires before the state of the component is restored. Return false to stop the restore. Fires before the state of the component is restored. Return false to stop the restore. Listeners will be called with the following arguments: `this` : Ext.Component `state` : Object The hash of state values | Component
| beforestatesave : ( `Ext.Component this`, `Object state` ) Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Listeners will be called with the following arguments: `this` : Ext.Component `state` : Object The hash of state values | Component
| blur : ( `Ext.form.Field this` ) Fires when this field loses input focus. Fires when this field loses input focus. Listeners will be called with the following arguments: `this` : Ext.form.Field | Field
| change : ( `Ext.form.Field this`, `Mixed newValue`, `Mixed oldValue` ) Fires just before the field blurs if the field value has changed. Fires just before the field blurs if the field value has changed. Listeners will be called with the following arguments: `this` : Ext.form.Field `newValue` : Mixed The new value `oldValue` : Mixed The original value | Field
| collapse : ( `Ext.form.ComboBox combo` ) Fires when the dropdown list is collapsed Fires when the dropdown list is collapsed Listeners will be called with the following arguments: `combo` : Ext.form.ComboBox This combo box | ComboBox
| destroy : ( `Ext.Component this` ) Fires after the component is destroyed. Fires after the component is destroyed. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| disable : ( `Ext.Component this` ) Fires after the component is disabled. Fires after the component is disabled. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| enable : ( `Ext.Component this` ) Fires after the component is enabled. Fires after the component is enabled. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| expand : ( `Ext.form.ComboBox combo` ) Fires when the dropdown list is expanded Fires when the dropdown list is expanded Listeners will be called with the following arguments: `combo` : Ext.form.ComboBox This combo box | ComboBox
| focus : ( `Ext.form.Field this` ) Fires when this field receives input focus. Fires when this field receives input focus. Listeners will be called with the following arguments: `this` : Ext.form.Field | Field
| hide : ( `Ext.Component this` ) Fires after the component is hidden. Fires after the component is hidden. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| invalid : ( `Ext.form.Field this`, `String msg` ) Fires after the field has been marked as invalid. Fires after the field has been marked as invalid. Listeners will be called with the following arguments: `this` : Ext.form.Field `msg` : String The validation message | Field
| move : ( `Ext.Component this`, `Number x`, `Number y` ) Fires after the component is moved. Fires after the component is moved. Listeners will be called with the following arguments: `this` : Ext.Component `x` : Number The new x position `y` : Number The new y position | BoxComponent
| render : ( `Ext.Component this` ) Fires after the component is rendered. Fires after the component is rendered. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| resize : ( `Ext.Component this`, `Number adjWidth`, `Number adjHeight`, `Number rawWidth`, `Number rawHeight` ) Fires after the component is resized. Fires after the component is resized. Listeners will be called with the following arguments: `this` : Ext.Component `adjWidth` : Number The box-adjusted width that was set `adjHeight` : Number The box-adjusted height that was set `rawWidth` : Number The width that was originally specified `rawHeight` : Number The height that was originally specified | BoxComponent
| select : ( `Ext.form.ComboBox combo`, `Ext.data.Record record`, `Number index` ) Fires when a list item is selected Fires when a list item is selected Listeners will be called with the following arguments: `combo` : Ext.form.ComboBox This combo box `record` : Ext.data.Record The data record returned from the underlying store `index` : Number The index of the selected item in the dropdown list | ComboBox
| show : ( `Ext.Component this` ) Fires after the component is shown. Fires after the component is shown. Listeners will be called with the following arguments: `this` : Ext.Component | Component
| specialkey : ( `Ext.form.Field this`, `Ext.EventObject e` ) Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check Ext.EventObject.g... Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check Ext.EventObject.getKey to determine which key was pressed. Listeners will be called with the following arguments: `this` : Ext.form.Field `e` : Ext.EventObject The event object | Field
| staterestore : ( `Ext.Component this`, `Object state` ) Fires after the state of the component is restored. Fires after the state of the component is restored. Listeners will be called with the following arguments: `this` : Ext.Component `state` : Object The hash of state values | Component
| statesave : ( `Ext.Component this`, `Object state` ) Fires after the state of the component is saved to the configured state provider. Fires after the state of the component is saved to the configured state provider. Listeners will be called with the following arguments: `this` : Ext.Component `state` : Object The hash of state values | Component
| valid : ( `Ext.form.Field this` ) Fires after the field has been validated with no errors. Fires after the field has been validated with no errors. Listeners will be called with the following arguments: `this` : Ext.form.Field | Field