ExtReact Docs Help

Introduction

The documentation for the ExtReact product diverges somewhat from the documentation of other Sencha products. The sections below describe documentation for all products except where indicated as unique to ExtReact.

Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an alias (or xtype if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

ExtReact component classes list the configurable name prominently at the top of the API class doc followed by the fully-qualified class name.

Access Levels

Framework classes or their members may be specified as private or protected. Else, the class / member is public. Public, protected, and private are access descriptors used to convey how and when the class or class member should be used.

Member Types

Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

Member Icons

- Indicates a class member of type config

Or in the case of an ExtReact component class this indicates a member of type prop

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

- Indicates that the class, member, or guide is new in the currently viewed version

Class Member Quick-Nav Menu

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

ExtReact component classes do not hoist the getter / setter methods into the prop. All methods will be described in the Methods section

History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.

The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.

Clicking on an empty search field will show your last 10 searches for quick navigation.

API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

ExtReact 6.5.0


top

ComboBoxField Ext.field.ComboBox

Summary

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; if the editable prop is true, then 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 props which are applied to the list via the itemTpl.

If your store is not remote, i.e. it depends only on local data and is loaded up front, you MUST set the queryMode to 'local'.

Example usage:

Children

The following Components (and their sub-components) may be included as children of ComboBoxField:
String
Object
No members found using the current filters

props

Optional Props

activeErrorsTpl : String / String[] / Ext.XTemplate
immutable imm

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.

Defaults to:

undefined

allQuery : String

The text query to use to filter the store when the trigger element is tapped (or expansion is requested by a keyboard gesture). By default, this is null causing no filtering to occur.

Defaults to:

null

allowBlank : Boolean

Specify false to not accept blank values

Defaults to:

null

anyMatch : Boolean

  • Only valid when queryMode is 'local'. Configure as true to cause the primaryFilter to match the typed characters at any position in the displayField's value when filtering locally*.

Defaults to:

false

ariaAttributes : Object

An object containing ARIA attributes to be set on this Component's ARIA element. Use this to set the attributes that cannot be determined by the Component's state, such as aria-live, aria-flowto, etc.

Note that this config is only meaningful at the Component rendering time, and setting it after that will do nothing.

ariaDescribedBy : String
immutable imm

DOM selector for a child element that is to be used as description for this Component, set in aria-describedby attribute. The selector works the same way as ariaLabelledBy.

ariaLabel : String
immutable imm

ARIA label for this Component. It is best to use ariaLabelledBy option instead, because screen readers prefer aria-labelledby attribute to aria-label. ariaLabel and ariaLabelledBy config options are mutually exclusive.

ariaLabelledBy : String
immutable imm

DOM selector for a child element that is to be used as label for this Component, set in aria-labelledby attribute. If the selector is by #id, the label element can be any existing element, not necessarily a child of the main Component element.

ariaLabelledBy and ariaLabel config options are mutually exclusive, and ariaLabelledBy has the higher precedence.

ariaRole : String
readonly ro

ARIA role for this Component, defaults to no role. With no role, no other ARIA attributes are set.

autoCapitalize : Boolean

True to set the field's DOM element auto=capitalize attribute to "on", false to set to "off".

Defaults to:

null

autoComplete : Boolean

Autocomplete is disabled on Picker fields by default.

Defaults to:

false

autoCorrect : Boolean

True to set the field DOM element auto-correct attribute to "on", false to set to "off".

Defaults to:

null

autoFitErrors : Boolean
immutable imm

Whether to adjust the component's body width to make room for error messages.

Defaults to:

null

autoFocus : Boolean

true to automatically focus 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

autoFocusLast : Boolean

When true, the last selected record in the dropdown list will be re-selected upon autoFocus. Set to false to always select the first record in the drop-down list. For accessible applications it is recommended to set this option to false.

Defaults to:

true

autoLoadOnValue : Boolean

This option controls whether to initially load the store when a value is set so that the display value can be determined from the appropriate record. The store will only be loaded in a limited set of circumstances:

  • The store is not currently loading.
  • The store does not have a pending Ext.data.Store#autoLoad.
  • The store has not been loaded before.

Defaults to:

false

autoSelect : Boolean

true to auto select the first value in the store or options when they are changed. Only happens when the value is set to null.

Defaults to:

false

axisLock : Boolean
immutable imm

If true, then, when showBy or alignTo fallback on constraint violation only takes place along the major align axis.

That is, if alignment "l-r" is being used, and axisLock: true is used, then if constraints fail, only fallback to "r-l" is considered.

Defaults to:

null

blankText : String
immutable imm

The error text to display if the allowBlank validation fails.

Defaults to:

'This field is required'

bodyAlign : 'start' / 'center' / 'end' / 'stretch'

The horizontal alignment of this field's component within the body of the field

Defaults to:

'start'

border : Boolean

Enables or disables bordering on this component. The following values are accepted:

  • null or `true (default): Do nothing and allow the border to be specified by the theme.
  • false: suppress the default border provided by the theme.

Please note that enabling bordering via this config will not add a border-color or border-style CSS property to the component; you provide the border-color and border-style via CSS rule or style configuration (if not already provide by the theme).

Defaults to:

null

bottom : Number / String

The absolute bottom position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

caseSensitive : Boolean

  • Only valid when queryMode is 'local'.* Configure as true to cause the primaryFilter to match with exact case matching.

Defaults to:

false

centered : Boolean

Configure this as true to have this Component centered within its Container. Setting this value to true will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

clearFilterOnBlur : Boolean

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

cls : String / String[]

The CSS class to add to this widget's element, in addition to the baseCls. In many cases, this property will be specified by the derived widget class. See userCls for adding additional CSS classes to widget instances (such as items in a Container).

Defaults to:

null

collapseOnSelect : Boolean

Has no effect if multiSelect is false

Configure as true to automatically hide the picker after a selection is made.

Defaults to:

null

component : Object

The config object to factory the Component that this Decorator wraps around.

containsFocus : Boolean
readonly ro

true if this currently focused element is within this Component's or Container's hierarchy. This property is set separately from hasFocus, and can be true when hasFocus is false.

Examples:

  • Text field with input element focused would be: focusable: true, hasFocus: true, containsFocus: true

  • Date field with drop-down picker currently focused would be: focusable: true, hasFocus: false, containsFocus: true

  • Form Panel with a child input field currently focused would be: focusable: false, hasFocus: false, containsFocus: true

See also hasFocus.

Defaults to:

false

contentEl : Ext.dom.Element / HTMLElement / String

The configured element will automatically be added as the content of this component. When you pass a string, we expect it to be an element id. If the content element is hidden, we will automatically show it.

Defaults to:

null

data : Object

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

Defaults to:

null

disabled : Boolean

true to disable the field.

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

Defaults to:

false

displayField : String / Number

The underlying data value name to bind to this Select control. If configured as null, the valueField is used.

This resolved value is the visibly rendered value of the available selection options.

Defaults to:

text

displayTpl : Function / String / String[]

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

If not specified, the displayField is shown in the text field.

Defaults to:

null

docked : String

The dock position of this component in its container. Can be left, top, right or bottom.

Notes

You must use a HTML5 doctype for docked bottom to work. To do this, simply add the following code to the HTML file:

<!doctype html>

So your index.html file should look a little like this:

<!doctype html>
<html>
    <head>
        <title>MY application title</title>
        ...

Defaults to:

null

draggable : Object

Configuration options to make this Component draggable

Defaults to:

null

edgePicker : String / Object

A configuration object, containing an cfg#xtype property which specifies the widget to create if picker: 'edge' (or if it's 'auto' and the app is on a phone)

Defaults to:

null

Available since: 6.5.0

editable : Boolean

Configure as false to prevent the user from typing text directly into the field; the field can only have its value set programmatically or via an action invoked by a trigger.

Contrast with readOnly which disables all mutation via the UI.

Defaults to:

true

enableRegEx : Boolean

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. Invalid regex values will be ignored.

Defaults to:

null

factoryConfig : Object
readonly ro

If this property is specified by the target class of this mixin its properties are used to configure the created Ext.Factory.

floatedPicker : String / Object

A configuration object, containing an cfg#xtype property which specifies the widget to create if picker: 'floated' (or if it's 'auto' and the app is not on a phone)

Defaults to:

null

Available since: 6.5.0

floatedPickerAlign : String

*Only valud when the floatedPicker is used. The showBy alignment string to use when showing the floated picker by the input field.

Defaults to:

tl-bl?

focusCls : String
immutable imm

CSS class that will be added to focused component's focusClsEl, and removed when component blurs.

Defaults to:

'x-focused'

focusClsEl : Ext.dom.Element
readonly ro

The element that will have the focusCls applied when component's focusEl is focused.

focusEl : Ext.dom.Element
readonly ro

The element that will be focused when focus method is called on this component. Usually this is the same element that receives focus via mouse clicks, taps, and pressing Tab key.

Defaults to:

'el'

focusable : Boolean
readonly ro

true for keyboard interactive Components or Widgets, false otherwise. For Containers, this property reflects interactiveness of the Container itself, not its children. See isFocusable.

Note: It is not enough to set this property to true to make a component keyboard interactive. You also need to make sure that the component's focusEl is reachable via Tab key (tabbable). See also tabIndex.

Defaults to:

false

forceSelection : Boolean

true to restrict the selected value to one of the values in the list, false to allow the user to set arbitrary text into the field.

Defaults to:

false

hasFocus : Boolean
readonly ro

true if this component's focusEl is focused. See also containsFocus.

Defaults to:

false

hasListeners : Object
readonly ro

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

height : Number / String

The height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. By default, if this is not explicitly set, this Component's element will simply have its own natural size. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

hidden : Boolean

Whether or not this Component is hidden (its CSS display property is set to none).

Defaults to true for floated Components.

Defaults to:

null

hiddenName : String

Specify a hiddenName if you're using the standardSubmit option. This name will be used to post the underlying value of the select to the server.

Defaults to:

null

hideAnimation : String / Mixed

Animation effect to apply when the Component is being hidden. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'. For more animations, check the Ext.fx.Animation#type config.

Defaults to:

null

hideOnMaskTap : Boolean

When using a modal Component, setting this to true will hide the modal mask and the Container when the mask is tapped on.

Defaults to:

null

hideTrigger : Boolean

true to hide the expand trigger.

Defaults to:

false

html : String / Ext.dom.Element / HTMLElement

Optional HTML content to render inside this Component, or a reference to an existing element on the page.

Defaults to:

null

inputCls : String
immutable imm

CSS class to add to the input element of this field

Defaults to:

null

inputType : String

The type attribute for input fields -- e.g. text, password, date, url, email, etc.

Defaults to:

null

isField : Boolean
readonly ro

Set to true on all Ext.field.Field subclasses. This is used by Ext.form.Panel#getValues to determine which components inside a form are fields.

Defaults to:

true

isObservable : Boolean
readonly ro

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

Defaults to:

true

itemTpl : Function / String / String[]

An XTemplate definition string (Or an Ext.XTemplate) which specifies how to display a list item from a record values object. This is automatically generated to display the displayField if not specified.

Defaults to:

false

keyMap : Object

An object containing handlers for keyboard events. The property names of this object are the key name and any modifiers. The values of the properties are the descriptors of how to handle each event.

The handler descriptor can be simply the handler function (either the literal function or the method name), or it can be an object with these properties:

  • handler: The function or its name to call to handle the event.
  • scope: The this pointer context (can be "this" or "controller").
  • event: An optional override of the key event to which to listen.

Important: Calls to setKeyMap do not replace the entire keyMap but instead update the provided mappings. That is, unless null is passed as the value of the keyMap which will clear the keyMap of all entries.

Properties

scope : String

The default scope to apply to key handlers which do not specify a scope. This is processed the same way as the scope of cfg-listeners. It defaults to the "controller", but using 'this' means that an instance method will be used.

keyMapEnabled : Boolean

Enables or disables processing keys in the keyMap. This value starts as null and if it is null when initKeyMap is called, it will automatically be set to true. Since initKeyMap is called by Ext.Component at the proper time, this is not something application code normally handles.

Defaults to:

null

label : String

The label of this field

Defaults to:

null

labelAlign : 'top' / 'left' / 'bottom' / 'right' / 'placeholder'

When value is 'placeholder', the label text will be rendered as placeholder text inside the empty input and will animated to "top" alignment when the input is focused or contains text.

The position to render the label relative to the field input.

Defaults to:

'left'

labelCls : String

Optional CSS class to add to the Label element.

Defaults to:

null

labelElement : Ext.dom.Element
readonly ro

The label Element associated with this Field.

labelTextAlign : 'top' / 'right' / 'bottom' / 'left'

Text alignment of this field's label

Defaults to:

'left'

labelWidth : Number / String

The width to make this field's label.

Defaults to:

'30%'

labelWrap : Boolean

true to allow the label to wrap. If set to false, the label will be truncated with an ellipsis.

Defaults to:

false

left : Number / String

The absolute left position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

listeners : Object

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 Ext.Component

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'); }
        }
    }
});

margin : Number / String

The margin to use on this Component. Can be specified as a number (in which case all edges get the same margin) or a CSS string like '5 10 10 10'

Defaults to:

null

matchFieldWidth : Boolean

*Only valid when the picker: 'floated' is used. Whether the floatedPicker's width should be explicitly set to match the width of the input element.

Defaults to:

true

maxHeight : Number / String

The maximum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size. Note that this config will not apply if the Component is 'positioned' (absolutely positioned or centered)

Defaults to:

null

maxLength : Number

The maximum number of permitted input characters.

Defaults to:

null

maxWidth : Number / String

The maximum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size. Note that this config will not apply if the Component is 'positioned' (absolutely positioned or centered)

Defaults to:

null

minChars : Number

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.

Defaults to:

false

minHeight : Number / String

The minimum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

minWidth : Number / String

The minimum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

modal : Boolean

true to make this Component modal. This will create a mask underneath the Component that covers its parent and does not allow the user to interact with any other Components until this Component is dismissed.

Defaults to:

null

msgTarget : String
immutable imm

[msgTarget="qtip"]

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 (or taps) the field. This is the default. Ext.tip.Manager#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 or tap
  • none Don't display any error message. This might be useful if you are implementing custom error display. [element id] Add the error message to the innerHTML of the specified element

name : String

The field's HTML name attribute.

Note: this property must be set if this field is to be automatically included with. form submit().

Defaults to:

null

options : Array

An array of select options.

[
    {text: 'First Option',  value: 'first'},
    {text: 'Second Option', value: 'second'},
    {text: 'Third Option',  value: 'third'}
]

Note: Option object member names should correspond with defined valueField and displayField values. This config will be ignored if a store instance is provided.

Defaults to:

null

padding : Number / String

The padding to use on this Component. Can be specified as a number (in which case all edges get the same padding) or a CSS string like '5 10 10 10'

Defaults to:

null

pattern : String

The value for the HTML5 pattern attribute. You can use this to change which keyboard layout will be used.

Even though it extends TextField, it will display the number keyboard.

Defaults to:

null

picker : String / Object

A string representing the type of picker to use. Can be one of the following values.

  • 'edge' to use the edgePicker, generally used on small formfactor devices.
  • 'floated' to use the floatedPicker, generally used on tablets or desktops.
  • 'auto' to allow the framework to select the appropriate picker for the device.

Can also be a config object for the picker.

Defaults to:

'auto'

placeholder : String

A string value displayed in the input when the control is empty.

Defaults to:

null

plugins : Object / String / Object[] / String[]

An object or array of objects that will provide custom functionality for this component. If a string is provided or a string is one of the elements of the array, that string is treated as the type alias. For example, "listpaging" is the type alias for Ext.plugin.ListPaging. The full alias includes the "plugin." prefix (i.e., 'plugin.listpaging').

Plugins should derive from Ext.plugin.Abstract but this is not required. The only requirement for a valid plugin is that it contain an init() method that accepts a reference to the owning 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.

Example code

A plugin by alias:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: 'listpaging'
 });

Multiple plugins by alias:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: ['listpaging', 'pullrefresh']
 });

Single plugin by class name with config options:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: {
         type: 'listpaging',
         autoPaging: true
     }
 });

Multiple plugins by type and class name with config options:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: [{
         xclass: 'Ext.plugin.PullRefresh',
         pullRefreshText: 'Pull to refresh...'
     }, {
         type: 'listpaging',
         autoPaging: true
     }]
 });

queryCaching : Boolean

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

queryDelay : Number

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

Defaults to:

true

queryMode : String

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

    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'

queryParam : String

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'

readOnly : Boolean

True to set the field DOM element readonly attribute to true.

Defaults to:

null

record : Ext.data.Model

A model instance which updates the Component's html based on it's tpl. Similar to the data configuration, but tied to to a record to make allow dynamic updates. This must be a model instance and not a configuration of one.

Defaults to:

null

required : Boolean

true to make this field required.

Note: this only causes a visual indication.

Doesn't prevent user from submitting the form.

Defaults to:

false

right : Number / String

The absolute right position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

scrollable : Boolean / String / Object

Configuration options to make this Component scrollable. Acceptable values are:

  • true to enable auto scrolling.
  • false (or null) to disable scrolling - this is the default.
  • x or horizontal to enable horizontal scrolling only
  • y or vertical to enable vertical scrolling only

Also accepts a configuration object for a Ext.scroll.Scroller if if advanced configuration is needed.

The getter for this config returns the Ext.scroll.Scroller instance. You can use the Scroller API to read or manipulate the scroll position:

// scrolls the component to 5 on the x axis and 10 on the y axis
component.getScrollable().scrollTo(5, 10);

Defaults to:

null

selectOnTab : Boolean

Whether the Tab key should select the currently highlighted item.

Defaults to:

true

selection : Ext.data.Model

The selected model. null if no value exists.

Defaults to:

null

showAnimation : String / Mixed

Animation effect to apply when the Component is being shown. Typically you want to use an inbound animation type such as 'fadeIn' or 'slideIn'. For more animations, check the Ext.fx.Animation#type config.

Defaults to:

null

startValue : Mixed

The value that the Field had at the time it was last focused. This is the value that is passed to the Ext.field.Text#change event which is fired if the value has been changed when the Field is blurred.

This will be undefined until the Field has been visited. Compare originalValue.

Defaults to:

false

store : Ext.data.Store / Object / String

The store to provide selection options data. Either a Store instance, configuration object or store ID.

Defaults to:

null

style : String / Object

Additional CSS styles that will be rendered into an inline style attribute when the widget is rendered.

You can pass either a string syntax:

style: 'background:red'

Or by using an object:

style: {
    background: 'red'
}

When using the object syntax, you can define CSS Properties by using a string:

style: {
    'border-left': '1px solid red'
}

Although the object syntax is much easier to read, we suggest you to use the string syntax for better performance.

Defaults to:

null

tabIndex : Number

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

Defaults to:

null

textAlign : 'left' / 'center' / 'right'

The text alignment of this field.

Defaults to:

null

top : Number / String

The absolute top position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

touchAction : Object
immutable imm

Emulates the behavior of the CSS touch-action property in a cross-browser compatible manner.

Keys in this object are touch action names, and values are false to disable a touch action or true to enable it. Accepted keys are:

  • panX
  • panY
  • pinchZoom
  • doubleTapZoom

All touch actions are enabled (true) by default, so it is usually only necessary to specify which touch actions to disable. For example, the following disables only horizontal scrolling and pinch-to-zoom on the component's main element:

touchAction: {
    panX: false,
    pinchZoom: false
}

Touch actions can be specified on reference elements using the reference element name, for example:

// disables horizontal scrolling on the main element, and double-tap-zoom
// on the child element named "body"
touchAction: {
    panY: false
    body: {
        doubleTapZoom: false
    }
}

The primary motivation for setting the touch-action of an element is to prevent the browser's default handling of a gesture such as pinch-to-zoom, or drag-to-scroll, so that the application can implement its own handling of that gesture on the element. Suppose, for example, a component has a custom drag handler on its element and wishes to prevent horizontal scrolling of its container while it is being dragged:

Ext.create('Ext.Widget', {
    touchAction: {
        panX: false
    },
    listeners: {
        drag: function(e) {
            // implement drag logic
        }
    }
});

Defaults to:

null

tpl : Function / String / String[]

A string, array of strings, or a function that returns JSX.

tpl = data =>

{data.first_name} {data.last_name}

Note The data configuration must be set for any content to be shown in the component when using this configuration.

Defaults to:

null

tplWriteMode : String

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

Valid modes are:

  • append
  • insertAfter
  • insertBefore
  • insertFirst
  • overwrite

Defaults to:

'overwrite'

triggerAction : String

The action to execute when the trigger is clicked.

See also queryParam.

Defaults to:

'all'

triggers : Object

Ext.field.trigger.Trigger to use in this field. The keys in this object are unique identifiers for the triggers. The values in this object are Ext.field.trigger.Trigger configuration objects.

The weight value may be a negative value in order to position custom triggers ahead of default triggers like that of a DatePicker field.

typeAhead : Boolean

true to populate and auto-select the remainder of the text being typed after a configurable delay (typeAheadDelay) if it matches a known value.

Defaults to:

false

typeAheadDelay : Number

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

Defaults to:

250

ui : String / String[]
immutable imm

The ui or uis to be used on this Component

When a ui is configured, CSS class names are added to the element, created by appending the ui name(s) to each classCls and/or baseCls.

Defaults to:

null

userCls : String / String[]
immutable imm

One or more CSS classes to add to the component's primary element. This config is intended solely for use by the component instantiator (the "user"), not by derived classes.

For example:

 items: [{
     xtype: 'button',
     userCls: 'my-button'
 ...
 }]

Defaults to:

null

validateDisabled : Boolean

true to validate the field, even if it is disabled.

Defaults to:

false

validateOnInit : "none" / "auto" / "all"
readonly ro

Determines how initial values will handle validation

  • none: Will not validate any initial values
  • auto: Will only validate non-empty initial values
  • all: Will validate all initial values

Defaults to:

'auto'

validationMessage : String

For HTML5 validation, regex, etc., this is the error message returned if field is invalid.

Defaults to:

'Is in the wrong format'

value : Mixed

A value to initialize this field with.

Defaults to:

null

valueCollection : Object / Ext.util.Collection
readonly ro

A Ext.util.Collection instance, or configuration object used to create the collection of selected records.

This is used by the picker as the core of its selection handling, and also as the collection of selected values for this widget.

Defaults to:

true

valueField : String / Number

The underlying data value name to bind to this Select control. If configured as null, the displayField is used.

Defaults to:

value

valueNotFoundText : String

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.

Defaults to:

null

weight : Number
immutable imm

This value controls this item's order in a weighted Container (see parent).

Lower values gravitate towards the start of the container - the top in vertical layouts, the locale start side in horizontal layouts.

Defaults to:

null

width : Number / String

The width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. By default, if this is not explicitly set, this Component's element will simply have its own natural size. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

xtype : String
immutable imm

The xtype configuration option can be used to optimize Component creation and rendering. It serves as a shortcut to the full component name. For example, the component Ext.button.Button has an xtype of button.

You can define your own xtype on a custom Ext.Component by specifying the alias config option with a prefix of widget. For example:

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

Any Component can be created implicitly as an object config with an xtype specified, allowing it to be declared and passed into the rendering pipeline without actually being instantiated as an object. Not only is rendering deferred, but the actual creation of the object itself is also deferred, saving memory and resources until they are actually needed. In complex, nested layouts containing many Components, this can make a noticeable improvement in performance.

// Explicit creation of contained Components:
var panel = new Ext.Panel({
   // ...
   items: [
      Ext.create('Ext.button.Button', {
         text: 'OK'
      })
   ]
});

// Implicit creation using xtype:
var panel = new Ext.Panel({
   // ...
   items: [{
      xtype: 'button',
      text: 'OK'
   }]
});

In the first example, the button will always be created immediately during the panel's initialization. With many added Components, this approach could potentially slow the rendering of the page. In the second example, the button will not be created or rendered until the panel is actually displayed in the browser. If the panel is never displayed (for example, if it is a tab that remains hidden) then the button will never be created and will never consume any resources whatsoever.

Defaults to:

"component"

zIndex : Number

The z-index to give this Component when it is rendered.

Not valid for floated Components. The Z ordering of floated Components is managed by ordering of the DOM elements.

Defaults to:

null

children

tooltip : String / Object
immutable imm

The tooltip for this component - can be a string to be used as innerHTML (html tags are accepted) or ToolTip config object.

The default behavior is to use a shared tip instance. The tooltip configuration is registered with the Ext.tip.Manager. To enable this, your application can set the Ext.app.Application#quickTips config, or an instance of the Ext.tip.Manager may be created manually.

To force a unique tooltip instance to be created, specify autoCreate: true on this configuration.

Configuring this with autoHide: false implies autoCreate: true so that the desired persistent behavior can be obtained with other targets still showing the singleton instance.

Defaults to:

null

methods

Instance Methods

addListener ( eventName, [fn], [scope], [options], [order] ) : Object

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

myGridPanel.on("itemclick", this.onItemClick, 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,
    select: this.onSelect,
    viewready: this.onViewReady,
    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},
    viewready: {fn: panel.onViewReady, scope: panel}
});

Names of methods in a specified scope may also be used:

myGridPanel.on({
    cellclick: {fn: 'onCellClick', scope: this, single: true},
    viewready: {fn: 'onViewReady', scope: panel}
});

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/String (optional)

The method the event invokes or 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: 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.

onFrame :  Number

Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.

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 Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.

This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.

For example, to add a click listener to a Panel's body:

  var panel = new Ext.panel.Panel({
      title: 'The title',
      listeners: {
          click: this.handlePanelClick,
          element: 'body'
      }
  });

In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.

 panel.body.un(...)

delegate :  String (optional)

A simple selector to filter the event target or look for a descendant of the target.

The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

See the delegate example below.

capture :  Boolean (optional)

When set to true, the listener is fired in the capture phase of the event propagation sequence, instead of the default bubble phase.

The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

stopPropagation :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopPropagation on the event object before firing the handler.

preventDefault :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call preventDefault on the event object before firing the handler.

stopEvent :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopEvent on the event object before firing the handler.

args :  Array (optional)

Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.

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. This syntax can be a helpful shortcut to using un; particularly when removing multiple listeners. NOTE - not compatible when using the element option. See un for the proper syntax for removing listeners added using the element config.

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 handlers 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. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.

order :  String (optional)

A legacy option that is provided for backward compatibility. It is recommended to use the priority option instead. Available options are:

  • 'before': equal to a priority of 100
  • 'current': equal to a priority of 0 or default priority
  • 'after': equal to a priority of -100

Defaults to:

'current'

order :  String (optional)

A shortcut for the order event option. Provided for backward compatibility. Please use the priority event option instead.

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

Attaching multiple handlers in 1 call

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.

grid.on({
    itemclick: 'onItemClick',
    itemcontextmenu: grid.onItemContextmenu,
    destroy: {
        fn: function () {
            // function called within the 'altCmp' scope instead of grid
        },
        scope: altCmp // unique scope for the destroy handler
    },
    scope: grid       // default scope - provided for example clarity
});

Delegate

This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:

var panel = Ext.create({
    xtype: 'panel',
    renderTo: document.body,
    title: 'Delegate Handler Example',
    frame: true,
    height: 220,
    width: 220,
    html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
});

// The click handler will only be called when the click occurs on the
// delegate: h1.myTitle ("h1" tag with class "myTitle")
panel.on({
    click: function (e) {
        console.log(e.getTarget().innerHTML);
    },
    element: 'body',
    delegate: 'h1.myTitle'
 });

Defaults to: 'current'

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();

addManagedListener ( item, ename, [fn], [scope], [options] ) : Object

The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.

Example:

Ext.define('Foo', {
    extend: 'Ext.Component',

    initComponent: function () {
        this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
        this.callParent();
    }
});

As you can see, when an instance of Foo is destroyed, it ensures that the 'show' listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.

Parameters

item :  Ext.util.Observable/Ext.dom.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/String (optional)

If the ename parameter was an event name, this is the handler function or the name of a method on the specified scope.

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();

addPlugin ( plugin )

Adds a plugin. For example:

 list.addPlugin('pullrefresh');

Or:

 list.addPlugin({
     type: 'pullrefresh',
     pullRefreshText: 'Pull to refresh...'
 });

Available since: 6.2.0

Parameters

plugin :  Object/String/Ext.plugin.Abstract

The plugin or config object or alias to add.

clearListeners

Removes all listeners for this object including the managed listeners

clearManagedListeners

Removes all managed listeners for this object.

destroyPlugin ( plugin ) : Ext.plugin.Abstract

Removes and destroys a plugin.

Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.

Available since: 6.2.0

Parameters

plugin :  String/Ext.plugin.Abstract

The plugin or its id to remove.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

enableBubble ( eventNames )

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.

findPlugin ( type ) : Ext.plugin.Abstract

Retrieves plugin by its type alias. For example:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: ['listpaging', 'pullrefresh']
 });

 list.findPlugin('pullrefresh').setPullRefreshText('Pull to refresh...');

Note: See also getPlugin.

Available since: 6.2.0

Parameters

type :  String

The Plugin's type as specified by the class's alias configuration.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

findRecordByValue ( value ) : Ext.data.Model

Finds the record in the store, or the valueCollection which has the valueField matching the passed value.

The valueCollection is included because of the createNewOnEnter, createNewOnBlur, valueNotFoundText and forceSelection props which allow for insertion into the valueCollection of newly created records which are not in the configured store.

Also, a currently selected value may be filtered out of visibility in the configured store

Parameters

value :  String

The value to match the valueField against.

Returns

:Ext.data.Model

The matched record or null.

fireEvent ( eventName, args ) : Boolean

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.

fireEventArgs ( eventName, args ) : Boolean

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.

fireEventedAction ( eventName, args, fn, [scope], [fnArgs] )

Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow.

By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events.

Parameters

eventName :  String

The name of the event to fire.

args :  Array

Arguments to pass to handlers and to the action function.

fn :  Function/String

The action function.

scope :  Object (optional)

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

fnArgs :  Array/Boolean (optional)

Optional arguments for the action fn. If not given, the normal args will be used to call fn. If false is passed, the args are used but if the first argument is this instance it will be removed from the args passed to the action function.

focus ( [selectText] ) : Boolean

Try to focus this component.

If this component is disabled or otherwise not focusable, a close relation will be targeted for focus instead to keep focus localized for keyboard users.

Parameters

selectText :  Boolean/Number[] (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.

Returns

:Boolean

true if focus target was found and focusing was attempted, false if no focusing attempt was made.

getActiveError String

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.

getActiveErrors Array

Gets the array of active errors for this component, if any.

Returns

:Array

The active error message(s) on the component.

getBodyAlign : 'start' / 'center' / 'end' / 'stretch'

Sets the value of bodyAlign

getHtml : String / Ext.dom.Element / HTMLElement

Sets the value of html

getInherited ( [inner] ) : Object

This method returns an object containing the inherited properties for this instance.

Available since: 5.0.0

Parameters

inner :  Boolean (optional)

Pass true to return inheritedStateInner instead of the normal inheritedState object. This is only needed internally and should not be passed by user code.

Defaults to: false

Returns

:Object

The inheritedState object containing inherited properties.

getInheritedConfig ( property, [skipThis] ) : Mixed

This method returns the value of a config property that may be inherited from some ancestor.

In some cases, a config may be explicitly set on a component with the intent of only being presented to its children while that component should act upon the inherited value (see referenceHolder for example). In these cases the skipThis parameter should be specified as true.

Available since: 5.0.0

Parameters

property :  String

The name of the config property to return.

skipThis :  Boolean (optional)

Pass true if the property should be ignored if found on this instance. In other words, true means the property must be inherited and not explicitly set on this instance.

Defaults to: false

Returns

:Mixed

The value of the requested property.

getLabelAlign : 'top' / 'left' / 'bottom' / 'right' / 'placeholder'

Sets the value of labelAlign

getLabelTextAlign : 'top' / 'right' / 'bottom' / 'left'

Sets the value of labelTextAlign

getParent Ext.Component

Returns the parent of this component, if it has one.

Returns

:Ext.Component

The parent of this component.

getPlugin ( id ) : Ext.plugin.Abstract

Retrieves a plugin by its id.

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: {
         xclass: 'Ext.plugin.PullRefresh',
         id: 'foo'
     }
 });

 list.getPlugin('foo').setPullRefreshText('Pull to refresh...');

Note: See also findPlugin.

Available since: 6.2.0

Parameters

id :  String

The id of the plugin.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

getTabIndex Number

Return the actual tabIndex for this Focusable.

Returns

:Number

tabIndex attribute value

getTextAlign : 'left' / 'center' / 'right'

Sets the value of textAlign

getValue String/String[]

Gets the currently selected value, or array of values if multiSelect is true.

Returns

:String/String[]

Value(s) of the value field from configured Model.

hasActiveError Boolean

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

:Boolean

hasListener ( eventName ) : Boolean

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

hasParent Boolean

Returns true if this component has a parent.

Returns

:Boolean

true if this component has a parent.

is Boolean
template tpl

Selector processing function for use by nextSibling,previousibling, nextNode,and previousNode, to filter candidate nodes.

The base implementation returns true. Classes which mix in Traversable may implement their own implementations. @link{Ext.Widget} does this to implement Ext.ComponentQuery based filterability.

Returns

:Boolean

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

isAncestor ( possibleDescendant )

Determines whether this Component is an ancestor of the passed Component. This will return true if the passed Component is anywhere within the subtree beneath this Component.

Parameters

possibleDescendant :  Ext.Component

The Component to test for presence within this Component's subtree.

isDescendantOf ( ancestor ) : Boolean

Determines whether this component is the descendant of a passed component.

Parameters

ancestor :  Ext.Component

A Component which may contain this Component.

Returns

:Boolean

true if the component is the descendant of the passed component, otherwise false.

isDirty Boolean

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

Returns

:Boolean

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

isEqual ( value1, value2 ) : Boolean

Returns whether two field values are logically equal. Field implementations may override this to provide custom comparison logic appropriate for the particular field's data type.

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.

isFocusable ( [deep] ) : Boolean

Determine if this Focusable can receive focus at this time.

Note that Containers can be non-focusable themselves while delegating focus treatment to a child Component; see Container for more information.

Parameters

deep :  Boolean (optional)

Optionally determine if the container itself is focusable, or if container's focus is delegated to a child component and that child is focusable.

Defaults to: false

Returns

:Boolean

True if component is focusable, false if not.

isSuspended ( [event] ) : Boolean

Checks if all events, or a specific event, is suspended.

Parameters

event :  String (optional)

The name of the specific event to check

Returns

:Boolean

true if events are suspended

isValid

Returns true if field is valid.

markInvalid

Mark field as invalid.

mon ( item, ename, [fn], [scope], [options] ) : Object

Shorthand for addManagedListener. The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.

Example:

Ext.define('Foo', {
    extend: 'Ext.Component',

    initComponent: function () {
        this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
        this.callParent();
    }
});

As you can see, when an instance of Foo is destroyed, it ensures that the 'show' listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.

Parameters

item :  Ext.util.Observable/Ext.dom.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/String (optional)

If the ename parameter was an event name, this is the handler function or the name of a method on the specified scope.

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();

mun ( item, ename, [fn], [scope] )

Shorthand for removeManagedListener. Removes listeners that were added by the mon method.

Parameters

item :  Ext.util.Observable/Ext.dom.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.

nextNode ( [selector] ) : Ext.Component

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

selector :  String (optional)

A Ext.ComponentQuery selector to filter the following nodes.

Returns

:Ext.Component

The next node (or the next node which matches the selector). Returns null if there is no matching node.

nextSibling ( [selector] ) : Ext.Component

Returns the next sibling of this Component.

Optionally selects the next sibling which matches the passed Ext.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

selector :  String (optional)

A Ext.ComponentQuery selector to filter the following items.

Returns

:Ext.Component

The next sibling (or the next sibling which matches the selector). Returns null if there is no matching sibling.

on ( eventName, [fn], [scope], [options], [order] ) : Object

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

myGridPanel.on("itemclick", this.onItemClick, 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,
    select: this.onSelect,
    viewready: this.onViewReady,
    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},
    viewready: {fn: panel.onViewReady, scope: panel}
});

Names of methods in a specified scope may also be used:

myGridPanel.on({
    cellclick: {fn: 'onCellClick', scope: this, single: true},
    viewready: {fn: 'onViewReady', scope: panel}
});

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/String (optional)

The method the event invokes or 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: 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.

onFrame :  Number

Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.

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 Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.

This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.

For example, to add a click listener to a Panel's body:

  var panel = new Ext.panel.Panel({
      title: 'The title',
      listeners: {
          click: this.handlePanelClick,
          element: 'body'
      }
  });

In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.

 panel.body.un(...)

delegate :  String (optional)

A simple selector to filter the event target or look for a descendant of the target.

The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

See the delegate example below.

capture :  Boolean (optional)

When set to true, the listener is fired in the capture phase of the event propagation sequence, instead of the default bubble phase.

The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

stopPropagation :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopPropagation on the event object before firing the handler.

preventDefault :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call preventDefault on the event object before firing the handler.

stopEvent :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopEvent on the event object before firing the handler.

args :  Array (optional)

Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.

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. This syntax can be a helpful shortcut to using un; particularly when removing multiple listeners. NOTE - not compatible when using the element option. See un for the proper syntax for removing listeners added using the element config.

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 handlers 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. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.

order :  String (optional)

A legacy option that is provided for backward compatibility. It is recommended to use the priority option instead. Available options are:

  • 'before': equal to a priority of 100
  • 'current': equal to a priority of 0 or default priority
  • 'after': equal to a priority of -100

Defaults to:

'current'

order :  String (optional)

A shortcut for the order event option. Provided for backward compatibility. Please use the priority event option instead.

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

Attaching multiple handlers in 1 call

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.

grid.on({
    itemclick: 'onItemClick',
    itemcontextmenu: grid.onItemContextmenu,
    destroy: {
        fn: function () {
            // function called within the 'altCmp' scope instead of grid
        },
        scope: altCmp // unique scope for the destroy handler
    },
    scope: grid       // default scope - provided for example clarity
});

Delegate

This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:

var panel = Ext.create({
    xtype: 'panel',
    renderTo: document.body,
    title: 'Delegate Handler Example',
    frame: true,
    height: 220,
    width: 220,
    html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
});

// The click handler will only be called when the click occurs on the
// delegate: h1.myTitle ("h1" tag with class "myTitle")
panel.on({
    click: function (e) {
        console.log(e.getTarget().innerHTML);
    },
    element: 'body',
    delegate: 'h1.myTitle'
 });

Defaults to: 'current'

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();

onAfter ( eventName, fn, [scope], [options] )

Appends an after-event handler.

Same as addListener with order set to 'after'.

Parameters

eventName :  String/String[]/Object

The name of the event to listen for.

fn :  Function/String

The method the event invokes.

scope :  Object (optional)

The scope for fn.

options :  Object (optional)

An object containing handler configuration.

onBefore ( eventName, fn, [scope], [options] )

Appends a before-event handler. Returning false from the handler will stop the event.

Same as addListener with order set to 'before'.

Parameters

eventName :  String/String[]/Object

The name of the event to listen for.

fn :  Function/String

The method the event invokes.

scope :  Object (optional)

The scope for fn.

options :  Object (optional)

An object containing handler configuration.

previousNode ( [selector] ) : Ext.Component

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

selector :  String (optional)

A Ext.ComponentQuery selector to filter the preceding nodes.

Returns

:Ext.Component

The previous node (or the previous node which matches the selector). Returns null if there is no matching node.

previousSibling ( [selector] ) : Ext.Component

Returns the previous sibling of this Component.

Optionally selects the previous sibling which matches the passed Ext.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

selector :  String (optional)

A Ext.ComponentQuery selector to filter the preceding items.

Returns

:Ext.Component

The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling.

relayEvents ( origin, events, [prefix] ) : Object

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 (unless the event is handled by a controller's control/listen event listener in which case 'this' will be the controller rather than the grid).

Parameters

origin :  Object

The Observable whose events this object is to relay.

events :  String[]/Object

Array of event names to relay or an Object with key/value pairs translating to ActualEventName/NewEventName respectively. For example: this.relayEvents(this, {add:'push', remove:'pop'});

Would now redispatch the add event of this as a push event and the remove event as a pop event.

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();

removeListener ( eventName, fn, [scope] )

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

Convenience Syntax

You can use the addListener destroyable: true config option in place of calling un(). For example:

var listeners = cmp.on({
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide,
    destroyable: true
});

// Remove listeners
listeners.destroy();
// or
cmp.un(
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide
);

Exception - DOM event handlers using the element config option

You must go directly through the element to detach an event handler attached using the addListener element option.

panel.on({
    element: 'body',
    click: 'onBodyCLick'
});

panel.body.un({
    click: 'onBodyCLick'
});

removeManagedListener ( item, ename, [fn], [scope] )

Removes listeners that were added by the mon method.

Parameters

item :  Ext.util.Observable/Ext.dom.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.

removePlugin ( plugin, [destroy] ) : Ext.plugin.Abstract

Removes and (optionally) destroys a plugin.

Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.

Available since: 6.2.0

Parameters

plugin :  String/Ext.plugin.Abstract

The plugin or its id to remove.

destroy :  Boolean (optional)

Pass true to not call destroy() on the plugin.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

reset Ext.field.Field

Resets the current field value back to the original value on this field when it was created.

// Update the value
field.setValue('new value');

// Now you can reset it back to the `first value`
field.reset();

Returns

:Ext.field.Field

this

resetOriginalValue

Resets the field's originalValue property so it matches the current value. This is called by FormPanel. setValues if the form's trackResetOnLoad property is set to true.

resumeEvent ( eventName )

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.

resumeEvents ( [discardQueue] )

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

discardQueue :  Boolean (optional)

true to prevent any previously queued events from firing while we were suspended. See suspendEvents.

setActiveError

Store the activeError message string, fire the errorchange event accordingly, and update the UI. If the error to be set is empty string, any validation UI is removed, otherwise the proper validation UI is displayed, based upon msgTarget.

setActiveErrors ( errors )

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. You probably want to call markInvalid instead.

Parameters

errors :  String[]

The error messages

setAllQuery ( allQuery )

Returns the value of allQuery

setAllowBlank ( allowBlank )

Returns the value of allowBlank

setAnyMatch ( anyMatch )

Returns the value of anyMatch

setAriaAttributes ( ariaAttributes )

Returns the value of ariaAttributes

setAutoCapitalize ( autoCapitalize )

Returns the value of autoCapitalize

setAutoComplete ( autoComplete )

Returns the value of autoComplete

setAutoCorrect ( autoCorrect )

Returns the value of autoCorrect

setAutoFocus ( autoFocus )

Returns the value of autoFocus

setAutoFocusLast ( autoFocusLast )

Returns the value of autoFocusLast

setAutoLoadOnValue ( autoLoadOnValue )

Returns the value of autoLoadOnValue

setAutoSelect ( autoSelect )

Returns the value of autoSelect

setBodyAlign ( bodyAlign )

Returns the value of bodyAlign

setBorder ( border )

Returns the value of border

setBottom ( bottom )

Returns the value of bottom

setCaseSensitive ( caseSensitive )

Returns the value of caseSensitive

setCentered ( centered )

Returns the value of centered

setClearFilterOnBlur ( clearFilterOnBlur )

Returns the value of clearFilterOnBlur

setCls ( cls )

Returns the value of cls

setCollapseOnSelect ( collapseOnSelect )

Returns the value of collapseOnSelect

setComponent ( component )

Returns the value of component

setContentEl ( contentEl )

Returns the value of contentEl

setData ( data )

Returns the value of data

setDisabled ( disabled )

Returns the value of disabled

setDisplayField ( displayField )

Returns the value of displayField

setDisplayTpl ( displayTpl )

Returns the value of displayTpl

setDocked ( docked )

Returns the value of docked

setDraggable ( draggable )

Returns the value of draggable

setEdgePicker ( edgePicker )

Returns the value of edgePicker

setEditable ( editable )

Returns the value of editable

setEnableRegEx ( enableRegEx )

Returns the value of enableRegEx

setFloatedPicker ( floatedPicker )

Returns the value of floatedPicker

setFloatedPickerAlign ( floatedPickerAlign )

Returns the value of floatedPickerAlign

setForceSelection ( forceSelection )

Returns the value of forceSelection

setHeight ( height )

Returns the value of height

setHidden ( hidden )

Returns the value of hidden

setHiddenName ( hiddenName )

Returns the value of hiddenName

setHideAnimation ( hideAnimation )

Returns the value of hideAnimation

setHideOnMaskTap ( hideOnMaskTap )

Returns the value of hideOnMaskTap

setHideTrigger ( hideTrigger )

Returns the value of hideTrigger

setHtml ( html )

Returns the value of html

setInputType ( inputType )

Returns the value of inputType

setItemTpl ( itemTpl )

Returns the value of itemTpl

setKeyMap ( keyMap )

Returns the value of keyMap

setKeyMapEnabled ( keyMapEnabled )

Returns the value of keyMapEnabled

setLabel ( label )

Returns the value of label

setLabelAlign ( labelAlign )

Returns the value of labelAlign

setLabelCls ( labelCls )

Returns the value of labelCls

setLabelTextAlign ( labelTextAlign )

Returns the value of labelTextAlign

setLabelWidth ( labelWidth )

Returns the value of labelWidth

setLabelWrap ( labelWrap )

Returns the value of labelWrap

setLeft ( left )

Returns the value of left

setListeners ( listeners )

An alias for addListener. In versions prior to 5.1, listeners had a generated setter which could be called to add listeners. In 5.1 the listeners config is not processed using the config system and has no generated setter, so this method is provided for backward compatibility. The preferred way of adding listeners is to use the on method.

Parameters

listeners :  Object

The listeners

setMargin ( margin )

Returns the value of margin

setMatchFieldWidth ( matchFieldWidth )

Returns the value of matchFieldWidth

setMaxHeight ( maxHeight )

Returns the value of maxHeight

setMaxLength ( maxLength )

Returns the value of maxLength

setMaxWidth ( maxWidth )

Returns the value of maxWidth

setMinChars ( minChars )

Returns the value of minChars

setMinHeight ( minHeight )

Returns the value of minHeight

setMinWidth ( minWidth )

Returns the value of minWidth

setModal ( modal )

Returns the value of modal

setName ( name )

Returns the value of name

setOptions ( options )

Returns the value of options

setPadding ( padding )

Returns the value of padding

setPattern ( pattern )

Returns the value of pattern

setPicker ( picker )

Returns the value of picker

setPlaceholder ( placeholder )

Returns the value of placeholder

setPlugins ( plugins )

Returns the value of plugins

setQueryCaching ( queryCaching )

Returns the value of queryCaching

setQueryDelay ( queryDelay )

Returns the value of queryDelay

setQueryMode ( queryMode )

Returns the value of queryMode

setQueryParam ( queryParam )

Returns the value of queryParam

setReadOnly ( readOnly )

Returns the value of readOnly

setRecord ( record )

Returns the value of record

setRequired ( required )

Returns the value of required

setRight ( right )

Returns the value of right

setScrollable ( scrollable )

Returns the value of scrollable

setSelectOnTab ( selectOnTab )

Returns the value of selectOnTab

setSelection ( selection )

Returns the value of selection

setShowAnimation ( showAnimation )

Returns the value of showAnimation

setStartValue ( startValue )

Returns the value of startValue

setStore ( store )

Returns the value of store

setStyle ( style )

Returns the value of style

setTabIndex ( newTabIndex )

Set the tabIndex property for this Focusable. If the focusEl is available, set tabIndex attribute on it, too.

Parameters

newTabIndex :  Number

new tabIndex to set

setTextAlign ( textAlign )

Returns the value of textAlign

setTop ( top )

Returns the value of top

setTpl ( tpl )

Returns the value of tpl

setTplWriteMode ( tplWriteMode )

Returns the value of tplWriteMode

setTriggerAction ( triggerAction )

Returns the value of triggerAction

setTriggers ( triggers )

Returns the value of triggers

setTypeAhead ( typeAhead )

Returns the value of typeAhead

setTypeAheadDelay ( typeAheadDelay )

Returns the value of typeAheadDelay

setUseClearIcon ( useClearIcon )

Returns the value of useClearIcon

setValidateDisabled ( validateDisabled )

Returns the value of validateDisabled

setValidationMessage ( validationMessage )

Returns the value of validationMessage

setValue ( value )

Returns the value of value

setValueCollection ( valueCollection )

Returns the value of valueCollection

setValueField ( valueField )

Returns the value of valueField

setValueNotFoundText ( valueNotFoundText )

Returns the value of valueNotFoundText

setWidth ( width )

Returns the value of width

setZIndex ( zIndex )

Returns the value of zIndex

suspendEvent ( eventName )

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.

suspendEvents ( queueSuspended )

Suspends the firing of all events. (see resumeEvents)

Parameters

queueSuspended :  Boolean

true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events.

un ( eventName, fn, [scope] )

Shorthand for removeListener. 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 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.

Convenience Syntax

You can use the addListener destroyable: true config option in place of calling un(). For example:

var listeners = cmp.on({
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide,
    destroyable: true
});

// Remove listeners
listeners.destroy();
// or
cmp.un(
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide
);

Exception - DOM event handlers using the element config option

You must go directly through the element to detach an event handler attached using the addListener element option.

panel.on({
    element: 'body',
    click: 'onBodyCLick'
});

panel.body.un({
    click: 'onBodyCLick'
});

unAfter ( eventName, fn, [scope], [options] )

Removes a before-event handler.

Same as removeListener with order set to 'after'.

Parameters

eventName :  String/String[]/Object

The name of the event the handler was associated with.

fn :  Function/String

The handler to remove.

scope :  Object (optional)

The scope originally specified for fn.

options :  Object (optional)

Extra options object.

unBefore ( eventName, fn, [scope], [options] )

Removes a before-event handler.

Same as removeListener with order set to 'before'.

Parameters

eventName :  String/String[]/Object

The name of the event the handler was associated with.

fn :  Function/String

The handler to remove.

scope :  Object (optional)

The scope originally specified for fn.

options :  Object (optional)

Extra options object.

up ( [selector], [limit] ) : Ext.Container

Walks up the ownership hierarchy looking for an ancestor Component which matches the passed simple selector.

Example:

var owningTabPanel = grid.up('tabpanel');

Parameters

selector :  String (optional)

The simple selector to test.

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

:Ext.Container

The matching ancestor Container (or undefined if no match was found).

validate

Validate the field and return it's validity state. To get the existing validity state without re-validating current value, use isValid.

Static Methods

override ( members ) : Ext.Base
static sta

Override members of this class. Overridden methods can be invoked via Ext.Base#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"

Direct use of this method should be rare. 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).

Parameters

members :  Object

The properties to add to this class. This should be specified as an object literal containing one or more properties.

Returns

:Ext.Base

this class

events

onAction : function ( this, e, eOpts )
preventable prev

Fires whenever the return key or go is pressed. FormPanel listeners for this event, and submits itself whenever it fires. Also note that this event bubbles up to parent containers.

Parameters

this :  Ext.field.Text

This field

e :  Mixed

The key event object

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

This action following this event is preventable. When any of the listeners returns false, the action is cancelled.

onAdded : function ( this, container, index, eOpts )

Fires after a Component had been added to a Container.

Parameters

this :  Ext.Component

container :  Ext.Container

Parent Container

index :  Number

The index of the item within the Container.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeBottomChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when bottom changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of bottom.

oldValue :  Number/String

The previous value of bottom.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeCenteredChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when centered changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean

The current value of centered.

oldValue :  Boolean

The previous value of centered.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeDisabledChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when disabled changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of disabled.

oldValue :  Boolean

The previous value of disabled.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeDockedChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when docked changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  String

The current value of docked.

oldValue :  String

The previous value of docked.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeHeightChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when height changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of height.

oldValue :  Number/String

The previous value of height.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeHiddenChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when hidden changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of hidden.

oldValue :  Boolean

The previous value of hidden.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeHide : function ( this, eOpts )

Fires before the Component is hidden. Hide may be vetoed by returning false from a handler.

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeLeftChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when left changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of left.

oldValue :  Number/String

The previous value of left.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeMaxHeightChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when maxHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxHeight.

oldValue :  Number/String

The previous value of maxHeight.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeMaxWidthChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when maxWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxWidth.

oldValue :  Number/String

The previous value of maxWidth.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeMinHeightChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when minHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minHeight.

oldValue :  Number/String

The previous value of minHeight.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeMinWidthChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when minWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minWidth.

oldValue :  Number/String

The previous value of minWidth.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforePickerCreate : function ( this, newValue, eOpts )

Fires before the pop-up picker is created to give a developer a chance to configure it.

Parameters

this :  Ext.field.ComboBox

newValue :  Object

The config object for the picker.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeQuery : function ( queryPlan, eOpts )

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.

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

lastQuery :  Object (optional)

The queryPlan object used in the previous query.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeRightChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when right changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of right.

oldValue :  Number/String

The previous value of right.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeScrollableChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when scrollable changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean/String/Object

The current value of scrollable.

oldValue :  Boolean/String/Object

The previous value of scrollable.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeShow : function ( this, eOpts )

Fires before the Component is shown. Show may be vetoed by returning false from a handler.

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeTopChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when top changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of top.

oldValue :  Number/String

The previous value of top.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeWidthChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when width changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of width.

oldValue :  Number/String

The previous value of width.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBlur : function ( this, e, eOpts )

Fires when this field loses input focus

Parameters

this :  Ext.field.Text

This field

e :  Ext.event.Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBottomChange : function ( sender, value, oldValue, eOpts )

This event fires when bottom changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of bottom.

oldValue :  Number/String

The previous value of bottom.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onCenteredChange : function ( sender, value, oldValue, eOpts )

This event fires when centered changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean

The current value of centered.

oldValue :  Boolean

The previous value of centered.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onChange : function ( this, newValue, oldValue, eOpts )

Fires when an option selection has changed

Parameters

this :  Ext.field.Select

newValue :  Ext.data.Model

The corresponding record for the new value

oldValue :  Ext.data.Model

The corresponding record for the old value

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onClearIconTap : function ( this, input, e, eOpts )
preventable prev

Fires when the clear icon is tapped

Parameters

this :  Ext.field.Text

This field

input :  Ext.field.Input

The field's input component.

e :  Ext.event.Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

This action following this event is preventable. When any of the listeners returns false, the action is cancelled.

onClick : function ( e, eOpts )

Fires whenever the input is clicked.

Parameters

e :  Ext.event.Event

The event object.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onCollapse : function ( field, eOpts )

Fires when the field's picker is collapsed.

Parameters

field :  Ext.form.field.Picker

This field instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onDestroy

Fires when the component is destroyed

onDisabledChange : function ( sender, value, oldValue, eOpts )

This event fires when disabled changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of disabled.

oldValue :  Boolean

The previous value of disabled.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onDockedChange : function ( sender, value, oldValue, eOpts )

This event fires when docked changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  String

The current value of docked.

oldValue :  String

The previous value of docked.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onErased : function ( this, eOpts )

Fires when the component is no longer displayed in the DOM. Listening to this event will degrade performance not recommend for general use.

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onExpand : function ( field, eOpts )

Fires when the field's picker is expanded.

Parameters

field :  Ext.form.field.Picker

This field instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onFocus : function ( this, e, eOpts )

Fires when this field receives input focus. This happens both when you tap on the field and when you focus on the field by using 'next' or 'tab' on a keyboard.

Please note that this event is not very reliable on Android. For example, if your Select field is second in your form panel, you cannot use the Next button to get to this select field. This functionality works as expected on iOS.

Parameters

this :  Ext.field.Select

This field

e :  Ext.event.Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onFocusEnter : function ( this, event, eOpts )

Fires when focus enters this Component's hierarchy.

Parameters

this :  Ext.Component

event :  Ext.event.Event

The focusenter event.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onFocusLeave : function ( this, event, eOpts )

Fires when focus leaves this Component's hierarchy.

Parameters

this :  Ext.Component

event :  Ext.event.Event

The focusleave event.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onFullscreen : function ( this, eOpts )

Fires whenever a Component with the fullscreen config is instantiated

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onHeightChange : function ( sender, value, oldValue, eOpts )

This event fires when height changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of height.

oldValue :  Number/String

The previous value of height.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onHiddenChange : function ( sender, value, oldValue, eOpts )

This event fires when hidden changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of hidden.

oldValue :  Boolean

The previous value of hidden.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onHide : function ( this, eOpts )

Fires whenever the Component is hidden

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onInitialize : function ( this, eOpts )

Fires when the component has been initialized

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onKeyUp : function ( this, e, eOpts )
preventable prev

Fires when a key is released on the input element

Parameters

this :  Ext.field.Text

This field

e :  Ext.event.Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

This action following this event is preventable. When any of the listeners returns false, the action is cancelled.

onLeftChange : function ( sender, value, oldValue, eOpts )

This event fires when left changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of left.

oldValue :  Number/String

The previous value of left.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onMaxHeightChange : function ( sender, value, oldValue, eOpts )

This event fires when maxHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxHeight.

oldValue :  Number/String

The previous value of maxHeight.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onMaxWidthChange : function ( sender, value, oldValue, eOpts )

This event fires when maxWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxWidth.

oldValue :  Number/String

The previous value of maxWidth.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onMinHeightChange : function ( sender, value, oldValue, eOpts )

This event fires when minHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minHeight.

oldValue :  Number/String

The previous value of minHeight.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onMinWidthChange : function ( sender, value, oldValue, eOpts )

This event fires when minWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minWidth.

oldValue :  Number/String

The previous value of minWidth.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onMouseDown : function ( this, e, eOpts )

Fires when this field receives a mousedown

Parameters

this :  Ext.field.Text

This field

e :  Ext.event.Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onMoved : function ( this, container, toIndex, fromIndex, eOpts )

Fires when a component si moved within its Container.

Parameters

this :  Ext.Component

container :  Ext.Container

Container which holds the component

toIndex :  Number

The new index of the item.

fromIndex :  Number

The old index of the item.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onPainted : function ( element, eOpts )

Fires whenever this Element actually becomes visible (painted) on the screen. This is useful when you need to perform 'read' operations on the DOM element, i.e: calculating natural sizes and positioning.

Note: This event is not available to be used with event delegation. Instead painted only fires if you explicitly add at least one listener to it, for performance reasons.

Parameters

element :  Ext.dom.Element

The component's outer element (this.element)

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onPaste : function ( this, e, eOpts )

Fires when this field is pasted.

Parameters

this :  Ext.field.Text

This field

e :  Ext.event.Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onPickerCreate : function ( this, picker, eOpts )

Fires after the pop-up picker is created to give a developer a chance to configure it.

Parameters

this :  Ext.field.ComboBox

picker :  Ext.dataview.List/Ext.Component

The instantiated picker.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onPositionedChange : function ( this, positioned, eOpts )

Fires whenever there is a change in the positioned status of a component

Parameters

this :  Ext.Component

The component instance

positioned :  Boolean

The component's new positioned state. This becomes true is a component is positioned using the cfg-top, cfg-right, cfg-bottom or cfg-left configs.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onRemoved : function ( this, container, index, eOpts )

Fires when a component is removed from a Container

Parameters

this :  Ext.Component

container :  Ext.Container

Container which holds the component

index :  Number

The index of the item that was removed.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onResize : function ( component, width, height, oldWidth, oldHeight, eOpts )

Fires asynchronously after a browser layout caused by a component resize. This may be triggered for any or several of the following reasons:

Parameters

component :  Ext.Component

This Component.

width :  String/Number

The new width.

height :  String/Number

The new height.

oldWidth :  String/Number

The previous width.

oldHeight :  String/Number

The previous height.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onRightChange : function ( sender, value, oldValue, eOpts )

This event fires when right changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of right.

oldValue :  Number/String

The previous value of right.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onScrollableChange : function ( sender, value, oldValue, eOpts )

This event fires when scrollable changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean/String/Object

The current value of scrollable.

oldValue :  Boolean/String/Object

The previous value of scrollable.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onShow : function ( this, eOpts )

Fires whenever the Component is shown

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onTopChange : function ( sender, value, oldValue, eOpts )

This event fires when top changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of top.

oldValue :  Number/String

The previous value of top.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onWidthChange : function ( sender, value, oldValue, eOpts )

This event fires when width changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of width.

oldValue :  Number/String

The previous value of width.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

theme variables

$field-background-color : color

Field background-color

Defaults to:

null

$field-disabled-background-color : color

Field background-color when disabled

Defaults to:

null

$field-disabled-label-background-color : color

Field label background-color when disabled

Defaults to:

null

$field-disabled-label-color : color

Field label text color when disabled

Defaults to:

null

$field-disabled-opacity : Number

Opacity of form fields when disabled

Defaults to:

.3

$field-error-icon-side : String

Field error icon when {#errorTarget} is 'side'

Defaults to:

$fa-var-exclamation-circle FontAwesome

$field-error-icon-side-color : color

Field error icon color when {#errorTarget} is 'side'

Defaults to:

$alert-color

$field-error-icon-side-font-size : Number

Field error icon font-size when {#errorTarget} is 'side'

Defaults to:

null

$field-error-icon-side-font-size-big : Number

Field error icon font-size when {#errorTarget} is 'side' in the big sizing scheme

Defaults to:

null

$field-error-icon-side-margin : Number / list

Field error icon margin when {#errorTarget} is 'side'

Defaults to:

0 5px

$field-error-icon-side-margin-big : Number / list

Field error icon margin when {#errorTarget} is 'side' in the big sizing scheme

Defaults to:

0 8px

$field-error-icon-side-size : Number

Field error icon size when {#errorTarget} is 'side'

Defaults to:

16px

$field-error-icon-side-size-big : Number

Field error icon size when {#errorTarget} is 'side' in the big sizing scheme

Defaults to:

30px

$field-error-icon-under : String

Field error icon when {#errorTarget} is 'under'

Defaults to:

$fa-var-exclamation-circle FontAwesome

$field-error-icon-under-color : color

Field error icon color when {#errorTarget} is 'under'

Defaults to:

$alert-color

$field-error-icon-under-font-size : Number

Field error icon font-size when {#errorTarget} is 'under'

Defaults to:

null

$field-error-icon-under-font-size-big : Number

Field error icon font-size when {#errorTarget} is 'under' in the big sizing scheme

Defaults to:

null

$field-error-icon-under-margin : Number / list

Field error icon margin when {#errorTarget} is 'under'

Defaults to:

0 5px 0 0

$field-error-icon-under-margin-big : Number / list

Field error icon margin when {#errorTarget} is 'under' in the big sizing scheme

Defaults to:

0 8px 0 0

$field-error-icon-under-size : Number

Field error icon size when {#errorTarget} is 'under'

Defaults to:

16px

$field-error-icon-under-size-big : Number

Field error icon size when {#errorTarget} is 'under' in the big sizing scheme

Defaults to:

30px

$field-error-message-color : color

Field error message color

Defaults to:

$alert-color

$field-error-message-font-family : String

Field error message font-family

Defaults to:

$font-family

$field-error-message-font-size : Number

Field error message font-size

Defaults to:

1rem

$field-error-message-font-size-big : Number

Field error message font-size in the big sizing scheme

Defaults to:

null

$field-error-message-font-weight : String / Number

Field error message font-weight

Defaults to:

$font-weight

$field-error-message-line-height : Number

Field error message line-height

Defaults to:

16px

$field-error-message-line-height-big : Number

Field error message line-height in the big sizing scheme

Defaults to:

24px

$field-error-under-margin : Number / list

Field error element margin when {#errorTarget} is 'under'

Defaults to:

2px 0

$field-error-under-margin-big : Number / list

Field error element margin when {#errorTarget} is 'under' in the big sizing scheme

Defaults to:

3px

$field-focused-background-color : color

Field background-color when focused

Defaults to:

null

$field-focused-label-background-color : color

Field label background-color when focused

Defaults to:

null

$field-focused-label-color : color

Field label text color when focused

Defaults to:

null

$field-invalid-background-color : color

Field background-color when invalid

Defaults to:

null

$field-invalid-label-background-color : color

Field label background-color when invalid

Defaults to:

null

$field-invalid-label-color : color

Field label text color when invalid

Defaults to:

null

$field-label-background-color : color

Field label background-color

Defaults to:

null

$field-label-color : color

Field label text color

Defaults to:

$color

$field-label-font-family : String

Field label font-family

Defaults to:

$font-family

$field-label-font-size : Number

Field label font-size

Defaults to:

$font-size

$field-label-font-size-big : Number

Field label font-size in the big sizing scheme

Defaults to:

$font-size-big

$field-label-font-weight : String / Number

Field label font-weight

Defaults to:

$font-weight-normal

$field-label-line-height : Number

Field label line-height

Defaults to:

17px

$field-label-line-height-big : Number

Field label line-height in the big sizing scheme

Defaults to:

20px

$field-label-min-width : Number

Field label min-width

Defaults to:

null

$field-label-min-width-big : Number

Field label min-width in the big sizing scheme

Defaults to:

null

$field-label-padding : Number / list

Field label padding

Defaults to:

4px 6px 3px 0

$field-label-padding-big : Number / list

Field label padding in the big sizing scheme

Defaults to:

6px 6px 6px 0

$field-label-width : Number

Field label width

Defaults to:

100px

$field-label-width-big : Number

Field label width in the big sizing scheme

Defaults to:

120px

$field-required-indicator-font-family : String

Field required indicator font-family

Defaults to:

null

$field-required-indicator-font-size : Number

Field required indicator font-size

Defaults to:

null

$field-required-indicator-font-weight : String / Number

Field required indicator font-weight

Defaults to:

null

$field-required-indicator-line-height : Number

Field required indicator line-height

Defaults to:

null

$field-required-indicator-margin : Number

Field required indicator margin

Defaults to:

-3px null null 4px

$field-required-indicator-margin-big : Number

Field required indicator margin in the big sizing scheme

Defaults to:

null

$field-vertical-spacing : Number

Vertical space in between form fields

Defaults to:

8px

$field-vertical-spacing-big : Number

Vertical space in between form fields in the big sizing scheme

Defaults to:

8px

$textfield-alt-ui : map

Parameters for the "alt" textfield UI. Set to null to eliminate the UI from the CSS output.

$textfield-body-width : Number

Text Field body width

Defaults to:

170px

$textfield-body-width-big : Number

Text Field body width in the big sizing scheme

Defaults to:

200px

$textfield-celleditor-ui : map

Parameters for the "celleditor" textfield UI. Set to null to eliminate the UI from the CSS output.

$textfield-disabled-input-background-color : color

Text Field input background-color when disabled

Defaults to:

null

$textfield-disabled-input-border-color : String / list

Text Field input border color when disabled

Defaults to:

null

$textfield-disabled-input-color : color

Text Field input color when disabled

Defaults to:

null

$textfield-faded-ui : map

Parameters for the "faded" textfield UI. Set to null to eliminate the UI from the CSS output.

$textfield-focused-input-background-color : color

Text Field input background-color when focused

Defaults to:

null

$textfield-focused-input-border-color : String / list

Text Field input border color when focused

Defaults to:

mix(#fff, #157fcc, 15%)

$textfield-focused-input-border-style : String / list

Text Field input border style when focused

Defaults to:

null

$textfield-focused-input-color : color

Text Field input color when focused

Defaults to:

null

$textfield-focused-input-underline-color : color

Text field input underline color when focused

Defaults to:

null

$textfield-focused-input-underline-width : Number

Text field input underline width when focused

Defaults to:

null

$textfield-input-background-color : color

Text Field input background-color

Defaults to:

$background-color

$textfield-input-border-color : color / list

Text Field input border color

Defaults to:

$neutral-color

$textfield-input-border-style : String / list

Text Field input border style

Defaults to:

solid

$textfield-input-border-width : Number / list

Text Field input border width

Defaults to:

1px

$textfield-input-color : color

Text Field input color

Defaults to:

$color

$textfield-input-font-family : String

Text Field input font-family

Defaults to:

$font-family

$textfield-input-font-size : Number

Text Field input font-size

Defaults to:

$font-size

$textfield-input-font-size-big : Number

Text Field input font-size in the big sizing scheme

Defaults to:

$font-size-big

$textfield-input-font-weight : String / Number

Text Field input font-weight

Defaults to:

$font-weight-normal

$textfield-input-line-height : Number

Text Field input line-height

Defaults to:

17px

$textfield-input-line-height-big : Number

Text Field input line-height in the big sizing scheme

Defaults to:

20px

$textfield-input-padding : Number / list

Text Field input padding

Defaults to:

3px 6px 2px

$textfield-input-padding-big : Number / list

Text Field input padding in the big sizing scheme

Defaults to:

5px 6px

$textfield-input-underline-color : color

Text field input underline color

Defaults to:

null

$textfield-input-underline-width : Number

Text field input underline width

Defaults to:

null

$textfield-invalid-input-background-color : color

Text Field input background-color when invalid

Defaults to:

null

$textfield-invalid-input-border-color : String / list

Text Field input border color when invalid

Defaults to:

$alert-color

$textfield-invalid-input-border-style : String / list

Text Field input border style when invalid

Defaults to:

null

$textfield-invalid-input-color : color

Text Field input color when invalid

Defaults to:

null

$textfield-invalid-input-underline-color : color

Text field input underline color when invalid

Defaults to:

null

$textfield-invalid-input-underline-width : Number

Text field input underline width when invalid

Defaults to:

null

$textfield-placeholder-color : color

Text Field placeholder color

Defaults to:

$neutral-medium-dark-color

$textfield-solo-ui : map

Parameters for the "solo" textfield UI. Set to null to eliminate the UI from the CSS output.

theme mixins

field-ui ( ...list... )

Creates a visual theme for a Field

Parameters

$ui :  String

The name of the UI being created. Can not included spaces or special punctuation (used in CSS class names).

$xtype :  String (optional)

The Ext.Class#xtype to use in CSS selectors. For use by UI mixins of derived classes.

Defaults to: field

$background-color :  color

Field background-color

$focused-background-color :  color

Field background-color when focused

$invalid-background-color :  color

Field background-color when invalid

$disabled-background-color :  color

Field background-color when disabled

$label-color :  color

Field label text color

$focused-label-color :  color

Field label text color when focused

$invalid-label-color :  color

Field label text color when invalid

$disabled-label-color :  color

Field label text color when disabled

$label-background-color :  color

Field label background-color

$focused-label-background-color :  color

Field label background-color when focused

$invalid-label-background-color :  color

Field label background-color when invalid

$disabled-label-background-color :  color

Field label background-color when disabled

$label-padding :  Number/list

Field label padding

$label-padding-big :  Number/list

Field label padding in the big sizing scheme

$label-font-weight :  String/Number

Field label font-weight

$label-font-size :  Number

Field label font-size

$label-font-size-big :  Number

Field label font-size in the big sizing scheme

$label-line-height :  Number

Field label line-height

$label-line-height-big :  Number

Field label line-height in the big sizing scheme

$label-font-family :  String

Field label font-family

$label-width :  Number

Field label width

$label-width-big :  Number

Field label width in the big sizing scheme

$label-min-width :  Number

Field label min-width

$label-min-width-big :  Number

Field label min-width in the big sizing scheme

$disabled-opacity :  Number

Opacity of form fields when disabled

$required-indicator-font-weight :  String/Number

Field required indicator font-weight

$required-indicator-font-size :  Number

Field required indicator font-size

$required-indicator-line-height :  Number

Field required indicator line-height

$required-indicator-font-family :  String

Field required indicator font-family

$required-indicator-margin :  Number

Field required indicator margin

$required-indicator-margin-big :  Number

Field required indicator margin in the big sizing scheme

$error-icon-side :  String

Field error icon when {#errorTarget} is 'side'

$error-icon-side-color :  color

Field error icon color when {#errorTarget} is 'side'

$error-icon-side-size :  Number

Field error icon size when {#errorTarget} is 'side'

$error-icon-side-size-big :  Number

Field error icon size when {#errorTarget} is 'side' in the big sizing scheme

$error-icon-side-font-size :  Number

Field error icon font-size when {#errorTarget} is 'side'

$error-icon-side-font-size-big :  Number

Field error icon font-size when {#errorTarget} is 'side' in the big sizing scheme

$error-icon-side-margin :  Number/list

Field error icon margin when {#errorTarget} is 'side'

$error-icon-side-margin-big :  Number/list

Field error icon margin when {#errorTarget} is 'side' in the big sizing scheme

$error-icon-under :  String

Field error icon when {#errorTarget} is 'under'

$error-icon-under-color :  color

Field error icon color when {#errorTarget} is 'under'

$error-icon-under-size :  Number

Field error icon size when {#errorTarget} is 'under'

$error-icon-under-size-big :  Number

Field error icon size when {#errorTarget} is 'under' in the big sizing scheme

$error-icon-under-font-size :  Number

Field error icon font-size when {#errorTarget} is 'under'

$error-icon-under-font-size-big :  Number

Field error icon font-size when {#errorTarget} is 'under' in the big sizing scheme

$error-icon-under-margin :  Number/list

Field error icon margin when {#errorTarget} is 'under'

$error-icon-under-margin-big :  Number/list

Field error icon margin when {#errorTarget} is 'under' in the big sizing scheme

$error-under-margin :  Number/list

Field error element margin when {#errorTarget} is 'under'

$error-under-margin-big :  Number/list

Field error element margin when {#errorTarget} is 'under' in the big sizing scheme

$error-message-color :  color

Field error message color

$error-message-font-weight :  String/Number

Field error message font-weight

$error-message-font-size :  Number

Field error message font-size

$error-message-font-size-big :  Number

Field error message font-size in the big sizing scheme

$error-message-line-height :  Number

Field error message line-height

$error-message-line-height-big :  Number

Field error message line-height in the big sizing scheme

$error-message-font-family :  String

Field error message font-family

textfield-ui ( ...list... )

Creates a visual theme for a Text Field

Parameters

$ui :  String

The name of the UI being created. Can not included spaces or special punctuation (used in CSS class names).

$xtype :  String (optional)

The Ext.Class#xtype to use in CSS selectors. For use by UI mixins of derived classes.

Defaults to: textfield

$background-color :  color

Text Field input background color

$focused-background-color :  color

Focused Text Field background color

$invalid-background-color :  color

Invalid Text Field background color

$disabled-background-color :  color

Disabled Text Field background color

$label-color :  color

Text Field label color

$focused-label-color :  color

Focused Text Field label color

$invalid-label-color :  color

Invalid Text Field label color

$disabled-label-color :  color

Disabled Text Field label color

$label-background-color :  color

Text Field Label background color

$focused-label-background-color :  color

Focused Text Field Label background color

$invalid-label-background-color :  color

Invalid Text Field Label background color

$disabled-label-background-color :  color

Disabled Text Field Label background color

$label-padding :  Number

Text Field label padding

$label-padding-big :  Number

Text Field label padding in the big sizing scheme

$label-font-weight :  Number

Text Field label font weight

$label-font-size :  Number

Text Field label font size

$label-font-size-big :  Number

Text Field label font size in the big sizing scheme

$label-line-height :  Number

Text Field label line height

$label-line-height-big :  Number

Text Field label line height in the big sizing scheme

$label-font-family :  String

Text Field label font family

$disabled-opacity :  Number

Text Field disabled opacity

$required-indicator-font-weight :  Number

Required indicator font weight

$required-indicator-font-size :  Number

Required indicator font size

$required-indicator-line-height :  Number

Required indicator line height

$required-indicator-font-family :  String

Required indicator font family

$required-indicator-margin :  String

Required indicator margin

$required-indicator-margin-big :  String

Required indicator margin in the big sizing scheme

$input-color :  color

Text field input color

$focused-input-color :  color

Text Field input color when focused

$invalid-input-color :  color

Text Field input color when invalid

$disabled-input-color :  color

Text Field input color when disabled

$input-border-width :  Number/list

Text Field input border width

$input-border-style :  String/list

Text Field input border style

$focused-input-border-style :  String/list

Text Field input border style when focused

$invalid-input-border-style :  String/list

Text Field input border style when invalid

$input-border-color :  color/list

Text Field input border color

$focused-input-border-color :  String/list

Text Field input border color when focused

$invalid-input-border-color :  String/list

Text Field input border color when invalid

$disabled-input-border-color :  String/list

Text Field input border color when disabled

$input-underline-width :  Number

Text field input underline width

$focused-input-underline-width :  Number

Text field input underline width when focused

$invalid-input-underline-width :  Number

Text field input underline width when invalid

$input-underline-color :  color

Text field input underline color

$focused-input-underline-color :  color

Text field input underline color when focused

$invalid-input-underline-color :  color

Text field input underline color when invalid

$input-background-color :  color

Text Field input background-color

$focused-input-background-color :  color

Text Field input background-color when focused

$invalid-input-background-color :  color

Text Field input background-color when invalid

$disabled-input-background-color :  color

Text Field input background-color when disabled

$input-padding :  color

Text Field input padding

$input-padding-big :  color

Text Field input padding in the big sizing scheme

$input-font-weight :  String/Number

Text Field input font-weight

$input-font-size :  Number

Text Field input font-size

$input-font-size-big :  Number

Text Field input font-size in the big sizing scheme

$input-line-height :  Number

Text Field input line-height

$input-line-height-big :  Number

Text Field input line-height in the big sizing scheme

$input-font-family :  String

Text Field input font-family

$placeholder-color :  color

Text Field placeholder color

$border-radius :  Number

The border radius of the text field

$body-width :  Number

Text Field body width

$body-width-big :  Number

Text Field body width in the big sizing scheme

$animate-underline-duration :  Number

The duration, in seconds, for the focus underline animation

ExtReact 6.5.0