Ext JS 2.3.0 Sencha Docs

Ext.form.ComboBox

Hierarchy

Subclasses

Files

A combobox control with support for autocomplete, remote-loading, paging and many other features.

A ComboBox works in a similar manner to a traditional HTML <select> field. The difference is that to submit the valueField, you must specify a hiddenName to create a hidden input field to hold the value of the valueField. The displayField is shown in the text field which is named according to the name.

Available since: 1.1.0

Defined By

Config options

Ext.form.ComboBox
view source
: String
The text query to send to the server to return all records for the list with no filtering (defaults to '') ...

The text query to send to the server to return all records for the list with no filtering (defaults to '')

Defaults to: ''

Available since: 1.1.0

False to validate that the value length > 0 (defaults to true) ...

False to validate that the value length > 0 (defaults to true)

Defaults to: true

Available since: 1.1.0

Whether the component can move the Dom node when rendering (defaults to true). ...

Whether the component can move the Dom node when rendering (defaults to true).

Defaults to: true

Available since: 1.1.0

The id of the element, a DOM element or an existing Element corresponding to a DIV that is already present in the doc...

The id of the element, a DOM element 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.

Available since: Ext JS 2.3.0

Ext.form.ComboBox
view source
: Boolean/Object
A DomHelper element spec, or true for a default element spec (defaults to: {tag: "input", type: "text", size: "24", a...

A DomHelper element spec, or true for a default element spec (defaults to: {tag: "input", type: "text", size: "24", autocomplete: "off"})

Available since: 1.1.0

Overrides: Ext.form.TriggerField.autoCreate

True if the component should check for hidden classes (e.g. ...

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).

Defaults to: false

Available since: Ext JS 2.3.0

Error text to display if the allow blank validation fails (defaults to "This field is required") ...

Error text to display if the allow blank validation fails (defaults to "This field is required")

Defaults to: "This field is required"

Available since: 1.1.0

The CSS class used to provide field clearing (defaults to 'x-form-clear-left')

The CSS class used to provide field clearing (defaults to 'x-form-clear-left')

Available since: Ext JS 2.3.0

Overrides: Ext.Component.clearCls

A custom CSS class to apply to the field's underlying element (defaults to "").

A custom CSS class to apply to the field's underlying element (defaults to "").

Available since: 1.1.0

Overrides: Ext.Component.cls

An optional extra CSS class that will be added to this component's container (defaults to ''). ...

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.

Available since: Ext JS 2.3.0

True to disable input keystroke filtering (defaults to false) ...

True to disable input keystroke filtering (defaults to false)

Defaults to: false

Available since: 1.1.0

True to disable the field (defaults to false). ...

True to disable the field (defaults to false).

Be aware that conformant with the HTML specification, disabled Fields will not be submitted.

Defaults to: false

Available since: 1.1.0

Overrides: Ext.Component.disabled

CSS class added to the component when it is disabled (defaults to "x-item-disabled"). ...

CSS class added to the component when it is disabled (defaults to "x-item-disabled").

Defaults to: "x-item-disabled"

Available since: Ext JS 2.3.0

Ext.form.ComboBox
view source
: 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)

Available since: 1.1.0

Ext.form.ComboBox
view source
: Boolean
False to prevent the user from typing text directly into the field, just like a traditional select (defaults to true) ...

False to prevent the user from typing text directly into the field, just like a traditional select (defaults to true)

Defaults to: true

Available since: 1.1.0

The CSS class to apply to an empty field to style the emptyText (defaults to 'x-form-empty-field'). ...

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.

Defaults to: 'x-form-empty-field'

Available since: 1.1.0

The default text to place into an empty field (defaults to null). ...

The default text to place into an empty field (defaults to null). Note that this value will be submitted to the server if this field is enabled and configured with a name.

Available since: 1.1.0

True to enable the proxying of key events for the HTML input field (defaults to false)

True to enable the proxying of key events for the HTML input field (defaults to false)

Available since: Ext JS 2.3.0

The default CSS class for the field (defaults to "x-form-field") ...

The default CSS class for the field (defaults to "x-form-field")

Defaults to: "x-form-field"

Available since: 1.1.0

The label text to display next to this field (defaults to '') A Field's label is not by default rendered as part of ...

The label text to display next to this field (defaults to '')

A Field's label is not by default rendered as part of the Field's structure. The label is rendered by the form layout layout manager of the Container to which the Field is added.

Available since: 1.1.0

Overrides: Ext.Component.fieldLabel

The CSS class to use when the field receives focus (defaults to "x-form-focus") ...

The CSS class to use when the field receives focus (defaults to "x-form-focus")

Defaults to: "x-form-focus"

Available since: 1.1.0

Ext.form.ComboBox
view source
: 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)

Defaults to: false

Available since: 1.1.0

Ext.form.ComboBox
view source
: Number
The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8) ...

The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)

Defaults to: 8

Available since: 1.1.0

The height of this component in pixels (defaults to auto).

The height of this component in pixels (defaults to auto).

Available since: Ext JS 2.3.0

Render this component hidden (default is false).

Render this component hidden (default is false).

Available since: Ext JS 2.3.0

Ext.form.ComboBox
view source
: String
If hiddenName is specified, hiddenId can also be provided to give the hidden field a unique id (defaults to the hidde...

If hiddenName is specified, hiddenId can also be provided to give the hidden field a unique id (defaults to the hiddenName). The hiddenId and combo id should be different, since no two DOM nodes should share the same id.

Available since: 1.1.0

Ext.form.ComboBox
view source
: 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. Note that the hidden field's id will also default to this name if hiddenId is not specified. The combo's id and the hidden field's ids should be different, since no two DOM nodes should share the same id, so if the combo and hidden names are the same, you should specify a unique hiddenId.

Available since: 1.1.0

True to completely hide the label element (defaults to false)

True to completely hide the label element (defaults to false)

Available since: Ext JS 2.3.0

Overrides: Ext.Component.hideLabel

How this component should be hidden. ...

How this component should be hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display".

For Containers which may be hidden and shown as part of a card layout Container such as a TabPanel, it is recommended that hideMode is configured as "offsets". This ensures that hidden Components still have height and width so that layout managers can perform measurements when calculating layouts.

Defaults to: 'display'

Available since: 1.1.0

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.

Defaults to: false

Available since: Ext JS 2.3.0

True to hide the trigger element and display only the base text field (defaults to false) ...

True to hide the trigger element and display only the base text field (defaults to false)

Defaults to: false

Available since: 1.1.0

The unique id of this component (defaults to an auto-assigned id). ...

The unique id of this component (defaults to an auto-assigned id). You should assign an id if you need to be able to access the component later and you do not have an object reference available (e.g., using Ext.ComponentMgr.getCmp). Note that this id will also be used as the element id for the containing HTML element that is rendered to the page for this component. This allows you to write id-based CSS rules to style the specific instance of this component uniquely, and also to select sub-elements using this component's id as the parent.

Available since: 1.1.0

The type attribute for input fields -- e.g. ...

The type attribute for input fields -- e.g. radio, text, password, file (defaults to "text"). The types "file" and "password" must be used to render those field types currently -- there are no separate Ext components for those. Note that if you use inputType:'file', emptyText is not supported and should be avoided.

Available since: 1.1.0

The CSS class to use when marking a field invalid (defaults to "x-form-invalid") ...

The CSS class to use when marking a field invalid (defaults to "x-form-invalid")

Defaults to: "x-form-invalid"

Available since: 1.1.0

The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field i...

The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid")

Defaults to: "The value in this field is invalid"

Available since: 1.1.0

An additional CSS class to apply to the wrapper's form item element of this field (defaults to the container's itemCl...

An additional CSS class to apply to the wrapper's form item element of this field (defaults to the container's itemCls value if set, or ''). Since it is applied to the item wrapper, it allows you to write standard CSS rules that can apply to the field, the label (if specified) or any other element within the markup for the field. NOTE: this will not have any effect on fields that are not part of a form. Example use:

// Apply a style to the field's label:
<style>
    .required .x-form-item-label {font-weight:bold;color:red;}
</style>

new Ext.FormPanel({
    height: 100,
    renderTo: document.body,
    items: [{
        xtype: 'textfield',
        fieldLabel: 'Name',
        itemCls: 'required' //this label will be styled
    },{
        xtype: 'textfield',
        fieldLabel: 'Favorite Color'
    }]
});

Available since: 1.1.0

Overrides: Ext.Component.itemCls

Ext.form.ComboBox
view source
: String
This setting is required if a custom XTemplate has been specified in tpl which assigns a class other than 'x-combo-l...

This setting is required if a custom XTemplate has been specified in tpl which assigns a class other than

'x-combo-list-item'

to dropdown list items. A simple CSS selector (e.g. div.some-class or span:first-child) that will be used to determine what nodes the DataView which handles the dropdown display will be working with.

Available since: Ext JS 2.3.0

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 ''.

Available since: 1.1.0

Overrides: Ext.Component.labelSeparator

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;'.

Available since: 1.1.0

Overrides: Ext.Component.labelStyle

Ext.form.ComboBox
view source
: Boolean
True to not initialize the list for this combo until the field is focused (defaults to true) ...

True to not initialize the list for this combo until the field is focused (defaults to true)

Defaults to: true

Available since: Ext JS 2.3.0

Ext.form.ComboBox
view source
: 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).

Available since: 1.1.0

Ext.form.ComboBox
view source
: String
A valid anchor position value. ...

A valid anchor position value. See Ext.Element.alignTo for details on supported anchor positions (defaults to 'tl-bl')

Defaults to: 'tl-bl?'

Available since: 1.1.0

Ext.form.ComboBox
view source
: String
CSS class to apply to the dropdown list element (defaults to '') ...

CSS class to apply to the dropdown list element (defaults to '')

Defaults to: ''

Available since: 1.1.0

Ext.form.ComboBox
view source
: Number
The width (used as a parameter to Ext.Element.setWidth) of the dropdown list (defaults to the width of the ComboBox f...

The width (used as a parameter to Ext.Element.setWidth) of the dropdown list (defaults to the width of the ComboBox field)

Available since: 1.1.0

(optional) A config object containing one or more event handlers to be added to this object during initialization. ...

(optional) 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.

Available since: 1.1.0

Ext.form.ComboBox
view source
: String
The text to display in the dropdown list while data is loading. ...

The text to display in the dropdown list while data is loading. Only applies when mode = 'remote' (defaults to 'Loading...')

Defaults to: 'Loading...'

Available since: 1.1.0

An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)

An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)

Available since: 1.1.0

Ext.form.ComboBox
view source
: Number
The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300) ...

The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)

Defaults to: 300

Available since: 1.1.0

Maximum input field length allowed (defaults to Number.MAX_VALUE)

Maximum input field length allowed (defaults to Number.MAX_VALUE)

Available since: 1.1.0

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}")

Defaults to: "The maximum length for this field is {0}"

Available since: 1.1.0

Ext.form.ComboBox
view source
: 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)

Defaults to: 4

Available since: 1.1.0

Ext.form.ComboBox
view source
: Number
The minimum height in pixels of the dropdown list when the list is constrained by its distance to the viewport edges ...

The minimum height in pixels of the dropdown list when the list is constrained by its distance to the viewport edges (defaults to 90)

Defaults to: 90

Available since: Ext JS 2.3.0

Minimum input field length required (defaults to 0) ...

Minimum input field length required (defaults to 0)

Defaults to: 0

Available since: 1.1.0

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}")

Defaults to: "The minimum length for this field is {0}"

Available since: 1.1.0

Ext.form.ComboBox
view source
: Number
The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if listWidth has a higher value) ...

The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if listWidth has a higher value)

Defaults to: 70

Available since: 1.1.0

Ext.form.ComboBox
view source
: String
Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server) ...

Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)

Defaults to: 'remote'

Available since: 1.1.0

Experimental The effect used when displaying a validation message under the field (defaults to 'normal'). ...

Experimental The effect used when displaying a validation message under the field (defaults to 'normal').

Defaults to: 'normal'

Available since: 1.1.0

The location where error text should display. ...

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

Defaults to: 'qtip'

Available since: 1.1.0

The field's HTML name attribute (defaults to "").

The field's HTML name attribute (defaults to "").

Available since: 1.1.0

An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and...

An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and removed when the mouse moves out. (defaults to ''). This can be useful for adding customized "active" or "hover" styles to the component or any of its children using standard CSS rules.

Available since: Ext JS 2.3.0

Ext.form.ComboBox
view source
: 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)

Defaults to: 0

Available since: 1.1.0

The page level x coordinate for this component if contained within a positioning container.

The page level x coordinate for this component if contained within a positioning container.

Available since: Ext JS 2.3.0

The page level y coordinate for this component if contained within a positioning container.

The page level y coordinate for this component if contained within a positioning container.

Available since: Ext JS 2.3.0

An object or array of objects that will provide custom functionality for this component. ...

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.

Available since: Ext JS 2.3.0

Ext.form.ComboBox
view source
: 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')

Defaults to: 500

Available since: 1.1.0

Ext.form.ComboBox
view source
: String
Name of the query as it will be passed on the querystring (defaults to 'query') ...

Name of the query as it will be passed on the querystring (defaults to 'query')

Defaults to: 'query'

Available since: 1.1.0

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.

Defaults to: false

Available since: 1.1.0

A JavaScript RegExp object to be tested against the field value during validation (defaults to null). ...

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.

Available since: 1.1.0

The error text to display if regex is used and the test fails during validation (defaults to "") ...

The error text to display if regex is used and the test fails during validation (defaults to "")

Defaults to: ""

Available since: 1.1.0

The id of the element, a DOM element or an existing Element that this component will be rendered into. ...

The id of the element, a DOM element or an existing Element that this component will be rendered into. When using this config, a call to render() is not required.

If this Component needs to be managed by a Container's layout manager, do not use this option. It is the responsiblity of the Container's layout manager to perform rendering. See render.

Available since: Ext JS 2.3.0

Ext.form.ComboBox
view source
: Boolean
True to add a resize handle to the bottom of the dropdown list (defaults to false) ...

True to add a resize handle to the bottom of the dropdown list (defaults to false)

Defaults to: false

Available since: 1.1.0

Ext.form.ComboBox
view source
: Boolean
True to select any existing text in the field immediately on focus. ...

True to select any existing text in the field immediately on focus. Only applies when editable = true (defaults to false)

Defaults to: false

Available since: 1.1.0

Overrides: Ext.form.TextField.selectOnFocus

Ext.form.ComboBox
view source
: String
CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected') ...

CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')

Defaults to: 'x-combo-selected'

Available since: 1.1.0

Ext.form.ComboBox
view source
: Boolean/String
True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right ...

True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right

Defaults to: 'sides'

Available since: 1.1.0

The unique id for this component to use for state management purposes (defaults to the component id if one was set, o...

The unique id for this component to use for state management purposes (defaults to the component id if one was set, otherwise null if the component is using a generated id).

See stateful for an explanation of saving and restoring Component state.

Available since: Ext JS 2.3.0

A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startup. ...

A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startup. The component must have either a stateId or id assigned for state to be managed. Auto-generated ids are not guaranteed to be stable across page loads and cannot be relied upon to save and restore the same state for a component.

For state saving to work, the state manager's provider must have been set to an implementation of Ext.state.Provider which overrides the set and get methods to save and recall name/value pairs. A built-in implementation, Ext.state.CookieProvider is available.

To set the state provider for the current page:

Ext.state.Manager.setProvider(new Ext.state.CookieProvider());

Components attempt to save state when one of the events listed in the stateEvents configuration fires.

You can perform extra processing on state save and restore by attaching handlers to the beforestaterestore, staterestore, beforestatesave and statesave events

Available since: Ext JS 2.3.0

The data source to which this combo is bound (defaults to undefined). ...

The data source to which this combo is bound (defaults to undefined). This can be any Ext.data.Store subclass, a 1-dimensional array (e.g., ['Foo','Bar']) or a 2-dimensional array (e.g., [['f','Foo'],['b','Bar']]). Arrays will be converted to a Ext.data.SimpleStore internally. 1-dimensional arrays will automatically be expanded (each array item will be the combo value and text) and for multi-dimensional arrays, the value in index 0 of each item will be assumed to be the combo value, while the value at index 1 is assumed to be the combo text.

Available since: 1.1.0

A JavaScript RegExp object used to strip unwanted content from the value before validation (defaults to null).

A JavaScript RegExp object used to strip unwanted content from the value before validation (defaults to null).

Available since: Ext JS 2.3.0

A custom style specification to be applied to this component's Element. ...

A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.applyStyles.

Available since: 1.1.0

The tabIndex for this field. ...

The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).

Available since: 1.1.0

Ext.form.ComboBox
view source
: 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)

Available since: 1.1.0

Ext.form.ComboBox
view source
: String/Ext.XTemplate
The template string, or Ext.XTemplate instance to use to display each item in the dropdown list. ...

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.

Available since: Ext JS 2.3.0

Ext.form.ComboBox
view source
: Mixed
The id, DOM node or element of an existing HTML SELECT to convert to a ComboBox. ...

The id, DOM node or element of an existing HTML SELECT to convert to a ComboBox. Note that if you specify this and the combo is going to be in a Ext.form.BasicForm or Ext.form.FormPanel, you must also set lazyRender = true.

Available since: 1.1.0

Ext.form.ComboBox
view source
: String
The action to execute when the trigger is clicked. ...

The action to execute when the trigger is clicked. Use 'all' to run the query specified by the allQuery config option (defaults to 'query')

Defaults to: 'query'

Available since: 1.1.0

Ext.form.ComboBox
view source
: String
An additional CSS class used to style the trigger button. ...

An additional CSS class used to style the trigger button. The trigger will always get the class 'x-form-trigger' and triggerClass will be appended if specified (defaults to 'x-form-arrow-trigger' which displays a downward arrow icon).

Defaults to: 'x-form-arrow-trigger'

Available since: 1.1.0

Overrides: Ext.form.TriggerField.triggerClass

A DomHelper config object specifying the structure of the trigger element for this Field. ...

A DomHelper config object specifying the structure of the trigger element for this Field. (Optional).

Specify this when you need a customized element to act as the trigger button for a TriggerField.

Note that when using this option, it is the developer's responsibility to ensure correct sizing, positioning and appearance of the trigger.

Available since: Ext JS 2.3.0

Ext.form.ComboBox
view source
: 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)

Defaults to: false

Available since: 1.1.0

The length of time in milliseconds to wait until the typeahead text is displayed if typeAhead = true (defaults to 250) ...

The length of time in milliseconds to wait until the typeahead text is displayed if typeAhead = true (defaults to 250)

Defaults to: 250

Available since: 1.1.0

Whether the field should validate when it loses focus (defaults to true). ...

Whether the field should validate when it loses focus (defaults to true).

Defaults to: true

Available since: 1.1.0

The length of time in milliseconds after user input begins until validation is initiated (defaults to 250) ...

The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)

Defaults to: 250

Available since: 1.1.0

The event that should initiate field validation. ...

The event that should initiate field validation. Set to false to disable automatic validation (defaults to "keyup").

Defaults to: "keyup"

Available since: 1.1.0

A custom validation function to be called during field validation (defaults to null). ...

A custom validation function to be called during field validation (defaults to null). If specified, this function will be called only after the built-in validations (allowBlank, minLength, maxLength) and any configured vtype all return true. This function 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.

Available since: 1.1.0

A value to initialize this field with (defaults to undefined).

A value to initialize this field with (defaults to undefined).

Available since: 1.1.0

Ext.form.ComboBox
view source
: 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.

Available since: 1.1.0

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). If this defaut text is used, it means there is no value set and no validation will occur on this field.

Available since: 1.1.0

A validation type name as defined in Ext.form.VTypes (defaults to null)

A validation type name as defined in Ext.form.VTypes (defaults to null)

Available since: 1.1.0

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.

Available since: 1.1.0

The width of this component in pixels (defaults to auto).

The width of this component in pixels (defaults to auto).

Available since: Ext JS 2.3.0

The local x (left) coordinate for this component if contained within a positioning container.

The local x (left) coordinate for this component if contained within a positioning container.

Available since: Ext JS 2.3.0

The registered xtype to create. ...

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.

Available since: Ext JS 2.3.0

The local y (top) coordinate for this component if contained within a positioning container.

The local y (top) coordinate for this component if contained within a positioning container.

Available since: Ext JS 2.3.0

Defined By

Properties

...

Defaults to: 'wrap'

Available since: Ext JS 2.3.0

private

private

Available since: Ext JS 2.3.0

private, set in afterRender to signify that the component has been rendered ...

private, set in afterRender to signify that the component has been rendered

Defaults to: false

Available since: Ext JS 2.3.0

Ext.form.ComboBox
view source
: Objectprivate
private ...

private

Defaults to: {tag: "input", type: "text", size: "24", autocomplete: "off"}

Available since: Ext JS 2.3.0

private ...

private

Defaults to: true

Available since: Ext JS 2.3.0

Overrides: Ext.BoxComponent.deferHeight

True if this component is disabled. ...

True if this component is disabled. Read-only.

Defaults to: false

Available since: 1.1.0

private ...

private

Defaults to: false

Available since: Ext JS 2.3.0

True if this component is hidden. ...

True if this component is hidden. Read-only.

Defaults to: false

Available since: 1.1.0

This Component's initial configuration specification. ...

This Component's initial configuration specification. Read-only.

Available since: Ext JS 2.3.0

private ...

private

Defaults to: true

Available since: Ext JS 2.3.0

Ext.form.ComboBox
view source
: String
The value of the match string used to filter the store. ...

The value of the match string used to filter the store. Delete this property to force a requery. Example use:

var combo = new Ext.form.ComboBox({
    ...
    mode: 'remote',
    ...
    listeners: {
        // delete the previous query in the beforequery event or set 
        // combo.lastQuery = null (this will reload the store the next time it expands)
        beforequery: function(qe){
            delete qe.combo.lastQuery;
        }
    }
});

Available since: Ext JS 2.3.0

private ...

private

Defaults to: false

Available since: Ext JS 2.3.0

private ...

private

Defaults to: true

Available since: Ext JS 2.3.0

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.

Available since: Ext JS 2.3.0

True if this component has been rendered. ...

True if this component has been rendered. Read-only.

Defaults to: false

Available since: 1.1.0

Ext.form.ComboBox
view source
: Ext.DataView

The DataView used to display the ComboBox's options.

The DataView used to display the ComboBox's options.

Available since: 1.1.0

Defined By

Methods

Ext.form.ComboBox
view source
new( config ) : Ext.form.ComboBox
Create a new ComboBox. ...

Create a new ComboBox.

Available since: 1.1.0

Parameters

  • config : Object

    Configuration options

Returns

Overrides: Ext.form.TriggerField.constructor

Adds a CSS class to the component's underlying element. ...

Adds a CSS class to the component's underlying element.

Available since: Ext JS 2.3.0

Parameters

  • cls : string

    The CSS class name to add

Used to define events on this Observable ...

Used to define events on this Observable

Available since: 1.1.0

Parameters

  • object : Object

    The object with the events defined

( eventName, handler, [scope], [options] )
Appends an event handler to this component ...

Appends an event handler to this component

Available since: 1.1.0

Parameters

  • eventName : String

    The type of event to listen for

  • handler : Function

    The method the event invokes

  • scope : Object (optional)

    The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

  • options : Object (optional)

    An object containing handler configuration properties. This may contain any of the following properties:

    • scope : Object
      The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.
    • 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.
    • target : Observable
      Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

    Combining Options
    Using the options argument, it is possible to combine different types of listeners:

    A delayed, one-time listener.

    myDataView.on('click', this.onClick, this, {
        single: true,
        delay: 100
    });

    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.

    myGridPanel.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:

    myGridPanel.on({
        'click' : this.onClick,
        'mouseover' : this.onMouseOver,
        'mouseout' : this.onMouseOut,
         scope: this
    });

Fires

    private ...

    private

    Available since: Ext JS 2.3.0

    Parameters

    • x : Object
    • y : Object
    private ...

    private

    Available since: Ext JS 2.3.0

    Parameters

    • w : Object
    • h : Object

    Fires

      Overrides: Ext.BoxComponent.adjustSize

      private ...

      private

      Available since: Ext JS 2.3.0

      Parameters

      • tag : Object
      • w : Object
      private ...

      private

      Available since: Ext JS 2.3.0

      Overrides: Ext.form.Field.afterRender

      private ...

      private

      Available since: Ext JS 2.3.0

      Overrides: Ext.form.Field.alignErrorIcon

      ...

      Available since: Ext JS 2.3.0

      Fires

        Apply this component to existing markup that is valid. ...

        Apply this component to existing markup that is valid. With this function, no call to render() is required.

        Available since: Ext JS 2.3.0

        Parameters

        Fires

        Ext.form.ComboBox
        view source
        ( )private
        private ...

        private

        Available since: Ext JS 2.3.0

        Fires

          Overrides: Ext.form.TriggerField.beforeBlur

          Ext.form.ComboBox
          view source
          ( store, initial )private
          private ...

          private

          Available since: Ext JS 2.3.0

          Parameters

          • store : Object
          • initial : Object
          private ...

          private

          Available since: Ext JS 2.3.0

          Parameters

          • e : Object

          Fires

            Clear any invalid styles/messages for this field ...

            Clear any invalid styles/messages for this field

            Available since: 1.1.0

            Fires

            Ext.form.ComboBox
            view source
            ( )
            Clears any text/value currently set in the field ...

            Clears any text/value currently set in the field

            Available since: 1.1.0

            Fires

              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.

              Available since: Ext JS 2.3.0

              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.form.ComboBox
              view source
              ( )
              Hides the dropdown list if it is currently expanded. ...

              Hides the dropdown list if it is currently expanded. Fires the collapse event on completion.

              Available since: 1.1.0

              Fires

              Ext.form.ComboBox
              view source
              ( e )private
              private ...

              private

              Available since: Ext JS 2.3.0

              Parameters

              • e : Object

              Fires

              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.

              Available since: 1.1.0

              Fires

              Disable this component. ...

              Disable this component.

              Available since: 1.1.0

              Returns

              Fires

              Ext.form.ComboBox
              view source
              ( query, forceAll )
              Execute a query to filter the dropdown list. ...

              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.

              Available since: 1.1.0

              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)

              Fires

              Enable this component. ...

              Enable this component.

              Available since: 1.1.0

              Returns

              Fires

              Ext.form.ComboBox
              view source
              ( )
              Expands the dropdown list if it is currently hidden. ...

              Expands the dropdown list if it is currently hidden. Fires the expand event on completion.

              Available since: 1.1.0

              Fires

              private ...

              private

              Available since: Ext JS 2.3.0

              Parameters

              • e : Object
              ...

              Available since: Ext JS 2.3.0

              Parameters

              • e : Object
              Find a container above this component at any level by a custom function. ...

              Find a container above this component at any level by a custom function. If the passed function returns true, the container will be returned. The passed function is called with the arguments (container, this component).

              Available since: Ext JS 2.3.0

              Parameters

              • fcn : Function
              • scope : Object (optional)

              Returns

              • Ext.Container

                The first Container for which the custom function returns true

              Find a container above this component at any level by xtype or class ...

              Find a container above this component at any level by xtype or class

              Available since: Ext JS 2.3.0

              Parameters

              • xtype : String/Class

                The xtype string for a component, or the class of the component directly

              Returns

              • Ext.Container

                The first Container which matches the given xtype or class

              Fires

                Ext.form.ComboBox
                view source
                ( prop, value )private
                private ...

                private

                Available since: Ext JS 2.3.0

                Parameters

                • prop : Object
                • value : Object
                ( eventName, 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).

                Available since: 1.1.0

                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

                Ext.form.ComboBox
                view source
                ( e )private
                private ...

                private

                Available since: Ext JS 2.3.0

                Parameters

                • e : Object

                Fires

                Overrides: Ext.form.Field.fireKey

                ( [selectText], [delay] ) : Ext.Componentchainable
                Try to focus this component. ...

                Try to focus this component.

                Available since: 1.1.0

                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

                Gets the current box measurements of the component's underlying element. ...

                Gets the current box measurements of the component's underlying element.

                Available since: 1.1.0

                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}

                Returns the underlying Ext.Element. ...

                Returns the underlying Ext.Element.

                Available since: 1.1.0

                Returns

                private ...

                private

                Available since: Ext JS 2.3.0

                Returns the id of this component. ...

                Returns the id of this component.

                Available since: 1.1.0

                Returns

                Returns the item id of this component. ...

                Returns the item id of this component.

                Available since: Ext JS 2.3.0

                Returns

                Fires

                  Ext.form.ComboBox
                  view source
                  ( ) : String
                  inherit docs ...

                  inherit docs

                  Available since: 1.1.0

                  Returns

                  Overrides: Ext.form.Field.getName

                  Ext.form.ComboBox
                  view source
                  ( q )private
                  private ...

                  private

                  Available since: Ext JS 2.3.0

                  Parameters

                  • q : Object
                  Gets the current XY position of the component's underlying element. ...

                  Gets the current XY position of the component's underlying element.

                  Available since: 1.1.0

                  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])

                  private ...

                  private

                  Available since: Ext JS 2.3.0

                  Overrides: Ext.BoxComponent.getPositionEl

                  Returns the raw data value which may or may not be a valid, defined value. ...

                  Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue.

                  Available since: 1.1.0

                  Returns

                  • Mixed

                    value The field value

                  private ...

                  private

                  Available since: Ext JS 2.3.0

                  Overrides: Ext.BoxComponent.getResizeEl

                  Gets the current size of the component's underlying element. ...

                  Gets the current size of the component's underlying element.

                  Available since: 1.1.0

                  Returns

                  • Object

                    An object containing the element's size {width: (element width), height: (element height)}

                  Ext.form.ComboBox
                  view source
                  ( ) : Ext.data.Store
                  Returns the store associated with this combo. ...

                  Returns the store associated with this combo.

                  Available since: Ext JS 2.3.0

                  Returns

                  Ext.form.ComboBox
                  view source
                  ( ) : String
                  Returns the currently selected field value or empty string if no value is set. ...

                  Returns the currently selected field value or empty string if no value is set.

                  Available since: 1.1.0

                  Returns

                  • String

                    value The selected value

                  Overrides: Ext.form.Field.getValue, Ext.form.ComboBox.getValue

                  Gets the xtype for this component as registered with Ext.ComponentMgr. ...

                  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'
                  

                  Available since: Ext JS 2.3.0

                  Returns

                  Returns this Component's xtype hierarchy as a slash-delimited string. ...

                  Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the Ext.Component header.

                  If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes.

                  Example usage:

                  var t = new Ext.form.TextField();
                  alert(t.getXTypes());  // alerts 'component/box/field/textfield'
                  

                  Available since: Ext JS 2.3.0

                  Returns

                  • String

                    The xtype hierarchy string

                  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

                  Available since: 1.1.0

                  Parameters

                  • eventName : String

                    The name of the event to check for

                  Returns

                  • Boolean

                    True if the event is being listened for, else false

                  Hide this component. ...

                  Hide this component.

                  Available since: 1.1.0

                  Returns

                  Fires

                  Ext.form.ComboBox
                  view source
                  ( )private
                  private ...

                  private

                  Available since: Ext JS 2.3.0

                  Fires

                  Overrides: Ext.form.Field.initComponent

                  Ext.form.ComboBox
                  view source
                  ( )private
                  private ...

                  private

                  Available since: Ext JS 2.3.0

                  Fires

                  Overrides: Ext.form.TextField.initEvents

                  Ext.form.ComboBox
                  view source
                  ( )private
                  private ...

                  private

                  Available since: Ext JS 2.3.0

                  Fires

                    Ext.form.ComboBox
                    view source
                    ( )private
                    private ...

                    private

                    Available since: Ext JS 2.3.0

                    Fires

                    private ...

                    private

                    Available since: Ext JS 2.3.0

                    Ext.form.ComboBox
                    view source
                    ( )private
                    private ...

                    private

                    Available since: Ext JS 2.3.0

                    Overrides: Ext.form.Field.initValue

                    Returns true if the value of this Field has been changed from its original value. ...

                    Returns true if the value of this Field has been changed from its original value. Will return false if the field is disabled or has not been rendered yet.

                    Note that if the owning form was configured with Ext.form.BasicForm.trackResetOnLoad then the original value is updated when the values are loaded by Ext.form.BasicForm.setValues.

                    Available since: 1.1.0

                    Returns

                    • Boolean

                      True if this field has been changed from its original value (and is not disabled), false otherwise.

                    Fires

                      Ext.form.ComboBox
                      view source
                      ( )
                      Returns true if the dropdown list is expanded, else false. ...

                      Returns true if the dropdown list is expanded, else false.

                      Available since: 1.1.0

                      ( preventMark ) : Boolean
                      Returns whether or not the field value is currently valid ...

                      Returns whether or not the field value is currently valid

                      Available since: 1.1.0

                      Parameters

                      • preventMark : Boolean

                        True to disable marking the field invalid

                      Returns

                      • Boolean

                        True if the value is valid, else false

                      Fires

                      Returns true if this component is visible. ...

                      Returns true if this component is visible.

                      Available since: 1.1.0

                      Returns

                      • Boolean

                        True if this component is visible, false otherwise.

                      Fires

                        ( xtype, [shallow] ) : Boolean
                        Tests whether or not this Component is of a specific xtype. ...

                        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).

                        If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes.

                        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
                        

                        Available since: Ext JS 2.3.0

                        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

                        • Boolean

                          True if this component descends from the specified xtype, false otherwise.

                        Fires

                          Mark this field as invalid, using msgTarget to determine how to display the error and applying invalidClass to the fi...

                          Mark this field as invalid, using msgTarget to determine how to display the error and applying invalidClass to the field's element.

                          Available since: 1.1.0

                          Parameters

                          Fires

                          private ...

                          private

                          Available since: Ext JS 2.3.0

                          Parameters

                          • e : Object

                          Fires

                            ( eventName, handler, [scope], [options] )
                            Appends an event handler to this element (shorthand for addListener) ...

                            Appends an event handler to this element (shorthand for addListener)

                            Available since: 1.1.0

                            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)
                            Ext.form.ComboBox
                            view source
                            ( )private
                            private ...

                            private

                            Available since: Ext JS 2.3.0

                            Fires

                              private ...

                              private

                              Available since: Ext JS 2.3.0

                              Overrides: Ext.form.Field.onBlur

                              Ext.form.ComboBox
                              view source
                              ( )private
                              private ...

                              private

                              Available since: Ext JS 2.3.0

                              Fires

                                Overrides: Ext.form.TriggerField.onDestroy

                                Ext.form.ComboBox
                                view source
                                ( )private
                                private ...

                                private

                                Available since: Ext JS 2.3.0

                                Overrides: Ext.form.TextField.onDisable

                                Ext.form.ComboBox
                                view source
                                ( )private
                                private ...

                                private

                                Available since: Ext JS 2.3.0

                                Fires

                                Ext.form.ComboBox
                                view source
                                ( )private
                                private ...

                                private

                                Available since: Ext JS 2.3.0

                                Overrides: Ext.form.TextField.onEnable

                                private ...

                                private

                                Available since: Ext JS 2.3.0

                                Overrides: Ext.form.Field.onFocus

                                private ...

                                private

                                Available since: Ext JS 2.3.0

                                Parameters

                                • e : Object

                                Fires

                                private ...

                                private

                                Available since: Ext JS 2.3.0

                                Parameters

                                • e : Object

                                Fires

                                Ext.form.ComboBox
                                view source
                                ( e )private
                                private ...

                                private

                                Available since: Ext JS 2.3.0

                                Parameters

                                • e : Object

                                Overrides: Ext.form.TextField.onKeyUp

                                private ...

                                private

                                Available since: Ext JS 2.3.0

                                Parameters

                                • e : Object

                                Fires

                                  Ext.form.ComboBox
                                  view source
                                  ( )private
                                  private ...

                                  private

                                  Available since: Ext JS 2.3.0

                                  Fires

                                  // protected Called after the component is moved, this method is empty by default but can be implemented by any subcl...

                                  // protected Called after the component is moved, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a move occurs.

                                  Available since: 1.1.0

                                  Parameters

                                  Ext.form.ComboBox
                                  view source
                                  ( ct, position )private
                                  private ...

                                  private

                                  Available since: Ext JS 2.3.0

                                  Parameters

                                  • ct : Object
                                  • position : Object

                                  Fires

                                    Overrides: Ext.form.TriggerField.onRender

                                    Ext.form.ComboBox
                                    view source
                                    ( w, h )private
                                    private ...

                                    private

                                    Available since: 1.1.0

                                    Parameters

                                    • w : Object
                                    • h : Object

                                    Overrides: Ext.form.TriggerField.onResize

                                    Ext.form.ComboBox
                                    view source
                                    ( record, index )private
                                    private ...

                                    private

                                    Available since: Ext JS 2.3.0

                                    Parameters

                                    • record : Object
                                    • index : Object

                                    Fires

                                    Ext.form.ComboBox
                                    view source
                                    ( )private
                                    private ...

                                    private

                                    Available since: Ext JS 2.3.0

                                    Fires

                                      Ext.form.ComboBox
                                      view source
                                      ( doFocus )private
                                      private ...

                                      private

                                      Available since: Ext JS 2.3.0

                                      Parameters

                                      • doFocus : Object

                                      Fires

                                      Ext.form.ComboBox
                                      view source
                                      ( e, t )private
                                      private ...

                                      private

                                      Available since: Ext JS 2.3.0

                                      Parameters

                                      • e : Object
                                      • t : Object
                                      Ext.form.ComboBox
                                      view source
                                      ( e, t )private
                                      private ...

                                      private

                                      Available since: Ext JS 2.3.0

                                      Parameters

                                      • e : Object
                                      • t : Object

                                      Fires

                                        private ...

                                        private

                                        Available since: Ext JS 2.3.0

                                        Fires

                                          private ...

                                          private

                                          Available since: Ext JS 2.3.0

                                          Fires

                                            protected - should be overridden by subclasses if necessary to prepare raw values for validation ...

                                            protected - should be overridden by subclasses if necessary to prepare raw values for validation

                                            Available since: Ext JS 2.3.0

                                            Parameters

                                            • value : Object

                                            Fires

                                              Overrides: Ext.form.Field.processValue

                                              Removes all listeners for this object ...

                                              Removes all listeners for this object

                                              Available since: 1.1.0

                                              Relays selected events from the specified Observable as if the events were fired by this. ...

                                              Relays selected events from the specified Observable as if the events were fired by this.

                                              Available since: Ext JS 2.3.0

                                              Parameters

                                              • o : Object

                                                The Observable whose events this object is to relay.

                                              • events : Array

                                                Array of event names to relay.

                                              Removes a CSS class from the component's underlying element. ...

                                              Removes a CSS class from the component's underlying element.

                                              Available since: Ext JS 2.3.0

                                              Parameters

                                              • cls : string

                                                The CSS class name to remove

                                              ( eventName, handler, [scope] )
                                              Removes a listener ...

                                              Removes a listener

                                              Available since: 1.1.0

                                              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

                                              ( [container], [position] ) : Ext.Componentchainable
                                              Render this Component into the passed HTML element. ...

                                              Render this Component into the passed HTML element.

                                              If you are using a Container object to house this Component, then do not use the render method.

                                              A Container's child Components are rendered by that Container's layout manager when the Container is first rendered.

                                              Certain layout managers allow dynamic addition of child components. Those that do include Ext.layout.CardLayout, Ext.layout.AnchorLayout, Ext.layout.FormLayout, Ext.layout.TableLayout.

                                              If the Container is already rendered when a new child Component is added, you may need to call the Container's doLayout to refresh the view which causes any unrendered child Components to be rendered. This is required so that you can add multiple child components if needed while only refreshing the layout once.

                                              When creating complex UIs, it is important to remember that sizing and positioning of child items is the responsibility of the Container's layout manager. If you expect child items to be sized in response to user interactions, you must configure the Container with a layout manager which creates and manages the type of layout you have in mind.

                                              Omitting the Container's layout config means that a basic layout manager is used which does nothing but render child components sequentially into the Container. No sizing or positioning will be performed in this situation.

                                              Available since: 1.1.0

                                              Parameters

                                              • container : Element/HTMLElement/String (optional)

                                                The element this Component should be rendered into. If it is being created from existing markup, this should be omitted.

                                              • 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

                                              Fires

                                              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. Also adds emptyText and emptyClass if the original value was blank.

                                              Available since: 1.1.0

                                              Fires

                                                Overrides: Ext.form.Field.reset

                                                Ext.form.ComboBox
                                                view source
                                                ( )private
                                                private ...

                                                private

                                                Available since: Ext JS 2.3.0

                                                Fires

                                                  Resume firing events. ...

                                                  Resume firing events. (see suspendEvents)

                                                  Available since: Ext JS 2.3.0

                                                  Ext.form.ComboBox
                                                  view source
                                                  ( index, scrollIntoView )
                                                  Select an item in the dropdown list by its numeric index in the list. ...

                                                  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.

                                                  Available since: 1.1.0

                                                  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)

                                                  Ext.form.ComboBox
                                                  view source
                                                  ( value, scrollIntoView ) : Boolean
                                                  Select an item in the dropdown list by its data value. ...

                                                  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.

                                                  Available since: 1.1.0

                                                  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

                                                  Fires

                                                    Ext.form.ComboBox
                                                    view source
                                                    ( )private
                                                    private ...

                                                    private

                                                    Available since: Ext JS 2.3.0

                                                    Fires

                                                      Ext.form.ComboBox
                                                      view source
                                                      ( )private
                                                      private ...

                                                      private

                                                      Available since: Ext JS 2.3.0

                                                      Fires

                                                        Selects text in this field ...

                                                        Selects text in this field

                                                        Available since: 1.1.0

                                                        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)

                                                        Fires

                                                          Convenience function for setting disabled/enabled by boolean. ...

                                                          Convenience function for setting disabled/enabled by boolean.

                                                          Available since: 1.1.0

                                                          Parameters

                                                          • disabled : Boolean
                                                          Ext.form.ComboBox
                                                          view source
                                                          ( value )
                                                          Allow or prevent the user from directly editing the field text. ...

                                                          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.

                                                          Available since: 1.1.0

                                                          Parameters

                                                          • value : Boolean

                                                            True to allow the user to directly edit the field text

                                                          Sets the height of the component. ...

                                                          Sets the height of the component. This method fires the resize event.

                                                          Available since: Ext JS 2.3.0

                                                          Parameters

                                                          • height : Number

                                                            The new height to set. This may be one of:

                                                            • A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
                                                            • A String used to set the CSS height style.
                                                            • undefined to leave the height unchanged.

                                                          Returns

                                                          Fires

                                                          Sets the page XY position of the component. ...

                                                          Sets the page XY position of the component. To set the left and top instead, use setPosition. This method fires the move event.

                                                          Available since: 1.1.0

                                                          Parameters

                                                          Returns

                                                          Fires

                                                          Sets the left and top of the component. ...

                                                          Sets the left and top of the component. To set the page XY position instead, use setPagePosition. This method fires the move event.

                                                          Available since: 1.1.0

                                                          Parameters

                                                          Returns

                                                          Fires

                                                          Sets the underlying DOM field's value directly, bypassing validation. ...

                                                          Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue.

                                                          Available since: 1.1.0

                                                          Parameters

                                                          • value : Mixed

                                                            The value to set

                                                          Returns

                                                          • Mixed

                                                            value The field value that is set

                                                          Sets the width and height of this BoxComponent. ...

                                                          Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept either width and height as separate arguments, or you can pass a size object like {width:10, height:20}.

                                                          Available since: 1.1.0

                                                          Parameters

                                                          • width : Mixed

                                                            The new width to set. This may be one of:

                                                            • A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
                                                            • A String used to set the CSS width style.
                                                            • A size object in the format {width: widthValue, height: heightValue}.
                                                            • undefined to leave the width unchanged.

                                                          • height : Mixed

                                                            The new height to set (not required if a size object is passed as the first arg). This may be one of:

                                                            • A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
                                                            • A String used to set the CSS height style. Animation may not be used.
                                                            • undefined to leave the height unchanged.

                                                          Returns

                                                          Fires

                                                          Ext.form.ComboBox
                                                          view source
                                                          ( value )
                                                          Sets the specified value into the field. ...

                                                          Sets the specified value into the field. If the value finds a match, the corresponding record text will be displayed in the field. If the value does not match the data value of an existing item, and the valueNotFoundText config option is defined, it will be displayed as the default field text. Otherwise the field will be blank (although the value will still be set).

                                                          Available since: 1.1.0

                                                          Parameters

                                                          • value : String

                                                            The value to match

                                                          Fires

                                                            Overrides: Ext.form.TextField.setValue, Ext.form.ComboBox.setValue

                                                            Convenience function to hide or show this component by boolean. ...

                                                            Convenience function to hide or show this component by boolean.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            • visible : Boolean

                                                              True to show, false to hide

                                                            Returns

                                                            Fires

                                                            Sets the width of the component. ...

                                                            Sets the width of the component. This method fires the resize event.

                                                            Available since: Ext JS 2.3.0

                                                            Parameters

                                                            • width : Number

                                                              The new width to setThis may be one of:

                                                            Returns

                                                            Fires

                                                            Show this component. ...

                                                            Show this component.

                                                            Available since: 1.1.0

                                                            Returns

                                                            Fires

                                                            Suspend the firing of all events. ...

                                                            Suspend the firing of all events. (see resumeEvents)

                                                            Available since: Ext JS 2.3.0

                                                            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.

                                                            Available since: 1.1.0

                                                            Returns

                                                            Fires

                                                            private ...

                                                            private

                                                            Available since: Ext JS 2.3.0

                                                            ( eventName, handler, [scope] )
                                                            Removes a listener (shorthand for removeListener) ...

                                                            Removes a listener (shorthand for removeListener)

                                                            Available since: 1.1.0

                                                            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

                                                            Ext.form.ComboBox
                                                            view source
                                                            ( )private
                                                            private ...

                                                            private

                                                            Available since: Ext JS 2.3.0

                                                            Sets the current box measurements of the component's underlying element. ...

                                                            Sets the current box measurements of the component's underlying element.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            • box : Object

                                                              An object in the format {x, y, width, height}

                                                            Returns

                                                            Fires

                                                            Validates the field value ...

                                                            Validates the field value

                                                            Available since: 1.1.0

                                                            Returns

                                                            • Boolean

                                                              True if the value is valid, else false

                                                            Fires

                                                            Ext.form.ComboBox
                                                            view source
                                                            ( )private
                                                            private ...

                                                            private

                                                            Available since: Ext JS 2.3.0

                                                            Overrides: Ext.form.TriggerField.validateBlur

                                                            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

                                                            Available since: 1.1.0

                                                            Parameters

                                                            • value : Mixed

                                                              The value to validate

                                                            Returns

                                                            • Boolean

                                                              True if the value is valid, else false

                                                            Fires

                                                            Overrides: Ext.form.Field.validateValue, Ext.form.TextField.validateValue

                                                            Defined By

                                                            Events

                                                            Fires when the autosize function is triggered. ...

                                                            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.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            Fires before the component is destroyed. ...

                                                            Fires before the component is destroyed. Return false to stop the destroy.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            Fires before the component is hidden. ...

                                                            Fires before the component is hidden. Return false to stop the hide.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            Ext.form.ComboBox
                                                            view source
                                                            ( queryEvent )
                                                            Fires before all queries are processed. ...

                                                            Fires before all queries are processed. Return false to cancel the query or set the queryEvent's cancel property to true.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            • 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

                                                            Fires before the component is rendered. ...

                                                            Fires before the component is rendered. Return false to stop the render.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            Ext.form.ComboBox
                                                            view source
                                                            ( combo, record, index )
                                                            Fires before a list item is selected. ...

                                                            Fires before a list item is selected. Return false to cancel the selection.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            Fires before the component is shown. ...

                                                            Fires before the component is shown. Return false to stop the show.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            Fires before the state of the component is restored. ...

                                                            Fires before the state of the component is restored. Return false to stop the restore.

                                                            Available since: Ext JS 2.3.0

                                                            Parameters

                                                            Fires before the state of the component is saved to the configured state provider. ...

                                                            Fires before the state of the component is saved to the configured state provider. Return false to stop the save.

                                                            Available since: Ext JS 2.3.0

                                                            Parameters

                                                            Fires when this field loses input focus. ...

                                                            Fires when this field loses input focus.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            ( this, newValue, 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.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            • this : Ext.form.Field
                                                            • newValue : Mixed

                                                              The new value

                                                            • oldValue : Mixed

                                                              The original value

                                                            Ext.form.ComboBox
                                                            view source
                                                            ( combo )
                                                            Fires when the dropdown list is collapsed ...

                                                            Fires when the dropdown list is collapsed

                                                            Available since: 1.1.0

                                                            Parameters

                                                            Fires after the component is destroyed. ...

                                                            Fires after the component is destroyed.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            Fires after the component is disabled. ...

                                                            Fires after the component is disabled.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            Fires after the component is enabled. ...

                                                            Fires after the component is enabled.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            Ext.form.ComboBox
                                                            view source
                                                            ( combo )
                                                            Fires when the dropdown list is expanded ...

                                                            Fires when the dropdown list is expanded

                                                            Available since: 1.1.0

                                                            Parameters

                                                            Fires when this field receives input focus. ...

                                                            Fires when this field receives input focus.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            Fires after the component is hidden. ...

                                                            Fires after the component is hidden.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            Fires after the field has been marked as invalid. ...

                                                            Fires after the field has been marked as invalid.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            Keydown input field event. ...

                                                            Keydown input field event. This event only fires if enableKeyEvents is set to true.

                                                            Available since: Ext JS 2.3.0

                                                            Parameters

                                                            Keypress input field event. ...

                                                            Keypress input field event. This event only fires if enableKeyEvents is set to true.

                                                            Available since: Ext JS 2.3.0

                                                            Parameters

                                                            Keyup input field event. ...

                                                            Keyup input field event. This event only fires if enableKeyEvents is set to true.

                                                            Available since: Ext JS 2.3.0

                                                            Parameters

                                                            Fires after the component is moved. ...

                                                            Fires after the component is moved.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            Fires after the component is rendered. ...

                                                            Fires after the component is rendered.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            ( this, adjWidth, adjHeight, rawWidth, rawHeight )
                                                            Fires after the component is resized. ...

                                                            Fires after the component is resized.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            • 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

                                                            Ext.form.ComboBox
                                                            view source
                                                            ( combo, record, index )
                                                            Fires when a list item is selected ...

                                                            Fires when a list item is selected

                                                            Available since: 1.1.0

                                                            Parameters

                                                            Fires after the component is shown. ...

                                                            Fires after the component is shown.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. ...

                                                            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.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            Fires after the state of the component is restored. ...

                                                            Fires after the state of the component is restored.

                                                            Available since: Ext JS 2.3.0

                                                            Parameters

                                                            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.

                                                            Available since: Ext JS 2.3.0

                                                            Parameters

                                                            Fires after the field has been validated with no errors. ...

                                                            Fires after the field has been validated with no errors.

                                                            Available since: 1.1.0

                                                            Parameters