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


top

HiddenField Ext.field.Hidden

Summary

Hidden fields allow you to easily inject additional data into a FormPanel without displaying additional fields on the screen. This is often useful for sending dynamic or previously collected data back to the server in the same request as the normal form submission. For example, here is how we might set up a form to send back a hidden userId field:

In the form above we created two fields - a hidden field and a CheckBox. Only the check box will be visible, but both fields will be submitted. Hidden fields cannot be tabbed to - they are removed from the tab index so when your user taps the next/previous field buttons the hidden field is skipped over.

It's easy to read and update the value of a hidden field within a form. Using the example above, we can get a reference to the hidden field and then set it to a new value in 2 lines of code:

var userId = form.down('hiddenfield')[0];
userId.setValue(1234);
No members found using the current filters

properties

Optional Properties

$eventOptions
readonly ro private pri

Matches options property names within a listeners specification object - property names which are never used as event names.

Defaults to:

{
    scope: 1,
    delay: 1,
    buffer: 1,
    onFrame: 1,
    single: 1,
    args: 1,
    destroyable: 1,
    priority: 1,
    order: 1
}

$vetoClearingPrototypeOnDestroy
readonly ro private pri

We don't want the base destructor to clear the prototype because our destroyObservable handler must be called the very last. It will take care of the prototype after completing Observable destruction sequence.

Defaults to:

true

activeAnimation
readonly ro private pri

Defaults to:

null

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

allowBlank : Boolean

Specify false to not accept blank values

Defaults to:

null

animateUnderline : Boolean

'true' to animate the underline of a field when focused

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.

Defaults to:

null

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.

ariaEl : String
readonly ro private pri

The name of the Component property that holds a reference to the Element that serves as that Component's ARIA element. This property will be replaced with the actual Element reference after rendering.

Most of the simple Components will have their main element as ariaEl.

Defaults to:

'el'

Available since: 6.0.0

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.

ariaRenderAttributes : Object
readonly ro private pri

Instance specific ARIA attributes to render into Component's ariaEl. This object is only used during rendering, and is discarded afterwards.

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 autocapitalize attribute to "on", false to set to "off". Defaults to undefined, leaving the attribute unset

Defaults to:

null

autoComplete : Boolean

true to set the field's DOM element autocomplete attribute to "on", false to set to "off". Defaults to undefined, leaving the attribute unset.

Defaults to:

null

autoCorrect : Boolean

true to set the field DOM element autocorrect attribute to "on", false to set to "off". Defaults to undefined, leaving the attribute unset.

Defaults to:

null

autoFitErrors : Boolean

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

Defaults to:

true

autoGenId : Boolean
readonly ro private pri

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

Defaults to:

false

Available since: 6.7.0

autoHideInputMask : Boolean

Specify as false to always show the inputMask.

Defaults to:

true

Available since: 6.5.0

axisLock : Boolean

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

badFormatMessage : String
immutable imm

The error message that will be displayed if the value cannot be parsed (for some derived types) or if the value does not match a configured inputMask.

Defaults to:

'Value does not match the required format'

Available since: 6.5.0

bind : Object / String

Setting this config option adds or removes data bindings for other configs. For example, to bind the title config:

 var panel = Ext.create({
     xtype: 'panel',
     bind: {
         title: 'Hello {user.name}'
     }
 });

To dynamically add bindings:

 panel.setBind({
     title: 'Greetings {user.name}!'
 });

To remove bindings:

 panel.setBind({
     title: null
 });

The bind expressions are presented to Ext.app.ViewModel#bind. The ViewModel instance is determined by lookupViewModel.

Note: If bind is passed as a string, it will use the Ext.Component#property-defaultBindProperty for the binding.

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 the contents of this field's body element.

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

bubbleDirty : Boolean

Set to false to disable dirty states affecting ancestor containers such as fieldpanel or formpanel. The dirty state of such containers is based on the presence of dirty descendants. In some cases, however, it may be desired to hide the dirty state of one of these containers from its ancestor containers.

Defaults to:

true

Available since: 7.0

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:

false

checked : Boolean

true if the checkbox should render initially checked.

Defaults to:

false

classCls
readonly ro

Defaults to:

Ext.baseCSSPrefix + 'component'

clearIcon : Boolean

true to use a clear icon in this field.

Defaults to:

true

clearable : Boolean

true to show a clear trigger in this field when it has a non-empty value

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

component : Object

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

Defaults to:

{
    xtype: 'component'
}

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

controller : String / Object / Ext.app.ViewController

A string alias, a configuration object or an instance of a ViewController for this container. Sample usage:

Ext.define('MyApp.UserController', {
    alias: 'controller.user'
});

Ext.define('UserContainer', {
    extend: 'Ext.container.container',
    controller: 'user'
});
// Or
Ext.define('UserContainer', {
    extend: 'Ext.container.container',
    controller: {
        type: 'user',
        someConfig: true
    }
});

// Can also instance at runtime
var ctrl = new MyApp.UserController();
var view = new UserContainer({
    controller: ctrl
});

Defaults to:

null

data : Object

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

Note: Data will be appended to any existing data.

Defaults to:

null

dataType : Ext.data.field.Field / Object / String

A config for a Ext.data.field.Field or data field sub-class instance used to serialize this field's value for form submission. This is used by the serialize method unless modelValidation is used, in which case, the data field of the bound Ext.data.Model is used.

For example:

 {
     xtype: 'datefield',
     dataType: {
         // type: 'date'  (datefield does this by default)
         dateWriteFormat: 'Y-m-d'
     }
 }

If this config is a string, it is used to create a Ext.data.field.Field by that alias.

Defaults to:

null

Available since: 7.0

defaultBindProperty : String
readonly ro

This property is used to determine the property of a bind config that is just the value. For example, if defaultBindProperty="value", then this shorthand bind config:

 bind: '{name}'

Is equivalent to this object form:

 bind: {
     value: '{name}'
 }

The defaultBindProperty is set to "value" for form fields and to "store" for grids and trees.

Defaults to:

'html'

defaultListenerScope : Boolean

If true, this component will be the default scope (this pointer) for events specified with string names so that the scope can be dynamically resolved. The component will automatically become the defaultListenerScope if a controller is specified.

See the introductory docs for Ext.container.Container for some sample usages.

NOTE: This value can only be reliably set at construction time. Setting it after that time may not correctly rewire all of the potentially effected listeners.

Defaults to:

false

dirty : Boolean

This config property describes the modified state of this component. In most cases this config's value is maintained by the component and should be considered readonly. The class implementor should be the only one to call the setter.

For containers, this config will be updated on a short delay in some cases.

Defaults to:

false

Available since: 7.0

disabled : Boolean

true to disable the field.

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

Defaults to:

false

displayed : Boolean

Set to true to call show and false to call hide. Unlike the hidden config, changing this config will potentially involve animations to show or hide the component.

Defaults to:

null

Available since: 6.5.0

doKeyDown
readonly ro protected pro

Called when a key has been pressed in the <input>

Defaults to:

Ext.emptyFn

dockPositions
readonly ro private pri

Defaults to:

{
    top: true,
    right: true,
    bottom: true,
    left: true
}

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 : Boolean / Object / Ext.drag.Source

Set to true to allow this component to be dragged. This can also be the config object for the Ext.drag.Source that will manage the drag.

Defaults to:

null

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

enterAnimation : String / Mixed
deprecated dep

Animation effect to apply when the Component is being shown. Typically you want to use an inbound animation type such as 'fadeIn' or 'slideIn'.

Defaults to:

null

Deprecated since version 2.0.0
Please use showAnimation instead.

error : String / String[]

The error (or errors) to display for this field. This config is typically set by the field's validators but can be set directly if an error needs to be associated with a field manually.

Errors will be HTML encoded as necessary and errorTpl before becoming the current errorMessage.

Defaults to:

null

Available since: 6.5.0

errorMessage : String

The field's error message to display as errorTarget. This message must already be properly formatted and encoded as appropriate for the errorTarget.

Defaults to:

null

Available since: 6.5.0

errorTarget : String

The location where the error message text should display.

The following are values that have predefined meaning:

  • qtip Display a Ext.tip.Manager containing the message when the user hovers (or taps) the field. For this option to work, quick tips must be enabled by calling Ext.tip.Manager#init.
  • side Add an error icon to the right of the field, displaying the message in a popup on hover or tap.
  • title Display the message in a default browser title attribute.
  • under Add a div beneath the field containing the error message.

Defaults to:

'qtip'

Available since: 6.5.0

errorTip : Object

The default config that will be used to display errors in the tooltip.

Defaults to:

null

Available since: 6.5.0

errorTpl : String / String[] / Ext.XTemplate

The template used to format the error set for this field. By default, the errorTarget is used to determine whether the error(s) are formatted as an HTML list or as plain text.

Defaults to:

null

Available since: 6.5.0

eventsSuspended
readonly ro private pri

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

Defaults to:

0

exitAnimation : String / Mixed
deprecated dep

Animation effect to apply when the Component is being hidden.

Defaults to:

null

Deprecated since version 2.0.0
Please use hideAnimation instead. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'.

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.

fastFocus : Boolean

Enable Fast Input Focusing on iOS, using this workaround will stop some touchstart events in order to prevent delayed focus issues.

Defaults to:

false

floatingCls
readonly ro

Defaults to:

Ext.baseCSSPrefix + 'floating'

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

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

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

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

htmlErrorsTpl : Ext.XTemplate
readonly ro private pri

The default template used to format errors in HTML. This property is promoted to an Ext.XTemplate instance on first use.

Defaults to:

[
    '<tpl if="count == 1">',
    '<tpl for="errors">{.:htmlEncode}</tpl>',
    '<tpl elseif="count">',
    '<ul class="{listCls}">',
    '<tpl for="errors"><li>{.:htmlEncode}</li></tpl>',
    '</ul>',
    '</tpl>'
]

Available since: 6.5.0

initFocusable
readonly ro protected pro

Template method to do any Focusable related initialization that does not involve event listeners creation.

Defaults to:

Ext.emptyFn

inline : Boolean

true to cause this field to layout with inline element behavior. An inline field's width is determined by the total width of its label and body elements instead of automatically expanding to fill the width of its container.

Defaults to:

false

inputCls : String
deprecated dep immutable imm

Deprecated since version 6.5.0
There is no longer an input component to which to add a class.

inputMask : String / Ext.field.InputMask

Important: To use this config you must require Ext.field.InputMask or use a complete framework build. The logic to implement an inputMask is not automatically included in a build.

Defaults to:

null

Available since: 6.5.0

inputValue
private pri

Defaults to:

null

isComponent
readonly ro private pri

Defaults to:

true

isField : Boolean
readonly ro

true in this class to identify an object this type, or subclass thereof.

This is used by Ext.form.Panel#getValues to determine which components inside a form are fields.

Defaults to:

true

isFocused : Boolean

true if the field currently has focus.

isFormField
readonly ro private pri

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

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.

Defaults to:

null

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

keyMapTarget : String
immutable imm protected pro

The name of the member that should be used to listen for keydown/keypress events. This is intended to be controlled at the class level not per instance.

Defaults to:

'el'

label : String

The label of this field

Defaults to:

null

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

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

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.

labelInPlaceholder
private pri

Defaults to:

true

labelMinWidth : Number / String

Min-width of this field's label.

Defaults to:

null

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

Text alignment of this field's label

Defaults to:

'left'

labelWidth : Number / String

Width of this field's label. Can be a number of pixels or any valid CSS value, such as '30%'. To size the label to its text, use labelWidth: 'auto'

Defaults to:

null

labelWrap : Boolean

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

Defaults to:

false

lastKeyMapEvent : Ext.event.Event
readonly ro

The last key event processed is cached on the component for use in subsequent event handlers.

Available since: 6.6.0

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

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

maxRows : Number

Sets the field DOM element maxRows attribute. Defaults to undefined, leaving the attribute unset.

Defaults to:

null

maxValue : Number

The maximum value that this Number field can accept (defaults to undefined, e.g. no maximum).

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

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

minValue : Number

The minimum value that this Number field can accept (defaults to undefined, e.g. no minimum).

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

modelValidation : Boolean
immutable imm

This config enables binding to your Ext.data.Model#validators. This is only processed by form fields (e.g., Ext.field.*) at present, however, this setting is inherited and so can be set on a parent container.

When set to true by a component (or by an ancestor container), the validators of for any {@Ext.data.Model record} fields will be used wherever the value is bound to such data fields.

While this config can be set arbitrarily high in the component hierarchy, doing so can create a lot overhead if most of your form fields do not actually rely on validators in your data model.

Using this setting for a form that is bound to an Ext.data.Model might look like this:

 {
     xtype: 'panel',
     modelValidation: true,
     items: [{
         xtype: 'textfield',
         bind: '{theUser.firstName}'
     },{
         xtype: 'textfield',
         bind: '{theUser.lastName}'
     },{
         xtype: 'textfield',
         bind: '{theUser.phoneNumber}'
     },{
         xtype: 'textfield',
         bind: '{theUser.email}'
     }]
 }

Defaults to:

null

Available since: 6.5.0

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

nameable : Boolean
immutable imm

Set to true for this component's name property to be tracked by its containing nameHolder.

Defaults to:

false

originalValue : Mixed
readonly ro private pri

The original value when the field was instantiated.

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

parseValidator : Ext.data.validator.Validator
private pri

Defaults to:

null

Available since: 6.5.1

pattern : String

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

Ext.define('Ux.field.Pattern', {
    extend : 'Ext.field.Text',
    xtype  : 'patternfield',

    config : {
        component : {
            pattern : '[0-9]*'
        }
    }
});

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

Defaults to:

null

placeHolder : String

A string value displayed in the input (if supported) when the control is empty.

Defaults to:

null

placeholder : String

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

Defaults to:

null

plainErrorsTpl : Ext.XTemplate
readonly ro private pri

The default template used to format errors as plain text. This property is promoted to an Ext.XTemplate instance on first use.

Defaults to:

[
    '<tpl if="count">',
    '<tpl for="errors" between="\\n">{.}</tpl>',
    '</tpl>'
]

Available since: 6.5.0

plugins : Array / Ext.enums.Plugin / Object / Ext.plugin.Abstract

This config describes one or more plugin config objects used to create plugin instances for this component.

Plugins are a way to bundle and reuse custom functionality. Plugins should extend Ext.plugin.Abstract but technically the only requirement for a valid plugin is that it contain an init method that accepts a reference to its owner. Once a plugin is created, the owner will call the init method, passing a reference to itself. Each plugin can then call methods or respond to events on its owner as needed to provide its functionality.

This config's value can take several different forms.

The value can be a single string with the plugin's Ext.enums.Plugin:

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

     plugins: 'listpaging'
 });

In the above examples, the string "listpaging" is the type alias for listpaging. The full alias includes the "plugin." prefix (i.e., 'plugin.listpaging').

The preferred form for multiple plugins or to configure plugins is the keyed-object form (new in version 6.5):

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

     plugins: {
         pullrefresh: true,
         listpaging: {
             autoPaging: true,
             weight: 10
         }
     }
 });

The object keys are the id's as well as the default type alias. This form allows the value of the plugins to be merged from base class to derived class and finally with the instance configuration. This allows classes to define a set of plugins that derived classes or instantiators can further configure or disable. This merge behavior is a feature of the config.

The plugins config can also be an array of plugin aliases (arrays are not merged so this form does not respect plugins defined by the class author):

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

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

An array can also contain elements that are config objects with a type property holding the type alias:

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

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

Defaults to:

null

positioned
readonly ro private pri

Defaults to:

false

publishes : String / String[] / Object

One or more names of config properties that this component should publish to its ViewModel. Generally speaking, only properties defined in a class config block (including ancestor config blocks and mixins) are eligible for publishing to the viewModel. Some components override this and publish their most useful configs by default.

Note: We'll discuss publishing properties not found in the config block below.

Values determined to be invalid by component (often form fields and model validations) will not be published to the ViewModel.

This config uses the cfg-reference to determine the name of the data object to place in the ViewModel. If reference is not set then this config is ignored.

By using this config and cfg-reference you can bind configs between components. For example:

 ...
     items: [{
         xtype: 'textfield',
         reference: 'somefield',  // component's name in the ViewModel
         publishes: 'value' // value is not published by default
     },{
         ...
     },{
         xtype: 'displayfield',
         bind: 'You have entered "{somefield.value}"'
     }]
 ...

Classes must provide this config as an Object:

 Ext.define('App.foo.Bar', {
     publishes: {
         foo: true,
         bar: true
     }
 });

This is required for the config system to properly merge values from derived classes.

For instances this value can be specified as a value as show above or an array or object as follows:

 {
     xtype: 'textfield',
     reference: 'somefield',
     publishes: [
         'value',
         'rawValue',
         'dirty'
     ]
 }

 // This achieves the same result as the above array form.
 {
     xtype: 'textfield',
     reference: 'somefield',
     publishes: {
         value: true,
         rawValue: true,
         dirty: true
     }
 }

In some cases, users may want to publish a property to the viewModel that is not found in a class config block. In these situations, you may utilize publishState if the property has a setter method. Let's use setFieldLabel as an example:

  setFieldLabel: function(fieldLabel) {
      this.callParent(arguments);
      this.publishState('fieldLabel', fieldLabel);
  }

With the above chunk of code, fieldLabel may now be published to the viewModel.

Defaults to:

null

Available since: 5.0.0

readOnly : Boolean

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

Mutation of TextField through triggers is also disabled.

To simply prevent typing into the field while still allowing mutation through triggers, set editable to false.

Defaults to:

false

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

reference : String
immutable imm

Specifies a name for this component inside its component hierarchy. This name must be unique within its view or its ViewController. See the documentation in Ext.container.Container for more information about references.

Note: Valid identifiers start with a letter or underscore and are followed by zero or more additional letters, underscores or digits. References are case sensitive.

Defaults to:

null

rendered : Boolean
readonly ro

The rendered flag is set when a widget is inserted into the document for the first time.

Note that this is a one-way operation. The first time a widget is inserted into the document, this flag is set, and it is never unset.

required : Boolean

true to make this field required.

Defaults to:

false

requiredMessage : String

The error message to display when required is true and the field's value is "empty" (null, undefined, or empty string).

Defaults to:

'This field is required'

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

session : Boolean / Object / Ext.data.Session

If provided this creates a new Session instance for this component. If this is a Container, this will then be inherited by all child components.

To create a new session you can specify true:

 Ext.create({
     xtype: 'viewport',
     session: true,

     items: [{
         ...
     }]
 });

Alternatively, a config object can be provided:

 Ext.create({
     xtype: 'viewport',
     session: {
         ...
     },

     items: [{
         ...
     }]
 });

Defaults to:

null

shareableName : Boolean
immutable imm

Set to true to allow this component's name to be shared by other items in the same nameHolder. Such items will be returned in an array from lookupName.

Defaults to:

false

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

sideError : String
private pri

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

stateId : String

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

Defaults to:

null

stateful : Boolean / Object / String[]

This config specifies the config properties that will be persisted using the Ext.state.Provider. If this config is set to true, the configs specified by statefulDefaults will be assumed.

 stateful: true

Otherwise, this config can be an array of strings of the properties to save:

 stateful: [
     'width',
     'height',
     'collapsed'
 ]

The above is equivalent to:

 stateful: {
     width: true,
     height: true,
     collapsed: true
 }

Note: To be truly stateful, an id or stateId must also be assigned.

A stateful object will save its state when any of these config properties change value.

Defaults to:

false

statefulDefaults : Object / String[]
protected pro

The default set of stateful properties. The form of this config is the same as stateful except this config cannot be a Boolean.

This config is intended for classes to specify so that instances can simply enable statefulness using stateful: true.

Defaults to:

null

stepValue : Number

The amount by which the field is incremented or decremented each time the spinner is tapped. Defaults to undefined, which means that the field goes up or down by 1 each time the spinner is tapped.

Defaults to:

null

stripCharsRe : RegExp
immutable imm

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

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

tag : String
readonly ro protected pro

The tag name to use for this field's input element. Subclasses should override this property on their class body. Not intended for instance-level use.

Defaults to:

'input'

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

The text alignment of this field.

Defaults to:

'left'

tipError : String
private pri

Defaults to:

null

titleError : String
private pri

Defaults to:

null

tooltip : String / Object

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

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 : String / String[] / Ext.Template / Ext.XTemplate[]

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

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'

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.

Ext.create('Ext.field.Text', {
    label: 'My Custom Field',
    triggers: {
        foo: {
            cls: 'my-foo-trigger',
            handler: function() {
                console.log('foo trigger clicked');
            }
        },
        bar: {
            cls: 'my-bar-trigger',
            handler: function() {
                console.log('bar trigger clicked');
            }
        }
    }
});

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

Ext.create('Ext.form.DatePicker', {
    label: 'Pick a Date',
    triggers: {
        foo: {
            cls: 'my-foo-trigger',
            weight: -2, // negative to place before default triggers
            handler: function() {
                console.log('foo trigger clicked');
            }
        },
        bar: {
            cls: 'my-bar-trigger',
            weight: -1,
            handler: function() {
                console.log('bar trigger clicked');
            }
        }
    }
});

Defaults to:

{
    clear: {
        type: 'clear'
    }
}

twoWayBindable : String / String[] / Object

This object holds a map of config properties that will update their binding as they are modified. For example, value is a key added by form fields. The form of this config is the same as publishes.

This config is defined so that updaters are not created and added for all bound properties since most cannot be modified by the end-user and hence are not appropriate for two-way binding.

Defaults to:

null

type : String

The type attribute for input fields -- e.g. radio, text, password.

If you want to use a file input, please use the FileField component instead.

Defaults to:

'text'

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

underError : String
private pri

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

userSelectable : Boolean / String / Object

Set to true to allow users to select text within this component.

Can also be any valid value for the CSS3 user-select property.

A value of true implies auto, while false implies none.

May also be an object keyed by child element name.

By default, the user cannot click+drag+select text/elements of the UI. Applications may want to enable user selection for specific DOM elements, such as the bodyElement of a component used as a tab panel. The tab and tab text would not be user selectable in this example, but the content area when the tab is selected would.

 userSelectable: {
     element: true,       // allow the element to be user selectable
     bodyElement: true    // allow the component's body element to be user selectable
 }

Defaults to:

false

Available since: 6.5.1

userSelectableClsMap
readonly ro private pri

Defaults to:

{
    "true": Ext.baseCSSPrefix + 'user-selectable-auto',
    "false": Ext.baseCSSPrefix + 'user-selectable-none',
    all: Ext.baseCSSPrefix + 'user-selectable-all',
    auto: Ext.baseCSSPrefix + 'user-selectable-auto',
    text: Ext.baseCSSPrefix + 'user-selectable-text',
    none: Ext.baseCSSPrefix + 'user-selectable-none'
}

validRefRe : RegExp
readonly ro private pri

Regular expression used for validating reference values.

Defaults to:

/^[a-z_][a-z0-9_]*$/i

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'

validators : Mixed

Field validators.

value : Mixed

A value to initialize this field with.

Defaults to:

null

viewModel : String / Object / Ext.app.ViewModel

The ViewModel is a data provider for this component and its children. The data contained in the ViewModel is typically used by adding bind configs to the components that want present or edit this data.

When set, the ViewModel is created and links to any inherited viewModel instance from an ancestor container as the "parent". The ViewModel hierarchy, once established, only supports creation or destruction of children. The parent of a ViewModel cannot be changed on the fly.

If this is a root-level ViewModel, the data model connection is made to this component's associated Ext.data.Session. This is determined by calling getInheritedSession.

Defaults to:

null

weight : Number

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:

0

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 like so:

Ext.define('PressMeButton', {
    extend: 'Ext.button.Button',
    xtype: '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.

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

methods

Instance Methods

_addDeclaredListeners ( listeners ) : Boolean
private pri

Adds declarative listeners as nested arrays of listener objects.

Parameters

listeners :  Array

Returns

:Boolean

true if any listeners were added

_fixReference
private pri

Sets up a reference on our current reference holder.

_flushStateful
private pri

This method is called before destroy to ensure that this instance's stateful properties are saved to persistent storage. Since this object is about to be destroyed, this cannot be delayed.

_getStateId String
private pri

Returns the state id for this object.

Returns

:String

The stateId or the configured id.

activatePlugin ( type ) : Ext.plugin.Abstract
private pri

Creates a particular plugin type if defined in the plugins configuration.

Available since: 6.2.0

Parameters

type :  String

The type of the plugin.

Returns

:Ext.plugin.Abstract

The plugin that was created.

addDelegatedListener ( eventName, fn, scope, options, order, caller, manager )
private pri

Adds a listeners with the "delegate" event option. Users should not invoke this method directly. Use the "delegate" event option of addListener instead.

Parameters

eventName :  Object

fn :  Object

scope :  Object

options :  Object

order :  Object

caller :  Object

manager :  Object

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

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 set of arguments to pass to the handler function before the actual fired event arguments. For example, if args is set to ['foo', 42], the event handler function will be called with an arguments list like this:

 handler('foo', 42, <actual event 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.

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

addTrigger ( name, trigger ) : Ext.field.trigger.Trigger

Adds a trigger to this text field.

Parameters

name :  String

Unique name (within this field) for the trigger. Cannot be the same as the name of an existing trigger for this field.

trigger :  Ext.field.trigger.Trigger/Object

The trigger instance or a config object for a trigger to add

Returns

:Ext.field.trigger.Trigger

The trigger that was added

adjustChildDirtyCount ( dirty )
private pri

This method is called by descendants that use this mixin when their dirty state changes.

Parameters

dirty :  Boolean

The dirty state of the descendant component.

afterEdit
private pri

Used to handle joining of a record to a tpl

afterErase
private pri

Used to handle joining of a record to a tpl

alignTo ( component, alignment, options )
private pri

Parameters

component :  Object

alignment :  Object

options :  Object

applyBind ( binds, currentBindings ) : Object
private pri

Available since: 5.0.0

Parameters

binds :  String/Object

currentBindings :  Object

Returns

:Object

applyCentered ( centered ) : Boolean
private pri

Parameters

centered :  Boolean

Returns

:Boolean

applyComponent ( config )
private pri

Parameters

config :  Object

applyPlugins ( plugins, oldPlugins )
private pri

Applier for the plugins config property.

Parameters

plugins :  String[]/Object[]/Ext.plugin.Abstract[]

The new plugins to use.

oldPlugins :  Ext.plugin.Abstract[]

The existing plugins in use.

applySession ( session ) : Ext.data.Session
private pri

Transforms a Session config to a proper instance.

Available since: 5.0.0

Parameters

session :  Object

Returns

:Ext.data.Session

applyTpl ( tpl )
private pri

Parameters

tpl :  Object

applyValidators ( validators )
private pri

Parameters

validators :  Object

applyViewModel ( viewModel ) : Ext.app.ViewModel
private pri

Transforms a ViewModel config to a proper instance.

Available since: 5.0.0

Parameters

viewModel :  String/Object/Ext.app.ViewModel

Returns

:Ext.app.ViewModel

beginSyncChildDirty
private pri

This method is called when the component hierarchy has changed and the current set of descendants will be reasserting their dirty state. This method is only called on nameHolder containers.

bubble ( fn, [scope], [args] )

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

Parameters

fn :  Function

The function to call

scope :  Object (optional)

The scope of the function. Defaults to current node.

args :  Array (optional)

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

center Ext.Component
chainable ch

Center this floated or positioned Component in its parent.

Returns

:Ext.Component

this

clearDelegatedListeners
private pri

Clears all listeners that were attached using the "delegate" event option. Users should not invoke this method directly. It is called automatically as part of normal clearListeners processing.

clearInvalid
deprecated dep

Mark field as valid.

Available since: 6.5.0

Deprecated since version 6.5.0
Use setError(null) instead. (for classic compatibility)

clearListeners

Removes all listeners for this object including the managed listeners

clearManagedListeners

Removes all managed listeners for this object.

clearValue

Clears the value of this field.

completeEdit
protected pro

Called when focus leaves this input field. Used to postprocess raw values and perform conversion and validation.

constructor ( config )

Creates new Component.

Parameters

config :  Object

The standard configuration object.

createPlugin ( config ) : Ext.plugin.Abstract
private pri

Converts the provided type or config object into a plugin instance.

Parameters

config :  String/Object/Ext.plugin.Abstract

The plugin type, config object or instance.

Returns

:Ext.plugin.Abstract

createRelayer ( newName, [beginEnd] ) : Function
private pri

Creates an event handling function which re-fires the event from this object as the passed event name.

Parameters

newName :  String

The name under which to re-fire the passed parameters.

beginEnd :  Array (optional)

The caller can specify on which indices to slice.

Returns

:Function

createTrigger ( name, trigger )
private pri

Parameters

name :  Object

trigger :  Object

destroy
private pri

Destructor for classes that extend Observable.

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.

didValueChange ( newVal, oldVal )
private pri

Checks if the value has changed. Allows subclasses to override for any more complex logic.

Parameters

newVal :  Object

oldVal :  Object

doDestroy

Perform the actual destruction sequence. This is the method to override in your subclasses to add steps specific to the destruction of custom Component.

If the Component is currently added to a Container it will first be removed from that Container. All Ext.Element references are also deleted and the Component is de-registered from Ext.ComponentManager.

As a rule of thumb, subclasses should destroy their child Components, Elements, and/or other objects before calling parent method. Any object references will be nulled after this method has finished, to prevent the possibility of memory leaks.

Available since: 6.2.0

doFireDelegatedEvent ( eventName, args )
private pri

Fires a delegated event. Users should not invoke this method directly. It is called automatically by the framework as needed (see the "delegate" event option of addListener for more details.

Parameters

eventName :  Object

args :  Object

doFireEvent ( eventName, args, bubbles )
private pri

Continue to fire event.

Parameters

eventName :  String

args :  Array

bubbles :  Boolean

doKeyUp ( me, e )
private pri

Called when a key has been pressed in the <input>

Parameters

me :  Object

e :  Object

doSetComponent ( component )
private pri

Parameters

component :  Object

doUnsetComponent ( component )
private pri

Parameters

component :  Object

doValidate ( value, errors, [skipLazy] )
private pri

This method is called by validate if the value is both non-empty (not null, undefined or '') and if the value can be parsed by the parseValue method. This parsing concern is technically only in play for TextField and derived classes (such as DateField and NumberField) but the guarantee here is that the value will be a parsed value and not the raw string and if the value cannot be parsed, this method will not be called.

Parameters

value :  Mixed

The (parsed) value

errors :  String[]

The array of validation errors

skipLazy :  Boolean (optional)

false (the default) to run all validators.

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.

findFocusTarget Ext.Component
private pri

Finds an alternate Component to focus if this Component is disabled while focused, or focused while disabled, or otherwise unable to focus.

In both cases, focus must not be lost to document.body, but must move to an intuitively connectible Component, either a sibling, or uncle or nephew.

This is both for the convenience of keyboard users, and also for when focus is tracked within a Component tree such as for ComboBoxes and their dropdowns.

For example, a ComboBox with a PagingToolbar in is BoundList. If the "Next Page" button is hit, the LoadMask shows and focuses, the next page is the last page, so the "Next Page" button is disabled. When the LoadMask hides, it attempt to focus the last focused Component which is the disabled "Next Page" button. In this situation, focus should move to a sibling within the PagingToolbar.

Returns

:Ext.Component

A closely related focusable Component to which focus can move.

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.

finishSyncChildDirty
private pri

This method is called when the component hierarchy has changed after the current set of descendants has reasserted their dirty state. This method is only called on nameHolder containers.

fireAction ( eventName, args, fn, [scope], [options], [order] )
deprecated dep

Fires the specified event with the passed parameters and executes a function (action). By default, the action function will be executed after any "before" event handlers (as specified using the order option of addListener), but before any other handlers are fired. This gives the "before" handlers an opportunity to cancel the event by returning false, and prevent the action function from being called.

The action can also be configured to run after normal handlers, but before any "after" handlers (as specified using the order event option) by passing 'after' as the order parameter. This configuration gives any event handlers except for "after" handlers the opportunity to cancel the event and prevent the action function from being called.

Parameters

eventName :  String

The name of the event to fire.

args :  Array

Arguments to pass to handlers and to the action function.

fn :  Function

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.

options :  Object (optional)

Event options for the action function. Accepts any of the options of addListener

order :  String (optional)

The order to call the action function relative too the event handlers ('before' or 'after'). Note that this option is simply used to sort the action function relative to the event handlers by "priority". An order of 'before' is equivalent to a priority of 99.5, while an order of 'after' is equivalent to a priority of -99.5. See the priority option of addListener for more details.

Defaults to: 'before'

Deprecated since version 5.5
Use fireEventedAction instead.

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

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.

Returns

:Boolean

fireKey ( e )
private pri

Parameters

e :  Object

fixDirtyState
private pri

This method is called after _fixReference() during the reference sync sweep. We need to inform our parent if we are a leaf component and if we are dirty. If we are a nameHolder then we'll inform the parent in finishSyncChildDirty.

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.

formatErrors ( errors ) : String
protected pro

Formats the given error(s) based on the given errorTpl and the specified errorTarget.

Available since: 6.5.0

Parameters

errors :  String[]

Returns

:String

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.

getAriaLabelEl ( [reference] ) : Ext.dom.Element
private pri

Find component(s) that label or describe this component, and return the id(s) of their ariaEl elements.

Parameters

reference :  Function/String/String[] (optional)

Component reference, or array of component references, or a function that should return the proper attribute string. The function will be called in the context of the labelled component.

Returns

:Ext.dom.Element

Element id string, or null

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

Sets the value of bodyAlign

getBubbleParent Ext.util.Observable
private pri

Gets the bubbling parent for an Observable

Returns

:Ext.util.Observable

The bubble parent. null is returned if no bubble target exists

getController Ext.app.ViewController

Returns the Ext.app.ViewController instance associated with this component via the controller config or setController method.

Returns

:Ext.app.ViewController

Returns this component's ViewController or null if one was not configured

getFocusClsEl ( [focusEl] ) : Ext.dom.Element
protected pro

Returns the element used to apply focus styling CSS class when Focusable's focusEl becomes focused. By default it is focusEl.

Parameters

focusEl :  Ext.dom.Element (optional)

Return focus styling element for the given focused element. This is used by Components implementing multiple focusable elements.

Returns

:Ext.dom.Element

The focus styling element.

getFocusEl Ext.dom.Element
protected pro

Returns the main focus holder element associated with this Focusable, i.e. the element that will be focused when Focusable's focus method is called. For most Focusables, this will be the focusEl.

Returns

:Ext.dom.Element

getHtml : String / Ext.dom.Element / HTMLElement

Sets the value of html

getId String

Retrieves the id. This method Will auto-generate an id if one has not already been configured.

Returns

:String

id

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'

Sets the value of labelAlign

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

Sets the value of labelTextAlign

getModalSibling
private pri

Returns the topmost modal floated component (other then this one).

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: [{
         type: '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.

getRawValue String

Returns the raw value of the field, without performing any normalization, conversion, or validation. To get a normalized and converted value see getValue.

Available since: 7.0

Returns

:String

value The raw String value of the field

getRefOwner
protected pro

Used by Ext.ComponentQuery, and the up method to find the owning Component in the linkage hierarchy.

By default this returns the Container which contains this Component.

This may be overridden by Component authors who implement ownership hierarchies which are not based upon ownerCt, such as BoundLists being owned by Fields or Menus being owned by Buttons.

getRenderTarget Ext.dom.Element
private pri

Returns the element into which the html content and items should be rendered. This defaults to the bodyElement but derived classes can override this method to use a different element.

For containers his only applies to inner items, not docked items. The positioned items are rendered to the element returned by the {@link Ext.Container#getPositionedItemTarget method.

Available since: 6.5.0

Returns

:Ext.dom.Element

getScrollableClientRegion Ext.util.Region
private pri

This method is required by the Scroller to return the scrollable client region

Returns

:Ext.util.Region

The scrolling viewport region.

getStateBuilder ( [cache] ) : Ext.state.Builder
private pri

Creates a state builder to access or edit this instance's state object. If this instance has a getStatefulOwner, the returned builder will have a parent reference that owner's state builder. This can be an arbitrarily deep chain but does proceed all the way up to the root instance (with no owner) since that is the instance that determines the ultimate state storage key.

Parameters

cache :  Boolean (optional)

Pass true to return a cached builder.

Defaults to: false

Returns

:Ext.state.Builder

getStatefulOwner Ext.state.Stateful/Array
private pri

This method allows a class to specify an owning stateful object. This is used by Ext.plugin.Abstract to save their state as part of their owning Ext.Component.

The return value can be either a Stateful object or an array whose first element is a Stateful object. This object's state will be stored inside the state object of the returned Stateful object. If an array is returned, the elements beyond the first are sub-keys in the state object.

For example, Ext.plugin.Abstract implement this method like so:

 getStatefulOwner: function() {
     return [ this.cmp, 'plugins' ];
 }

The effect of this is to produce a state object like so:

 {
     plugins: {
         pluginId1: {
             //...
         }
     }
 }

In order for a child object's state to be saved and restored, all of its parents must also be stateful (i.e., have a stateId).

Returns

:Ext.state.Stateful/Array

getTabIndex Number

Return the actual tabIndex for this Focusable.

Returns

:Number

tabIndex attribute value

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

Sets the value of textAlign

getTextSelection Array

Returns the selection range of an input element as an array of three values:

 [ start, end, direction ]

These have the same meaning as the parameters to select.

Available since: 6.5.0

Returns

:Array

getTipError : String
private

Sets the value of tipError

getValue Mixed

Returns the field data value.

Returns

:Mixed

value The field value.

getViewModel : String / Object / Ext.app.ViewModel

Sets the value of viewModel

getXTypes String

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

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

Example usage:

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

Returns

:String

The xtype hierarchy string.

handleBlurEvent ( info )
private pri

Parameters

info :  Object

handleFocusEvent ( info )
private pri

Parameters

info :  Object

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.

hide ( [animation] ) : Ext.Component
chainable ch

Hides this Component optionally using an animation.

Parameters

animation :  Object/Boolean (optional)

You can specify an animation here or a bool to use the hideAnimation config.

Returns

:Ext.Component

initBindable
private pri

This method triggers the lazy configs and must be called when it is time to fully boot up. The configs that must be initialized are: bind, publishes, session, twoWayBindable and viewModel.

Available since: 5.0.0

initDragConstraints ( draggable )
template tpl

This method is called when a drag is initializing. This method should adjust the drag constraints to ensure all drag movements are properly restricted. See Ext.drag.Source#constrain.

Available since: 6.5.0

Parameters

draggable :  Ext.drag.Source

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

initFocusableElement ( force )
private pri

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

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

Parameters

force :  Object

initFocusableEvents ( force )
protected pro

Template method to do any event listener initialization for a Focusable. This generally happens after the focusEl is available.

Parameters

force :  Object

initInheritedState ( inheritedState )
protected pro

Called by getInherited to initialize the inheritedState the first time it is requested.

Parameters

inheritedState :  Object

initKeyMap
protected pro

This method should be called when the instance is ready to start listening for keyboard events. This is called automatically for Ext.Component and derived classes. This is done after the component is rendered.

initialize
template tpl protected pro

Allows addition of behavior to the rendering phase.

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

invalidateInheritedState
private pri

This method marks the current inherited state as invalid. The next time a call is made to getInherited the objects will be recreated and initialized.

Available since: 5.0.0

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 ) : Boolean

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.

Returns

:Boolean

isBlurring ( e ) : Boolean
private pri

Parameters

e :  Object

Returns

:Boolean

isBound ( [name] ) : Boolean

Determines if the passed property name is bound to ViewModel data.

Available since: 6.5.0

Parameters

name :  String (optional)

The property name to test. Defaults to the defaultBindProperty

Returns

:Boolean

true if the passed property receives data from a ViewModel.

isCentered Boolean
private pri

Returns

:Boolean

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.

isDestructing Boolean
private pri

Determines if this Component is inside a Component tree which is destroyed, or is being destroyed.

Returns

:Boolean

true if this Component, or any ancestor is destroyed, or is being destroyed.

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.

isFocusing ( e ) : Boolean
private pri

Parameters

e :  Object

Returns

:Boolean

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

isSyncing ( name ) : Boolean
private pri

Checks if a particular binding is synchronizing the value.

Parameters

name :  String

The name of the property being bound to.

Returns

:Boolean

true if the binding is syncing.

isValid

Returns true if field is valid.

loadState ( state, stateful ) : Object
private pri

This method is called to load state from the provided state builder. This method should return the config properties loaded from state.

This method, like saveState, can be overridden by derived classes:

 loadState: function(state) {
     var ret = this.callParent([ state ]);

     if (ret.foo) {
         // use custom data...

         delete ret.foo;  // remove it since it isn't a config
     }

     return ret;
 }

When overriding this method, it is also likely necessary to override saveState.

Parameters

state :  Ext.state.Builder

stateful :  Object

The stateful properties as an object keyed by config name.

Returns

:Object

lookupController ( [skipThis] ) : Ext.app.ViewController

Gets the controller that controls this view. May be a controller that belongs to a view higher in the hierarchy.

Available since: 5.0.1

Parameters

skipThis :  Boolean (optional)

true to not consider the controller directly attached to this view (if it exists).

Defaults to: false

Returns

:Ext.app.ViewController

The controller. null if no controller is found.

lookupNameHolder ( [skipThis] ) : Ext.Component
private pri

Gets the Form or Component that is used as the name holder for this component.

Available since: 6.5.0

Parameters

skipThis :  Boolean (optional)

false to return this as the name holder if this instance has set nameHolder. Unlike getInheritedConfig this method defaults to true because it is possible that a name property set by the owner of a component that is also a nameHolder itself. In this case, the name connects not to this component but to the parent nameHolder.

Defaults to: true

Returns

:Ext.Component

The name holder.

lookupReferenceHolder ( [skipThis] ) : Ext.app.ViewController/Ext.Container
private pri

Gets the Controller or Component that is used as the reference holder for this view.

Available since: 5.0.0

Parameters

skipThis :  Boolean (optional)

false to return this as the reference holder if this instance has set referenceHolder. Unlike getInheritedConfig this method defaults to true because it is possible that a reference property set by the owner of a component that is also a referenceHolder itself. In this case, the reference connects not to this component but to the parent referenceHolder.

Defaults to: true

Returns

:Ext.app.ViewController/Ext.Container

The reference holder.

lookupSession ( [skipThis] ) : Ext.data.Session

Returns the Ext.data.Session for this instance. This property may come from this instance's session or be inherited from this object's parent.

Available since: 5.0.0

Parameters

skipThis :  Boolean (optional)

Pass true to ignore a session configured on this instance and only consider an inherited session.

Defaults to: false

Returns

:Ext.data.Session

lookupViewModel ( [skipThis] ) : Ext.app.ViewModel

Returns the Ext.app.ViewModel for this instance. This property may come from this this instance's viewModel or be inherited from this object's parent.

Available since: 5.0.0

Parameters

skipThis :  Boolean (optional)

Pass true to ignore a viewModel configured on this instance and only consider an inherited view model.

Defaults to: false

Returns

:Ext.app.ViewModel

markInvalid ( messages )
deprecated dep

Mark field as invalid.

Available since: 6.5.0

Parameters

messages :  Object

Deprecated since version 6.5.0
Use setError instead. (for classic compatibility)

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.

onBlur ( e )
private pri

Parameters

e :  Object

onFocus ( e )
private pri

Parameters

e :  Object

onFocusEnter ( e )
template tpl protected pro

Called when focus enters this Component's hierarchy

Parameters

e :  Object

event :  Ext.event.Event

The underlying DOM event.

target :  HTMLElement

The element gaining focus.

relatedTarget :  HTMLElement

The element losing focus.

toComponent :  Ext.Component

The Component gaining focus.

fromComponent :  Ext.Component

The Component losing focus.

backwards :  Boolean

true if the fromComponent is after the toComponent* in the DOM tree, indicating that the user usedSHIFT+TABto move focus. Note that settingtabIndexvalues to affect tabbing order can cause this to be incorrect. SettingtabIndex values is not advised.

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

onFocusLeave ( e )
template tpl protected pro

Called when focus exits from this Component's hierarchy

Parameters

e :  Ext.event.Event

event :  Ext.event.Event

The underlying DOM event.

target :  HTMLElement

The element gaining focus.

relatedTarget :  HTMLElement

The element losing focus.

toComponent :  Ext.Component

The Component gaining focus.

fromComponent :  Ext.Component

The Component losing focus.

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

onFocusMove ( info )
template tpl protected pro

Called when focus moves within this Component's hierarchy

Parameters

info :  Object

event :  Ext.event.Event

The underlying Event object.

toElement :  HTMLElement

The element gaining focus.

fromElement :  HTMLElement

The element losing focus.

toComponent :  Ext.Component

The Component gaining focus.

fromComponent :  Ext.Component

The Component losing focus.

backwards :  Boolean

true if the focus movement is backward in DOM order

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

onInheritedAdd ( parent, instanced )
private pri

Called when this Inheritable is added to a parent

Parameters

parent :  Object

instanced :  Boolean

onInheritedRemove ( destroying )
private pri

Called when this inheritable is removed from a parent

Parameters

destroying :  Boolean

true if this item will be destroyed by it's container

onInitialized ( fn, scope, args )
private pri

Parameters

fn :  Object

scope :  Object

args :  Object

onResize ( width, height, oldWidth, oldHeight )
template tpl protected pro

Optional template method. If implemented, this is called asynchronously after a browser layout caused by a component resize. This may be triggered for any or several of the following reasons:

Parameters

width :  Number

The new width.

height :  Number

The new height.

oldWidth :  Number

The previous width.

oldHeight :  Number

The previous height.

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

onScrollEnd ( x, y )
template tpl protected pro

Invoked when a scroll operation is completed via this component's scroller.

Parameters

x :  Number

The current x position

y :  Number

The current y position

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

onScrollMove ( x, y )
template tpl protected pro

Invoked when this component is scrolled via its scroller.

Parameters

x :  Number

The current x position

y :  Number

The current y position

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

onScrollStart ( x, y )
template tpl protected pro

Invoked when a scroll is initiated on this component via its scroller.

Parameters

x :  Number

The current x position

y :  Number

The current y position

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

onStatefulChange
private pri

This method is called when any of the stateful configs are modified.

parseValue ( value, errors ) : Mixed
template tpl protected pro

Parses the given value and returns it in the desired representation. By default this will return the value given (no change). Derived classes (such as datefield and numberfield) will override this method and return a Date or a Number, respectively.

If value cannot be parsed, this method will return null, otherwise it will return the parsed value. It is the parsed value that will become the field's value.

This method is not called directly but is called internally by the validate. This call to parse a value is not made on empty or null values.

Note: It is not expected that applications will need to override this method because an application can achieve value parsing by virtue of the validators it defines. These can come from this component or from a bound model field (using modelValidation). In addition, datefield and numberfield both provide default parsing for their values.

Available since: 6.5.1

Parameters

value :  String

The value to parse (never null).

errors :  String[]

The set of validation errors. If the value cannot be parsed, the error message should be added to this array.

Returns

:Mixed

The parsed value.

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

persistState
private pri

Saves the state of this instance to the persistence store. This method is called by the Ext.state.Provider when it is ready to save state to storage.

preprocessShow ( component, alignment, options )
private pri

This is the private method to ensure everything is set up for showing. This is called by both show and showBy to set a component up. the user-facing method is beforeShow, this setup must have happened by the time that is called.

Parameters

component :  Object

alignment :  Object

options :  Object

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.

processRawValue ( value ) : Object

Performs any necessary manipulation of a raw field value to prepare it for conversion and/or validation, for instance stripping out ignored characters. In the base implementation it does nothing; individual subclasses may override this as needed.

Available since: 7.0

Parameters

value :  Object

The unprocessed string value

Returns

:Object

The processed string value

publishState ( [property], [value] )
protected pro

Publish this components state to the ViewModel. If no arguments are given (or if this is the first call), the entire state is published. This state is determined by the publishes property.

This method is called only by component authors.

Available since: 5.0.0

Parameters

property :  String (optional)

The name of the property to update.

value :  Object (optional)

The value of property. Only needed if property is given.

rawToValue ( rawValue ) : Object

Converts a raw input field value into a mixed-type value that is suitable for this particular field type. This allows controlling the normalization and conversion of user-entered values into field-type-appropriate values, e.g. a Date object for DateField, and is invoked by getValue.

It is up to individual implementations to decide how to handle raw values that cannot be successfully converted to the desired object type.

The base implementation does no conversion, returning the raw value untouched.

Available since: 7.0

Parameters

rawValue :  Object

Returns

:Object

The converted value.

readStateObject Object
private pri

Returns this instance's state object from the persistence store. This object should contain config properties.

Returns

:Object

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

removeDelegatedListener ( eventName, fn, scope )
private pri

Removes delegated listeners for a given eventName, function, and scope. Users should not invoke this method directly. It is called automatically by the framework as part of removeListener processing.

Parameters

eventName :  Object

fn :  Object

scope :  Object

removeListener ( eventName, fn, [scope] ) :
chainable ch

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.

Returns

:

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.

removeManagedListenerItem ( isClear, managedListener, item, ename, fn, scope )
private pri

Remove a single managed listener item

Parameters

isClear :  Boolean

True if this is being called during a clear

managedListener :  Object

The managed listener item

item :  Object

ename :  String

fn :  Function

scope :  Object

See removeManagedListener for other args

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.

removeTrigger ( trigger, [destroy] ) : Ext.field.trigger.Trigger

Removes a trigger from this text field.

Parameters

trigger :  String/Ext.field.trigger.Trigger

The name of the trigger to remove, or a trigger reference.

destroy :  Boolean (optional)

False to prevent the trigger from being destroyed on removal. Only use this option if you want to reuse the trigger instance.

Defaults to: true

Returns

:Ext.field.trigger.Trigger

The trigger that was removed

reset Ext.field.Field
chainable ch

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

// This will create a field with an original value
var field = Ext.Viewport.add({
    xtype: 'textfield',
    value: 'first value'
});

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

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

Returns

:Ext.field.Field

this

resetFloating
deprecated dep

Resets top, right, bottom and left configurations to null, which will cause this component to stop being 'positioned' and to take its place in its owning container's layout.

Deprecated since version 6.2
Use resetPositioned instead.

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.

resetPositioned

Resets top, right, bottom and left configurations to null, which will cause this component to stop being 'positioned' and to take its place in its owning container's layout.

resolveListenerScope ( [defaultScope] ) : Object
protected pro

Gets the default scope for firing late bound events (string names with no scope attached) at runtime.

Parameters

defaultScope :  Object (optional)

The default scope to return if none is found.

Defaults to: this

Returns

:Object

The default event scope

resolveSatelliteListenerScope ( satellite, [defaultScope] ) : Object
protected pro

Returns the default listener scope for a "satellite" of this component. Used for resolving scope for observable objects that are not part of the normal Container/Component hierarchy (for example, plugins)

Available since: 5.1.1

Parameters

satellite :  Ext.mixin.Observable

defaultScope :  Object (optional)

Returns

:Object

The listener scope

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.

revertFocus
private pri

Returns focus to the Component or element found in the cached focusEnterEvent.

revertFocusTo ( target )
private pri

This field is on the recieving end of a call from revertFocus.

It is called when focus is being pushed back into this Component from a Component that is focused and is being hidden or disabled.

We must focus the passed element.

Subclasses may perform some extra processing to prepare for refocusing.

Parameters

target :  Object

saveState ( state, stateful )
private pri

Saves the current state of this object to the provided state builder. By default this method saves the configs specified as stateful.

This method can also be overridden by subclasses to store custom data directly to the state builder:

 saveState: function(state) {
     this.callParent([ state ]);

     state.set('foo', 42);
 }

When overriding this method, it is also likely necessary to override loadState.

Parameters

state :  Ext.state.Builder

The state builder to which to save state.

stateful :  Object

The stateful properties as an object keyed by config name.

select ( [start], [end], [direction] ) : Ext.field.Text
chainable ch

Select the specified contents of the input field (all by default).

Parameters

start :  Number (optional)

Defaults to: 0

end :  Number (optional)

direction :  "f"/"b"/"forward"/"backward" (optional)

Pass "f" for forward, "b" for backwards.

Defaults to: "f"

Returns

:Ext.field.Text

this

serialize String

A function which converts the field’s value for submission. This is the value used for form submit. The field's value is serialized using the serializer for the associated Ext.data.Model when using modelValidation, or using the serializer specified by the dataType config.

Available since: 7.0

Returns

:String

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

setAllowBlank ( allowBlank )

Returns the value of allowBlank

setAnimateUnderline ( animateUnderline )

Returns the value of animateUnderline

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

setAutoFitErrors ( autoFitErrors )

Returns the value of autoFitErrors

setAutoHideInputMask ( autoHideInputMask )

Returns the value of autoHideInputMask

setAxisLock ( axisLock )

Returns the value of axisLock

setBind ( bind )

Returns the value of bind

setBodyAlign ( bodyAlign )

Returns the value of bodyAlign

setBorder ( border )

Returns the value of border

setBottom ( bottom )

Returns the value of bottom

setBubbleDirty ( bubbleDirty )

Returns the value of bubbleDirty

setCentered ( centered )

Returns the value of centered

setChecked ( checked )

Returns the value of checked

setClearIcon ( clearIcon )

Returns the value of clearIcon

setClearable ( clearable )

Returns the value of clearable

setCls ( cls )

Returns the value of cls

setComponent ( component )

Returns the value of component

setContentEl ( contentEl )

Returns the value of contentEl

setController ( controller )

Returns the value of controller

setData ( data )

Returns the value of data

setDataType ( dataType )

Returns the value of dataType

setDefaultListenerScope ( defaultListenerScope )

Returns the value of defaultListenerScope

setDirty ( dirty )

Returns the value of dirty

setDisabled ( disabled )
private pri

Parameters

disabled :  Object

setDisplayed ( displayed )

Returns the value of displayed

setDocked ( docked )

Returns the value of docked

setDraggable ( draggable )

Returns the value of draggable

setEditable ( editable )

Returns the value of editable

setEnterAnimation ( enterAnimation )

Returns the value of enterAnimation

setError ( error )

Returns the value of error

setErrorMessage ( errorMessage )

Returns the value of errorMessage

setErrorTarget ( errorTarget )

Returns the value of errorTarget

setErrorTip ( errorTip )

Returns the value of errorTip

setErrorTpl ( errorTpl )

Returns the value of errorTpl

setExitAnimation ( exitAnimation )

Returns the value of exitAnimation

setFastFocus ( fastFocus )

Returns the value of fastFocus

setHeight ( height )

Returns the value of height

setHideAnimation ( hideAnimation )

Returns the value of hideAnimation

setHideOnMaskTap ( hideOnMaskTap )

Returns the value of hideOnMaskTap

setHtml ( html )

Returns the value of html

setInline ( inline )

Returns the value of inline

setInputAttribute ( attribute, newValue )
private pri

Helper method to update or remove an attribute on the inputElement

Parameters

attribute :  Object

newValue :  Object

setInputMask ( inputMask )

Returns the value of inputMask

setInputValue ( inputValue )
private

Returns the value of inputValue

setIsFocused ( isFocused )

Returns the value of isFocused

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

setLabelInPlaceholder ( labelInPlaceholder )
private

Returns the value of labelInPlaceholder

setLabelMinWidth ( labelMinWidth )

Returns the value of labelMinWidth

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

setMaxHeight ( maxHeight )

Returns the value of maxHeight

setMaxLength ( maxLength )

Returns the value of maxLength

setMaxRows ( maxRows )

Returns the value of maxRows

setMaxValue ( maxValue )

Returns the value of maxValue

setMaxWidth ( maxWidth )

Returns the value of maxWidth

setMinHeight ( minHeight )

Returns the value of minHeight

setMinValue ( minValue )

Returns the value of minValue

setMinWidth ( minWidth )

Returns the value of minWidth

setModal ( modal )

Returns the value of modal

setName ( name )

Returns the value of name

setPadding ( padding )

Returns the value of padding

setParseValidator ( parseValidator )
private

Returns the value of parseValidator

setPattern ( pattern )

Returns the value of pattern

setPlaceHolder ( placeHolder )

Returns the value of placeHolder

setPlaceholder ( placeholder )

Returns the value of placeholder

setPlugins ( plugins )

Returns the value of plugins

setPublishes ( publishes )

Returns the value of publishes

setReadOnly ( readOnly )

Returns the value of readOnly

setRecord ( record )

Returns the value of record

setRequired ( required )

Returns the value of required

setRequiredMessage ( requiredMessage )

Returns the value of requiredMessage

setRight ( right )

Returns the value of right

setScrollable ( scrollable )

Returns the value of scrollable

setSession ( session )

Returns the value of session

setShowAnimation ( showAnimation )

Returns the value of showAnimation

setSideError ( sideError )
private

Returns the value of sideError

setStartValue ( startValue )

Returns the value of startValue

setStateId ( stateId )

Returns the value of stateId

setStateful ( stateful )

Returns the value of stateful

setStatefulDefaults ( statefulDefaults )
protected

Returns the value of statefulDefaults

setStepValue ( stepValue )

Returns the value of stepValue

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

setTipError ( tipError )
private

Returns the value of tipError

setTitleError ( titleError )
private

Returns the value of titleError

setTooltip ( tooltip )

Returns the value of tooltip

setTop ( top )

Returns the value of top

setTpl ( tpl )

Returns the value of tpl

setTplWriteMode ( tplWriteMode )

Returns the value of tplWriteMode

setTriggers ( triggers )

Returns the value of triggers

setTwoWayBindable ( twoWayBindable )

Returns the value of twoWayBindable

setType ( type )

Returns the value of type

setUnderError ( underError )
private

Returns the value of underError

setUserSelectable ( userSelectable )

Returns the value of userSelectable

setValidateDisabled ( validateDisabled )

Returns the value of validateDisabled

setValidationMessage ( validationMessage )

Returns the value of validationMessage

setValidators ( validators )

Returns the value of validators

setValue ( value )

Returns the value of value

setViewModel ( viewModel )

Returns the value of viewModel

setVisibility ( isVisible )
private pri

Parameters

isVisible :  Object

setWeight ( weight )

Returns the value of weight

setWidth ( width )

Returns the value of width

setXY ( x, y, animation )
private pri

This method has the same arguments as element's setXY method, but is used to maintain the x and y configs (for floated components) or the left and top config for positioned components.

Available since: 6.5.0

Parameters

x :  Object

y :  Object

animation :  Object

setZIndex ( zIndex )

Returns the value of zIndex

show ( [animation] ) : Ext.Component
chainable ch

Shows this component optionally using an animation.

Parameters

animation :  Object/Boolean (optional)

You can specify an animation here or a bool to use the showAnimation config.

Returns

:Ext.Component

showAt ( x, [y] ) : Ext.Component
chainable ch

Displays component at specific xy position. A floating component (like a menu) is positioned relative to its ownerCt if any. Useful for popping up a context menu:

listeners: {
    itemcontextmenu: function(view, record, item, index, event, options) {
        Ext.create('Ext.menu.Menu', {
            width: 100,
            height: 100,
            margin: '0 0 10 0',
            items: [{
                text: 'regular item 1'
            },{
                text: 'regular item 2'
            },{
                text: 'regular item 3'
            }]
        }).showAt(event.getXY());
    }
}

Parameters

x :  Number/Number[]/Object

The new x position or array of [x,y], or an object {x:10, y:10}.

y :  Number (optional)

The new y position.

Returns

:Ext.Component

this

showBy ( component, [alignment], [options] )

Shows this component by another component. If you specify no alignment, it will automatically position this component relative to the reference component depending upon the alignment parameter.

The alignment parameter describes the edge-to-edge alignment of this component with the target. It can be specified thus:

  • Blank: Defaults to positioning where the component will fit trying 'l-r?', 'r-l?', 'b-t?' then 't-b?' in that order.
  • Two anchors: If two values from the table below are passed separated by a dash, the first value is used as the element's anchor point, and the second value is used as the target's anchor point.
  • Two edge/offset descriptors: An edge/offset descriptor is an edge initial (t/r/b/l) followed by a percentage along that side. This describes a point to align with a similar point in the target. So 't0-b0' would be the same as 'tl-bl', 'l0-r50' would place the top left corner of this item halfway down the right edge of the target item. This allows more flexibility and also describes which two edges are considered adjacent when positioning a tip pointer.

Following are all of the supported predefined anchor positions:

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

You can put a '?' at the end of the alignment string to constrain the positioned element to the Ext.Viewport. The element will attempt to align as specified, but the position will be adjusted to constrain to the viewport if necessary. Note that the element being aligned might be swapped to align to a different position than that specified in order to enforce the viewport constraints.

Example Usage:

// show `panel` by `button` using the default positioning (auto fit)
panel.showBy(button);

// align the top left corner of `panel` with the top right corner of `button`
// (constrained to viewport)
panel.showBy(button, "tl-tr?");

// align the bottom right corner of `panel` with the center left edge of `button`
// (not constrained by viewport)
panel.showBy(button, "br-cl");

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

// align the 25% point on the bottom edge of this panel
// with the 75% point on the top edge of button.
panel.showBy(button, 'b25-t75');

Parameters

component :  Ext.Component

The target component to show this component by.

alignment :  String (optional)

The alignment string, eg: 'tl-bl'.

options :  Object/Array (optional)

An object containing options for the Ext.util.Region#alignTo method, if an Array is used, it will be assumed to be the offset.

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.

syncTriggers
private pri

Synchronizes the DOM to match the triggers' configured weight, side, and grouping

toggleInvalidCls ( hasError )
private pri

Add/remove invalid class(es)

Parameters

hasError :  Boolean

transformRawValue ( value ) : Object
protected pro

Transform the raw value before it is set

Available since: 7.0

Parameters

value :  Object

The value

Returns

:Object

The value to set

transformStatefulConfig ( instanceConfig, configurator ) : Object
private pri

This method is called internally by initConfig to apply whatever changes are needed from persistent storage.

Parameters

instanceConfig :  Object

The base config object

configurator :  Ext.Configurator

Returns

:Object

The config object to use.

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

updateComponent ( newComponent, oldComponent )
private pri

Parameters

newComponent :  Object

oldComponent :  Object

updateData ( newData )
private pri

Parameters

newData :  Object

updateSession ( session )
private pri

Updates the session config.

Parameters

session :  Ext.data.Session

updateViewModel ( viewModel, oldViewModel )
private pri

Updates the viewModel config.

Parameters

viewModel :  Ext.app.ViewModel

oldViewModel :  Ext.app.ViewModel

validate Boolean

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

Returns

:Boolean

The new validity state.

whenVisible ( fn, [args] ) : Boolean
private pri

Queue a function to run when the component is visible & painted. If those conditions are met, the function will execute immediately, otherwise it will wait until it is visible and painted.

Parameters

fn :  String

The function to execute on this component.

args :  Object[] (optional)

The arguments to pass.

Returns

:Boolean

true if the function was executed immediately.

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 ( sender, container, index, eOpts )

Fires after a Component had been added to a Container.

Parameters

sender :  Ext.Component

The component firing this event.

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 ( sender, eOpts )

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

Parameters

sender :  Ext.Component

The component firing this event.

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.

onBeforeOrientationChange
removed rem

Fires before orientation changes.

This method has been REMOVED since 2.0.0

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 ( sender, eOpts )

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

Parameters

sender :  Ext.Component

The component firing this event.

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, event, eOpts )

Fires when this Component's focusEl loses focus.

Parameters

this :  Ext.Component

event :  Ext.event.Event

The blur 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 the value has changed.

Parameters

this :  Ext.field.Field

This field

newValue :  String

The new value

oldValue :  String

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

onDestroy

Fires when the component is destroyed

onDirtyChange : function ( this, dirty, eOpts )

Fires when a change in the component's cfg-dirty state is detected.

For containers, this event will be fired on a short delay in some cases.

Available since: 7.0

Parameters

this :  Ext.Component

dirty :  Boolean

True if the component is now dirty.

eOpts : Object

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

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 ( sender, 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

sender :  Ext.Component

The component firing this event.

eOpts : Object

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

onErrorChange : function ( this, error, eOpts )

Fires when the active error message changes.

Available since: 6.5.0

Parameters

this :  Ext.field.Field

error :  String

The current error message

eOpts : Object

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

onFloatingChange : function ( sender, positioned, eOpts )
deprecated dep

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

Parameters

sender :  Ext.Component

The component firing this event.

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.

Deprecated since version 6.2.0
Use positionedchange instead

onFocus : function ( this, event, eOpts )

Fires when this Component's focusEl receives focus.

Parameters

this :  Ext.Component/Ext.Widget

event :  Ext.event.Event

The focus 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 ( sender, eOpts )

Fires whenever a Component with the fullscreen config is instantiated

Parameters

sender :  Ext.Component

The component firing this event.

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 ( sender, eOpts )

Fires whenever the Component is hidden

Parameters

sender :  Ext.Component

The component firing this event.

eOpts : Object

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

onInitialize : function ( sender, eOpts )

Fires when the component has been initialized

Parameters

sender :  Ext.Component

The component firing this event.

eOpts : Object

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

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

Fires when a key is pressed on the input element

Available since: 7.0

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.

onKeyUp : function ( e, eOpts )

Fires whenever keyup is detected.

Parameters

e :  Ext.event.Event

The event object.

eOpts : Object

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

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.

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

Fires whenever a mask is tapped.

Parameters

this :  Ext.field.Input

e :  Ext.event.Event

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

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 ( e, eOpts )

Fires whenever the input has a mousedown occur.

Parameters

e :  Ext.event.Event

The event object.

eOpts : Object

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

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

Fires when a component si moved within its Container.

Parameters

sender :  Ext.Component

The component firing this event.

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.

onOrientationChange
removed rem

Fires when orientation changes.

This method has been REMOVED since 2.0.0

onPainted : function ( sender, 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

sender :  Ext.Component

The component firing this event.

element :  Ext.dom.Element

The component's outer element (this.element)

eOpts : Object

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

onPaste : function ( e, eOpts )

Fires whenever paste is detected.

Parameters

e :  Ext.event.Event

The event object.

eOpts : Object

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

onPositionedChange : function ( sender, positioned, eOpts )

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

Parameters

sender :  Ext.Component

The component firing this event.

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 ( sender, container, index, eOpts )

Fires when a component is removed from a Container

Parameters

sender :  Ext.Component

The component firing this event.

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 ( element, info, eOpts )

Important note: For the best performance on mobile devices, use this only when you absolutely need to monitor a Element's size.

Note: This event is not available to be used with event delegation. Instead resize 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).

info :  Object

The component's new size parameters.

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 ( sender, eOpts )

Fires whenever the Component is shown

Parameters

sender :  Ext.Component

The component firing this event.

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.

onUpdateData : function ( sender, newData, eOpts )

Fires whenever the data of the component is updated

Parameters

sender :  Ext.Component

The component firing this event.

newData :  Object

The new data

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.

ExtReact 6.7.0