Ext JS Sencha Docs

Ext.form.field.ComboBox

Alternate names

Ext.form.ComboBox

Hierarchy

Mixins

Inherited mixins

Requires

Subclasses

Files

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

A ComboBox is like a combination of a traditional HTML text <input> field and a <select> field; the user is able to type freely into the field, and/or pick values from a dropdown selection list. The user can input any value by default, even if it does not appear in the selection list; to prevent free-form values and restrict them to items in the list, set forceSelection to true.

The selection list's options are populated from any Ext.data.Store, including remote stores. The data items in the store are mapped to each option's displayed text and backing value via the valueField and displayField configurations, respectively.

If your store is not remote, i.e. it depends only on local data and is loaded up front, you should be sure to set the queryMode to 'local', as this will improve responsiveness for the user.

Example usage:

// The data store containing the list of states
var states = Ext.create('Ext.data.Store', {
    fields: ['abbr', 'name'],
    data : [
        {"abbr":"AL", "name":"Alabama"},
        {"abbr":"AK", "name":"Alaska"},
        {"abbr":"AZ", "name":"Arizona"}
        //...
    ]
});

// Create the combo box, attached to the states data store
Ext.create('Ext.form.ComboBox', {
    fieldLabel: 'Choose State',
    store: states,
    queryMode: 'local',
    displayField: 'name',
    valueField: 'abbr',
    renderTo: Ext.getBody()
});

Events

To do something when something in ComboBox is selected, configure the select event:

var cb = Ext.create('Ext.form.ComboBox', {
    // all of your config options
    listeners:{
         scope: yourScope,
         'select': yourFunction
    }
});

// Alternatively, you can assign events after the object is created:
var cb = new Ext.form.field.ComboBox(yourOptions);
cb.on('select', yourFunction, yourScope);

Multiple Selection

ComboBox also allows selection of multiple items from the list; to enable multi-selection set the multiSelect config to true.

Filtered Stores

If you have a local store that is already filtered, you can use the lastQuery config option to prevent the store from having the filter being cleared on first expand.

Customized combobox

Both the text shown in dropdown menu and text field can be easily customized:

var states = Ext.create('Ext.data.Store', {
    fields: ['abbr', 'name'],
    data : [
        {"abbr":"AL", "name":"Alabama"},
        {"abbr":"AK", "name":"Alaska"},
        {"abbr":"AZ", "name":"Arizona"}
    ]
});

Ext.create('Ext.form.ComboBox', {
    fieldLabel: 'Choose State',
    store: states,
    queryMode: 'local',
    valueField: 'abbr',
    renderTo: Ext.getBody(),
    // Template for the dropdown menu.
    // Note the use of "x-boundlist-item" class,
    // this is required to make the items selectable.
    tpl: Ext.create('Ext.XTemplate',
        '<tpl for=".">',
            '<div class="x-boundlist-item">{abbr} - {name}</div>',
        '</tpl>'
    ),
    // template for the content inside text field
    displayTpl: Ext.create('Ext.XTemplate',
        '<tpl for=".">',
            '{abbr} - {name}',
        '</tpl>'
    )
});

See also the listConfig option for additional configuration of the dropdown.

Config options

Defined By

Required config options

Ext.form.field.ComboBox
view source
: Stringrequired
The underlying data value name to bind to this ComboBox. ...

The underlying data value name to bind to this ComboBox.

Note: use of a valueField requires the user to make a selection in order for a value to be mapped. See also displayField.

Defaults to match the value of the displayField config.

Defined By

Optional config options

If specified, then the component will be displayed with this value as its active error when first rendered. ...

If specified, then the component will be displayed with this value as its active error when first rendered. Use setActiveError or unsetActiveError to change it after component creation.

The template used to format the Array of error messages passed to setActiveErrors into a single HTML string. ...

The template used to format the Array of error messages passed to setActiveErrors into a single HTML string. if the msgTarget is title, it defaults to a list separated by new lines. Otherwise, it renders each message as an item in an unordered list.

An optional string or XTemplate configuration to insert in the field markup at the end of the input containing element. ...

An optional string or XTemplate configuration to insert in the field markup at the end of the input containing element. If an XTemplate is used, the component's render data serves as the context.

An optional string or XTemplate configuration to insert in the field markup after the label text. ...

An optional string or XTemplate configuration to insert in the field markup after the label text. If an XTemplate is used, the component's render data serves as the context.

An optional string or XTemplate configuration to insert in the field markup after the label element. ...

An optional string or XTemplate configuration to insert in the field markup after the label element. If an XTemplate is used, the component's render data serves as the context.

An optional string or XTemplate configuration to insert in the field markup after the subTpl markup. ...

An optional string or XTemplate configuration to insert in the field markup after the subTpl markup. If an XTemplate is used, the component's render data serves as the context.

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

The text query to send to the server to return all records for the list with no filtering

Defaults to: ''

Specify false to validate that the value's length must be > 0. ...

Specify false to validate that the value's length must be > 0. If true, then a blank value is always taken to be valid regardless of any vtype validation that may be applied.

If vtype validation must still be applied to blank values, configure validateBlank as true;

Defaults to: true

Specify false to automatically trim the value before validating the whether the value is blank. ...

Specify false to automatically trim the value before validating the whether the value is blank. Setting this to false automatically sets allowBlank to false.

Defaults to: true

Ext.form.field.ComboBox
view source
: Boolean
Configure as true to allow match the typed characters at any position in the valueField's value. ...

Configure as true to allow match the typed characters at any position in the valueField's value.

Defaults to: false

A tag name or DomHelper spec used to create the Element which will encapsulate this Component. ...

A tag name or DomHelper spec used to create the Element which will encapsulate this Component.

You do not normally need to specify this. For the base classes Ext.Component and Ext.container.Container, this defaults to 'div'. The more complex Sencha classes use a more complex DOM structure specified by their own renderTpls.

This is intended to allow the developer to create application-specific utility Components encapsulated by different DOM elements. Example usage:

{
    xtype: 'component',
    autoEl: {
        tag: 'img',
        src: 'http://www.example.com/example.jpg'
    }
}, {
    xtype: 'component',
    autoEl: {
        tag: 'blockquote',
        html: 'autoEl is cool!'
    }
}, {
    xtype: 'container',
    autoEl: 'ul',
    cls: 'ux-unordered-list',
    items: {
        xtype: 'component',
        autoEl: 'li',
        html: 'First list item'
    }
}

Available since: 2.3.0

Whether to adjust the component's body area to make room for 'side' or 'under' error messages. ...

Whether to adjust the component's body area to make room for 'side' or 'under' error messages.

Defaults to: true

An alias for loader config which also allows to specify just a string which will be used as the url that's automatica...

An alias for loader config which also allows to specify just a string which will be used as the url that's automatically loaded:

Ext.create('Ext.Component', {
    autoLoad: 'content.html',
    renderTo: Ext.getBody()
});

The above is the same as:

Ext.create('Ext.Component', {
    loader: {
        url: 'content.html',
        autoLoad: true
    },
    renderTo: Ext.getBody()
});

Don't use it together with loader config.

This cfg has been deprected since 4.1.1

Use loader config instead.

This config is intended mainly for non-floating Components which may or may not be shown. ...

This config is intended mainly for non-floating Components which may or may not be shown. Instead of using renderTo in the configuration, and rendering upon construction, this allows a Component to render itself upon first show. If floating is true, the value of this config is omitted as if it is true.

Specify as true to have this Component render to the document body upon first show.

Specify as an element, or the ID of an element to have this Component render to a specific element upon first show.

Defaults to: false

true to use overflow:'auto' on the components layout element and show scroll bars automatically when necessary, false...

true to use overflow:'auto' on the components layout element and show scroll bars automatically when necessary, false to clip any overflowing content. This should not be combined with overflowX or overflowY.

Defaults to: false

Ext.form.field.ComboBox
view source
: Boolean
true to automatically highlight the first result gathered by the data store in the dropdown list when it is opened. ...

true to automatically highlight the first result gathered by the data store in the dropdown list when it is opened. A false value would cause nothing in the list to be highlighted automatically, so the user would have to manually highlight an item before pressing the enter or tab key to select it (unless the value of (typeAhead) were true), or use the mouse to select a value.

Defaults to: true

true to automatically show the component upon creation. ...

true to automatically show the component upon creation. This config option may only be used for floating components or components that use autoRender.

Defaults to: false

Available since: 2.3.0

The CSS class to be applied to the body content element. ...

The CSS class to be applied to the body content element.

Defaults to: Ext.baseCSSPrefix + 'form-item-body'

The base CSS class to apply to this component's element. ...

The base CSS class to apply to this component's element. This will also be prepended to elements within this component like Panel's body will get a class x-panel-body. This means that if you create a subclass of Panel, and you want it to get all the Panels styling for the element and the body, you leave the baseCls x-panel and use componentCls to add specific styling for this component.

Defaults to: Ext.baseCSSPrefix + 'field'

Overrides: Ext.AbstractComponent.baseCls

An optional string or XTemplate configuration to insert in the field markup at the beginning of the input containing ...

An optional string or XTemplate configuration to insert in the field markup at the beginning of the input containing element. If an XTemplate is used, the component's render data serves as the context.

An optional string or XTemplate configuration to insert in the field markup before the label text. ...

An optional string or XTemplate configuration to insert in the field markup before the label text. If an XTemplate is used, the component's render data serves as the context.

An optional string or XTemplate configuration to insert in the field markup before the label element. ...

An optional string or XTemplate configuration to insert in the field markup before the label element. If an XTemplate is used, the component's render data serves as the context.

An optional string or XTemplate configuration to insert in the field markup before the subTpl markup. ...

An optional string or XTemplate configuration to insert in the field markup before the subTpl markup. If an XTemplate is used, the component's render data serves as the context.

The error text to display if the allowBlank validation fails ...

The error text to display if the allowBlank validation fails

Defaults to: 'This field is required'

Specifies the border size for this component. ...

Specifies the border size for this component. The border can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10' (top, right, bottom, left).

For components that have no border by default, setting this won't make the border appear by itself. You also need to specify border color and style:

border: 5,
style: {
    borderColor: 'red',
    borderStyle: 'solid'
}

To turn off the border, use border: false.

Ext.form.field.ComboBox
view source
: Boolean
Configure as true to make the filtering match with exact case matching ...

Configure as true to make the filtering match with exact case matching

Defaults to: false

Defines a timeout in milliseconds for buffering checkChangeEvents that fire in rapid succession. ...

Defines a timeout in milliseconds for buffering checkChangeEvents that fire in rapid succession. Defaults to 50 milliseconds.

Defaults to: 50

A list of event names that will be listened for on the field's input element, which will cause the field's value to b...

A list of event names that will be listened for on the field's input element, which will cause the field's value to be checked for changes. If a change is detected, the change event will be fired, followed by validation if the validateOnChange option is enabled.

Defaults to ['change', 'propertychange', 'keyup'] in Internet Explorer, and ['change', 'input', 'textInput', 'keyup', 'dragdrop'] in other browsers. This catches all the ways that field values can be changed in most supported browsers; the only known exceptions at the time of writing are:

  • Safari 3.2 and older: cut/paste in textareas via the context menu, and dragging text into textareas
  • Opera 10 and 11: dragging text into text fields and textareas, and cut via the context menu in text fields and textareas
  • Opera 9: Same as Opera 10 and 11, plus paste from context menu in text fields and textareas

If you need to guarantee on-the-fly change notifications including these edge cases, you can call the checkChange method on a repeating interval, e.g. using Ext.TaskManager, or if the field is within a Ext.form.Panel, you can use the FormPanel's Ext.form.Panel.pollForChanges configuration to set up such a task automatically.

An array describing the child elements of the Component. ...

An array describing the child elements of the Component. Each member of the array is an object with these properties:

  • name - The property name on the Component for the child element.
  • itemId - The id to combine with the Component's id that is the id of the child element.
  • id - The id of the child element.

If the array member is a string, it is equivalent to { name: m, itemId: m }.

For example, a Component which renders a title and body text:

Ext.create('Ext.Component', {
    renderTo: Ext.getBody(),
    renderTpl: [
        '<h1 id="{id}-title">{title}</h1>',
        '<p>{msg}</p>',
    ],
    renderData: {
        title: "Error",
        msg: "Something went wrong"
    },
    childEls: ["title"],
    listeners: {
        afterrender: function(cmp){
            // After rendering the component will have a title property
            cmp.title.setStyle({color: "red"});
        }
    }
});

A more flexible, but somewhat slower, approach is renderSelectors.

The CSS class to be applied to the special clearing div rendered directly after the field contents wrapper to provide...

The CSS class to be applied to the special clearing div rendered directly after the field contents wrapper to provide field clearing.

Defaults to: Ext.baseCSSPrefix + 'clear'

Ext.form.field.ComboBox
view source
: Boolean
When queryMode is 'local' only As text is entered, the underlying store is filtered to match the value. ...

When queryMode is 'local' only

As text is entered, the underlying store is filtered to match the value. When this option is true, any filtering applied by this field will be cleared when focus is removed & reinstated on focus. If false, the filters will be left in place.

Defaults to: true

An optional extra CSS class that will be added to this component's Element. ...

An optional extra CSS class that will be added to this component's Element. This can be useful for adding customized styles to the component or any of its children using standard CSS rules.

Defaults to: ''

Available since: 1.1.0

Defines the column width inside column layout. ...

Defines the column width inside column layout.

Can be specified as a number or as a percentage.

CSS Class to be added to a components root level element to give distinction to it via styling.

CSS Class to be added to a components root level element to give distinction to it via styling.

Ext.form.field.ComboBox
view source
: String/Object
The sizing and positioning of a Component's internal Elements is the responsibility of the Component's layout manager...

The sizing and positioning of a Component's internal Elements is the responsibility of the Component's layout manager which sizes a Component's internal structure in response to the Component being sized.

Generally, developers will not use this configuration as all provided Components which need their internal elements sizing (Such as input fields) come with their own componentLayout managers.

The default layout manager will be used on instances of the base Ext.Component class which simply sizes the Component's encapsulating element to the height and width specified in the setSize method.

Defaults to: 'combobox'

Overrides: Ext.form.field.Trigger.componentLayout

True to constrain this Components within its containing element, false to allow it to fall outside of its containing ...

True to constrain this Components within its containing element, false to allow it to fall outside of its containing element. By default this Component will be rendered to document.body. To render and constrain this Component within another element specify renderTo.

Defaults to: false

A Region (or an element from which a Region measurement will be read) which is used to constrain the component. ...

A Region (or an element from which a Region measurement will be read) which is used to constrain the component. Only applies when the component is floating.

An object or a string (in TRBL order) specifying insets from the configured constrain region within which this compon...

An object or a string (in TRBL order) specifying insets from the configured constrain region within which this component must be constrained when positioning or sizing. example:

constraintInsets: '10 10 10 10' // Constrain with 10px insets from parent

Specify an existing HTML element, or the id of an existing HTML element to use as the content for this component. ...

Specify an existing HTML element, or the id of an existing HTML element to use as the content for this component.

This config option is used to take an existing HTML element and place it in the layout element of a new component (it simply moves the specified DOM element after the Component is rendered to use as the content.

Notes:

The specified HTML element is appended to the layout element of the component after any configured HTML has been inserted, and so the document will not contain this element at the time the render event is fired.

The specified HTML element used will not participate in any layout scheme that the Component may use. It is just HTML. Layouts operate on child items.

Add either the x-hidden or the x-hide-display CSS class to prevent a brief flicker of the content before it is rendered to the panel.

Available since: 3.4.0

The initial set of data to apply to the tpl to update the content area of the Component.

The initial set of data to apply to the tpl to update the content area of the Component.

Available since: 3.4.0

The default Ext.Element#getAlignToXY anchor position value for this menu relative to its element of origin. ...

The default Ext.Element#getAlignToXY anchor position value for this menu relative to its element of origin. Used in conjunction with showBy.

Defaults to: "tl-bl?"

Ext.form.field.ComboBox
view source
: Object
Set of options that will be used as defaults for the user-configured listConfig object. ...

Set of options that will be used as defaults for the user-configured listConfig object.

Defaults to: {loadingHeight: 70, minWidth: 70, maxHeight: 300, shadow: 'sides'}

Ext.form.field.ComboBox
view source
: String
The character(s) used to separate the display values of multiple selected items when multiSelect = true. ...

The character(s) used to separate the display values of multiple selected items when multiSelect = true.

Defaults to: ', '

The CSS class to use when the field value is dirty. ...

The CSS class to use when the field value is dirty.

Defaults to: Ext.baseCSSPrefix + 'form-dirty'

Specify true to disable input keystroke filtering ...

Specify true to disable input keystroke filtering

Defaults to: false

True to disable the field. ...

True to disable the field. Disabled Fields will not be submitted.

Defaults to: false

Overrides: Ext.AbstractComponent.disabled

CSS class to add when the Component is disabled. ...

CSS class to add when the Component is disabled.

Defaults to: 'x-item-disabled'

Ext.form.field.ComboBox
view source
: String
The underlying data field name to bind to this ComboBox. ...

The underlying data field name to bind to this ComboBox.

See also valueField.

Defaults to: 'text'

The template to be used to display selected records inside the text field. ...

The template to be used to display selected records inside the text field. An array of the selected records' data will be passed to the template. Defaults to:

'<tpl for=".">' +
    '{[typeof values === "string" ? values : values["' + me.displayField + '"]]}' +
    '<tpl if="xindex < xcount">' + me.delimiter + '</tpl>' +
'</tpl>'
Specify as true to make a floating Component draggable using the Component's encapsulating element as the drag handle. ...

Specify as true to make a floating Component draggable using the Component's encapsulating element as the drag handle.

This may also be specified as a config object for the ComponentDragger which is instantiated to perform dragging.

For example to create a Component which may only be dragged around using a certain internal element as the drag handle, use the delegate option:

new Ext.Component({
    constrain: true,
    floating: true,
    style: {
        backgroundColor: '#fff',
        border: '1px solid black'
    },
    html: '<h1 style="cursor:move">The title</h1><p>The content</p>',
    draggable: {
        delegate: 'h1'
    }
}).show();

Defaults to: false

Overrides: Ext.AbstractComponent.draggable

False to prevent the user from typing text directly into the field; the field can only have its value set via selecti...

False to prevent the user from typing text directly into the field; the field can only have its value set via selecting a value from the picker. In this state, the picker can also be opened by clicking directly on the input field itself.

Defaults to: true

Overrides: Ext.form.field.Trigger.editable

The CSS class to apply to an empty field to style the emptyText. ...

The CSS class to apply to an empty field to style the emptyText. This class is automatically added and removed as needed depending on the current field value.

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

The default text to place into an empty field. ...

The default text to place into an empty field.

Note that normally this value will be submitted to the server if this field is enabled; to prevent this you can set the submitEmptyText option of Ext.form.Basic.submit to false.

Also note that if you use inputType:'file', emptyText is not supported and should be avoided.

Note that for browsers that support it, setting this property will use the HTML 5 placeholder attribute, and for older browsers that don't support the HTML 5 placeholder attribute the value will be placed directly into the input element itself as the raw value. This means that older browsers will obfuscate the emptyText value for password input fields.

true to enable the proxying of key events for the HTML input field ...

true to enable the proxying of key events for the HTML input field

Defaults to: false

Ext.form.field.ComboBox
view source
: Boolean
When queryMode is 'local' only Set to true to have the ComboBox use the typed value as a RegExp source to filter the...

When queryMode is 'local' only

Set to true to have the ComboBox use the typed value as a RegExp source to filter the store to get possible matches.

True to set the maxLength property on the underlying input field. ...

True to set the maxLength property on the underlying input field. Defaults to false

The CSS class to be applied to the error message element. ...

The CSS class to be applied to the error message element.

Defaults to: Ext.baseCSSPrefix + 'form-error-msg'

An extra CSS class to be applied to the body content element in addition to baseBodyCls. ...

An extra CSS class to be applied to the body content element in addition to baseBodyCls.

Defaults to: ''

The default CSS class for the field input ...

The default CSS class for the field input

Defaults to: 'x-form-field'

The label for the field. ...

The label for the field. It gets appended with the labelSeparator, and its position and sizing is determined by the labelAlign, labelWidth, and labelPad configs.

Optional CSS style(s) to be applied to the field input element. ...

Optional CSS style(s) to be applied to the field input element. Should be a valid argument to Ext.Element.applyStyles. Defaults to undefined. See also the setFieldStyle method for changing the style after initialization.

Ext.form.field.ComboBox
view source
: Ext.XTemplate
The content of the field body is defined by this config option. ...

The content of the field body is defined by this config option.

Defaults to: ['<div class="{hiddenDataCls}" role="presentation"></div>', '<input id="{id}" type="{type}" role="{role}" {inputAttrTpl} class="{fieldCls} {typeCls} {editableCls}" autocomplete="off"', '<tpl if="value"> value="{[Ext.util.Format.htmlEncode(values.value)]}"</tpl>', '<tpl if="name"> name="{name}"</tpl>', '<tpl if="placeholder"> placeholder="{placeholder}"</tpl>', '<tpl if="size"> size="{size}"</tpl>', '<tpl if="maxLength !== undefined"> maxlength="{maxLength}"</tpl>', '<tpl if="readOnly"> readonly="readonly"</tpl>', '<tpl if="disabled"> disabled="disabled"</tpl>', '<tpl if="tabIdx"> tabIndex="{tabIdx}"</tpl>', '<tpl if="fieldStyle"> style="{fieldStyle}"</tpl>', '/>', {compiled: true, disableFormats: true}]

Overrides: Ext.form.field.Base.fieldSubTpl

Configure as true to have this Component fixed at its X, Y coordinates in the browser viewport, immune to scrolling t...

Configure as true to have this Component fixed at its X, Y coordinates in the browser viewport, immune to scrolling the document.

Only in browsers that support position:fixed

IE6 and IE7, 8 and 9 quirks do not support position: fixed

Defaults to: false

Specify as true to float the Component outside of the document flow using CSS absolute positioning. ...

Specify as true to float the Component outside of the document flow using CSS absolute positioning.

Components such as Windows and Menus are floating by default.

Floating Components that are programatically rendered will register themselves with the global ZIndexManager

Floating Components as child items of a Container

A floating Component may be used as a child item of a Container. This just allows the floating Component to seek a ZIndexManager by examining the ownerCt chain.

When configured as floating, Components acquire, at render time, a ZIndexManager which manages a stack of related floating Components. The ZIndexManager brings a single floating Component to the top of its stack when the Component's toFront method is called.

The ZIndexManager is found by traversing up the ownerCt chain to find an ancestor which itself is floating. This is so that descendant floating Components of floating Containers (Such as a ComboBox dropdown within a Window) can have its zIndex managed relative to any siblings, but always above that floating ancestor Container.

If no floating ancestor is found, a floating Component registers itself with the default ZIndexManager.

Floating components do not participate in the Container's layout. Because of this, they are not rendered until you explicitly show them.

After rendering, the ownerCt reference is deleted, and the floatParent property is set to the found floating ancestor Container. If no floating ancestor Container was found the floatParent property will not be set.

Defaults to: false

Overrides: Ext.AbstractComponent.floating

The CSS class to use when the field receives focus ...

The CSS class to use when the field receives focus

Defaults to: 'x-form-focus'

Specifies whether the floated component should be automatically focused when it is brought to the front. ...

Specifies whether the floated component should be automatically focused when it is brought to the front.

Defaults to: true

Ext.form.field.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

When inside FormPanel, any component configured with formBind: true will be enabled/disabled depending on the validit...

When inside FormPanel, any component configured with formBind: true will be enabled/disabled depending on the validity state of the form. See Ext.form.Panel for more information and example.

Defaults to: false

A CSS class to be applied to the outermost element to denote that it is participating in the form field layout. ...

A CSS class to be applied to the outermost element to denote that it is participating in the form field layout.

Defaults to: Ext.baseCSSPrefix + 'form-item'

Specify as true to have the Component inject framing elements within the Component at render time to provide a graphi...

Specify as true to have the Component inject framing elements within the Component at render time to provide a graphical rounded frame around the Component content.

This is only necessary when running on outdated, or non standard-compliant browsers such as Microsoft's Internet Explorer prior to version 9 which do not support rounded corners natively.

The extra space taken up by this framing is available from the read only property frameSize.

A string that will be appended to the field's current value for the purposes of calculating the target field size. ...

A string that will be appended to the field's current value for the purposes of calculating the target field size. Only used when the grow config is true. Defaults to a single capital "W" (the widest character in common fonts) to leave enough space for the next typed character and avoid the field value shifting before the width is adjusted.

Defaults to: 'W'

Ext.form.field.ComboBox
view source
: Boolean
false to not allow the component to resize itself when its data changes (and its grow property is true) ...

false to not allow the component to resize itself when its data changes (and its grow property is true)

Defaults to: true

The height of this component in pixels.

The height of this component in pixels.

true to hide the component. ...

true to hide the component.

Defaults to: false

Available since: 2.3.0

Ext.form.field.ComboBox
view source
: Stringprivate
CSS class used to find the hiddenDataEl ...

CSS class used to find the hiddenDataEl

Defaults to: Ext.baseCSSPrefix + 'hide-display ' + Ext.baseCSSPrefix + 'form-data-hidden'

Ext.form.field.ComboBox
view source
: String
The name of an underlying hidden field which will be synchronized with the underlying value of the combo. ...

The name of an underlying hidden field which will be synchronized with the underlying value of the combo. This option is useful if the combo is part of a form element doing a regular form post. The hidden field will not be created unless a hiddenName is specified.

Defaults to: ""

When set to true, the label element (fieldLabel and labelSeparator) will be automatically hidden if the fieldLabel is...

When set to true, the label element (fieldLabel and labelSeparator) will be automatically hidden if the fieldLabel is empty. Setting this to false will cause the empty label element to be rendered and space to be reserved for it; this is useful if you want a field without a label to line up with other labeled fields in the same form.

If you wish to unconditionall hide the label even if a non-empty fieldLabel is configured, then set the hideLabel config to true.

Defaults to: true

Set to true to completely hide the label element (fieldLabel and labelSeparator). ...

Set to true to completely hide the label element (fieldLabel and labelSeparator). Also see hideEmptyLabel, which controls whether space will be reserved for an empty fieldLabel.

Defaults to: false

A String which specifies how this Component's encapsulating DOM element will be hidden. ...

A String which specifies how this Component's encapsulating DOM element will be hidden. Values may be:

  • 'display' : The Component will be hidden using the display: none style.
  • 'visibility' : The Component will be hidden using the visibility: hidden style.
  • 'offsets' : The Component will be hidden by absolutely positioning it out of the visible area of the document. This is useful when a hidden Component must maintain measurable dimensions. Hiding using display results in a Component having zero dimensions.

Defaults to: 'display'

Available since: 1.1.0

true to hide the trigger element and display only the base text field ...

true to hide the trigger element and display only the base text field

Defaults to: false

An HTML fragment, or a DomHelper specification to use as the layout element content. ...

An HTML fragment, or a DomHelper specification to use as the layout element content. The HTML content is added after the component is rendered, so the document will not contain this HTML at the time the render event is fired. This content is inserted into the body before any configured contentEl is appended.

Defaults to: ''

Available since: 3.4.0

The unique id of this component instance. ...

The unique id of this component instance.

It should not be necessary to use this configuration except for singleton objects in your application. Components created with an id may be accessed globally using Ext.getCmp.

Instead of using assigned ids, use the itemId config, and ComponentQuery which provides selector-based searching for Sencha Components analogous to DOM querying. The Container class contains shortcut methods to query its descendant Components by selector.

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.

Note: To avoid complications imposed by a unique id also see itemId.

Note: To access the container of a Component see ownerCt.

Defaults to an auto-assigned id.

Available since: 1.1.0

An optional string or XTemplate configuration to insert in the field markup inside the input element (as attributes). ...

An optional string or XTemplate configuration to insert in the field markup inside the input element (as attributes). If an XTemplate is used, the component's subTpl data serves as the context.

The id that will be given to the generated input DOM element. ...

The id that will be given to the generated input DOM element. Defaults to an automatically generated id. If you configure this manually, you must make sure it is unique in the document.

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

The type attribute for input fields -- e.g. radio, text, password, file. The extended types supported by HTML5 inputs (url, email, etc.) may also be used, though using them will cause older browsers to fall back to 'text'.

The type 'password' must be used to render that field type currently -- there is no separate Ext component for that. You can use Ext.form.field.File which creates a custom-rendered file upload field, but if you want a plain unstyled file input you can use a Base with inputType:'file'.

Defaults to: 'text'

The CSS class to use when marking the component invalid. ...

The CSS class to use when marking the component invalid.

Defaults to: Ext.baseCSSPrefix + 'form-invalid'

The error text to use when marking a field invalid and no message is provided ...

The error text to use when marking a field invalid and no message is provided

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

An itemId can be used as an alternative way to get a reference to a component when no object reference is available. ...

An itemId can be used as an alternative way to get a reference to a component when no object reference is available. Instead of using an id with Ext.getCmp, use itemId with Ext.container.Container.getComponent which will retrieve itemId's or id's. Since itemId's are an index to the container's internal MixedCollection, the itemId is scoped locally to the container -- avoiding potential conflicts with Ext.ComponentManager which requires a unique id.

var c = new Ext.panel.Panel({ //
    height: 300,
    renderTo: document.body,
    layout: 'auto',
    items: [
        {
            itemId: 'p1',
            title: 'Panel 1',
            height: 150
        },
        {
            itemId: 'p2',
            title: 'Panel 2',
            height: 150
        }
    ]
})
p1 = c.getComponent('p1'); // not the same as Ext.getCmp()
p2 = p1.ownerCt.getComponent('p2'); // reference via a sibling

Also see id, Ext.container.Container.query, Ext.container.Container.down and Ext.container.Container.child.

Note: to access the container of an item see ownerCt.

Available since: 3.4.0

Controls the position and alignment of the fieldLabel. ...

Controls the position and alignment of the fieldLabel. Valid values are:

  • "left" (the default) - The label is positioned to the left of the field, with its text aligned to the left. Its width is determined by the labelWidth config.
  • "top" - The label is positioned above the field.
  • "right" - The label is positioned to the left of the field, with its text aligned to the right. Its width is determined by the labelWidth config.

Defaults to: 'left'

An optional string or XTemplate configuration to insert in the field markup inside the label element (as attributes). ...

An optional string or XTemplate configuration to insert in the field markup inside the label element (as attributes). If an XTemplate is used, the component's render data serves as the context.

The CSS class to be applied to the label element. ...

The CSS class to be applied to the label element. This (single) CSS class is used to formulate the renderSelector and drives the field layout where it is concatenated with a hyphen ('-') and labelAlign. To add additional classes, use labelClsExtra.

Defaults to: Ext.baseCSSPrefix + 'form-item-label'

An optional string of one or more additional CSS classes to add to the label element. ...

An optional string of one or more additional CSS classes to add to the label element. Defaults to empty.

The amount of space in pixels between the fieldLabel and the input field. ...

The amount of space in pixels between the fieldLabel and the input field.

Defaults to: 5

Character(s) to be inserted at the end of the label text. ...

Character(s) to be inserted at the end of the label text.

Set to empty string to hide the separator completely.

Defaults to: ':'

A CSS style specification string to apply directly to this field's label.

A CSS style specification string to apply directly to this field's label.

The width of the fieldLabel in pixels. ...

The width of the fieldLabel in pixels. Only applicable if the labelAlign is set to "left" or "right".

Defaults to: 100

The rendering template for the field decorations. ...

The rendering template for the field decorations. Component classes using this mixin should include logic to use this as their renderTpl, and implement the getSubTplMarkup method to generate the field body content.

The structure of a field is a table as follows:

If labelAlign: 'left',msgTarget: 'side'`

 +----------------------+----------------------+-------------+
 | Label:               | InputField           | sideErrorEl |
 +----------------------+----------------------+-------------+

If labelAlign: 'left',msgTarget: 'under'`

 +----------------------+------------------------------------+
 | Label:               | InputField      (colspan=2)        |
 |                      | underErrorEl                       |
 +----------------------+------------------------------------+

If labelAlign: 'top',msgTarget: 'side'`

 +---------------------------------------------+-------------+
 | label                                       |             |
 | InputField                                  | sideErrorEl |
 +---------------------------------------------+-------------+

If labelAlign: 'top',msgTarget: 'under'`

 +-----------------------------------------------------------+
 | label                                                     |
 | InputField                      (colspan=2)               |
 | underErrorEl                                              |
 +-----------------------------------------------------------+

The total columns always the same for fields with each setting of labelAlign because when rendered into a Ext.layout.container.Form layout, just the TR of the table will be placed into the form's main TABLE, and the columns of all the siblings must match so that they all line up. In a Ext.layout.container.Form layout, different settings of labelAlign are not supported because of the incompatible column structure.

When the triggerCell or side error cell are hidden or shown, the input cell's colspan is recalculated to maintain the correct 3 visible column count.

Defaults to: ['<tr role="presentation" id="{id}-inputRow" <tpl if="inFormLayout">id="{id}"</tpl> class="{inputRowCls}">', '<tpl if="labelOnLeft">', '<td role="presentation" id="{id}-labelCell" style="{labelCellStyle}" {labelCellAttrs}>', '{beforeLabelTpl}', '<label id="{id}-labelEl" {labelAttrTpl}', '<tpl if="inputId && !(boxLabel && !fieldLabel)"> for="{inputId}"</tpl>', ' class="{labelCls}"', '<tpl if="labelStyle"> style="{labelStyle}"</tpl>', ' unselectable="on"', '>', '{beforeLabelTextTpl}', '<tpl if="fieldLabel">{fieldLabel}', '<tpl if="labelSeparator">', '<span role="separator">{labelSeparator}</span>', '</tpl>', '</tpl>', '{afterLabelTextTpl}', '</label>', '{afterLabelTpl}', '</td>', '</tpl>', '<td role="presentation" class="{baseBodyCls} {fieldBodyCls} {extraFieldBodyCls}" id="{id}-bodyEl" colspan="{bodyColspan}" role="presentation">', '{beforeBodyEl}', '<tpl if="labelAlign==\'top\'">', '{beforeLabelTpl}', '<div role="presentation" id="{id}-labelCell" style="{labelCellStyle}">', '<label id="{id}-labelEl" {labelAttrTpl}<tpl if="inputId"> for="{inputId}"</tpl> class="{labelCls}"', '<tpl if="labelStyle"> style="{labelStyle}"</tpl>', ' unselectable="on"', '>', '{beforeLabelTextTpl}', '<tpl if="fieldLabel">{fieldLabel}', '<tpl if="labelSeparator">', '<span role="separator">{labelSeparator}</span>', '</tpl>', '</tpl>', '{afterLabelTextTpl}', '</label>', '</div>', '{afterLabelTpl}', '</tpl>', '{beforeSubTpl}', '{[values.$comp.getSubTplMarkup(values)]}', '{afterSubTpl}', '<tpl if="msgTarget===\'side\'">', '{afterBodyEl}', '</td>', '<td role="presentation" id="{id}-sideErrorCell" vAlign="{[values.labelAlign===\'top\' && !values.hideLabel ? \'bottom\' : \'middle\']}" style="{[values.autoFitErrors ? \'display:none\' : \'\']}" width="{errorIconWidth}">', '<div role="alert" aria-live="polite" id="{id}-errorEl" class="{errorMsgCls}" style="display:none"></div>', '</td>', '<tpl elseif="msgTarget==\'under\'">', '<div role="alert" aria-live="polite" id="{id}-errorEl" class="{errorMsgClass}" colspan="2" style="display:none"></div>', '{afterBodyEl}', '</td>', '</tpl>', '</tr>', {disableFormats: true}]

Ext.form.field.ComboBox
view source
: Object
An optional set of configuration properties that will be passed to the Ext.view.BoundList's constructor. ...

An optional set of configuration properties that will be passed to the Ext.view.BoundList's constructor. Any configuration that is valid for BoundList can be included. Some of the more useful ones are:

  • cls - defaults to empty
  • emptyText - defaults to empty string
  • itemSelector - defaults to the value defined in BoundList
  • loadingText - defaults to 'Loading...'
  • minWidth - defaults to 70
  • maxWidth - defaults to undefined
  • maxHeight - defaults to 300
  • resizable - defaults to false
  • shadow - defaults to 'sides'
  • width - defaults to undefined (automatically set to the width of the ComboBox field if matchFieldWidth is true) getInnerTpl A function which returns a template string which renders the ComboBox's displayField value in the dropdown. This defaults to just outputting the raw value, but may use any XTemplate methods to produce output.

    The running template is configured with some extra properties that provide some context:

    - field ComboBox This combobox
    - store Store This combobox's data store
    
A config object containing one or more event handlers to be added to this object during initialization. ...

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.

DOM events from Ext JS Components

While some Ext JS Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

new Ext.panel.Panel({
    width: 400,
    height: 200,
    dockedItems: [{
        xtype: 'toolbar'
    }],
    listeners: {
        click: {
            element: 'el', //bind to the underlying el property on the panel
            fn: function(){ console.log('click el'); }
        },
        dblclick: {
            element: 'body', //bind to the underlying body property on the panel
            fn: function(){ console.log('dblclick body'); }
        }
    }
});
A configuration object or an instance of a Ext.ComponentLoader to load remote content for this Component. ...

A configuration object or an instance of a Ext.ComponentLoader to load remote content for this Component.

Ext.create('Ext.Component', {
    loader: {
        url: 'content.html',
        autoLoad: true
    },
    renderTo: Ext.getBody()
});
Specifies the margin for this component. ...

Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10' (top, right, bottom, left).

An input mask regular expression that will be used to filter keystrokes (character being typed) that do not match. ...

An input mask regular expression that will be used to filter keystrokes (character being typed) that do not match. Note: It does not filter characters already in the input.

Whether the picker dropdown's width should be explicitly set to match the width of the field. ...

Whether the picker dropdown's width should be explicitly set to match the width of the field. Defaults to true.

Defaults to: true

The maximum value in pixels which this Component will set its height to. ...

The maximum value in pixels which this Component will set its height to.

Warning: This will override any size management applied by layout managers.

Maximum input field length allowed by validation. ...

Maximum input field length allowed by validation. This behavior is intended to provide instant feedback to the user by improving usability to allow pasting and editing or overtyping and back tracking. To restrict the maximum number of characters that can be entered into the field use the enforceMaxLength option.

Defaults to Number.MAX_VALUE.

Error text to display if the maximum length validation fails ...

Error text to display if the maximum length validation fails

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

The maximum value in pixels which this Component will set its width to. ...

The maximum value in pixels which this Component will set its width to.

Warning: This will override any size management applied by layout managers.

Ext.form.field.ComboBox
view source
: Number
The minimum number of characters the user must type before autocomplete and typeAhead activate. ...

The minimum number of characters the user must type before autocomplete and typeAhead activate.

Defaults to 4 if queryMode = 'remote' or 0 if queryMode = 'local', does not apply if editable = false.

The minimum value in pixels which this Component will set its height to. ...

The minimum value in pixels which this Component will set its height to.

Warning: This will override any size management applied by layout managers.

Minimum input field length required ...

Minimum input field length required

Defaults to: 0

Error text to display if the minimum length validation fails. ...

Error text to display if the minimum length validation fails.

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

The minimum value in pixels which this Component will set its width to. ...

The minimum value in pixels which this Component will set its width to.

Warning: This will override any size management applied by layout managers.

The location where the error message text should display. ...

The location where the error message text should display. Must be one of the following values:

  • qtip Display a quick tip containing the message when the user hovers over the field. This is the default.

    Ext.tip.QuickTipManager.init must have been called for this setting to work.

  • title Display the message in a default browser title attribute popup.

  • under Add a block div beneath the field containing the error message.
  • side Add an error icon to the right of the field, displaying the message in a popup on hover.
  • none Don't display any error message. This might be useful if you are implementing custom error display.
  • [element id] Add the error message directly to the innerHTML of the specified element.

Defaults to: 'qtip'

Ext.form.field.ComboBox
view source
: Boolean
If set to true, allows the combo field to hold more than one value at a time, and allows selecting multiple items fro...

If set to true, allows the combo field to hold more than one value at a time, and allows selecting multiple items from the dropdown list. The combo's text field will show all selected values separated by the delimiter.

Defaults to: false

The name of the field. ...

The name of the field. This is used as the parameter name when including the field value in a form submit(). If no name is configured, it falls back to the inputId. To prevent the field from being included in the form submit, set submitValue to false.

Overrides: Ext.form.field.Field.name

A class to be added to the field's bodyEl element when the picker is opened. ...

A class to be added to the field's bodyEl element when the picker is opened.

Defaults to: 'x-pickerfield-open'

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. This can be useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.

Defaults to: ''

Available since: 2.3.0

Possible values are: * 'auto' to enable automatic horizontal scrollbar (overflow-x: 'auto'). ...

Possible values are: * 'auto' to enable automatic horizontal scrollbar (overflow-x: 'auto'). * 'scroll' to always enable horizontal scrollbar (overflow-x: 'scroll'). The default is overflow-x: 'hidden'. This should not be combined with autoScroll.

Possible values are: * 'auto' to enable automatic vertical scrollbar (overflow-y: 'auto'). ...

Possible values are: * 'auto' to enable automatic vertical scrollbar (overflow-y: 'auto'). * 'scroll' to always enable vertical scrollbar (overflow-y: 'scroll'). The default is overflow-y: 'hidden'. This should not be combined with autoScroll.

Specifies the padding for this component. ...

Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10' (top, right, bottom, left).

Ext.form.field.ComboBox
view source
: Number
If greater than 0, a Ext.toolbar.Paging is displayed in the footer of the dropdown list and the filter queries will e...

If greater than 0, a Ext.toolbar.Paging is displayed in the footer of the dropdown list and the filter queries will execute with page start and limit parameters. Only applies when queryMode = 'remote'.

Defaults to: 0

The alignment position with which to align the picker. ...

The alignment position with which to align the picker. Defaults to "tl-bl?"

Defaults to: 'tl-bl?'

An offset [x,y] to use in addition to the pickerAlign when positioning the picker. ...

An offset [x,y] to use in addition to the pickerAlign when positioning the picker. Defaults to undefined.

An array of plugins to be added to this component. ...

An array of plugins to be added to this component. Can also be just a single plugin instead of array.

Plugins provide custom functionality for a 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.

Plugins can be added to component by either directly referencing the plugin instance:

plugins: [Ext.create('Ext.grid.plugin.CellEditing', {clicksToEdit: 1})],

By using config object with ptype:

plugins: [{ptype: 'cellediting', clicksToEdit: 1}],

Or with just a ptype:

plugins: ['cellediting', 'gridviewdragdrop'],

See Ext.enums.Plugin for list of all ptypes.

Available since: 2.3.0

true to disable displaying any error message set on this object. ...

true to disable displaying any error message set on this object.

Defaults to: false

Ext.form.field.ComboBox
view source
: Boolean
When true, this prevents the combo from re-querying (either locally or remotely) when the current query is the same a...

When true, this prevents the combo from re-querying (either locally or remotely) when the current query is the same as the previous query.

Defaults to: true

Ext.form.field.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 queryMode = 'remote' or 10 if queryMode = 'local'

Ext.form.field.ComboBox
view source
: String
The mode in which the ComboBox uses the configured Store. ...

The mode in which the ComboBox uses the configured Store. Acceptable values are:

  • 'remote' :

    In queryMode: 'remote', the ComboBox loads its Store dynamically based upon user interaction.

    This is typically used for "autocomplete" type inputs, and after the user finishes typing, the Store is loaded.

    A parameter containing the typed string is sent in the load request. The default parameter name for the input string is query, but this can be configured using the queryParam config.

    In queryMode: 'remote', the Store may be configured with remoteFilter: true, and further filters may be programatically added to the Store which are then passed with every load request which allows the server to further refine the returned dataset.

    Typically, in an autocomplete situation, hideTrigger is configured true because it has no meaning for autocomplete.

  • 'local' :

    ComboBox loads local data

    var combo = new Ext.form.field.ComboBox({
        renderTo: document.body,
        queryMode: 'local',
        store: new Ext.data.ArrayStore({
            id: 0,
            fields: [
                'myId',  // numeric value is the key
                'displayText'
            ],
            data: [[1, 'item1'], [2, 'item2']]  // data is local
        }),
        valueField: 'myId',
        displayField: 'displayText',
        triggerAction: 'all'
    });
    

Defaults to: 'remote'

Ext.form.field.ComboBox
view source
: String
Name of the parameter used by the Store to pass the typed string when the ComboBox is configured with queryMode: 'rem...

Name of the parameter used by the Store to pass the typed string when the ComboBox is configured with queryMode: 'remote'. If explicitly set to a falsy value it will not be sent.

Defaults to: 'query'

true to prevent the user from changing the field, and hides the trigger. ...

true to prevent the user from changing the field, and hides the trigger. Supercedes the editable and hideTrigger options if the value is true.

Defaults to: false

Overrides: Ext.form.field.Base.readOnly

The CSS class applied to the component's main element when it is readOnly. ...

The CSS class applied to the component's main element when it is readOnly.

Defaults to: Ext.baseCSSPrefix + 'form-readonly'

A JavaScript RegExp object to be tested against the field value during validation. ...

A JavaScript RegExp object to be tested against the field value during validation. If the test fails, the field will be marked invalid using either regexText or invalidText.

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

The error text to display if regex is used and the test fails during validation

Defaults to: ''

: "north"/"south"/"east"/"west"/"center"
Defines the region inside border layout. ...

Defines the region inside border layout.

Possible values:

  • north - Positions component at top.
  • south - Positions component at bottom.
  • east - Positions component at right.
  • west - Positions component at left.
  • center - Positions component at the remaining space. There must be a component with region: "center" in every border layout.
The data used by renderTpl in addition to the following property values of the component: id ui uiCls baseCls compo...

The data used by renderTpl in addition to the following property values of the component:

  • id
  • ui
  • uiCls
  • baseCls
  • componentCls
  • frame

See renderSelectors and childEls for usage examples.

An object containing properties specifying DomQuery selectors which identify child elements created by the render pro...

An object containing properties specifying DomQuery selectors which identify child elements created by the render process.

After the Component's internal structure is rendered according to the renderTpl, this object is iterated through, and the found Elements are added as properties to the Component using the renderSelector property name.

For example, a Component which renders a title and description into its element:

Ext.create('Ext.Component', {
    renderTo: Ext.getBody(),
    renderTpl: [
        '<h1 class="title">{title}</h1>',
        '<p>{desc}</p>'
    ],
    renderData: {
        title: "Error",
        desc: "Something went wrong"
    },
    renderSelectors: {
        titleEl: 'h1.title',
        descEl: 'p'
    },
    listeners: {
        afterrender: function(cmp){
            // After rendering the component will have a titleEl and descEl properties
            cmp.titleEl.setStyle({color: "red"});
        }
    }
});

For a faster, but less flexible, alternative that achieves the same end result (properties for child elements on the Component after render), see childEls and addChildEls.

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

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

Notes:

Do not use this option if the Component is to be a child item of a Container. It is the responsibility of the Container's layout manager to render and manage its child items.

When using this config, a call to render() is not required.

See also: render.

Available since: 2.3.0

An XTemplate used to create the internal structure inside this Component's encapsulating Element. ...

An XTemplate used to create the internal structure inside this Component's encapsulating Element.

You do not normally need to specify this. For the base classes Ext.Component and Ext.container.Container, this defaults to null which means that they will be initially rendered with no internal structure; they render their Element empty. The more specialized Ext JS and Sencha Touch classes which use a more complex DOM structure, provide their own template definitions.

This is intended to allow the developer to create application-specific utility Components with customized internal structure.

Upon rendering, any created child elements may be automatically imported into object properties using the renderSelectors and childEls options.

Defaults to: '{%this.renderContent(out,values)%}'

true to attach a click repeater to the trigger. ...

true to attach a click repeater to the trigger.

Defaults to: false

The CSS class to apply to a required field, i.e. ...

The CSS class to apply to a required field, i.e. a field where allowBlank is false.

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

Specify as true to apply a Resizer to this Component after rendering. ...

Specify as true to apply a Resizer to this Component after rendering.

May also be specified as a config object to be passed to the constructor of Resizer to override any defaults. By default the Component passes its minimum and maximum size, and uses Ext.resizer.Resizer.dynamic: false

A valid Ext.resizer.Resizer handles config string. ...

A valid Ext.resizer.Resizer handles config string. Only applies when resizable = true.

Defaults to: 'all'

True to layout this component and its descendants in "rtl" (right-to-left) mode. ...

True to layout this component and its descendants in "rtl" (right-to-left) mode. Can be explicitly set to false to override a true value inherited from an ancestor.

Defined in override Ext.rtl.AbstractComponent.

A buffer to be applied if many state events are fired within a short period. ...

A buffer to be applied if many state events are fired within a short period.

Defaults to: 100

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

Overrides: Ext.form.field.Text.selectOnFocus

Ext.form.field.ComboBox
view source
: Boolean
Whether the Tab key should select the currently highlighted item. ...

Whether the Tab key should select the currently highlighted item.

Defaults to: true

Specifies whether the floating component should be given a shadow. ...

Specifies whether the floating component should be given a shadow. Set to true to automatically create an Ext.Shadow, or a string indicating the shadow's display Ext.Shadow.mode. Set to false to disable the shadow.

Defaults to: 'sides'

Number of pixels to offset the shadow.

Number of pixels to offset the shadow.

If this property is a number, it is interpreted as follows: 0: Neither width nor height depend on content. ...

If this property is a number, it is interpreted as follows:

  • 0: Neither width nor height depend on content. This is equivalent to false.
  • 1: Width depends on content (shrink wraps), but height does not.
  • 2: Height depends on content (shrink wraps), but width does not. The default.
  • 3: Both width and height depend on content (shrink wrap). This is equivalent to true.

In CSS terms, shrink-wrap width is analogous to an inline-block element as opposed to a block-level element. Some container layouts always shrink-wrap their children, effectively ignoring this property (e.g., Ext.layout.container.HBox, Ext.layout.container.VBox, Ext.layout.component.Dock).

Defaults to: 2

An initial value for the 'size' attribute on the text input element. ...

An initial value for the 'size' attribute on the text input element. This is only used if the field has no configured width and is not given a width by its container's layout. Defaults to 20.

Defaults to: 20

An array of events that, when fired, should trigger this object to save its state. ...

An array of events that, when fired, should trigger this object to save its state. Defaults to none. stateEvents may be any type of event supported by this object, including browser or custom events (e.g., ['click', 'customerchange']).

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

The unique id for this object to use for state management purposes. ...

The unique id for this object to use for state management purposes.

See stateful for an explanation of saving and restoring state.

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

A flag which causes the object to attempt to restore the state of internal properties from a saved state on startup. The object must have a stateId 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 object.

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({ expires: new Date(new Date().getTime()+(10006060247)), //7 days from now }));

A stateful object attempts to save state when one of the events listed in the stateEvents configuration fires.

To save state, a stateful object first serializes its state by calling getState.

The Component base class implements getState to save its width and height within the state only if they were initially configured, and have changed from the configured value.

The Panel class saves its collapsed state in addition to that.

The Grid class saves its column state in addition to its superclass state.

If there is more application state to be save, the developer must provide an implementation which first calls the superclass method to inherit the above behaviour, and then injects new properties into the returned object.

The value yielded by getState is passed to Ext.state.Manager.set which uses the configured Ext.state.Provider to save the object keyed by the stateId.

During construction, a stateful object attempts to restore its state by calling Ext.state.Manager.get passing the stateId

The resulting object is passed to applyState*. The default implementation of applyState simply copies properties into the object, but a developer may override this to support restoration of more complex application state.

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

Defaults to: false

Ext.form.field.ComboBox
view source
: Ext.data.Store/String/Array
The data source to which this combo is bound. ...

The data source to which this combo is bound. Acceptable values for this property are:

  • any Store subclass
  • an ID of a store
  • an Array : Arrays will be converted to a Ext.data.Store internally, automatically generating field names to work with all data components.

    • 1-dimensional array : (e.g., ['Foo','Bar'])

      A 1-dimensional array will automatically be expanded (each array item will be used for both the combo valueField and displayField)

    • 2-dimensional array : (e.g., [['f','Foo'],['b','Bar']])

      For a multi-dimensional array, the value in index 0 of each item will be assumed to be the combo valueField, while the value at index 1 is assumed to be the combo displayField.

See also queryMode.

A JavaScript RegExp object used to strip unwanted content from the value during input. ...

A JavaScript RegExp object used to strip unwanted content from the value during input. If stripCharsRe is specified, every character sequence matching stripCharsRe will be removed.

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.

new Ext.panel.Panel({
    title: 'Some Title',
    renderTo: Ext.getBody(),
    width: 400, height: 300,
    layout: 'form',
    items: [{
        xtype: 'textarea',
        style: {
            width: '95%',
            marginBottom: '10px'
        }
    },
    new Ext.button.Button({
        text: 'Send',
        minWidth: '100',
        style: {
            marginBottom: '10px'
        }
    })
    ]
});

Available since: 1.1.0

Setting this to false will prevent the field from being submitted even when it is not disabled. ...

Setting this to false will prevent the field from being submitted even when it is not disabled.

Defaults to: true

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

True to automatically call toFront when the show method is called on an already visible, floating component. ...

True to automatically call toFront when the show method is called on an already visible, floating component.

Defaults to: true

An Ext.Template, Ext.XTemplate or an array of strings to form an Ext.XTemplate. ...

An Ext.Template, Ext.XTemplate or an array of strings to form an Ext.XTemplate. Used in conjunction with the data and tplWriteMode configurations.

Available since: 3.4.0

The Ext.(X)Template method to use when updating the content area of the Component. ...

The Ext.(X)Template method to use when updating the content area of the Component. See Ext.XTemplate.overwrite for information on default mode.

Defaults to: 'overwrite'

Available since: 3.4.0

Ext.form.field.ComboBox
view source
: String/HTMLElement/Ext.Element
The id, DOM node or Ext.Element of an existing HTML <select> element to convert into a ComboBox. ...

The id, DOM node or Ext.Element of an existing HTML <select> element to convert into a ComboBox. The target select's options will be used to build the options in the ComboBox dropdown; a configured store will take precedence over this.

Ext.form.field.ComboBox
view source
: Boolean
true to automatically render this combo box in place of the select element that is being transformed. ...

true to automatically render this combo box in place of the select element that is being transformed. If false, this combo will be rendered using the normal rendering, either as part of a layout, or using renderTo or render.

Defaults to: true

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

The action to execute when the trigger is clicked.

See also queryParam.

Defaults to: 'all'

The base CSS class that is always added to the trigger button. ...

The base CSS class that is always added to the trigger button. The triggerCls will be appended in addition to this class.

Defaults to: Ext.baseCSSPrefix + 'form-trigger'

Ext.form.field.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 triggerBaseCls by default and triggerCls will be appended if specified.

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

Overrides: Ext.form.field.Trigger.triggerCls

The CSS class that is added to the text field when component is read-only or not editable. ...

The CSS class that is added to the text field when component is read-only or not editable.

Defaults to: Ext.baseCSSPrefix + 'trigger-noedit'

The CSS class that is added to the div wrapping the trigger button(s). ...

The CSS class that is added to the div wrapping the trigger button(s).

Defaults to: Ext.baseCSSPrefix + 'form-trigger-wrap'

Ext.form.field.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

Ext.form.field.ComboBox
view source
: Number
The length of time in milliseconds to wait until the typeahead text is displayed if typeAhead = true ...

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

Defaults to: 250

A UI style for a component. ...

A UI style for a component.

Defaults to: 'default'

An array of of classNames which are currently applied to this component. ...

An array of of classNames which are currently applied to this component.

Defaults to: []

Specify as true to modify the behaviour of allowBlank so that blank values are not passed as valid, but are subject t...

Specify as true to modify the behaviour of allowBlank so that blank values are not passed as valid, but are subject to any configure vtype validation.

Defaults to: false

Whether the field should validate when it loses focus. ...

Whether the field should validate when it loses focus. This will cause fields to be validated as the user steps through the fields in the form regardless of whether they are making changes to those fields along the way. See also validateOnChange.

Defaults to: true

Specifies whether this field should be validated immediately whenever a change in its value is detected. ...

Specifies whether this field should be validated immediately whenever a change in its value is detected. If the validation results in a change in the field's validity, a validitychange event will be fired. This allows the field to show feedback about the validity of its contents immediately as the user is typing.

When set to false, feedback will not be immediate. However the form will still be validated before submitting if the clientValidation option to Ext.form.Basic.doAction is enabled, or if the field or form are validated manually.

See also Ext.form.field.Base.checkChangeEvents for controlling how changes to the field's value are detected.

Defaults to: true

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

A custom validation function to be called during field validation (getErrors). If specified, this function will be called first, allowing the developer to override the default validation process.

This function will be passed the following parameters:

Parameters

  • value : Object

    The current field value

Returns

  • Boolean/String
    • True if the value is valid
    • An error message if the value is invalid

A value to initialize this field with.

A value to initialize this field with.

Ext.form.field.ComboBox
view source
: String
When using a name/value combo, if the value passed to setValue is not found in the store, valueNotFoundText will be d...

When using a name/value combo, if the value passed to setValue is not found in the store, valueNotFoundText will be displayed as the field text if defined. If this default text is used, it means there is no value set and no validation will occur on this field.

A validation type name as defined in Ext.form.field.VTypes

A validation type name as defined in Ext.form.field.VTypes

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. Note: only applies if vtype is set, else ignored.

A value to control how Components are laid out in a Border layout or as docked items. ...

A value to control how Components are laid out in a Border layout or as docked items.

In a Border layout, this can control how the regions (not the center) region lay out if the west or east take full height or if the north or south region take full width. Also look at the Ext.layout.container.Border.regionWeights on the Border layout. An example to show how you can take control of this is:

Ext.create('Ext.container.Viewport', {
    layout      : 'border',
    defaultType : 'panel',
    items       : [
        {
            region : 'north',
            title  : 'North',
            height : 100
        },
        {
            region : 'south',
            title  : 'South',
            height : 100,
            weight : -25
        },
        {
            region : 'west',
            title  : 'West',
            width  : 200,
            weight : 15
        },
        {
            region : 'east',
            title  : 'East',
            width  : 200
        },
        {
            region : 'center',
            title  : 'center'
        }
    ]
});

If docked items, the weight will order how the items are laid out. Here is an example to put a Ext.toolbar.Toolbar above a Ext.panel.Panel's header:

Ext.create('Ext.panel.Panel', {
    renderTo    : document.body,
    width       : 300,
    height      : 300,
    title       : 'Panel',
    html        : 'Panel Body',
    dockedItems : [
        {
            xtype : 'toolbar',
            items : [
                {
                    text : 'Save'
                }
            ]
        },
        {
            xtype  : 'toolbar',
            weight : -10,
            items  : [
                {
                    text : 'Remove'
                }
            ]
        }
    ]
});

Defaults to: 0

The width of this component in pixels.

The width of this component in pixels.

This property provides a shorter alternative to creating objects than using a full class name. ...

This property provides a shorter alternative to creating objects than using a full class name. Using xtype is the most common way to define component instances, especially in a container. For example, the items in a form containing text fields could be created explicitly like so:

 items: [
     Ext.create('Ext.form.field.Text', {
         fieldLabel: 'Foo'
     }),
     Ext.create('Ext.form.field.Text', {
         fieldLabel: 'Bar'
     }),
     Ext.create('Ext.form.field.Number', {
         fieldLabel: 'Num'
     })
 ]

But by using xtype, the above becomes:

 items: [
     {
         xtype: 'textfield',
         fieldLabel: 'Foo'
     },
     {
         xtype: 'textfield',
         fieldLabel: 'Bar'
     },
     {
         xtype: 'numberfield',
         fieldLabel: 'Num'
     }
 ]

When the xtype is common to many items, Ext.container.AbstractContainer.defaultType is another way to specify the xtype for all items that don't have an explicit xtype:

 defaultType: 'textfield',
 items: [
     { fieldLabel: 'Foo' },
     { fieldLabel: 'Bar' },
     { fieldLabel: 'Num', xtype: 'numberfield' }
 ]

Each member of the items array is now just a "configuration object". These objects are used to create and configure component instances. A configuration object can be manually used to instantiate a component using Ext.widget:

 var text1 = Ext.create('Ext.form.field.Text', {
     fieldLabel: 'Foo'
 });

 // or alternatively:

 var text1 = Ext.widget({
     xtype: 'textfield',
     fieldLabel: 'Foo'
 });

This conversion of configuration objects into instantiated components is done when a container is created as part of its {Ext.container.AbstractContainer.initComponent} process. As part of the same process, the items array is converted from its raw array form into a Ext.util.MixedCollection instance.

You can define your own xtype on a custom component by specifying the xtype property in Ext.define. For example:

Ext.define('MyApp.PressMeButton', {
    extend: 'Ext.button.Button',
    xtype: 'pressmebutton',
    text: 'Press Me'
});

Care should be taken when naming an xtype in a custom component because there is a single, shared scope for all xtypes. Third part components should consider using a prefix to avoid collisions.

Ext.define('Foo.form.CoolButton', {
    extend: 'Ext.button.Button',
    xtype: 'ux-coolbutton',
    text: 'Cool!'
});

See Ext.enums.Widget for list of all available xtypes.

Available since: 2.3.0

Properties

Defined By

Instance properties

...

Defaults to: 'Ext.Base'

...

Defaults to: /^([a-z]+)-([a-z]+)(\?)?$/

Setting this property to true causes the isLayoutRoot method to return true and stop the search for the top-most comp...

Setting this property to true causes the isLayoutRoot method to return true and stop the search for the top-most component for a layout.

Defaults to: false

...

Defaults to: ['position', 'top', 'left']

Ext.form.field.ComboBox
view source
: Stringprivate
...

Defaults to: 'combobox'

Overrides: Ext.form.field.Text.ariaRole

...

Defaults to: {tag: 'table', cellpadding: 0, role: 'presentation'}

true indicates an id was auto-generated rather than provided by configuration. ...

true indicates an id was auto-generated rather than provided by configuration.

Defaults to: false

The div Element wrapping the component's contents. ...

The div Element wrapping the component's contents. Only available after the component has been rendered.

private ...

private

Defaults to: Ext.baseCSSPrefix + 'border-box'

...

Defaults to: []

...

Defaults to: [{name: 'triggerCell', select: '.' + Ext.baseCSSPrefix + 'trigger-cell'}, {name: 'triggerEl', select: '.' + Ext.baseCSSPrefix + 'form-trigger'}, 'triggerWrap', 'inputCell']

Overrides: Ext.form.Labelable.childEls

The number of component layout calls made on this object. ...

The number of component layout calls made on this object.

Defaults to: 0

...

Defaults to: {}

The name of the padding property that is used by the layout to manage padding. ...

The name of the padding property that is used by the layout to manage padding. See managePadding

Defaults to: 'padding'

By default this method does nothing but return the position spec passed to it. ...

By default this method does nothing but return the position spec passed to it. In rtl mode it is overridden to convert "l" to "r" and vice versa when required.

...

Defaults to: 'autocomponent'

Indicates whether or not the component can be dragged. ...

Indicates whether or not the component can be dragged.

Defaults to: false

The div Element that will contain the component's error message(s). ...

The div Element that will contain the component's error message(s). Note that depending on the configured msgTarget, this element may be hidden in favor of some other form of presentation, but will always be present in the DOM for use by assistive technologies.

Initial suspended call count. ...

Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.

Defaults to: 0

Only present for floating Components which were inserted as child items of Containers. ...

Only present for floating Components which were inserted as child items of Containers.

There are other similar relationships such as the button which activates a menu, or the menu item which activated a submenu, or the column header which activated the column menu.

These differences are abstracted away by the up method.

Floating Components that are programatically rendered will not have a floatParent property.

See floating and zIndexManager

...

Defaults to: Ext.baseCSSPrefix + 'frame'

...

Defaults to: ['TL', 'TC', 'TR', 'ML', 'MC', 'MR', 'BL', 'BC', 'BR', 'Table']

...

Defaults to: ['tl', 'tc', 'tr', 'ml', 'mc', 'mr', 'bl', 'bc', 'br']

...

Defaults to: /[\-]frame\d+[TMB][LCR]$/

Cache the frame information object so as not to cause style recalculations ...

Cache the frame information object so as not to cause style recalculations

Defaults to: {}

Indicates the width of any framing elements which were added within the encapsulating element to provide graphical, r...

Indicates the width of any framing elements which were added within the encapsulating element to provide graphical, rounded borders. See the frame config. This property is null if the component is not framed.

This is an object containing the frame width in pixels for all four sides of the Component containing the following properties:

  • top : Number (optional)

    The width of the top framing element in pixels.

    Defaults to: 0

  • right : Number (optional)

    The width of the right framing element in pixels.

    Defaults to: 0

  • bottom : Number (optional)

    The width of the bottom framing element in pixels.

    Defaults to: 0

  • left : Number (optional)

    The width of the left framing element in pixels.

    Defaults to: 0

  • width : Number (optional)

    The total width of the left and right framing elements in pixels.

    Defaults to: 0

  • height : Number (optional)

    The total height of the top and right bottom elements in pixels.

    Defaults to: 0

...

Defaults to: ['{%this.renderDockedItems(out,values,0);%}', '<tpl if="top">', '<tpl if="left"><div id="{fgid}TL" class="{frameCls}-tl {baseCls}-tl {baseCls}-{ui}-tl<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tl</tpl>{frameElCls}" role="presentation"></tpl>', '<tpl if="right"><div id="{fgid}TR" class="{frameCls}-tr {baseCls}-tr {baseCls}-{ui}-tr<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tr</tpl>{frameElCls}" role="presentation"></tpl>', '<div id="{fgid}TC" class="{frameCls}-tc {baseCls}-tc {baseCls}-{ui}-tc<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tc</tpl>{frameElCls}" role="presentation"></div>', '<tpl if="right"></div></tpl>', '<tpl if="left"></div></tpl>', '</tpl>', '<tpl if="left"><div id="{fgid}ML" class="{frameCls}-ml {baseCls}-ml {baseCls}-{ui}-ml<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-ml</tpl>{frameElCls}" role="presentation"></tpl>', '<tpl if="right"><div id="{fgid}MR" class="{frameCls}-mr {baseCls}-mr {baseCls}-{ui}-mr<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mr</tpl>{frameElCls}" role="presentation"></tpl>', '<div id="{fgid}MC" class="{frameCls}-mc {baseCls}-mc {baseCls}-{ui}-mc<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mc</tpl>{frameElCls}" role="presentation">', '{%this.applyRenderTpl(out, values)%}', '</div>', '<tpl if="right"></div></tpl>', '<tpl if="left"></div></tpl>', '<tpl if="bottom">', '<tpl if="left"><div id="{fgid}BL" class="{frameCls}-bl {baseCls}-bl {baseCls}-{ui}-bl<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bl</tpl>{frameElCls}" role="presentation"></tpl>', '<tpl if="right"><div id="{fgid}BR" class="{frameCls}-br {baseCls}-br {baseCls}-{ui}-br<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-br</tpl>{frameElCls}" role="presentation"></tpl>', '<div id="{fgid}BC" class="{frameCls}-bc {baseCls}-bc {baseCls}-{ui}-bc<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bc</tpl>{frameElCls}" role="presentation"></div>', '<tpl if="right"></div></tpl>', '<tpl if="left"></div></tpl>', '</tpl>', '{%this.renderDockedItems(out,values,1);%}']

private ...

private

Defaults to: false

This object holds a key for any event that has a listener. ...

This object holds a key for any event that has a listener. The listener may be set directly on the instance, or on its class or a super class (via observe) or on the MVC EventBus. The values of this object are truthy (a non-zero number) and falsy (0 or undefined). They do not represent an exact count of listeners. The value for an event is truthy if the event must be fired and is falsy if there is no need to fire the event.

The intended use of this property is to avoid the expense of fireEvent calls when there are no listeners. This can be particularly helpful when one would otherwise have to call fireEvent hundreds or thousands of times. It is used like this:

 if (this.hasListeners.foo) {
     this.fireEvent('foo', this, arg1);
 }
Ext.form.field.ComboBox
view source
: Ext.Elementprivate
...

Defaults to: ['<tpl if="errors && errors.length">', '<ul class="{listCls}">', '<tpl if="Ext.enableAria">', '<tpl if="fieldLabel"><div>{fieldLabel}</div></tpl>', '</tpl>', '<tpl for="errors"><li>{.}</li></tpl>', '</ul>', '</tpl>']

Ext.form.field.ComboBox
view source
: Numberprivate
private ...

private

Defaults to: 0

...

Defaults to: []

...

Defaults to: {}

A reference to the TD element wrapping the input element. ...

A reference to the TD element wrapping the input element. Only set after the field has been rendered.

The input Element for this Field. ...

The input Element for this Field. Only available after the field has been rendered.

private ...

private

Defaults to: Ext.baseCSSPrefix + 'form-item-input-row'

...

Defaults to: true

true in this class to identify an object as an instantiated Component, or subclass thereof. ...

true in this class to identify an object as an instantiated Component, or subclass thereof.

Defaults to: true

True if the picker is currently expanded, false if not.

True if the picker is currently expanded, false if not.

Flag denoting that this object is labelable as a field. ...

Flag denoting that this object is labelable as a field. Always true.

Defaults to: true

Flag denoting that this component is a Field. ...

Flag denoting that this component is a Field. Always true.

Defaults to: true

...

Defaults to: true

true in this class to identify an object as an instantiated Observable, or subclass thereof. ...

true in this class to identify an object as an instantiated Observable, or subclass thereof.

Defaults to: true

The <TD> Element which contains the label Element for this component. ...

The <TD> Element which contains the label Element for this component. Only available after the component has been rendered.

The label Element for this component. ...

The label Element for this component. Only available after the component has been rendered.

...

Defaults to: ['beforeBodyEl', 'afterBodyEl', 'beforeLabelTpl', 'afterLabelTpl', 'beforeSubTpl', 'afterSubTpl', 'beforeLabelTextTpl', 'afterLabelTextTpl', 'labelAttrTpl']

This is an array to avoid a split on every call to Ext.copyTo ...

This is an array to avoid a split on every call to Ext.copyTo

Defaults to: ['allowBlank', 'id', 'labelAlign', 'fieldBodyCls', 'extraFieldBodyCls', 'baseBodyCls', 'clearCls', 'labelSeparator', 'msgTarget', 'inputRowCls']

Ext.form.field.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.field.ComboBox({
    ...
    queryMode: '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;
        }
    }
});

To make sure the filter in the store is not cleared the first time the ComboBox trigger is used configure the combo with lastQuery=''. Example use:

var combo = new Ext.form.field.ComboBox({
    ...
    queryMode: 'local',
    triggerAction: 'all',
    lastQuery: ''
});
This is an internal flag that you use when creating custom components. ...

This is an internal flag that you use when creating custom components. By default this is set to true which means that every component gets a mask when it's disabled. Components like FieldContainer, FieldSet, Field, Button, Tab override this property to false since they want to implement custom disable logic.

Defaults to: false

Overrides: Ext.AbstractComponent.maskOnDisable

Tells the layout system that the height can be measured immediately because the width does not need setting. ...

Tells the layout system that the height can be measured immediately because the width does not need setting.

Defaults to: true

...

Defaults to: Ext.baseCSSPrefix + 'hide-offsets'

The original value of the field as configured in the value configuration, or as loaded by the last form load operatio...

The original value of the field as configured in the value configuration, or as loaded by the last form load operation if the form's trackResetOnLoad setting is true.

This Component's owner Container (is set automatically when this Component is added to a Container). ...

This Component's owner Container (is set automatically when this Component is added to a Container).

Important. This is not a universal upwards navigation pointer. It indicates the Container which owns and manages this Component if any. There are other similar relationships such as the button which activates a menu, or the menu item which activated a submenu, or the column header which activated the column menu.

These differences are abstracted away by the up method.

Note: to access items within the Container see itemId.

Available since: 2.3.0

...

Defaults to: ['<tpl if="errors && errors.length">', '<tpl if="Ext.enableAria">', '<tpl if="fieldLabel">{fieldLabel}\n</tpl>', '</tpl>', '<tpl for="errors"><tpl if="xindex &gt; 1">\n</tpl>{.}</tpl>', '</tpl>']

Ext.form.field.ComboBox
view source
: Objectprivate

private, tells the layout to recalculate its startingWidth when a record is removed from its bound store

private, tells the layout to recalculate its startingWidth when a record is removed from its bound store

Indicates whether or not the component has been rendered. ...

Indicates whether or not the component has been rendered.

Defaults to: false

Available since: 1.1.0

...

Defaults to: Ext.baseCSSPrefix + 'body'

An object property which provides unified information as to which dimensions are scrollable based upon the autoScroll...

An object property which provides unified information as to which dimensions are scrollable based upon the autoScroll, overflowX and overflowY settings (And for views of trees and grids, the owning panel's scroll setting).

Note that if you set overflow styles using the style config or bodyStyle config, this object does not include that information; it is best to use autoScroll, overflowX and overflowY if you need to access these flags.

This object has the following properties:

  • x : Boolean

    true if this Component is scrollable horizontally - style setting may be 'auto' or 'scroll'.

  • y : Boolean

    true if this Component is scrollable vertically - style setting may be 'auto' or 'scroll'.

  • both : Boolean

    true if this Component is scrollable both horizontally and vertically.

  • overflowX : String

    The overflow-x style setting, 'auto' or 'scroll' or ''.

  • overflowY : String

    The overflow-y style setting, 'auto' or 'scroll' or ''.

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics for a detailed comparison

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); // dependent on 'this'
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'
Instructs the layout to stretch the inputEl to 100% width when laying out under fixed conditions. ...

Instructs the layout to stretch the inputEl to 100% width when laying out under fixed conditions. Defaults to true for all fields except check/radio Doesn't seem worth it to introduce a whole new layout class just for this flag

Defaults to: true

...

Defaults to: ['inputAttrTpl']

A composite of all the trigger button elements. ...

A composite of all the trigger button elements. Only set after the field has been rendered.

...

Defaults to: /trigger-index-(\d+)/

Width of the trigger element. ...

Width of the trigger element. Unless set explicitly, it will be automatically calculated through creating a temporary element on page. (That will be done just once per app run.)

A reference to the TABLE element which encapsulates the input field and all trigger button(s). ...

A reference to the TABLE element which encapsulates the input field and all trigger button(s). Only set after the field has been rendered.

private ...

private

Defaults to: false

Only present for floating Components after they have been rendered. ...

Only present for floating Components after they have been rendered.

A reference to the ZIndexManager which is managing this Component's z-index.

The ZIndexManager maintains a stack of floating Component z-indices, and also provides a single modal mask which is insert just beneath the topmost visible modal floating Component.

Floating Components may be brought to the front or sent to the back of the z-index stack.

This defaults to the global ZIndexManager for floating Components that are programatically rendered.

For floating Components which are added to a Container, the ZIndexManager is acquired from the first ancestor Container found which is floating. If no floating ancestor is found, the global ZIndexManager is used.

See floating and zIndexParent

Only present for floating Components which were inserted as child items of Containers, and which have a floating Cont...

Only present for floating Components which were inserted as child items of Containers, and which have a floating Container in their containment ancestry.

For floating Components which are child items of a Container, the zIndexParent will be a floating ancestor Container which is responsible for the base z-index value of all its floating descendants. It provides a ZIndexManager which provides z-indexing services for all its descendant floating Components.

Floating Components that are programatically rendered will not have a zIndexParent property.

For example, the dropdown BoundList of a ComboBox which is in a Window will have the Window as its zIndexParent, and will always show above that Window, wherever the Window is placed in the z-index stack.

See floating and zIndexManager

Defined By

Static properties

...

Defaults to: []

Methods

Defined By

Instance methods

Creates new Component. ...

Creates new Component.

Parameters

  • config : Ext.Element/String/Object

    The configuration options may be specified as either:

    • an element : it is set as the internal element and its id used as the component id
    • a string : it is assumed to be the id of an existing element and is used as the component id
    • anything else : it is assumed to be a standard config object and is applied to the component

Returns

Overrides: Ext.AbstractComponent.constructor

Adds each argument passed to this method to the childEls array. ...

Adds each argument passed to this method to the childEls array.

Adds a CSS class to the top level element representing this component. ...

Adds a CSS class to the top level element representing this component.

Available since: 2.3.0

This method has been deprected since 4.1

Use addCls instead.

Parameters

Returns

Adds a CSS class to the top level element representing this component. ...

Adds a CSS class to the top level element representing this component.

Parameters

Returns

Adds a cls to the uiCls array, which will also call addUIClsToElement and adds to all elements of this component. ...

Adds a cls to the uiCls array, which will also call addUIClsToElement and adds to all elements of this component.

Parameters

  • classes : String/String[]

    A string or an array of strings to add to the uiCls.

  • skip : Object

    (Boolean) skip true to skip adding it to the class and do it later (via the return).

Adds the specified events to the list of events which this Observable may fire. ...

Adds the specified events to the list of events which this Observable may fire.

Parameters

  • eventNames : Object/String...

    Either an object with event names as properties with a value of true. For example:

    this.addEvents({
        storeloaded: true,
        storecleared: true
    });
    

    Or any number of event names as separate parameters. For example:

    this.addEvents('storeloaded', 'storecleared');
    
Sets up the focus listener on this Component's focusEl if it has one. ...

Sets up the focus listener on this Component's focusEl if it has one.

Form Components which must implicitly participate in tabbing order usually have a naturally focusable element as their focusEl, and it is the DOM event of that receiving focus which drives the Component's onFocus handling, and the DOM event of it being blurred which drives the onBlur handling.

If the focusEl is not naturally focusable, then the listeners are only added if the FocusManager is enabled.

( element, listeners, scope, options ) : Object
Appends an event handler to this object. ...

Appends an event handler to this object. For example:

myGridPanel.on("mouseover", this.onMouseOver, this);

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

myGridPanel.on({
    cellClick: this.onCellClick,
    mouseover: this.onMouseOver,
    mouseout: this.onMouseOut,
    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

myGridPanel.on({
    cellClick: {fn: this.onCellClick, scope: this, single: true},
    mouseover: {fn: panel.onMouseOver, scope: panel}
});

Names of methods in a specified scope may also be used. Note that scope MUST be specified to use this option:

myGridPanel.on({
    cellClick: {fn: 'onCellClick', scope: this, single: true},
    mouseover: {fn: 'onMouseOver', scope: panel}
});

Parameters

Returns

  • Object

    Only when the destroyable option is specified.

    A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

    this.btnListeners =  = myButton.on({
        destroyable: true
        mouseover:   function() { console.log('mouseover'); },
        mouseout:    function() { console.log('mouseout'); },
        click:       function() { console.log('click'); }
    });
    

    And when those listeners need to be removed:

    Ext.destroy(this.btnListeners);
    

    or

    this.btnListeners.destroy();
    

Overrides: Ext.util.Observable.addListener

( item, ename, [fn], [scope], [options] ) : Object
Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destr...

Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destroyed.

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item to which to add a listener/listeners.

  • ename : Object/String

    The event name, or an object containing event name properties.

  • fn : Function (optional)

    If the ename parameter was an event name, this is the handler function.

  • scope : Object (optional)

    If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

  • options : Object (optional)

    If the ename parameter was an event name, this is the addListener options.

Returns

  • Object

    Only when the destroyable option is specified.

    A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

    this.btnListeners =  = myButton.mon({
        destroyable: true
        mouseover:   function() { console.log('mouseover'); },
        mouseout:    function() { console.log('mouseout'); },
        click:       function() { console.log('click'); }
    });
    

    And when those listeners need to be removed:

    Ext.destroy(this.btnListeners);
    

    or

    this.btnListeners.destroy();
    
Adds a plugin. ...

Adds a plugin. May be called at any time in the component's lifecycle.

Parameters

( state, propName, [value] ) : Booleanprotected
Save a property to the given state object if it is not its default or configured value. ...

Save a property to the given state object if it is not its default or configured value.

Parameters

  • state : Object

    The state object.

  • propName : String

    The name of the property on this object to save.

  • value : String (optional)

    The value of the state property (defaults to this[propName]).

Returns

  • Boolean

    The state object or a new object if state was null and the property was saved.

Add events that will trigger the state to be saved. ...

Add events that will trigger the state to be saved. If the first argument is an array, each element of that array is the name of a state event. Otherwise, each argument passed to this method is the name of a state event.

Parameters

  • events : String/String[]

    The event name or an array of event names.

Method which adds a specified UI + uiCls to the components element. ...

Method which adds a specified UI + uiCls to the components element. Can be overridden to remove the UI from more than just the components element.

Parameters

  • ui : String

    The UI to remove from the element.

Method which adds a specified UI to the components element. ...

Method which adds a specified UI to the components element.

private ==> used outside of core TODO: currently only used by ToolTip. ...

private ==> used outside of core TODO: currently only used by ToolTip. does this method belong here?

Parameters

...

Parameters

Called by the layout system after the Component has been laid out. ...

Called by the layout system after the Component has been laid out.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Fires

Overrides: Ext.Component.afterComponentLayout

( [callback], [scope] )protectedtemplate
Invoked after the Component has been hidden. ...

Invoked after the Component has been hidden.

Gets passed the same callback and scope parameters that onHide received.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Parameters

Fires

Ext.form.field.ComboBox
view source
( queryPlan )template
A method called when the filtering caused by the doQuery call is complete and the store has been either filtered loca...

A method called when the filtering caused by the doQuery call is complete and the store has been either filtered locally (if queryMode is "local"), or has been loaded using the specified filtering.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Parameters

  • queryPlan : Object

    An object containing details about the query was executed.

    • query : String

      The query value to be used to match against the ComboBox's valueField.

    • forceAll : Boolean

      If true, causes the query to be executed even if the minChars threshold is not met.

    • cancel : Boolean

      A boolean value which, if set to true upon return, causes the query not to be executed.

    • rawQuery : Boolean

      If true indicates that the raw input field value is being used, and upon store load, the input field value should not be overwritten.

Ext.form.field.ComboBox
view source
( )protectedtemplate
Allows addition of behavior after rendering is complete. ...

Allows addition of behavior after rendering is complete. At this stage the Component’s Element will have been styled according to the configuration, will have had any configured CSS class names added, and will be in the configured visibility and the configured enable state.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Overrides: Ext.form.field.Text.afterRender

( ax, ay )protectedtemplate
Template method called after a Component has been positioned. ...

Template method called after a Component has been positioned.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Parameters

Fires

Overrides: Ext.AbstractComponent.afterSetPosition

( [animateTarget], [callback], [scope] )protectedtemplate
Invoked after the Component is shown (after onShow is called). ...

Invoked after the Component is shown (after onShow is called).

Gets passed the same parameters as show.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Parameters

Fires

Ext.form.field.ComboBox
view source
( )protected
Aligns the picker to the input element ...

Aligns the picker to the input element

Overrides: Ext.form.field.Picker.alignPicker

( element, [position], [offsets], [animate] ) : Ext.util.Positionablechainable
Aligns the element with another element relative to the specified anchor points. ...

Aligns the element with another element relative to the specified anchor points. If the other element is the document it aligns it to the viewport. The position parameter is optional, and can be specified in any one of the following formats:

  • Blank: Defaults to aligning the element's top-left corner to the target's bottom-left corner ("tl-bl").
  • One anchor (deprecated): The passed anchor position is used as the target element's anchor point. The element being aligned will position its top-left corner (tl) to that point. This method has been deprecated in favor of the newer two anchor syntax below.
  • Two anchors: If two values from the table below are passed separated by a dash, the first value is used as the element's anchor point, and the second value is used as the target's anchor point.

In addition to the anchor points, the position parameter also supports the "?" character. If "?" is passed at the end of the position string, the element will attempt to align as specified, but the position will be adjusted to constrain to the viewport if necessary. Note that the element being aligned might be swapped to align to a different position than that specified in order to enforce the viewport constraints. Following are all of the supported anchor positions:

Value  Description
-----  -----------------------------
tl     The top left corner (default)
t      The center of the top edge
tr     The top right corner
l      The center of the left edge
c      In the center of the element
r      The center of the right edge
bl     The bottom left corner
b      The center of the bottom edge
br     The bottom right corner

Example Usage:

// align el to other-el using the default positioning
// ("tl-bl", non-constrained)
el.alignTo("other-el");

// align the top left corner of el with the top right corner of other-el
// (constrained to viewport)
el.alignTo("other-el", "tr?");

// align the bottom right corner of el with the center left edge of other-el
el.alignTo("other-el", "br-l?");

// align the center of el with the bottom left corner of other-el and
// adjust the x position by -6 pixels (and the y position by 0)
el.alignTo("other-el", "c-bl", [-6, 0]);

Parameters

  • element : Ext.util.Positionable/HTMLElement/String

    The Positionable, HTMLElement, or id of the element to align to.

  • position : String (optional)

    The position to align to

    Defaults to: "tl-bl?"

  • offsets : Number[] (optional)

    Offset the positioning by [x, y]

  • animate : Boolean/Object (optional)

    true for the default animation or a standard Element animation config object

Returns

( element, [position], [offsets], [animate], [monitorScroll], [callback] ) : Ext.util.Positionablechainable
Anchors an element to another element and realigns it when the window is resized. ...

Anchors an element to another element and realigns it when the window is resized.

Parameters

  • element : Ext.util.Positionable/HTMLElement/String

    The Positionable, HTMLElement, or id of the element to align to.

  • position : String (optional)

    The position to align to

    Defaults to: "tl-bl?"

  • offsets : Number[] (optional)

    Offset the positioning by [x, y]

  • animate : Boolean/Object (optional)

    true for the default animation or a standard Element animation config object

  • monitorScroll : Boolean/Number (optional)

    True to monitor body scroll and reposition. If this parameter is a number, it is used as the buffer delay in milliseconds.

    Defaults to: 50

  • callback : Function (optional)

    The function to call after the animation finishes

Returns

process the passed fx configuration. ...
  • process the passed fx configuration.

Parameters

Performs custom animation on this object. ...

Performs custom animation on this object.

This method is applicable to both the Component class and the Sprite class. It performs animated transitions of certain properties of this object over a specified timeline.

Animating a Component

When animating a Component, the following properties may be specified in from, to, and keyframe objects:

  • x - The Component's page X position in pixels.

  • y - The Component's page Y position in pixels

  • left - The Component's left value in pixels.

  • top - The Component's top value in pixels.

  • width - The Component's width value in pixels.

  • height - The Component's height value in pixels.

  • dynamic - Specify as true to update the Component's layout (if it is a Container) at every frame of the animation. Use sparingly as laying out on every intermediate size change is an expensive operation.

For example, to animate a Window to a new size, ensuring that its internal layout and any shadow is correct:

myWindow = Ext.create('Ext.window.Window', {
    title: 'Test Component animation',
    width: 500,
    height: 300,
    layout: {
        type: 'hbox',
        align: 'stretch'
    },
    items: [{
        title: 'Left: 33%',
        margins: '5 0 5 5',
        flex: 1
    }, {
        title: 'Left: 66%',
        margins: '5 5 5 5',
        flex: 2
    }]
});
myWindow.show();
myWindow.header.el.on('click', function() {
    myWindow.animate({
        to: {
            width: (myWindow.getWidth() == 500) ? 700 : 500,
            height: (myWindow.getHeight() == 300) ? 400 : 300
        }
    });
});

For performance reasons, by default, the internal layout is only updated when the Window reaches its final "to" size. If dynamic updating of the Window's child Components is required, then configure the animation with dynamic: true and the two child items will maintain their proportions during the animation.

Parameters

Returns

Overrides: Ext.util.Animate.animate

Sets references to elements inside the component. ...

Sets references to elements inside the component.

Parameters

Sets references to elements inside the component. ...

Sets references to elements inside the component. This applies renderSelectors as well as childEls.

Overrides: Ext.util.Renderable.applyRenderSelectors

Applies the state to the object. ...

Applies the state to the object. This should be overridden in subclasses to do more complex state operations. By default it applies the state properties onto the current object.

Parameters

Overrides: Ext.state.Stateful.applyState

Ext.form.field.ComboBox
view source
( )private
A utility for grouping a set of modifications which may trigger value changes into a single transaction, to prevent e...

A utility for grouping a set of modifications which may trigger value changes into a single transaction, to prevent excessive firing of change events. This is useful for instance if the field has sub-fields which are being updated as a group; you don't want the container field to check its own changed state for each subfield change.

Parameters

  • fn : Object

    A function containing the transaction code

Fires

Ext.form.field.ComboBox
view source
( )protected
Template method to do any pre-blur processing. ...

Template method to do any pre-blur processing.

Fires

Overrides: Ext.AbstractComponent.beforeBlur

( adjWidth, adjHeight )protectedtemplate
Occurs before componentLayout is run. ...

Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout from being executed.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Parameters

  • adjWidth : Number

    The box-adjusted width that was set.

  • adjHeight : Number

    The box-adjusted height that was set.

Invoked before the Component is destroyed. ...

Invoked before the Component is destroyed.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Occurs before componentLayout is run. ...

Occurs before componentLayout is run. In previous releases, this method could return false to prevent its layout but that is not supported in Ext JS 4.1 or higher. This method is simply a notification of the impending layout to give the component a chance to adjust the DOM. Ideally, DOM reads should be avoided at this time to reduce expensive document reflows.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Overrides: Ext.AbstractComponent.beforeLayout

Ext.form.field.ComboBox
view source
( queryPlan )template
A method which may modify aspects of how the store is to be filtered (if queryMode is "local") of loaded (if queryMod...

A method which may modify aspects of how the store is to be filtered (if queryMode is "local") of loaded (if queryMode is "remote").

This is called by the {@link doQuery method, and may be overridden in subclasses to modify the default behaviour.

This method is passed an object containing information about the upcoming query operation which it may modify before returning.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Parameters

  • queryPlan : Object

    An object containing details about the query to be executed.

    • query : String

      The query value to be used to match against the ComboBox's valueField.

    • forceAll : Boolean

      If true, causes the query to be executed even if the minChars threshold is not met.

    • cancel : Boolean

      A boolean value which, if set to true upon return, causes the query not to be executed.

    • rawQuery : Boolean

      If true indicates that the raw input field value is being used, and upon store load, the input field value should not be overwritten.

Fires

Ext.form.field.ComboBox
view source
( )protected
Template method before a field is reset. ...

Template method before a field is reset.

Overrides: Ext.form.field.Field.beforeReset

Template method called before a Component is positioned. ...

Template method called before a Component is positioned.

Ensures that the position is adjusted so that the Component is constrained if so configured.

Overrides: Ext.AbstractComponent.beforeSetPosition

Invoked before the Component is shown. ...

Invoked before the Component is shown.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Binds a store to this instance. ...

Binds a store to this instance.

Parameters

  • store : Ext.data.AbstractStore/String (optional)

    The store to bind or ID of the store. When no store given (or when null or undefined passed), unbinds the existing store.

Binds listeners for this component to the store. ...

Binds listeners for this component to the store. By default it will add anything bound by the getStoreListeners method, however it can be overridden in a subclass to provide any more complicated handling.

Parameters

( fn, [scope], [args] ) : Ext.Componentchainable
Bubbles up the component/container heirarchy, calling the specified function with each component. ...

Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of function call will be the scope provided or the current component. The arguments to the function will be the args provided or the current component. If the function returns false at any point, the bubble is stopped.

Parameters

  • fn : Function

    The function to call

  • scope : Object (optional)

    The scope of the function. Defaults to current node.

  • args : Array (optional)

    The args to call the function with. Defaults to passing the current component.

Returns

( [anchor], [extraX], [extraY], [size] ) : Number[]private
Calculates x,y coordinates specified by the anchor position on the element, adding extraX and extraY values. ...

Calculates x,y coordinates specified by the anchor position on the element, adding extraX and extraY values.

Parameters

  • anchor : String (optional)

    The specified anchor position. See alignTo for details on supported anchor positions.

    Defaults to: 'tl'

  • extraX : Number (optional)

    value to be added to the x coordinate

  • extraY : Number (optional)

    value to be added to the y coordinate

  • size : Object (optional)

    An object containing the size to use for calculating anchor position {width: (target width), height: (target height)} (defaults to the element's current size)

Returns

  • Number[]

    [x, y] An array containing the element's x and y coordinates

( [constrainTo], [proposedPosition], [local], [proposedSize] ) : Number[]
Calculates the new [x,y] position to move this Positionable into a constrain region. ...

Calculates the new [x,y] position to move this Positionable into a constrain region.

By default, this Positionable is constrained to be within the container it was added to, or the element it was rendered to.

Priority is given to constraining the top and left within the constraint.

An alternative constraint may be passed.

Parameters

  • constrainTo : String/HTMLElement/Ext.Element/Ext.util.Region (optional)

    The Element or Region into which this Component is to be constrained. Defaults to the element into which this Positionable was rendered, or this Component's {@link Ext.Component.constrainTo.

  • proposedPosition : Number[] (optional)

    A proposed [X, Y] position to test for validity and to coerce into constraints instead of using this Positionable's current position.

  • local : Boolean (optional)

    The proposedPosition is local (relative to floatParent if a floating Component)

  • proposedSize : Number[] (optional)

    A proposed [width, height] size to use when calculating constraints instead of using this Positionable's current size.

Returns

  • Number[]

    If the element needs to be translated, the new [X, Y] position within constraints if possible, giving priority to keeping the top and left edge in the constrain region. Otherwise, false.

( args ) : Objectdeprecatedprotected
Call the original method that was previously overridden with override Ext.define('My.Cat', { constructor: functi...

Call the original method that was previously overridden with override

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callOverridden();

        alert("Meeeeoooowwww");
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

This method has been deprected

as of 4.1. Use callParent instead.

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

Returns

  • Object

    Returns the result of calling the overridden method

Call the "parent" method of the current method. ...

Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext.define).

 Ext.define('My.Base', {
     constructor: function (x) {
         this.x = x;
     },

     statics: {
         method: function (x) {
             return x;
         }
     }
 });

 Ext.define('My.Derived', {
     extend: 'My.Base',

     constructor: function () {
         this.callParent([21]);
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // alerts 21

This can be used with an override as follows:

 Ext.define('My.DerivedOverride', {
     override: 'My.Derived',

     constructor: function (x) {
         this.callParent([x*2]); // calls original My.Derived constructor
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // now alerts 42

This also works with static methods.

 Ext.define('My.Derived2', {
     extend: 'My.Base',

     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Base.method
         }
     }
 });

 alert(My.Base.method(10);     // alerts 10
 alert(My.Derived2.method(10); // alerts 20

Lastly, it also works with overridden static methods.

 Ext.define('My.Derived2Override', {
     override: 'My.Derived2',

     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Derived2.method
         }
     }
 });

 alert(My.Derived2.method(10); // now alerts 40

To override a method and replace it and also call the superclass method, use callSuper. This is often done to patch a method to fix a bug.

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

  • Object

    Returns the result of calling the parent method

This method is used by an override to call the superclass method but bypass any overridden method. ...

This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.

Consider:

 Ext.define('Ext.some.Class', {
     method: function () {
         console.log('Good');
     }
 });

 Ext.define('Ext.some.DerivedClass', {
     method: function () {
         console.log('Bad');

         // ... logic but with a bug ...

         this.callParent();
     }
 });

To patch the bug in DerivedClass.method, the typical solution is to create an override:

 Ext.define('App.paches.DerivedClass', {
     override: 'Ext.some.DerivedClass',

     method: function () {
         console.log('Fixed');

         // ... logic but with bug fixed ...

         this.callSuper();
     }
 });

The patch method cannot use callParent to call the superclass method since that would call the overridden method containing the bug. In other words, the above patch would only produce "Fixed" then "Good" in the console log, whereas, using callParent would produce "Fixed" then "Bad" then "Good".

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

  • Object

    Returns the result of calling the superclass method

Cancel any deferred focus on this component ...

Cancel any deferred focus on this component

...

Parameters

Center this Component in its container. ...

Center this Component in its container.

Returns

Fires

  • move
Checks whether the value of the field has changed since the last time it was checked. ...

Checks whether the value of the field has changed since the last time it was checked. If the value has changed, it:

  1. Fires the change event,
  2. Performs validation if the validateOnChange config is enabled, firing the validitychange event if the validity has changed, and
  3. Checks the dirty state of the field and fires the dirtychange event if it has changed.

Fires

Checks the isDirty state of the field and if it has changed since the last time it was checked, fires the dirtychange...

Checks the isDirty state of the field and if it has changed since the last time it was checked, fires the dirtychange event.

Fires

...

Parameters

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

Clear any invalid styles/messages for this field.

Note: this method does not cause the Field's validate or isValid methods to return true if the value does not pass validation. So simply clearing a field's errors will not necessarily allow submission of forms submitted with the Ext.form.action.Submit.clientValidation option set.

Overrides: Ext.form.field.Field.clearInvalid

Removes all listeners for this object including the managed listeners ...

Removes all listeners for this object including the managed listeners

Removes all managed listeners for this object. ...

Removes all managed listeners for this object.

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

Clears any value currently set in the ComboBox.

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.

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

Collapses this field's picker dropdown. ...

Collapses this field's picker dropdown.

Fires

Runs on mousewheel and mousedown of doc to check to see if we should collapse the picker ...

Runs on mousewheel and mousedown of doc to check to see if we should collapse the picker

Parameters

Fires

...

Parameters

  • ptype : String/Object

    string or config object containing a ptype property.

    Constructs a plugin according to the passed config object/ptype string.

    Ensures that the constructed plugin always has a cmp reference back to this component. The setting up of this is done in PluginManager. The PluginManager ensures that a reference to this component is passed to the constructor. It also ensures that the plugin's setCmp method (if any) is called.

Returns an array of fully constructed plugin instances. ...

Returns an array of fully constructed plugin instances. This converts any configs into their appropriate instances.

It does not mutate the plugins array. It creates a new array.

( eventName, args, bubbles )private
Continue to fire event. ...

Continue to fire event.

Parameters

Defined in override Ext.rtl.AbstractComponent. ...

Defined in override Ext.rtl.AbstractComponent.

Parameters

Ext.form.field.ComboBox
view source
( )
Creates and returns the component to be used as this field's picker. ...

Creates and returns the component to be used as this field's picker. Must be implemented by subclasses of Picker. The current field should also be passed as a configuration option to the picker component as the pickerField property.

Overrides: Ext.form.field.Picker.createPicker

Creates an event handling function which refires the event from this object as the passed event name. ...

Creates an event handling function which refires the event from this object as the passed event name.

Parameters

  • newName : String

    The name under which to refire the passed parameters.

  • beginEnd : Array (optional)

    The caller can specify on which indices to slice.

Returns

Checks if the value has changed. ...

Checks if the value has changed. Allows subclasses to override for any more complex logic.

Parameters

Disable the component. ...

Disable the component.

Available since: 1.1.0

Parameters

  • silent : Boolean (optional)

    Passing true will suppress the disable event from being fired.

    Defaults to: false

Fires

Performs the alignment on the picker using the class defaults ...

Performs the alignment on the picker using the class defaults

Called from the selected frame generation template to insert this Component's inner structure inside the framing stru...

Called from the selected frame generation template to insert this Component's inner structure inside the framing structure.

When framing is used, a selected frame generation template is used as the primary template of the getElConfig instead of the configured renderTpl. The renderTpl is invoked by this method which is injected into the framing template.

Parameters

Handles autoRender. ...

Handles autoRender. Floating Components may have an ownerCt. If they are asking to be constrained, constrain them within that ownerCt, and have their z-index managed locally. Floating Components are always rendered to document.body

Fires

  • afterrender
  • beforerender
  • move
  • render
Ext.form.field.ComboBox
view source
( )private
If the autoSelect config is true, and the picker is open, highlights the first item. ...

If the autoSelect config is true, and the picker is open, highlights the first item.

This method needs to be called whenever you change something on this component that requires the Component's layout t...

This method needs to be called whenever you change something on this component that requires the Component's layout to be recalculated.

Returns

Overrides: Ext.AbstractComponent.doComponentLayout

Moves this floating Component into a constrain region. ...

Moves this floating Component into a constrain region.

By default, this Component is constrained to be within the container it was added to, or the element it was rendered to.

An alternative constraint may be passed.

Parameters

  • constrainTo : String/HTMLElement/Ext.Element/Ext.util.Region (optional)

    The Element or Region into which this Component is to be constrained. Defaults to the element into which this floating Component was rendered.

Fires

  • move
Ext.form.field.ComboBox
view source
( queryPlan )private
...

Parameters

Fires

Ext.form.field.ComboBox
view source
( queryString, [forceAll], [rawQuery] ) : Boolean
Executes a query to filter the dropdown list. ...

Executes a query to filter the dropdown list. Fires the beforequery event prior to performing the query allowing the query action to be canceled if needed.

Parameters

  • queryString : String

    The string to use to filter available items by matching against the configured valueField.

  • forceAll : Boolean (optional)

    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

  • rawQuery : Boolean (optional)

    Pass as true if the raw typed value is being used as the query string. This causes the resulting store load to leave the raw value undisturbed.

    Defaults to: false

Returns

  • Boolean

    true if the query was permitted to run, false if it was cancelled by a beforequery handler.

Fires

Ext.form.field.ComboBox
view source
( )private
Execute the query with the raw contents within the textfield. ...

Execute the query with the raw contents within the textfield.

Fires

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

Parameters

Fires

...

Parameters

...

Parameters

Ext.form.field.ComboBox
view source
( )private
...
Enable the component ...

Enable the component

Available since: 1.1.0

Parameters

  • silent : Boolean (optional)

    Passing true will suppress the enable event from being fired.

    Defaults to: false

Fires

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. ...

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. There is no implementation in the Observable base class.

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

Example:

Ext.define('Ext.overrides.form.field.Base', {
    override: 'Ext.form.field.Base',

    //  Add functionality to Field's initComponent to enable the change event to bubble
    initComponent: function () {
        this.callParent();
        this.enableBubble('change');
    }
});

var myForm = Ext.create('Ext.form.Panel', {
    title: 'User Details',
    items: [{
        ...
    }],
    listeners: {
        change: function() {
            // Title goes red if form has been modified.
            myForm.header.setStyle('color', 'red');
        }
    }
});

Parameters

  • eventNames : String/String[]

    The event name to bubble, or an Array of event names.

Ensures that this component is attached to document.body. ...

Ensures that this component is attached to document.body. If the component was rendered to Ext.getDetachedBody, then it will be appended to document.body. Any configured position is also restored.

Parameters

  • runLayout : Boolean (optional)

    True to run the component's layout.

    Defaults to: false

Fires

  • move
Expands this field's picker dropdown. ...

Expands this field's picker dropdown.

Fires

Only relevant if the instance's isFileUpload method returns true. ...

Only relevant if the instance's isFileUpload method returns true. Returns a reference to the file input DOM element holding the user's selected file. The input will be appended into the submission form and will not be returned, so this method should also create a replacement.

Returns

  • HTMLElement
private ...

private

Parameters

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.

See also the up method.

Parameters

  • fn : Function

    The custom function to call with the arguments (container, this component).

Returns

Find a container above this component at any level by xtype or class See also the up method. ...

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

See also the up method.

Parameters

  • xtype : String/Ext.Class

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

Returns

Retrieves plugin from this component's collection by its ptype. ...

Retrieves plugin from this component's collection by its ptype.

Parameters

  • ptype : String

    The Plugin's ptype as specified by the class's alias configuration.

Returns

Ext.form.field.ComboBox
view source
( field, value ) : Ext.data.Model
Finds the record by searching for a specific field/value combination. ...

Finds the record by searching for a specific field/value combination.

Parameters

  • field : String

    The name of the field to test.

  • value : Object

    The value to match the field against.

Returns

Ext.form.field.ComboBox
view source
( value ) : Ext.data.Model
Finds the record by searching values in the displayField. ...

Finds the record by searching values in the displayField.

Parameters

  • value : Object

    The value to match the field against.

Returns

Ext.form.field.ComboBox
view source
( value ) : Ext.data.Model
Finds the record by searching values in the valueField. ...

Finds the record by searching values in the valueField.

Parameters

  • value : Object

    The value to match the field against.

Returns

This method visits the rendered component tree in a "top-down" order. ...

This method visits the rendered component tree in a "top-down" order. That is, this code runs on a parent component before running on a child. This method calls the onRender method of each component.

Parameters

  • containerIdx : Number

    The index into the Container items of this Component.

Fires

  • afterrender
  • move
  • render
Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addList...

Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addListener).

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble.

Parameters

  • eventName : String

    The name of the event to fire.

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

Fires the specified event with the passed parameter list. ...

Fires the specified event with the passed parameter list.

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble.

Parameters

  • eventName : String

    The name of the event to fire.

  • args : Object[]

    An array of parameters which are passed to handlers.

Returns

  • Boolean

    returns false if any of the handlers return false otherwise it returns true.

For more information on the hierarchy events, see the note for the hierarchyEventSource observer defined in the onCla...

For more information on the hierarchy events, see the note for the hierarchyEventSource observer defined in the onClassCreated callback.

This functionality is contained in Component (as opposed to Container) because a Component can be the ownerCt for a floating component (loadmask), and the loadmask needs to know when its owner is shown/hidden via the hierarchyEventSource so that its hidden state can be synchronized.

TODO: merge this functionality with Ext.globalEvents

Parameters

private ...

private

Parameters

Fires

...

Parameters

Fires

  • move
( [selectText], [delay], [callback], [scope] ) : Ext.Component
Try to focus this component. ...

Try to focus this component.

Parameters

  • selectText : Mixed (optional)

    If applicable, true to also select all the text in this component, or an array consisting of start and end (defaults to start) position of selection.

  • delay : Boolean/Number (optional)

    Delay the focus this number of milliseconds (true for 10 milliseconds).

  • callback : Function (optional)

    Only needed if the delay parameter is used. A function to call upon focus.

  • scope : Function (optional)

    Only needed if the delay parameter is used. The scope (this reference) in which to execute the callback.

Returns

  • Ext.Component

    The focused Component. Usually this Component. Some Containers may delegate focus to a descendant Component (Windows can do this through their defaultFocus config option.

Forces this component to redo its componentLayout. ...

Forces this component to redo its componentLayout.

This method has been deprected since 4.1.0

Use updateLayout instead.

Deprecate 5.0 ...

Deprecate 5.0

Overrides: Ext.Component.getActionEl

Returns the current animation if this object has any effects actively running or queued, else returns false. ...

Returns the current animation if this object has any effects actively running or queued, else returns false.

Returns

Gets the active error message for this component, if any. ...

Gets the active error message for this component, if any. This does not trigger validation on its own, it merely returns any message that the component may already hold.

Returns

  • String

    The active error message on the component; if there is no error, an empty string is returned.

Gets an Array of any active error messages currently applied to the field. ...

Gets an Array of any active error messages currently applied to the field. This does not trigger validation on its own, it merely returns any messages that the component may already hold.

Returns

  • String[]

    The active error messages on the component; if there are no errors, an empty Array is returned.

( element, [position], [offsets] ) : Number[]
Gets the x,y coordinates to align this element with another element. ...

Gets the x,y coordinates to align this element with another element. See alignTo for more info on the supported position values.

Parameters

  • element : Ext.util.Positionable/HTMLElement/String

    The Positionable, HTMLElement, or id of the element to align to.

  • position : String (optional)

    The position to align to

    Defaults to: "tl-bl?"

  • offsets : Number[] (optional)

    Offset the positioning by [x, y]

Returns

private ...

private

( el, [anchor], [local], [size] ) : Number[]private
Begin Positionable methods Overridden in Ext.rtl.AbstractComponent. ...

Begin Positionable methods


Overridden in Ext.rtl.AbstractComponent.

Parameters

  • el : Ext.dom.Element

    The element

  • anchor : String (optional)

    The specified anchor position. See alignTo for details on supported anchor positions.

    Defaults to: 'tl'

  • local : Boolean (optional)

    True to get the local (element top/left-relative) anchor position instead of page coordinates

  • size : Object (optional)

    An object containing the size to use for calculating anchor position {width: (target width), height: (target height)} (defaults to the element's current size)

Returns

  • Number[]

    [x, y] An array containing the element's x and y coordinates

Overrides: Ext.util.Positionable.getAnchorToXY

( [anchor], [local], [size] ) : Number[]
Gets the x,y coordinates specified by the anchor position on the element. ...

Gets the x,y coordinates specified by the anchor position on the element.

Parameters

  • anchor : String (optional)

    The specified anchor position. See alignTo for details on supported anchor positions.

    Defaults to: 'tl'

  • local : Boolean (optional)

    True to get the local (element top/left-relative) anchor position instead of page coordinates

  • size : Object (optional)

    An object containing the size to use for calculating anchor position {width: (target width), height: (target height)} (defaults to the element's current size)

Returns

  • Number[]

    [x, y] An array containing the element's x and y coordinates

...

Parameters

Calculates the colspan value for the body cell - the cell which contains the input field. ...

Calculates the colspan value for the body cell - the cell which contains the input field.

The field table structure contains 4 columns:

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

Returns

  • Object

    an object with the following numeric properties - beforeX - afterX - beforeY - afterY

Overrides: Ext.util.Positionable.getBorderPadding

Return an object defining the area of this Element which can be passed to setBox to set another Element's size/locati...

Return an object defining the area of this Element which can be passed to setBox to set another Element's size/location to match this element.

Parameters

  • contentBox : Boolean (optional)

    If true a box for the content of the element is returned.

  • local : Boolean (optional)

    If true the element's left and top relative to its offsetParent are returned instead of page x/y.

Returns

  • Object

    box An object in the format:

    {
        x: <Element's X position>,
        y: <Element's Y position>,
        left: <Element's X position (an alias for x)>,
        top: <Element's Y position (an alias for y)>,
        width: <Element's width>,
        height: <Element's height>,
        bottom: <Element's lower bound>,
        right: <Element's rightmost bound>
    }
    

    The returned object may also be addressed as an Array where index 0 contains the X position and index 1 contains the Y position. The result may also be used for setXY

Gets the bubbling parent for an Observable ...

Gets the bubbling parent for an Observable

Returns

Implements an upward event bubbling policy. ...

Implements an upward event bubbling policy. By default a Component bubbles events up to its reference owner.

Component subclasses may implement a different bubbling strategy by overriding this method.

Overrides: Ext.AbstractComponent.getBubbleTarget

...

Parameters

( [constrainTo], [proposedPosition], [proposedSize] ) : Number[]/Boolean
Returns the [X, Y] vector by which this Positionable's element must be translated to make a best attempt to constrain...

Returns the [X, Y] vector by which this Positionable's element must be translated to make a best attempt to constrain within the passed constraint. Returns false if the element does not need to be moved.

Priority is given to constraining the top and left within the constraint.

The constraint may either be an existing element into which the element is to be constrained, or a Region into which this element is to be constrained.

By default, any extra shadow around the element is not included in the constrain calculations - the edges of the element are used as the element bounds. To constrain the shadow within the constrain region, set the constrainShadow property on this element to true.

Parameters

  • constrainTo : Ext.util.Positionable/HTMLElement/String/Ext.util.Region (optional)

    The Positionable, HTMLElement, element id, or Region into which the element is to be constrained.

  • proposedPosition : Number[] (optional)

    A proposed [X, Y] position to test for validity and to produce a vector for instead of using the element's current position

  • proposedSize : Number[] (optional)

    A proposed [width, height] size to constrain instead of using the element's current size

Returns

  • Number[]/Boolean

    If the element needs to be translated, an [X, Y] vector by which this element must be translated. Otherwise, false.

Ext.form.field.ComboBox
view source
( )private
Generates the string value to be displayed in the text field for the currently stored value ...

Generates the string value to be displayed in the text field for the currently stored value

Retrieves the top level element representing this component. ...

Retrieves the top level element representing this component.

Available since: 1.1.0

Returns

Overrides: Ext.AbstractComponent.getEl

Validates a value according to the field's validation rules and returns an array of errors for any failing validations. ...

Validates a value according to the field's validation rules and returns an array of errors for any failing validations. Validation rules are processed in the following order:

  1. Field specific validator

    A validator offers a way to customize and reuse a validation specification. If a field is configured with a validator function, it will be passed the current field value. The validator function is expected to return either:

    • Boolean true if the value is valid (validation continues).
    • a String to represent the invalid message if invalid (validation halts).
  2. Basic Validation

    If the validator has not halted validation, basic validation proceeds as follows:

  3. Preconfigured Validation Types (VTypes)

    If none of the prior validation steps halts validation, a field configured with a vtype will utilize the corresponding VTypes validation function. If invalid, either the field's vtypeText or the VTypes vtype Text property will be used for the invalid message. Keystrokes on the field will be filtered according to the VTypes vtype Mask property.

  4. Field specific regex test

    If none of the prior validation steps halts validation, a field's configured regex test will be processed. The invalid message for this test is configured with regexText

Parameters

  • value : Object

    The value to validate. The processed raw value will be used if nothing is passed.

Returns

  • String[]

    Array of any validation errors

Overrides: Ext.form.field.Field.getErrors

Returns the label for the field. ...

Returns the label for the field. Defaults to simply returning the fieldLabel config. Can be overridden to provide a custom generated label.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Returns

  • String

    The configured field label, or empty string if not defined

Returns the focus holder element associated with this Component. ...

Returns the focus holder element associated with this Component. At the Component base class level, this function returns undefined.

Subclasses which use embedded focusable elements (such as Window, Field and Button) should override this for use by the focus method.

Containers which need to participate in the FocusManager's navigation and Container focusing scheme also need to return a focusEl, although focus is only listened for in this case if the FocusManager is enabled.

Returns

  • undefined

    undefined because raw Components cannot by default hold focus.

Overrides: Ext.AbstractComponent.getFocusEl

Private ...

Private

On render, reads an encoded style attribute, "filter" from the style of this Component's element. ...

On render, reads an encoded style attribute, "filter" from the style of this Component's element. This information is memoized based upon the CSS class name of this Component's element. Because child Components are rendered as textual HTML as part of the topmost Container, a dummy div is inserted into the document to receive the document element's CSS class name, and therefore style attributes.

...

Parameters

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

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

Returns

A component's hierarchyState is used to keep track of aspects of a component's state that affect its descendants hier...

A component's hierarchyState is used to keep track of aspects of a component's state that affect its descendants hierarchically like "collapsed" and "hidden". For example, if this.hierarchyState.hidden == true, it means that either this component, or one of its ancestors is hidden.

Hierarchical state management is implemented by chaining each component's hierarchyState property to its parent container's hierarchyState property via the prototype. The result is such that if a component's hierarchyState does not have it's own property, it inherits the property from the nearest ancestor that does.

To set a hierarchical "hidden" value:

this.getHierarchyState().hidden = true;

It is important to remember when unsetting hierarchyState properties to delete them instead of just setting them to a falsy value. This ensures that the hierarchyState returns to a state of inheriting the value instead of overriding it To unset the hierarchical "hidden" value:

delete this.getHierarchyState().hidden;

IMPORTANT! ALWAYS access hierarchyState using this method, not by accessing this.hierarchyState directly. The hierarchyState property does not exist until the first time getHierarchyState() is called. At that point getHierarchyState() walks up the component tree to establish the hierarchyState prototype chain. Additionally the hierarchyState property should NOT be relied upon even after the initial call to getHierarchyState() because it is possible for the hierarchyState to be invalidated. Invalidation typically happens when a component is moved to a new container. In such a case the hierarchy state remains invalid until the next time getHierarchyState() is called on the component or one of its descendants.

Parameters

Retrieves the id of this component. ...

Retrieves the id of this component. Will auto-generate an id if one has not already been set.

Returns

Overrides: Ext.AbstractComponent.getId

Returns the initial configuration passed to constructor when instantiating this class. ...

Returns the initial configuration passed to constructor when instantiating this class.

Parameters

  • name : String (optional)

    Name of the config option to return.

Returns

  • Object/Mixed

    The full config object or a single config value when name parameter specified.

Returns the input id for this field. ...

Returns the input id for this field. If none was specified via the inputId config, then an id will be automatically generated.

Overrides: Ext.form.Labelable.getInputId

This function takes the position argument passed to onRender and returns a DOM element that you can use in the insert...

This function takes the position argument passed to onRender and returns a DOM element that you can use in the insertBefore.

Parameters

Returns

  • HTMLElement

    DOM element that you can use in the insertBefore

...

Parameters

Returns the value of itemId assigned to this component, or when that is not set, returns the value of id. ...

Returns the value of itemId assigned to this component, or when that is not set, returns the value of id.

Returns

Gets any label styling for the labelEl ...

Gets any label styling for the labelEl

Returns

Gets the width of the label (if visible) ...

Gets the width of the label (if visible)

Returns

Generates the arguments for the field decorations rendering template. ...

Generates the arguments for the field decorations rendering template.

Returns

Overrides: Ext.form.Labelable.getLabelableRenderData

Gets the Ext.ComponentLoader for this Component. ...

Gets the Ext.ComponentLoader for this Component.

Returns

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

Returns

Overrides: Ext.util.Positionable.getLocalX

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

Returns

  • Number[]

    The local XY position of the element

Overrides: Ext.util.Positionable.getLocalXY

Returns the y coordinate of this element reletive to its offsetParent. ...

Returns the y coordinate of this element reletive to its offsetParent.

Returns

Overrides: Ext.util.Positionable.getLocalY

( includeEmptyText, isSubmitting ) : Object
Returns the value(s) that should be saved to the Ext.data.Model instance for this field, when Ext.form.Basic.updateRe...

Returns the value(s) that should be saved to the Ext.data.Model instance for this field, when Ext.form.Basic.updateRecord is called. Typically this will be an object with a single name-value pair, the name being this field's name and the value being its current data value. More advanced field implementations may return more than one name-value pair. The returned values will be saved to the corresponding field names in the Model.

Note that the values returned from this method are not guaranteed to have been successfully validated.

Parameters

Returns

  • Object

    A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted.

Returns the name attribute of the field. ...

Returns the name attribute of the field. This is used as the parameter name when including the field value in a form submit().

Returns

Returns the offsets of this element from the passed element. ...

Returns the offsets of this element from the passed element. The element must both be part of the DOM tree and not have display:none to have page coordinates.

Parameters

Returns

  • Number[]

    The XY page offsets (e.g. [100, -200])

Include margins ...

Include margins

Get an el for overflowing, defaults to the target el ...

Get an el for overflowing, defaults to the target el

Returns the CSS style object which will set the Component's scroll styles. ...

Returns the CSS style object which will set the Component's scroll styles. This must be applied to the target element.

Returns the owning container if that container uses border layout. ...

Returns the owning container if that container uses border layout. Otherwise this method returns null.

Defined in override Ext.layout.container.border.Region.

Returns

Returns the owning border (Ext.layout.container.Border) instance if there is one. ...

Returns the owning border (Ext.layout.container.Border) instance if there is one. Otherwise this method returns null.

Defined in override Ext.layout.container.border.Region.

Returns

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

private

Parameters

Returns a reference to the picker component for this field, creating it if necessary by calling createPicker. ...

Returns a reference to the picker component for this field, creating it if necessary by calling createPicker.

Returns

Retrieves a plugin from this component's collection by its pluginId. ...

Retrieves a plugin from this component's collection by its pluginId.

Parameters

Returns

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

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

Parameters

  • local : Boolean (optional)

    If true the element's left and top are returned instead of page XY.

    Defaults to: false

Returns

  • Number[]

    The XY position of the element (e.g., [100, 200])

Deprecate 5.0 ...

Deprecate 5.0

Returns the raw String value of the field, without performing any normalization, conversion, or validation. ...

Returns the raw String value of the field, without performing any normalization, conversion, or validation. Gets the current value of the input element if the field has been rendered, ignoring the value if it is the emptyText. To get a normalized and converted value see getValue.

Returns

  • String

    The raw String value of the field

Overrides: Ext.form.field.Base.getRawValue

Used by ComponentQuery, and the up method to find the owning Component in the linkage hierarchy. ...

Used by ComponentQuery, and the up method to find the owning Component in the linkage hierarchy.

By default this returns the Container which contains this Component.

This may be overriden by Component authors who implement ownership hierarchies which are not based upon ownerCt, such as BoundLists being owned by Fields or Menus being owned by Buttons.

Returns a region object that defines the area of this element. ...

Returns a region object that defines the area of this element.

Returns

...

Fires

  • beforerender
Deprecate 5.0 ...

Deprecate 5.0

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

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

Parameters

  • contentSize : Boolean (optional)

    true to get the width/size minus borders and padding

Returns

Returns an object that describes how this component's width and height are managed. ...

Returns an object that describes how this component's width and height are managed. All of these objects are shared and should not be modified.

Parameters

Returns

The supplied default state gathering method for the AbstractComponent class. ...

The supplied default state gathering method for the AbstractComponent class.

This method returns dimension settings such as flex, anchor, width and height along with collapsed state.

Subclasses which implement more complex state should call the superclass's implementation, and apply their state to the result if this basic state is to be saved.

Note that Component state will only be saved if the Component has a stateId and there as a StateProvider configured for the document.

Returns

Overrides: Ext.AbstractComponent.getState

Gets the state id for this object. ...

Gets the state id for this object.

Returns

  • String

    The 'stateId' or the implicit 'id' specified by component configuration.

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

Returns the store associated with this ComboBox.

Returns

Overrides: Ext.util.Bindable.getStore

Ext.form.field.ComboBox
view source
( ) : Objectprotected
Gets the listeners to bind to a new store. ...

Gets the listeners to bind to a new store.

Returns

  • Object

    The listeners to be bound to the store in object literal form. The scope may be omitted, it is assumed to be the current instance.

Overrides: Ext.util.Bindable.getStoreListeners

Returns an offscreen div with the same class name as the element this is being rendered. ...

Returns an offscreen div with the same class name as the element this is being rendered. This is because child item rendering takes place in a detached div which, being not part of the document, has no styling.

Parameters

Ext.form.field.ComboBox
view source
( ) : Objecttemplate
Creates and returns the data object to be used when rendering the fieldSubTpl. ...

Creates and returns the data object to be used when rendering the fieldSubTpl.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Returns

Overrides: Ext.form.field.Trigger.getSubTplData

Gets the markup to be inserted into the outer template's bodyEl. ...

Gets the markup to be inserted into the outer template's bodyEl. For fields this is the actual input element.

Parameters

Overrides: Ext.form.field.Base.getSubTplMarkup

private override to use getSubmitValue() as a convenience ...

private override to use getSubmitValue() as a convenience

Returns

  • Object

    A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted.

Overrides: Ext.form.field.Field.getSubmitData

Ext.form.field.ComboBox
view source
( ) : String
Returns the value that would be included in a standard form submit for this field. ...

Returns the value that would be included in a standard form submit for this field. This will be combined with the field's name to form a name=value pair in the submitted parameters. If an empty string is returned then just the name= will be submitted; if null is returned then nothing will be submitted.

Note that the value returned will have been processed but may or may not have been successfully validated.

Returns

  • String

    The value to be submitted, or null.

Overrides: Ext.form.field.Base.getSubmitValue

This is used to determine where to insert the 'html', 'contentEl' and 'items' in this component. ...

This is used to determine where to insert the 'html', 'contentEl' and 'items' in this component.

...

Parameters

Returns a set of flags that describe the trigger state. ...

Returns a set of flags that describe the trigger state. These are just used to easily determine if the DOM is out-of-sync with the component's properties.

Get the total width of the trigger button area. ...

Get the total width of the trigger button area.

Returns

  • Number

    The total trigger width

Ext.form.field.ComboBox
view source
( ) : Object
Returns the current data value of the field. ...

Returns the current data value of the field. The type of value returned is particular to the type of the particular field (e.g. a Date object for Ext.form.field.Date), as the result of calling rawToValue on the field's processed String value. To return the raw String value, see getRawValue.

Returns

Overrides: Ext.form.field.Base.getValue

Returns the content region of this element. ...

Returns the content region of this element. That is the region within the borders and padding.

Returns

  • Ext.util.Region

    A Region containing "top, left, bottom, right" member data.

Deprecate 5.0 ...

Deprecate 5.0

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

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

Returns

Gets the current X position of the DOM element based on page coordinates. ...

Gets the current X position of the DOM element based on page coordinates.

Returns

  • Number

    The X position of the element

Overrides: Ext.util.Positionable.getX

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

Gets the xtype for this component as registered with Ext.ComponentManager. For a list of all available xtypes, see the Ext.Component header. Example usage:

var t = new Ext.form.field.Text();
alert(t.getXType());  // alerts 'textfield'

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.field.Text();
alert(t.getXTypes());  // alerts 'component/field/textfield'

Available since: 2.3.0

Returns

  • String

    The xtype hierarchy string

Gets the current position of the DOM element based on page coordinates. ...

Gets the current position of the DOM element based on page coordinates.

Returns

  • Number[]

    The XY position of the element

Overrides: Ext.util.Positionable.getXY

Gets the current Y position of the DOM element based on page coordinates. ...

Gets the current Y position of the DOM element based on page coordinates.

Returns

  • Number

    The Y position of the element

Overrides: Ext.util.Positionable.getY

Tells whether the field currently has an active error message. ...

Tells whether the field currently has an active error message. This does not trigger validation on its own, it merely looks for any message that the component may already hold.

Returns

Returns the current animation if this object has any effects actively running or queued, else returns false. ...

Returns the current animation if this object has any effects actively running or queued, else returns false.

This method has been deprected since 4.0

Replaced by getActiveAnimation

Returns

Checks if the specified CSS class exists on this element's DOM node. ...

Checks if the specified CSS class exists on this element's DOM node.

Parameters

  • className : String

    The CSS class to check for.

Returns

  • Boolean

    true if the class exists, else false.

...

Parameters

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. ...

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer indicates whether the event needs firing or not.

Parameters

  • eventName : String

    The name of the event to check for

Returns

  • Boolean

    true if the event is being listened for or bubbles, else false

Checks if there is currently a specified uiCls. ...

Checks if there is currently a specified uiCls.

Parameters

  • cls : String

    The cls to check.

Checks if the field has a visible label ...

Checks if the field has a visible label

Returns

  • Boolean

    True if the field has a visible label

( [animateTarget], [callback], [scope] ) : Ext.Componentchainable
Hides this Component, setting it to invisible using the configured hideMode. ...

Hides this Component, setting it to invisible using the configured hideMode.

Parameters

  • animateTarget : String/Ext.Element/Ext.Component (optional)

    only valid for floating Components such as Windows or ToolTips, or regular Components which have been configured with floating: true.. The target to which the Component should animate while hiding.

    Defaults to: null

  • callback : Function (optional)

    A callback function to call after the Component is hidden.

  • scope : Object (optional)

    The scope (this reference) in which the callback is executed. Defaults to this Component.

Returns

Fires

This method is called by the Ext.layout.container.Border class when instances are added as regions to the layout. ...

This method is called by the Ext.layout.container.Border class when instances are added as regions to the layout. Since it is valid to add any component to a border layout as a region, this method must be added to Ext.Component but is only ever called when that component is owned by a border layout.

Defined in override Ext.layout.container.border.Region.

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

private

Available since: 1.1.0

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Fires

Overrides: Ext.form.field.Picker.initComponent

( config ) : Ext.Basechainableprotected
Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

Ext.define('My.awesome.Class', {
    // The default config
    config: {
        name: 'Awesome',
        isAwesome: true
    },

    constructor: function(config) {
        this.initConfig(config);
    }
});

var awesome = new My.awesome.Class({
    name: 'Super Awesome'
});

alert(awesome.getName()); // 'Super Awesome'

Parameters

Returns

...

Parameters

Ext.form.field.ComboBox
view source
( )protected
private ...
Initializes this Field mixin on the current instance. ...

Initializes this Field mixin on the current instance. Components using this mixin should call this method during their own initialization process.

Create the framingTpl from the string. ...

Create the framingTpl from the string. Poke in a reference to applyRenderTpl(frameInfo, out)

Parameters

Called by getHierarchyState to initialize the hierarchyState the first time it is requested. ...

Called by getHierarchyState to initialize the hierarchyState the first time it is requested.

Overridden in Ext.rtl.AbstractComponent.

Parameters

Performs initialization of this mixin. ...

Performs initialization of this mixin. Component classes using this mixin should call this method during their own initialization.

Initializes padding by applying it to the target element, or if the layout manages padding ensures that the padding o...

Initializes padding by applying it to the target element, or if the layout manages padding ensures that the padding on the target element is "0".

Parameters

...

Parameters

Initialized the renderData to be used when rendering the renderTpl. ...

Initialized the renderData to be used when rendering the renderTpl.

Returns

  • Object

    Object with keys and values that are going to be applied to the renderTpl

Overrides: Ext.util.Renderable.initRenderData

Initializes the renderTpl. ...

Initializes the renderTpl.

Returns

Overrides: Ext.util.Renderable.initRenderTpl

...

Parameters

Initializes the state of the object upon construction. ...

Initializes the state of the object upon construction.

Fires

Applies padding, margin, border, top, left, height, and width configs to the appropriate elements. ...

Applies padding, margin, border, top, left, height, and width configs to the appropriate elements.

Parameters

Initializes the field's value based on the initial config. ...

Initializes the field's value based on the initial config.

Tests whether this Component matches the selector string. ...

Tests whether this Component matches the selector string.

Parameters

  • selector : String

    The selector string to test against.

Returns

  • Boolean

    true if this Component matches the selector.

Utility method to determine if a Component is floating, and has an owning Container whose coordinate system it must b...

Utility method to determine if a Component is floating, and has an owning Container whose coordinate system it must be positioned in when using setPosition.

...

Parameters

Determines whether this component is the descendant of a particular container. ...

Determines whether this component is the descendant of a particular container.

Parameters

Returns

  • Boolean

    true if the component is the descendant of a particular container, otherwise false.

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

Returns true if the value of this Field has been changed from its originalValue. Will always return false if the field is disabled.

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

Returns

  • Boolean

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

Method to determine whether this Component is currently disabled. ...

Method to determine whether this Component is currently disabled.

Returns

  • Boolean

    the disabled state of this Component.

Method to determine whether this Component is draggable. ...

Method to determine whether this Component is draggable.

Returns

  • Boolean

    the draggable state of this component.

Method to determine whether this Component is droppable. ...

Method to determine whether this Component is droppable.

Returns

  • Boolean

    the droppable state of this component.

Ext.form.field.ComboBox
view source
( v1, v2 )private
Override. ...

Override. Treat undefined and null values as equal to an empty string value.

Parameters

Overrides: Ext.form.field.Text.isEqual

Returns whether two values are logically equal. ...

Returns whether two values are logically equal. Similar to isEqual, however null or undefined values will be treated as empty strings.

Parameters

  • value1 : Object

    The first value to compare

  • value2 : Object

    The second value to compare

Returns

  • Boolean

    True if the values are equal, false if inequal.

returns true if the picker has a load mask and the passed event is within the load mask ...

returns true if the picker has a load mask and the passed event is within the load mask

Parameters

Returns

Returns whether this Field is a file upload field; if it returns true, forms will use special techniques for submitti...

Returns whether this Field is a file upload field; if it returns true, forms will use special techniques for submitting the form via AJAX. See Ext.form.Basic.hasUpload for details. If this returns true, the extractFileInput method must also be implemented to return the corresponding file input element.

Returns

Overrides: Ext.form.field.Field.isFileUpload

Method to determine whether this Component is floating. ...

Method to determine whether this Component is floating.

Returns

  • Boolean

    the floating state of this component.

Method to determine whether this Component is currently set to hidden. ...

Method to determine whether this Component is currently set to hidden.

Returns

  • Boolean

    the hidden state of this Component.

Determines whether this Component is the root of a layout. ...

Determines whether this Component is the root of a layout. This returns true if this component can run its layout without assistance from or impact on its owner. If this component cannot run its layout given these restrictions, false is returned and its owner will be considered as the next candidate for the layout root.

Setting the _isLayoutRoot property to true causes this method to always return true. This may be useful when updating a layout of a Container which shrink wraps content, and you know that it will not change size, and so can safely be the topmost participant in the layout run.

Returns true if layout is suspended for this component. ...

Returns true if layout is suspended for this component. This can come from direct suspension of this component's layout activity (Ext.Container.suspendLayout) or if one of this component's containers is suspended.

Returns

  • Boolean

    true layout of this component is suspended.

Returns true if this component's local coordinate system is rtl. ...

Returns true if this component's local coordinate system is rtl. For normal components this equates to the value of isParentRtl(). Floaters are a bit different because a floater's element can be a childNode of something other than its parent component's element. For floaters we have to read the dom to see if the component's element's parentNode has a css direction value of "rtl".

Defined in override Ext.rtl.AbstractComponent.

Returns

Defined in override Ext.rtl.AbstractComponent. ...

Defined in override Ext.rtl.AbstractComponent.

Returns true if this component's parent container is rtl. ...

Returns true if this component's parent container is rtl. Used by rtl positioning methods to determine if the component should be positioned using a right-to-left coordinate system.

Defined in override Ext.rtl.AbstractComponent.

Returns

Returns whether or not the field value is currently valid by validating the processed raw value of the field. ...

Returns whether or not the field value is currently valid by validating the processed raw value of the field. Note: disabled fields are always treated as valid.

Returns

  • Boolean

    True if the value is valid, else false

Overrides: Ext.form.field.Field.isValid

Returns true if this component is visible. ...

Returns true if this component is visible.

Available since: 1.1.0

Parameters

  • deep : Boolean (optional)

    Pass true to interrogate the visibility status of all parent Containers to determine whether this Component is truly visible to the user.

    Generally, to determine whether a Component is hidden, the no argument form is needed. For example when creating dynamically laid out UIs in a hidden Container before showing them.

    Defaults to: false

Returns

  • Boolean

    true if this component is visible, false otherwise.

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.field.Text();
var isText = t.isXType('textfield');        // true
var isBoxSubclass = t.isXType('field');       // true, descended from Ext.form.field.Base
var isBoxInstance = t.isXType('field', true); // false, not a direct Ext.form.field.Base instance

Available since: 2.3.0

Parameters

  • xtype : String

    The xtype to check for this Component

  • shallow : Boolean (optional)

    true to check whether this Component is directly of the specified xtype, false to check whether this Component is descended from the xtype.

    Defaults to: false

Returns

  • Boolean

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

Ext.form.field.ComboBox
view source
( pageNum, options )private
...

Parameters

...

Parameters

Display one or more error messages associated with this field, using msgTarget to determine how to display the messag...

Display one or more error messages associated with this field, using msgTarget to determine how to display the messages and applying invalidCls to the field's UI element.

Note: this method does not cause the Field's validate or isValid methods to return false if the value does pass validation. So simply marking a Field as invalid will not prevent submission of forms submitted with the Ext.form.action.Submit.clientValidation option set.

Parameters

  • errors : String/String[]

    The validation message(s) to display.

Overrides: Ext.form.field.Field.markInvalid

( msg, msgCls, elHeight )private
...

Parameters

( item, ename, [fn], [scope], [options] ) : Object
Shorthand for addManagedListener. ...

Shorthand for addManagedListener.

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item to which to add a listener/listeners.

  • ename : Object/String

    The event name, or an object containing event name properties.

  • fn : Function (optional)

    If the ename parameter was an event name, this is the handler function.

  • scope : Object (optional)

    If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

  • options : Object (optional)

    If the ename parameter was an event name, this is the addListener options.

Returns

  • Object

    Only when the destroyable option is specified.

    A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

    this.btnListeners =  = myButton.mon({
        destroyable: true
        mouseover:   function() { console.log('mouseover'); },
        mouseout:    function() { console.log('mouseout'); },
        click:       function() { console.log('click'); }
    });
    

    And when those listeners need to be removed:

    Ext.destroy(this.btnListeners);
    

    or

    this.btnListeners.destroy();
    
( direction, distance, [animate] )
Move the element relative to its current position. ...

Move the element relative to its current position.

Parameters

  • direction : String

    Possible values are:

    • "l" (or "left")
    • "r" (or "right")
    • "t" (or "top", or "up")
    • "b" (or "bottom", or "down")
  • distance : Number

    How far to move the element in pixels

  • animate : Boolean/Object (optional)

    true for the default animation or a standard Element animation config object

( item, ename, [fn], [scope] )
Shorthand for removeManagedListener. ...

Shorthand for removeManagedListener.

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item from which to remove a listener/listeners.

  • ename : Object/String

    The event name, or an object containing event name properties.

  • fn : Function (optional)

    If the ename parameter was an event name, this is the handler function.

  • scope : Object (optional)

    If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

Returns the next node in the Component tree in tree traversal order. ...

Returns the next node in the Component tree in tree traversal order.

Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the tree to attempt to find a match. Contrast with nextSibling.

Parameters

Returns

  • Ext.Component

    The next node (or the next node which matches the selector). Returns null if there is no matching node.

Returns the next sibling of this Component. ...

Returns the next sibling of this Component.

Optionally selects the next sibling which matches the passed ComponentQuery selector.

May also be referred to as next()

Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with nextNode

Parameters

Returns

  • Ext.Component

    The next sibling (or the next sibling which matches the selector). Returns null if there is no matching sibling.

( eventName, [fn], [scope], [options] ) : Object
Shorthand for addListener. ...

Shorthand for addListener.

Parameters

  • eventName : String/Object

    The name of the event to listen for. May also be an object who's property names are event names.

  • fn : Function (optional)

    The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below.

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

    Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

    This object 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 : Ext.util.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.

    • element : String

      This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

      This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

        new Ext.panel.Panel({
            title: 'The title',
            listeners: {
                click: this.handlePanelClick,
                element: 'body'
            }
        });
      
    • destroyable : Boolean (optional)

      When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

      Defaults to: false

    • priority : Number (optional)

      An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code.

      Combining Options

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

      A delayed, one-time listener.

      myPanel.on('hide', this.handleClick, this, {
          single: true,
          delay: 100
      });
      

Returns

  • Object

    Only when the destroyable option is specified.

    A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

    this.btnListeners =  = myButton.on({
        destroyable: true
        mouseover:   function() { console.log('mouseover'); },
        mouseout:    function() { console.log('mouseout'); },
        click:       function() { console.log('click'); }
    });
    

    And when those listeners need to be removed:

    Ext.destroy(this.btnListeners);
    

    or

    this.btnListeners.destroy();
    
Ext.form.field.ComboBox
view source
( )protectedtemplate
The picker (the dropdown) must have its zIndex managed by the same ZIndexManager which is providing the zIndex of our...

The picker (the dropdown) must have its zIndex managed by the same ZIndexManager which is providing the zIndex of our Container.

Available since: 3.4.0

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Fires

Overrides: Ext.Component.onAdded

Ext.form.field.ComboBox
view source
( list, record )private
...

Parameters

Fires

Ext.form.field.ComboBox
view source
( )private
...
Ext.form.field.ComboBox
view source
( list, record )private
...

Parameters

Fires

Ext.form.field.ComboBox
view source
( store, initial )protected
Template method, it is called when a new store is bound to the current instance. ...

Template method, it is called when a new store is bound to the current instance.

Parameters

Overrides: Ext.util.Bindable.onBindStore

The default blur handling must not occur for a TriggerField, implementing this template method disables that. ...

The default blur handling must not occur for a TriggerField, implementing this template method disables that. Instead the tab key is monitored, and the superclass's onBlur is called when tab is detected

Overrides: Ext.AbstractComponent.onBlur

Invoked when this component has first achieved size. ...

Invoked when this component has first achieved size. Occurs after the componentLayout has completed its initial run.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Fires

Overrides: Ext.AbstractComponent.onBoxReady

If grow=true, invoke the autoSize method when the field's value is changed. ...

If grow=true, invoke the autoSize method when the field's value is changed.

Parameters

Overrides: Ext.form.field.Field.onChange

Ext.form.field.ComboBox
view source
( )private
...
Ext.form.field.ComboBox
view source
( )private
Disables the key nav for the BoundList when it is collapsed. ...

Disables the key nav for the BoundList when it is collapsed.

Overrides: Ext.form.field.Picker.onCollapse

( names, callback, scope )private
...

Parameters

Ext.form.field.ComboBox
view source
( )private
...
Ext.form.field.ComboBox
view source
( )privateprotected
Allows addition of behavior to the destroy operation. ...

Allows addition of behavior to the destroy operation. After calling the superclass's onDestroy, the Component will be destroyed.

Overrides: Ext.form.field.Picker.onDestroy

Called when the field's dirty state changes. ...

Called when the field's dirty state changes. Adds/removes the dirtyCls on the main element.

Parameters

Overrides: Ext.form.field.Field.onDirtyChange

private ...

private

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Overrides: Ext.form.field.Base.onDisable

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

Parameters

private ...

private

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Overrides: Ext.form.field.Base.onEnable

private ...

private

Parameters

Fires

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

Fires

Ext.form.field.ComboBox
view source
( )private
Enables the key nav for the BoundList when it is expanded. ...

Enables the key nav for the BoundList when it is expanded.

Fires

Overrides: Ext.form.field.Picker.onExpand

Ext.form.field.ComboBox
view source
( )private
( [animateTarget], [callback], [scope] )protectedtemplate
Possibly animates down to a target element. ...

Possibly animates down to a target element.

Allows addition of behavior to the hide operation. After calling the superclass’s onHide, the Component will be hidden.

Gets passed the same parameters as hide.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Parameters

Fires

Overrides: Ext.AbstractComponent.onHide

Ext.form.field.ComboBox
view source
( picker, record )private
...

Parameters

Fires

Listen for TAB events and wrap round if tabbing of either end of the Floater ...

Listen for TAB events and wrap round if tabbing of either end of the Floater

Parameters

Fires

Overrides: Ext.util.Floating.onKeyDown

Ext.form.field.ComboBox
view source
( e, t )private
store the last key and doQuery if relevant ...

store the last key and doQuery if relevant

Parameters

Overrides: Ext.form.field.Text.onKeyUp

Ext.form.field.ComboBox
view source
( )private
...
Ext.form.field.ComboBox
view source
( list, selectedRecords )private
...

Parameters

Fires

Ext.form.field.ComboBox
view source
( store, records, success )private
...

Parameters

Fires

Mousedown brings to front, and programatically grabs focus unless the mousedown was on a focusable element ...

Mousedown brings to front, and programatically grabs focus unless the mousedown was on a focusable element

Parameters

Overrides: Ext.util.Floating.onMouseDown

Ext.form.field.ComboBox
view source
( toolbar, newPage )private
...

Parameters

Ext.form.field.ComboBox
view source
( )private
...
Called after the component is moved, this method is empty by default but can be implemented by any subclass that need...

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.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Parameters

  • x : Number

    The new x position.

  • y : Number

    The new y position.

Ext.form.field.ComboBox
view source
( )private
...
( destroying )protectedtemplate
Method to manage awareness of when components are removed from their respective Container, firing a removed event. ...

Method to manage awareness of when components are removed from their respective Container, firing a removed event. References are properly cleaned up after removing a component from its owning container.

Allows addition of behavior when a Component is removed from its parent Container. At this stage, the Component has been removed from its parent Container's collection of child items, but has not been destroyed (It will be destroyed if the parent Container's autoDestroy is true, or if the remove call was passed a truthy second parameter). After calling the superclass's onRemoved, the ownerCt and the refOwner will not be present.

Available since: 3.4.0

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Parameters

  • destroying : Boolean

    Will be passed as true if the Container performing the remove operation will delete this Component upon remove.

Fires

private ...

private

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Overrides: Ext.form.field.Base.onRender

( width, height, oldWidth, oldHeight )protectedtemplate
Allows addition of behavior to the resize operation. ...

Allows addition of behavior to the resize operation.

Called when Ext.resizer.Resizer#drag event is fired.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Parameters

Fires

( [animateTarget], [callback], [scope] )protectedtemplate
Allows addition of behavior to the show operation. ...

Allows addition of behavior to the show operation. After calling the superclass's onShow, the Component will be visible.

Override in subclasses where more complex behaviour is needed.

Gets passed the same parameters as show.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Parameters

Fires

Overrides: Ext.AbstractComponent.onShow

( [callback], [scope] )protectedtemplate
Invoked after the afterShow method is complete. ...

Invoked after the afterShow method is complete.

Gets passed the same callback and scope parameters that afterShow received.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Parameters

Fires

This method is called when any of the stateEvents are fired. ...

This method is called when any of the stateEvents are fired.

Fires

Ext.form.field.ComboBox
view source
( )protected
Handles the trigger click; by default toggles between expanding and collapsing the picker component. ...

Handles the trigger click; by default toggles between expanding and collapsing the picker component.

Fires

Overrides: Ext.form.field.Picker.onTriggerClick

process clicks upon triggers. ...

process clicks upon triggers. determine which trigger index, and dispatch to the appropriate click handler

Handle trigger mouse up gesture. ...

Handle trigger mouse up gesture. To be implemented in subclasses. Currently the Spinner subclass refocuses the input element upon end of spin.

Ext.form.field.ComboBox
view source
( )private
...
Ext.form.field.ComboBox
view source
( store )protected
Template method, it is called when an existing store is unbound from the current instance. ...

Template method, it is called when an existing store is unbound from the current instance.

Parameters

Overrides: Ext.util.Bindable.onUnbindStore

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

Parameters

Prepares a given class for observable instances. ...

Prepares a given class for observable instances. This method is called when a class derives from this class or uses this class as a mixin.

Parameters

  • T : Function

    The class constructor to prepare.

Returns the previous node in the Component tree in tree traversal order. ...

Returns the previous node in the Component tree in tree traversal order.

Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the tree in reverse order to attempt to find a match. Contrast with previousSibling.

Parameters

Returns

  • Ext.Component

    The previous node (or the previous node which matches the selector). Returns null if there is no matching node.

Returns the previous sibling of this Component. ...

Returns the previous sibling of this Component.

Optionally selects the previous sibling which matches the passed ComponentQuery selector.

May also be referred to as prev()

Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with previousNode

Parameters

Returns

  • Ext.Component

    The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling.

Performs any necessary manipulation of a raw String value to prepare it for conversion and/or validation. ...

Performs any necessary manipulation of a raw String value to prepare it for conversion and/or validation. For text fields this applies the configured stripCharsRe to the raw value.

Parameters

  • value : String

    The unprocessed string value

Returns

  • String

    The processed string value

Overrides: Ext.form.field.Base.processRawValue

...

Parameters

Converts a raw input field value into a mixed-type value that is suitable for this particular field type. ...

Converts a raw input field value into a mixed-type value that is suitable for this particular field type. This allows controlling the normalization and conversion of user-entered values into field-type-appropriate values, e.g. a Date object for Ext.form.field.Date, and is invoked by getValue.

It is up to individual implementations to decide how to handle raw values that cannot be successfully converted to the desired object type.

See valueToRaw for the opposite conversion.

The base implementation does no conversion, returning the raw value untouched.

Parameters

Returns

Called by Component#doAutoRender Register a Container configured floating: true with this Component's ZIndexManager. ...

Called by Component#doAutoRender

Register a Container configured floating: true with this Component's ZIndexManager.

Components added in this way will not participate in any layout, but will be rendered upon first show in the way that Windows are.

Parameters

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.

For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:

this.relayEvents(this.getStore(), ['load']);

The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword.

Parameters

  • origin : Object

    The Observable whose events this object is to relay.

  • events : String[]

    Array of event names to relay.

  • prefix : String (optional)

    A common prefix to prepend to the event names. For example:

    this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
    

    Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.

Returns

  • Object

    A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:

    this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
    

    Can be undone by calling

    Ext.destroy(this.storeRelayers);
    

    or this.store.relayers.destroy();

Remove any anchor to this element. ...

Remove any anchor to this element. See anchorTo.

Returns

Removes items in the childEls array based on the return value of a supplied test function. ...

Removes items in the childEls array based on the return value of a supplied test function. The function is called with a entry in childEls and if the test function return true, that entry is removed. If false, that entry is kept.

Parameters

...

Available since: 2.3.0

Removes a CSS class from the top level element representing this component. ...

Removes a CSS class from the top level element representing this component.

Parameters

Returns

Removes a cls to the uiCls array, which will also call removeUIClsFromElement and removes it from all elements of thi...

Removes a cls to the uiCls array, which will also call removeUIClsFromElement and removes it from all elements of this component.

Parameters

  • cls : String/String[]

    A string or an array of strings to remove to the uiCls.

Removes an event handler. ...

Removes an event handler.

Parameters

  • eventName : String

    The type of event the handler was associated with.

  • fn : Function

    The handler to remove. This must be a reference to the function passed into the Ext.util.Observable.addListener call.

  • scope : Object (optional)

    The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable.addListener or the listener will not be removed.

Removes listeners that were added by the mon method. ...

Removes listeners that were added by the mon method.

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item from which to remove a listener/listeners.

  • ename : Object/String

    The event name, or an object containing event name properties.

  • fn : Function (optional)

    If the ename parameter was an event name, this is the handler function.

  • scope : Object (optional)

    If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

inherit docs ...

inherit docs

Parameters

  • isClear : Boolean

    True if this is being called during a clear

  • managedListener : Object

    The managed listener item See removeManagedListener for other args

Overrides: Ext.util.Observable.removeManagedListenerItem

...

Parameters

Method which removes a specified UI + uiCls from the components element. ...

Method which removes a specified UI + uiCls from the components element. The cls which is added to the element will be: this.baseCls + '-' + ui.

Parameters

  • ui : String

    The UI to add to the element.

Method which removes a specified UI from the components element. ...

Method which removes a specified UI from the components element.

( [container], [position] )
Renders the Component into the passed HTML element. ...

Renders the 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.

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.

Parameters

  • container : Ext.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)

Fires

  • afterrender
  • beforerender
  • move
  • render
Overrides the method from the Ext.form.Labelable mixin to also add the invalidCls to the inputEl, as that is required...

Overrides the method from the Ext.form.Labelable mixin to also add the invalidCls to the inputEl, as that is required for proper styling in IE with nested fields (due to lack of child selector)

Overrides: Ext.form.Labelable.renderActiveError

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 emptyCls if the original value was blank.

Overrides: Ext.form.field.Field.reset

Resets the field's originalValue property so it matches the current value. ...

Resets the field's originalValue property so it matches the current value. This is called by Ext.form.Basic.setValues if the form's trackResetOnLoad property is set to true.

Fires

Ext.form.field.ComboBox
view source
( )private
invoked when a different store is bound to this combo than the original ...

invoked when a different store is bound to this combo than the original

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

private helper

Resumes firing of the named event(s). ...

Resumes firing of the named event(s).

After calling this method to resume events, the events will fire when requested to fire.

Note that if the suspendEvent method is called multiple times for a certain event, this converse method will have to be called the same number of times for it to resume firing.

Parameters

  • eventName : String...

    Multiple event names to resume.

Resumes firing events (see suspendEvents). ...

Resumes firing events (see suspendEvents).

If events were suspended using the queueSuspended parameter, then all events fired during event suspension will be sent to any listeners now.

...

Parameters

( propName, state, [stateName] ) : Boolean
Conditionally saves a single property from this object to the given state object. ...

Conditionally saves a single property from this object to the given state object. The idea is to only save state which has changed from the initial state so that current software settings do not override future software settings. Only those values that are user-changed state should be saved.

Parameters

  • propName : String

    The name of the property to save.

  • state : Object

    The state object in to which to save the property.

  • stateName : String (optional)

    The name to use for the property in state.

Returns

  • Boolean

    True if the property was saved, false if not.

Gathers additional named properties of the instance and adds their current values to the passed state object. ...

Gathers additional named properties of the instance and adds their current values to the passed state object.

Parameters

  • propNames : String/String[]

    The name (or array of names) of the property to save.

  • state : Object

    The state object in to which to save the property values.

Returns

Saves the state of the object to the persistence store. ...

Saves the state of the object to the persistence store.

Fires

( deltaX, deltaY, animate )
Scrolls this Component's target element by the passed delta values, optionally animating. ...

Scrolls this Component's target element by the passed delta values, optionally animating.

All of the following are equivalent:

 comp.scrollBy(10, 10, true);
 comp.scrollBy([10, 10], true);
 comp.scrollBy({ x: 10, y: 10 }, true);

Parameters

  • deltaX : Number/Number[]/Object

    Either the x delta, an Array specifying x and y deltas or an object with "x" and "y" properties.

  • deltaY : Number/Boolean/Object

    Either the y delta, or an animate flag or config object.

  • animate : Boolean/Object

    Animate flag/config object if the delta values were passed separately.

Ext.form.field.ComboBox
view source
( r )
Selects an item by a Model, or by a key value. ...

Selects an item by a Model, or by a key value.

Parameters

Fires

Selects text in this field ...

Selects text in this field

Parameters

  • start : Number (optional)

    The index where the selection should start

    Defaults to: 0

  • end : Number (optional)

    The index where the selection should end (defaults to the text length)

Ensures that all effects queued after sequenceFx is called on this object are run in sequence. ...

Ensures that all effects queued after sequenceFx is called on this object are run in sequence. This is the opposite of syncFx.

Returns

( [active], [newActive] )
This method is called internally by Ext.ZIndexManager to signal that a floating Component has either been moved to th...

This method is called internally by Ext.ZIndexManager to signal that a floating Component has either been moved to the top of its zIndex stack, or pushed from the top of its zIndex stack.

If a Window is superceded by another Window, deactivating it hides its shadow.

This method also fires the activate or deactivate event depending on which action occurred.

Parameters

  • active : Boolean (optional)

    True to activate the Component, false to deactivate it.

    Defaults to: false

  • newActive : Ext.Component (optional)

    The newly active Component which is taking over topmost zIndex position.

Fires

  • activate
  • deactivate
Sets the active error message to the given string. ...

Sets the active error message to the given string. This replaces the entire error message contents with the given string. Also see setActiveErrors which accepts an Array of messages and formats them according to the activeErrorsTpl. Note that this only updates the error message element's text and attributes, you'll have to call doComponentLayout to actually update the field's layout to match. If the field extends Ext.form.field.Base you should call markInvalid instead.

Parameters

  • msg : String

    The error message

Set the active error message to an Array of error messages. ...

Set the active error message to an Array of error messages. The messages are formatted into a single message string using the activeErrorsTpl. Also see setActiveError which allows setting the entire error contents with a single string. Note that this only updates the error message element's text and attributes, you'll have to call doComponentLayout to actually update the field's layout to match. If the field extends Ext.form.field.Base you should call markInvalid instead.

Parameters

  • errors : String[]

    The error messages

Sets the overflow on the content element of the component. ...

Sets the overflow on the content element of the component.

Parameters

  • scroll : Boolean

    True to allow the Component to auto scroll.

Returns

...

Parameters

  • border : String/Number

    The border, see border. If a falsey value is passed the border will be removed.

This method changes the region config property for this border region. ...

This method changes the region config property for this border region. This is only valid if this component is in a border layout (Ext.layout.container.Border).

Defined in override Ext.layout.container.border.Region.

Parameters

  • region : String

    The new region value ("north", "south", "east" or "west").

Returns

  • String

    The previous value of the region property.

Sets the element's box. ...

Sets the element's box. If animate is true then x, y, width, and height will be animated concurrently.

Parameters

  • box : Object

    The box to fill {x, y, width, height}

  • animate : Boolean/Object (optional)

    true for the default animation or a standard Element animation config object

Returns

Fires

  • move
...

Parameters

( config, applyIfNotSet ) : Ext.Basechainableprivate
...

Parameters

Returns

Enable or disable the component. ...

Enable or disable the component.

Parameters

  • disabled : Boolean

    true to disable.

Sets the dock position of this component in its parent panel. ...

Sets the dock position of this component in its parent panel. Note that this only has effect if this item is part of the dockedItems collection of a parent that has a DockLayout (note that any Panel has a DockLayout by default)

Parameters

  • dock : Object

    The dock position.

  • layoutParent : Boolean (optional)

    true to re-layout parent.

    Defaults to: false

Returns

Sets the editable state of this field. ...

Sets the editable state of this field. This method is the runtime equivalent of setting the 'editable' config option at config time.

Parameters

  • editable : Boolean

    True to allow the user to directly edit the field text. If false is passed, the user will only be able to modify the field using the trigger. Will also add a click event to the text field which will call the trigger.

Set the current error state ...

Set the current error state

Parameters

  • error : String

    The error message to set

Applies a set of default configuration values to this Labelable instance. ...

Applies a set of default configuration values to this Labelable instance. For each of the properties in the given object, check if this component hasOwnProperty that config; if not then it's inheriting a default value from its prototype and we should apply the default value.

Parameters

  • defaults : Object

    The defaults to apply to the object.

Set the label of this field. ...

Set the label of this field.

Parameters

  • label : String

    The new label. The labelSeparator will be automatically appended to the label string.

Set the CSS style of the field input element. ...

Set the CSS style of the field input element.

Parameters

...

Parameters

Sets the height of the component. ...

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

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

...

Parameters

Ext.form.field.ComboBox
view source
( values )private
Set the value of hiddenDataEl Dynamically adds and removes input[type=hidden] elements ...

Set the value of hiddenDataEl Dynamically adds and removes input[type=hidden] elements

Parameters

...

Parameters

This method allows you to show or hide a LoadMask on top of this component. ...

This method allows you to show or hide a LoadMask on top of this component.

Parameters

  • load : Boolean/Object/String

    True to show the default LoadMask, a config object that will be passed to the LoadMask constructor, or a message String to show. False to hide the current LoadMask.

  • targetEl : Boolean (optional)

    True to mask the targetEl of this Component instead of the this.el. For example, setting this to true on a Panel will cause only the body to be masked.

    Defaults to: false

Returns

  • Ext.LoadMask

    The LoadMask instance that has just been shown.

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

Parameters

Returns

Overrides: Ext.util.Positionable.setLocalX

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

Parameters

Returns

Overrides: Ext.util.Positionable.setLocalXY

Sets the local y coordinate of this element using CSS style. ...

Sets the local y coordinate of this element using CSS style. When used on an absolute positioned element this method is symmetrical with getLocalY, but may not be symmetrical when used on a relatively positioned element.

Parameters

Returns

Overrides: Ext.util.Positionable.setLocalY

Sets the margin on the target element. ...

Sets the margin on the target element.

Parameters

( overflowX, overflowY ) : Ext.Componentchainable
Sets the overflow x/y on the content element of the component. ...

Sets the overflow x/y on the content element of the component. The x/y overflow values can be any valid CSS overflow (e.g., 'auto' or 'scroll'). By default, the value is 'hidden'. Passing null for one of the values will erase the inline style. Passing undefined will preserve the current value.

Parameters

  • overflowX : String

    The overflow-x value.

  • overflowY : String

    The overflow-y value.

Returns

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.

Parameters

  • x : Number/Number[]

    The new x position or an array of [x,y].

  • y : Number (optional)

    The new y position.

  • animate : Boolean/Object (optional)

    True to animate the Component into its new position. You may also pass an animation configuration.

Returns

Fires

( x, [y], [animate] ) : Ext.Componentchainable
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.

Parameters

  • x : Number/Number[]/Object

    The new left, an array of [x,y], or animation config object containing x and y properties.

  • y : Number (optional)

    The new top.

  • animate : Boolean/Object (optional)

    If true, the Component is animated into its new position. You may also pass an animation configuration.

Returns

Fires

Sets the field's raw value directly, bypassing value conversion, change detection, and validation. ...

Sets the field's raw value directly, bypassing value conversion, change detection, and validation. To set the value with these additional inspections see setValue.

Parameters

  • value : Object

    The value to set

Returns

  • Object

    value The field value that is set

Sets the read-only state of this field. ...

Sets the read-only state of this field. This method is the runtime equivalent of setting the 'readOnly' config option at config time.

Parameters

  • readOnly : Boolean

    True to prevent the user changing the field and explicitly hide the trigger. Setting this to true will supercede settings editable and hideTrigger. Setting this to false will defer back to editable and hideTrigger.

Overrides: Ext.form.field.Base.setReadOnly

Sets the element's position and size to the specified region. ...

Sets the element's position and size to the specified region. If animation is true then width, height, x and y will be animated concurrently.

Parameters

  • region : Ext.util.Region

    The region to fill

  • animate : Boolean/Object (optional)

    true for the default animation or a standard Element animation config object

Returns

Fires

  • move
Sets the weight config property for this component. ...

Sets the weight config property for this component. This is only valid if this component is in a border layout (Ext.layout.container.Border).

Defined in override Ext.layout.container.border.Region.

Parameters

  • weight : Number

    The new weight value.

Returns

  • Number

    The previous value of the weight property.

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

Sets the width and height of this Component. 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}.

Parameters

  • width : Number/String/Object

    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 : Number/String

    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

Sets the UI for the component. ...

Sets the UI for the component. This will remove any existing UIs on the component. It will also loop through any uiCls set on the component and rename them so they include the new UI.

Parameters

  • ui : String

    The new UI for the component.

Ext.form.field.ComboBox
view source
( value, [doSelect] ) : Ext.form.field.Field
Sets the specified value(s) into the field. ...

Sets the specified value(s) into the field. For each value, if a record is found in the store that matches based on the valueField, then that record's displayField will be displayed in the field. If no match is found, and the valueNotFoundText config option is defined, then that will be displayed as the default field text. Otherwise a blank value will be shown, although the value will still be set.

Parameters

  • value : String/String[]

    The value(s) to be set. Can be either a single String or Ext.data.Model, or an Array of Strings or Models.

  • doSelect : Boolean (optional)

    Prevent selection of the value by passing false otherwise the row will be selected in the list.

    Defaults to: true

Returns

Fires

Overrides: Ext.form.field.Text.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

Sets the width of the component. ...

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

Parameters

  • width : Number

    The new width to setThis may be one of:

Returns

Sets the X position of the DOM element based on page coordinates. ...

Sets the X position of the DOM element based on page coordinates.

Parameters

Returns

Overrides: Ext.util.Positionable.setX

Sets the position of the DOM element in page coordinates. ...

Sets the position of the DOM element in page coordinates.

Parameters

Returns

Overrides: Ext.util.Positionable.setXY

Sets the Y position of the DOM element based on page coordinates. ...

Sets the Y position of the DOM element based on page coordinates.

Parameters

Returns

Overrides: Ext.util.Positionable.setY

z-index is managed by the zIndexManager and may be overwritten at any time. ...

z-index is managed by the zIndexManager and may be overwritten at any time. Returns the next z-index to be used. If this is a Container, then it will have rebased any managed floating Components, and so the next available z-index will be approximately 10000 above that.

Parameters

Inject a reference to the function which applies the render template into the framing template. ...

Inject a reference to the function which applies the render template into the framing template. The framing template wraps the content.

Parameters

...

Parameters

( [animateTarget], [callback], [scope] ) : Ext.Componentchainable
Shows this Component, rendering it first if autoRender or floating are true. ...

Shows this Component, rendering it first if autoRender or floating are true.

After being shown, a floating Component (such as a Ext.window.Window), is activated it and brought to the front of its z-index stack.

Parameters

  • animateTarget : String/Ext.Element (optional)

    only valid for floating Components such as Windows or ToolTips, or regular Components which have been configured with floating: true. The target from which the Component should animate from while opening.

    Defaults to: null

  • callback : Function (optional)

    A callback function to call after the Component is displayed. Only necessary if animation was specified.

  • scope : Object (optional)

    The scope (this reference) in which the callback is executed. Defaults to this Component.

Returns

Fires

Overrides: Ext.AbstractComponent.show

( x, [y], [animate] ) : Ext.Componentchainable
Displays component at specific xy position. ...

Displays component at specific xy position. A floating component (like a menu) is positioned relative to its ownerCt if any. Useful for popping up a context menu:

listeners: {
    itemcontextmenu: function(view, record, item, index, event, options) {
        Ext.create('Ext.menu.Menu', {
            width: 100,
            height: 100,
            margin: '0 0 10 0',
            items: [{
                text: 'regular item 1'
            },{
                text: 'regular item 2'
            },{
                text: 'regular item 3'
            }]
        }).showAt(event.getXY());
    }
}

Parameters

  • x : Number/Number[]

    The new x position or array of [x,y].

  • y : Number (optional)

    The new y position

  • animate : Boolean/Object (optional)

    True to animate the Component into its new position. You may also pass an animation configuration.

Returns

Fires

( component, [position], [offsets] ) : Ext.Componentchainable
Shows this component by the specified Component or Element. ...

Shows this component by the specified Component or Element. Used when this component is floating.

Parameters

Returns

Fires

Get the reference to the class from which this object was instantiated. ...

Get the reference to the class from which this object was instantiated. Note that unlike self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

Ext.define('My.Cat', {
    statics: {
        totalCreated: 0,
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        var statics = this.statics();

        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                        // equivalent to: My.Cat.speciesName

        alert(this.self.speciesName);   // dependent on 'this'

        statics.totalCreated++;
    },

    clone: function() {
        var cloned = new this.self;                      // dependent on 'this'

        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName

        return cloned;
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',

    statics: {
        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
    },

    constructor: function() {
        this.callParent();
    }
});

var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'

var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
alert(clone.groupName);                 // alerts 'Cat'

alert(My.Cat.totalCreated);             // alerts 3

Returns

Stops any running effects and clears this object's internal effects queue if it contains any additional effects that ...

Stops any running effects and clears this object's internal effects queue if it contains any additional effects that haven't started yet.

Returns

Stops any running effects and clears this object's internal effects queue if it contains any additional effects that ...

Stops any running effects and clears this object's internal effects queue if it contains any additional effects that haven't started yet.

This method has been deprected since 4.0

Replaced by stopAnimation

Returns

Suspends firing of the named event(s). ...

Suspends firing of the named event(s).

After calling this method to suspend events, the events will no longer fire when requested to fire.

Note that if this is called multiple times for a certain event, the converse method resumeEvent will have to be called the same number of times for it to resume firing.

Parameters

  • eventName : String...

    Multiple event names to suspend.

Suspends the firing of all events. ...

Suspends the firing of all events. (see resumeEvents)

Parameters

  • queueSuspended : Boolean

    Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events.

Ensures that all effects queued after syncFx is called on this object are run concurrently. ...

Ensures that all effects queued after syncFx is called on this object are run concurrently. This is the opposite of sequenceFx.

Returns

synchronizes the hidden state of this component with the state of its hierarchy ...

synchronizes the hidden state of this component with the state of its hierarchy

Fires

  • afterrender
  • beforehide
  • beforerender
  • beforeshow
  • move
  • render
Ext.form.field.ComboBox
view source
( )private
Synchronizes the selection in the picker to match the current value of the combobox. ...

Synchronizes the selection in the picker to match the current value of the combobox.

Sends this Component to the back of (lower z-index than) any other visible windows ...

Sends this Component to the back of (lower z-index than) any other visible windows

Returns

Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManag...

Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManager

If this Component is modal, inserts the modal mask just below this Component in the z-index stack.

Parameters

  • preventFocus : Boolean (optional)

    Specify true to prevent the Component from being focused.

    Defaults to: false

Returns

Allows for any necessary modifications before the original value is set ...

Allows for any necessary modifications before the original value is set

Parameters

  • value : Object

    The initial value

Returns

  • Object

    The modified initial value

Transform the raw value before it is set ...

Transform the raw value before it is set

Parameters

Returns

Translates the passed page coordinates into left/top css values for the element ...

Translates the passed page coordinates into left/top css values for the element

Parameters

  • x : Number/Array

    The page x or an array containing [x, y]

  • y : Number (optional)

    The page y, required if x is not an array

Returns

  • Object

    An object with left and top properties. e.g. {left: (value), top: (value)}

Translates the passed page coordinates into x and y css values for the element ...

Translates the passed page coordinates into x and y css values for the element

Parameters

  • x : Number/Array

    The page x or an array containing [x, y]

  • y : Number (optional)

    The page y, required if x is not an array

Returns

  • Object

    An object with x and y properties. e.g. {x: (value), y: (value)}

Returns the trimmed label by slicing off the label separator character. ...

Returns the trimmed label by slicing off the label separator character. Can be overridden.

Returns

  • String

    The trimmed field label, or empty string if not defined

( eventName, fn, [scope] )
Shorthand for removeListener. ...

Shorthand for removeListener.

Parameters

  • eventName : String

    The type of event the handler was associated with.

  • fn : Function

    The handler to remove. This must be a reference to the function passed into the Ext.util.Observable.addListener call.

  • scope : Object (optional)

    The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable.addListener or the listener will not be removed.

Unbinds listeners from this component to the store. ...

Unbinds listeners from this component to the store. By default it will remove anything bound by the bindStoreListeners method, however it can be overridden in a subclass to provide any more complicated handling.

Parameters

Overridden in Ext.rtl.AbstractComponent. ...

Overridden in Ext.rtl.AbstractComponent.

Parameters

Clears the active error message(s). ...

Clears the active error message(s). Note that this only clears the error message element's text and attributes, you'll have to call doComponentLayout to actually update the field's layout to match. If the field extends Ext.form.field.Base you should call clearInvalid instead.

Navigates up the ownership hierarchy searching for an ancestor Container which matches any passed selector or component. ...

Navigates up the ownership hierarchy searching for an ancestor Container which matches any passed selector or component.

Important. There is not a universal upwards navigation pointer. There are several upwards relationships such as the button which activates a menu, or the menu item which activated a submenu, or the column header which activated the column menu.

These differences are abstracted away by this method.

Example:

var owningTabPanel = grid.up('tabpanel');

Parameters

  • selector : String/Ext.Component (optional)

    The selector component or actual component to test. If not passed the immediate owner/activater is returned.

  • limit : String/Number/Ext.Component (optional)

    This may be a selector upon which to stop the upward scan, or a limit of the number of steps, or Component reference to stop on.

Returns

( htmlOrData, [loadScripts], [callback] )
Update the content area of a component. ...

Update the content area of a component.

Available since: 3.4.0

Parameters

  • htmlOrData : String/Object

    If this component has been configured with a template via the tpl config then it will use this argument as data to populate the template. If this component was not configured with a template, the components content area will be updated via Ext.Element update.

  • loadScripts : Boolean (optional)

    Only legitimate when using the html configuration.

    Defaults to: false

  • callback : Function (optional)

    Only legitimate when using the html configuration. Callback to execute when scripts have finished loading.

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

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

Parameters

  • box : Object

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

Returns

Fires

Updates this component's layout. ...

Updates this component's layout. If this update affects this components ownerCt, that component's updateLayout method will be called to perform the layout instead. Otherwise, just this component (and its child items) will layout.

Parameters

  • options : Object (optional)

    An object with layout options.

    • defer : Boolean

      true if this layout should be deferred.

    • isRoot : Boolean

      true if this layout should be the root of the layout.

Returns whether or not the field value is currently valid by validating the field's current value, and fires the vali...

Returns whether or not the field value is currently valid by validating the field's current value, and fires the validitychange event if the field's validity has changed since the last validation. Note: disabled fields are always treated as valid.

Custom implementations of this method are allowed to have side-effects such as triggering error message display. To validate without side-effects, use isValid.

Returns

  • Boolean

    True if the value is valid, else false

Fires

This should be overridden by any subclass that needs to check whether or not the field can be blurred. ...

This should be overridden by any subclass that needs to check whether or not the field can be blurred.

Parameters

Uses getErrors to build an array of validation errors. ...

Uses getErrors to build an array of validation errors. If any errors are found, they are passed to markInvalid and false is returned, otherwise true is returned.

Previously, subclasses were invited to provide an implementation of this to process validations - from 3.2 onwards getErrors should be overridden instead.

Parameters

  • value : Object

    The value to validate

Returns

  • Boolean

    True if all validations passed, false if one or more failed

Converts a mixed-type value to a raw representation suitable for displaying in the field. ...

Converts a mixed-type value to a raw representation suitable for displaying in the field. This allows controlling how value objects passed to setValue are shown to the user, including localization. For instance, for a Ext.form.field.Date, this would control how a Date object passed to setValue would be converted to a String for display in the field.

See rawToValue for the opposite conversion.

The base implementation simply does a standard toString conversion, and converts empty values to an empty string.

Parameters

  • value : Object

    The mixed-type value to convert to the raw representation.

Returns

  • Object

    The converted raw value.

Defined By

Static methods

( config )privatestatic
...

Parameters

( members )chainableprivatestatic
...

Parameters

( name, member )chainableprivatestatic
...

Parameters

( members )chainablestatic
Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

Ext.define('My.awesome.Cat', {
    constructor: function() {
        ...
    }
});

 My.awesome.Cat.addMembers({
     meow: function() {
        alert('Meowww...');
     }
 });

 var kitty = new My.awesome.Cat;
 kitty.meow();

Parameters

( members ) : Ext.Basechainablestatic
Add / override static properties of this class. ...

Add / override static properties of this class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.addStatics({
    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
});

Parameters

Returns

( xtype )chainableprivatestatic
...

Parameters

( fromClass, members ) : Ext.Basechainableprivatestatic
Borrow another class' members to the prototype of this class. ...

Borrow another class' members to the prototype of this class.

Ext.define('Bank', {
    money: '$$$',
    printMoney: function() {
        alert('$$$$$$$');
    }
});

Ext.define('Thief', {
    ...
});

Thief.borrow(Bank, ['money', 'printMoney']);

var steve = new Thief();

alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'

Parameters

  • fromClass : Ext.Base

    The class to borrow members from

  • members : Array/String

    The names of the members to borrow

Returns

Create a new instance of this Class. ...

Create a new instance of this Class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.create({
    someConfig: true
});

All parameters are passed to the constructor of the class.

Returns

Overrides: Ext.layout.Layout.create

( alias, origin )static
Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

Ext.define('My.cool.Class', {
    method1: function() { ... },
    method2: function() { ... }
});

var test = new My.cool.Class();

My.cool.Class.createAlias({
    method3: 'method1',
    method4: 'method2'
});

test.method3(); // test.method1()

My.cool.Class.createAlias('method5', 'method3');

test.method5(); // test.method3() -> test.method1()

Parameters

( config )privatestatic
...

Parameters

Get the current class' name in string format. ...

Get the current class' name in string format.

Ext.define('My.cool.Class', {
    constructor: function() {
        alert(this.self.getName()); // alerts 'My.cool.Class'
    }
});

My.cool.Class.getName(); // 'My.cool.Class'

Returns

( )deprecatedstatic
Adds members to class. ...

Adds members to class.

This method has been deprected since 4.1

Use addMembers instead.

( name, mixinClass )privatestatic
Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Parameters

( fn, scope )chainableprivatestatic
...

Parameters

( members ) : Ext.Basechainabledeprecatedstatic
Override members of this class. ...

Override members of this class. Overridden methods can be invoked via callParent.

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

As of 4.1, direct use of this method is deprecated. Use Ext.define instead:

Ext.define('My.CatOverride', {
    override: 'My.Cat',
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

This method has been deprected since 4.1.0

Use Ext.define instead

Parameters

  • members : Object

    The properties to add to this class. This should be specified as an object literal containing one or more properties.

Returns

Defined By

Events

Fires after a Component has been visually activated. ...

Fires after a Component has been visually activated.

Note This event is only fired if this Component is a child of a Ext.container.Container that uses Ext.layout.container.Card as it's layout or this Component is a floating Component.

Parameters

( this, container, pos, eOpts )
Fires after a Component had been added to a Container. ...

Fires after a Component had been added to a Container.

Available since: 3.4.0

Parameters

Fires after the component rendering is finished. ...

Fires after the component rendering is finished.

The afterrender event is fired after this Component has been rendered, been postprocessed by any afterRender method defined for the Component.

Available since: 3.4.0

Parameters

Fires when the autoSize function is triggered and the field is resized according to the grow/growMin/growMax configs ...

Fires when the autoSize function is triggered and the field is resized according to the grow/growMin/growMax configs as a result. This event provides a hook for the developer to apply additional logic at runtime to resize the field if needed.

Parameters

Fires before a Component has been visually activated. ...

Fires before a Component has been visually activated. Returning false from an event listener can prevent the activate from occurring.

Note This event is only fired if this Component is a child of a Ext.container.Container that uses Ext.layout.container.Card as it's layout.

Parameters

Fires before a Component has been visually deactivated. ...

Fires before a Component has been visually deactivated. Returning false from an event listener can prevent the deactivate from occurring.

Note This event is only fired if this Component is a child of a Ext.container.Container that uses Ext.layout.container.Card as it's layout.

Parameters

Ext.form.field.ComboBox
view source
( combo, record, index, eOpts )
Fires before the deselected item is removed from the collection ...

Fires before the deselected item is removed from the collection

Parameters

Fires before the component is destroyed. ...

Fires before the component is destroyed. Return false from an event handler to stop the destroy.

Available since: 1.1.0

Parameters

Fires before the component is hidden when calling the hide method. ...

Fires before the component is hidden when calling the hide method. Return false from an event handler to stop the hide.

Available since: 1.1.0

Parameters

Ext.form.field.ComboBox
view source
( queryPlan, eOpts )
Fires before all queries are processed. ...

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

Parameters

  • queryPlan : Object

    An object containing details about the query to be executed.

    • combo : Ext.form.field.ComboBox

      A reference to this ComboBox.

    • query : String

      The query value to be used to match against the ComboBox's valueField.

    • forceAll : Boolean

      If true, causes the query to be executed even if the minChars threshold is not met.

    • cancel : Boolean

      A boolean value which, if set to true upon return, causes the query not to be executed.

    • rawQuery : Boolean

      If true indicates that the raw input field value is being used, and upon store load,

  • eOpts : Object

    The options object passed to Ext.util.Observable.addListener.

Fires before the component is rendered. ...

Fires before the component is rendered. Return false from an event handler to stop the render.

Available since: 1.1.0

Parameters

Ext.form.field.ComboBox
view source
( combo, record, index, eOpts )
Fires before the selected item is added to the collection ...

Fires before the selected item is added to the collection

Parameters

Fires before the component is shown when calling the show method. ...

Fires before the component is shown when calling the show method. Return false from an event handler to stop the show.

Available since: 1.1.0

Parameters

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

Fires before the state of the object is restored. Return false from an event handler to stop the restore.

Parameters

  • this : Ext.state.Stateful
  • state : Object

    The hash of state values returned from the StateProvider. If this event is not vetoed, then the state object is passed to applyState. By default, that simply copies property values into this object. The method maybe overriden to provide custom state restoration.

  • eOpts : Object

    The options object passed to Ext.util.Observable.addListener.

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

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

Parameters

Fires when this Component loses focus. ...

Fires when this Component loses focus.

Parameters

( this, width, height, eOpts )
Fires one time - after the component has been laid out for the first time at its initial size. ...

Fires one time - after the component has been laid out for the first time at its initial size.

Parameters

( this, newValue, oldValue, eOpts )
Fires when the value of a field is changed via the setValue method. ...

Fires when the value of a field is changed via the setValue method.

Parameters

Fires when the field's picker is collapsed. ...

Fires when the field's picker is collapsed.

Parameters

Fires after a Component has been visually deactivated. ...

Fires after a Component has been visually deactivated.

Note This event is only fired if this Component is a child of a Ext.container.Container that uses Ext.layout.container.Card as it's layout or this Component is a floating Component.

Parameters

Fires after the component is destroyed. ...

Fires after the component is destroyed.

Available since: 1.1.0

Parameters

Fires when a change in the field's isDirty state is detected. ...

Fires when a change in the field's isDirty state is detected.

Parameters

Fires after the component is disabled. ...

Fires after the component is disabled.

Available since: 1.1.0

Parameters