ExtReact Docs Help

Introduction

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

Terms, Icons, and Labels

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

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

Access Levels

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

Member Types

Member Syntax

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

lookupComponent ( item ) : Ext.Component
protected

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

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

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

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

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

Member Flags

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

Class Icons

- Indicates a framework class

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

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

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

Member Icons

- Indicates a class member of type config

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

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

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

Class Member Quick-Nav Menu

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

Getter and Setter Methods

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

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

History Bar

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

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

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

Search and Filters

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

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

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

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

API Doc Class Metadata

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

Expanding and Collapsing Examples and Class Members

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

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

Desktop -vs- Mobile View

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

Viewing the Class Source

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

ExtReact 6.5.1


top

Ext.field.trigger.Reveal xtype: revealtrigger, trigger.reveal

No members found using the current filters

configs

Optional Configs

alwaysOnTop : Boolean / Number
bindable bind

A flag indicating that this component should be above its floated siblings.

This may be a positive number to prioritize the ordering of multiple visible always on top components.

This may be set to a negative number to prioritize a component to the bottom of the z-index stack.

Defaults to:

false

Available since: 6.2.0

getAlwaysOnTop : Boolean / Number

Returns the value of alwaysOnTop

Returns

Boolean / Number

setAlwaysOnTop (alwaysOnTop)

Sets the value of alwaysOnTop

Parameters

alwaysOnTop :  Boolean / Number

ariaAttributes : Object
bindable bind

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.

getAriaAttributes : Object

Returns the value of ariaAttributes

Returns

Object

setAriaAttributes (ariaAttributes)

Sets the value of ariaAttributes

Parameters

ariaAttributes :  Object

ariaDescribedBy : String

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

ariaLabel : String

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

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.

border : Boolean
bindable bind

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

getBorder : Boolean

Returns the value of border

Returns

Boolean

setBorder (border)

Sets the value of border

Parameters

border :  Boolean

cls : String / String[]
bindable bind

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

getCls : String / String[]

Returns the value of cls

Returns

String / String[]

setCls (cls)

Sets the value of cls

Parameters

cls :  String / String[]

constrainAlign : String / Ext.util.Region / Ext.dom.Element
bindable bind

A specification of the constraint to apply when showBy or alignTo is called to align a floated or positioned component.

Defaults to the parent container for positioned components (components which have their top, right, bottom or left set to move them out of their container's layout flow).

Defaults to the viewport for floated components.

May be a Ext.ComponentQuery selector to find an ancestor component to constrain within.

May be false to specify that constraining is not applied.

You may also specify an element, or a Ext.util.Region

setConstrainAlign (constrainAlign)

Sets the value of constrainAlign

Parameters

constrainAlign :  String / Ext.util.Region / Ext.dom.Element

disabled : Boolean
bindable bind

Whether or not this component is disabled

Defaults to:

null

getDisabled : Boolean

Returns the value of disabled

Returns

Boolean

setDisabled (disabled)

Sets the value of disabled

Parameters

disabled :  Boolean

flex : Number / String / Object
bindable bind

The flex of this item if this item item is inside a Ext.layout.HBox or Ext.layout.VBox layout.

You can also update the flex of a component dynamically using the Ext.layout.FlexBox#setItemFlex method.

When supplied as a string or number this option supports the same syntax as CSS flex. For example:

flex: '1 2 auto'

sets flex-grow property to 0, flex-shrink to 2 and flex-basis to 'auto'.

The default flex-shrink value for box layout items is set to 0 in the stylesheet, which is different from the browser's default flex-shrink value of 1. This accommodates the majority use case for applications since where non-flexed components are typically not expected to shrink smaller than their default size.

For convenience when only a single number is supplied it is used as the value for both flex-grow and flex-shrink, for example flex: 3 is the same as flex: '3 3'

An object form is also accepted:

flex: {
    grow: 1,
    shrink: 2,
    basis: 'auto'
}

When the object form is supplied shrink always defaults to 0 regardless of the value of grow.

Although 'auto' is the default value for flex-basis, flex-basis defaults to 0% when flex is supplied as a single numeric or string value (e.g. flex: 1). If this behavior is not desired either explicitly set flex-basis to 'auto' or use the object form to set only grow and/or shrink:

flex: {
    grow: 2
}

getFlex : Number / String / Object

Returns the value of flex

Returns

Number / String / Object

setFlex (flex)

Sets the value of flex

Parameters

flex :  Number / String / Object

floated : Boolean
bindable bind

A Component may be floated above all other components in the application. This means that the component is absolutely positioned, and will move to the front and occlude other sibling floated component if clicked.

A Floated component may have floated descendants. It will bring these decendants to the front with it when brought to the front of its sibling floated components.

By default, descendant floated components are all positioned using the viewport coordinate system. To make a floating component a positioning parent for descendants, and have the ancestors positioned relatively, configure the parent floated component with cfg-relative: true.

Defaults to:

false

Available since: 6.2.0

getFloated : Boolean

Returns the value of floated

Returns

Boolean

setFloated (floated)

Sets the value of floated

Parameters

floated :  Boolean

focusCls : String

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

Defaults to:

'x-focused'

focusOnTap : Boolean
bindable bind

If true, the field will be focused upon tap of the trigger.

To show the keyboard, tap the input field while it is focused.

Defaults to:

true

getFocusOnTap : Boolean

Returns the value of focusOnTap

Returns

Boolean

setFocusOnTap (focusOnTap)

Sets the value of focusOnTap

Parameters

focusOnTap :  Boolean

group : String

The name of an optional group trigger that this trigger belongs to. If no trigger Exists by that name one will automatically be created. A group trigger is a special trigger that contains other triggers. Those triggers' elements are appended to the group trigger's element in the DOM.

The weight of grouped triggers is relative to other triggers in the group.

handler : Function / String
bindable bind

Function to run when trigger is clicked or tapped.

Defaults to:

null

getHandler : Function / String

Returns the value of handler

Returns

Function / String

setHandler (handler)

Sets the value of handler

Parameters

handler :  Function / String

height : Number / String
bindable bind

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

getHeight : Number / String

Returns the value of height

Returns

Number / String

setHeight (height)

Sets the value of height

Parameters

height :  Number / String

hidden : Boolean
bindable bind

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

Defaults to true for floated Components.

Defaults to:

null

getHidden : Boolean

Returns the value of hidden

Returns

Boolean

setHidden (hidden)

Sets the value of hidden

Parameters

hidden :  Boolean

hideMode : 'clip' / 'display' / 'offsets' / 'opacity' / 'visibility'
bindable bind

A String which specifies how this component's DOM element will be hidden. The accepted values are any of these:

Hiding using display results in having no dimensions as well as resetting scroll positions to 0.

The other modes overcome this but may have different trade-offs in certain circumstances.

Defaults to:

'display'

Available since: 6.5.0

getHideMode : 'clip' / 'display' / 'offsets' / 'opacity' / 'visibility'

Returns the value of hideMode

Returns

'clip' / 'display' / 'offsets' / 'opacity' / 'visibility'

setHideMode (hideMode)

Sets the value of hideMode

Parameters

hideMode :  'clip' / 'display' / 'offsets' / 'opacity' / 'visibility'

iconCls : String
bindable bind

One or more space separated CSS classes to be applied to the icon element. The CSS rule(s) applied should specify a background image to be used as the icon.

An example of specifying a custom icon class would be something like:

// specify the property in the prop for the class:
iconCls="my-home-icon"

// css rule specifying the background image to be used as the icon image:
.my-home-icon {
    background-image: url(../images/my-home-icon.gif) !important;
}

In addition to specifying your own classes, you can use the font icons provided in the SDK using the following syntax:

// using Font Awesome
iconCls="x-fa fa-home"

// using Pictos
iconCls="pictos pictos-home"

Depending on the theme you're using, you may need include the font icon packages in your application in order to use the icons included in the SDK. For more information see:

Defaults to:

null

getIconCls : String

Returns the value of iconCls

Returns

String

setIconCls (iconCls)

Sets the value of iconCls

Parameters

iconCls :  String

id : String

The unique id of this component instance.

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

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

Note that this id will also be used as the element id for the containing HTML element that is rendered to the page for this component. This allows you to write id-based CSS rules to style the specific instance of this component uniquely, and also to select sub-elements using this component's id as the parent.

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

Defaults to an auto-assigned id.

getId String

Retrieves the id of this component. Will autogenerate an id if one has not already been set.

Returns

:String

id

itemId : String
bindable bind

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

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

getItemId : String

Returns the value of itemId

Returns

String

setItemId (itemId)

Sets the value of itemId

Parameters

itemId :  String

keyMap : Object
bindable bind

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

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

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

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

Properties

scope : String

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

getKeyMap : Object

Returns the value of keyMap

Returns

Object

setKeyMap (keyMap)

Sets the value of keyMap

Parameters

keyMap :  Object

keyMapEnabled : Boolean
bindable bind

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

getKeyMapEnabled : Boolean

Returns the value of keyMapEnabled

Returns

Boolean

setKeyMapEnabled (keyMapEnabled)

Sets the value of keyMapEnabled

Parameters

keyMapEnabled :  Boolean

listeners : Object
bindable bind

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

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

name : String

Name for the widget to be used with Ext.Container#lookupName et al.

Defaults to:

null

plugins : Object / String / Object[] / String[]
bindable bind

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

Plugins should derive from Ext.plugin.Abstract but this is not required. The only requirement for a valid plugin is that it contain an init() method that accepts a reference to the owning component.

When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.

Example code

A plugin by alias:

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

     plugins: 'listpaging'
 });

Multiple plugins by alias:

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

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

Single plugin by class name with config options:

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

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

Multiple plugins by type and class name with config options:

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

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

getPlugins : Object / String / Object[] / String[]

Returns the value of plugins

Returns

Object / String / Object[] / String[]

setPlugins (plugins)

Sets the value of plugins

Parameters

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

relative : Boolean
bindable bind

Only valid when a component is cfg-floated

Configure this as true if you require descendant floated components to be positioned relative to this component's coordinate space, not the viewport's coordinate space.

Note: The coordinate space is this Component's encapsulating element's area. Not that of the inner element in which static child items are rendered by the layout.

Defaults to:

false

Available since: 6.2.0

getRelative : Boolean

Returns the value of relative

Returns

Boolean

setRelative (relative)

Sets the value of relative

Parameters

relative :  Boolean

renderTo : Ext.dom.Element

Optional element to render this Component to. Not required if this component is an item of a Container of a Container.

Defaults to:

true

repeat : Boolean / Object
bindable bind

true to attach a Ext.util.ClickRepeater to the trigger, or a config object for a tap repeater.

Defaults to:

null

getRepeat : Boolean / Object

Returns the value of repeat

Returns

Boolean / Object

setRepeat (repeat)

Sets the value of repeat

Parameters

repeat :  Boolean / Object

ripple : Boolean / Object / String
bindable bind

Set to truthy, Color or Object value for the ripple.

Available since: 6.5.0

Properties

color : String

The background color of the ripple.

position : Array

Position for the ripple to start at [x,y]. Determines if a Ripple effect should happen whenever this element is pressed.

For example: { ripple: true }

Or:

 {
     ripple: {
         color: 'red'
     }
 }

For complex components, individual elements can suppress ripples by adding the x-no-ripple class to disable rippling for a tree of elements.

getRipple : Boolean / Object / String

Returns the value of ripple

Returns

Boolean / Object / String

setRipple (ripple)

Sets the value of ripple

Parameters

ripple :  Boolean / Object / String

scope : Object
bindable bind

Execution context for the handler function.

Defaults to:

null

getScope : Object

Returns the value of scope

Returns

Object

setScope (scope)

Sets the value of scope

Parameters

scope :  Object

selfAlign : String
bindable bind

Specifies the self alignment of this widget in a box layout

getSelfAlign : String

Returns the value of selfAlign

Returns

String

setSelfAlign (selfAlign)

Sets the value of selfAlign

Parameters

selfAlign :  String

shadow : Boolean
bindable bind

Configure as true for the component to have a drop shadow. 'false' will suppress any default shadow. By default the theme will determine the presence of a shadow.

Available since: 6.2.0

getShadow : Boolean

Returns the value of shadow

Returns

Boolean

setShadow (shadow)

Sets the value of shadow

Parameters

shadow :  Boolean

shim : Boolean
bindable bind

Only valid when a component is cfg-floated

Configure as true for the component to use an <iframe> as an underlay to ensure certain non-standard browser plugins are occluded by this component.

Defaults to:

false

Available since: 6.2.0

getShim : Boolean

Returns the value of shim

Returns

Boolean

setShim (shim)

Sets the value of shim

Parameters

shim :  Boolean

side : 'left' / 'right'

The side of the text field's input to render the trigger on.

Defaults to:

'right'

style : String / Object
bindable bind

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

setStyle (style)

Sets the value of style

Parameters

style :  String / Object

toFrontOnShow : Boolean
bindable bind

True to automatically call toFront when a cfg-floated Component is shown.

Defaults to:

true

getToFrontOnShow : Boolean

Returns the value of toFrontOnShow

Returns

Boolean

setToFrontOnShow (toFrontOnShow)

Sets the value of toFrontOnShow

Parameters

toFrontOnShow :  Boolean

touchAction : Object

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:

true

ui : String / String[]

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:

true

userCls : String / String[]

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:

true

width : Number / String
bindable bind

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

getWidth : Number / String

Returns the value of width

Returns

Number / String

setWidth (width)

Sets the value of width

Parameters

width :  Number / String

x : Number
bindable bind

Only valid when a component is cfg-floated

The x position at which to position this component. This is usually viewport-relative. But if there is a relative: true ancestor, it will be relative to that.

Defaults to:

0

getX : Number

Returns the value of x

Returns

Number

setX (x)

Sets the value of x

Parameters

x :  Number

y : Number
bindable bind

Only valid when a component is cfg-floated

The x position at which to position this component. This is usually viewport-relative. But if there is a relative: true ancestor, it will be relative to that.

Defaults to:

0

getY : Number

Returns the value of y

Returns

Number

setY (y)

Sets the value of y

Parameters

y :  Number

properties

Instance Properties

factoryConfig : Object

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

focusClsEl : Ext.dom.Element

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

focusEl : Ext.dom.Element

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'

isObservable : Boolean

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

Defaults to:

true

methods

Instance Methods

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

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

myGridPanel.on("itemclick", this.onItemClick, this);

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

myGridPanel.on({
    cellclick: this.onCellClick,
    select: this.onSelect,
    viewready: this.onViewReady,
    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

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

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

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

Parameters

eventName :  String/Object

The name of the event to listen for. May also be an object who's property names are event names.

fn :  Function/String (optional)

The method the event invokes or the name of the method within the specified scope. Will be called with arguments given to Ext.util.Observable#fireEvent plus the options parameter described below.

scope :  Object (optional)

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

options :  Object (optional)

An object containing handler configuration.

Note: The options object will also be passed as the last argument to every event handler.

This object may contain any of the following properties:

scope :  Object

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

delay :  Number

The number of milliseconds to delay the invocation of the handler after the event fires.

single :  Boolean

True to add a handler to handle just the next firing of the event, and then remove itself.

buffer :  Number

Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

onFrame :  Number

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

target :  Ext.util.Observable

Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

element :  String

This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.

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

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

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

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

 panel.body.un(...)

delegate :  String (optional)

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

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

See the delegate example below.

capture :  Boolean (optional)

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

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

stopPropagation :  Boolean (optional)

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

preventDefault :  Boolean (optional)

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

stopEvent :  Boolean (optional)

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

args :  Array (optional)

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

destroyable :  Boolean (optional)

When specified as true, the function returns a destroyable object. An object which implements the destroy method which removes all listeners added in this call. This syntax can be a helpful shortcut to using un; particularly when removing multiple listeners. NOTE - not compatible when using the element option. See un for the proper syntax for removing listeners added using the element config.

Defaults to:

false

priority :  Number (optional)

An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.

order :  String (optional)

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

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

Defaults to:

'current'

order :  String (optional)

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

Combining Options

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

A delayed, one-time listener.

myPanel.on('hide', this.handleClick, this, {
    single: true,
    delay: 100
});

Attaching multiple handlers in 1 call

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

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

Delegate

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

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

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

Defaults to: 'current'

Returns

:Object

Only when the destroyable option is specified.

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

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

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

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

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

Example:

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

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

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

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

Parameters

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

The item to which to add a listener/listeners.

ename :  Object/String

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

fn :  Function/String (optional)

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

scope :  Object (optional)

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

options :  Object (optional)

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

Returns

:Object

Only when the destroyable option is specified.

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

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

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

addPlugin ( plugin )

Adds a plugin. For example:

 list.addPlugin('pullrefresh');

Or:

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

Available since: 6.2.0

Parameters

plugin :  Object/String/Ext.plugin.Abstract

The plugin or config object or alias to add.

clearListeners

Removes all listeners for this object including the managed listeners

clearManagedListeners

Removes all managed listeners for this object.

destroyPlugin ( plugin ) : Ext.plugin.Abstract

Removes and destroys a plugin.

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

Available since: 6.2.0

Parameters

plugin :  String/Ext.plugin.Abstract

The plugin or its id to remove.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

enableBubble ( eventNames )

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. There is no implementation in the Observable base class.

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component#getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

Example:

Ext.define('Ext.overrides.form.field.Base', {
    override: 'Ext.form.field.Base',

    //  Add functionality to Field's initComponent to enable the change event to bubble
    initComponent: function () {
        this.callParent();
        this.enableBubble('change');
    }
});

var myForm = Ext.create('Ext.form.Panel', {
    title: 'User Details',
    items: [{
        ...
    }],
    listeners: {
        change: function() {
            // Title goes red if form has been modified.
            myForm.header.setStyle('color', 'red');
        }
    }
});

Parameters

eventNames :  String/String[]

The event name to bubble, or an Array of event names.

findPlugin ( type ) : Ext.plugin.Abstract

Retrieves plugin by its type alias. For example:

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

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

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

Note: See also getPlugin.

Available since: 6.2.0

Parameters

type :  String

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

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

fireEvent ( eventName, args ) : Boolean

Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addListener).

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component#getBubbleTarget) by calling enableBubble.

Parameters

eventName :  String

The name of the event to fire.

args :  Object...

Variable number of parameters are passed to handlers.

Returns

:Boolean

returns false if any of the handlers return false otherwise it returns true.

fireEventArgs ( eventName, args ) : Boolean

Fires the specified event with the passed parameter list.

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component#getBubbleTarget) by calling enableBubble.

Parameters

eventName :  String

The name of the event to fire.

args :  Object[]

An array of parameters which are passed to handlers.

Returns

:Boolean

returns false if any of the handlers return false otherwise it returns true.

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

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

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

Parameters

eventName :  String

The name of the event to fire.

args :  Array

Arguments to pass to handlers and to the action function.

fn :  Function/String

The action function.

scope :  Object (optional)

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

fnArgs :  Array/Boolean (optional)

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

focus ( [selectText] ) : Boolean

Try to focus this component.

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

Parameters

selectText :  Boolean/Number[] (optional)

If applicable, true to also select all the text in this component, or an array consisting of start and end (defaults to start) position of selection.

Returns

:Boolean

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

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.

getPlugin ( id ) : Ext.plugin.Abstract

Retrieves a plugin by its id.

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

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

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

Note: See also findPlugin.

Available since: 6.2.0

Parameters

id :  String

The id of the plugin.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

getTabIndex Number

Return the actual tabIndex for this Focusable.

Returns

:Number

tabIndex attribute value

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

isAncestor ( possibleDescendant )

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

Parameters

possibleDescendant :  Ext.Component

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

isDescendantOf ( ancestor ) : Boolean

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

Parameters

ancestor :  Ext.Component

A Component which may contain this Component.

Returns

:Boolean

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

isFocusable ( [deep] ) : Boolean

Determine if this Focusable can receive focus at this time.

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

Parameters

deep :  Boolean (optional)

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

Defaults to: false

Returns

:Boolean

True if component is focusable, false if not.

isSuspended ( [event] ) : Boolean

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

Parameters

event :  String (optional)

The name of the specific event to check

Returns

:Boolean

true if events are suspended

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.

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.

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

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

For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:

this.relayEvents(this.getStore(), ['load']);

The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword (unless the event is handled by a controller's control/listen event listener in which case 'this' will be the controller rather than the grid).

Parameters

origin :  Object

The Observable whose events this object is to relay.

events :  String[]/Object

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

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

prefix :  String (optional)

A common prefix to prepend to the event names. For example:

this.relayEvents(this.getStore(), ['load', 'clear'], 'store');

Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.

Returns

:Object

A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:

this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');

Can be undone by calling

Ext.destroy(this.storeRelayers);

or this.store.relayers.destroy();

removeListener ( eventName, fn, [scope] )

Removes an event handler.

Parameters

eventName :  String

The type of event the handler was associated with.

fn :  Function

The handler to remove. This must be a reference to the function passed into the addListener call.

scope :  Object (optional)

The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable#addListener or the listener will not be removed.

Convenience Syntax

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

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

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

Exception - DOM event handlers using the element config option

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

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

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

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

Removes listeners that were added by the mon method.

Parameters

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

The item from which to remove a listener/listeners.

ename :  Object/String

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

fn :  Function (optional)

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

scope :  Object (optional)

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

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

Removes and (optionally) destroys a plugin.

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

Available since: 6.2.0

Parameters

plugin :  String/Ext.plugin.Abstract

The plugin or its id to remove.

destroy :  Boolean (optional)

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

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

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.

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

suspendEvent ( eventName )

Suspends firing of the named event(s).

After calling this method to suspend events, the events will no longer fire when requested to fire.

Note that if this is called multiple times for a certain event, the converse method resumeEvent will have to be called the same number of times for it to resume firing.

Parameters

eventName :  String...

Multiple event names to suspend.

suspendEvents ( queueSuspended )

Suspends the firing of all events. (see resumeEvents)

Parameters

queueSuspended :  Boolean

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

un ( eventName, fn, [scope] )

Shorthand for removeListener. Removes an event handler.

Parameters

eventName :  String

The type of event the handler was associated with.

fn :  Function

The handler to remove. This must be a reference to the function passed into the addListener call.

scope :  Object (optional)

The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable#addListener or the listener will not be removed.

Convenience Syntax

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

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

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

Exception - DOM event handlers using the element config option

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

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

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

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

Removes a before-event handler.

Same as removeListener with order set to 'after'.

Parameters

eventName :  String/String[]/Object

The name of the event the handler was associated with.

fn :  Function/String

The handler to remove.

scope :  Object (optional)

The scope originally specified for fn.

options :  Object (optional)

Extra options object.

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

Removes a before-event handler.

Same as removeListener with order set to 'before'.

Parameters

eventName :  String/String[]/Object

The name of the event the handler was associated with.

fn :  Function/String

The handler to remove.

scope :  Object (optional)

The scope originally specified for fn.

options :  Object (optional)

Extra options object.

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

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

Example:

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

Parameters

selector :  String (optional)

The simple selector to test.

limit :  String/Number/Ext.Component (optional)

This may be a selector upon which to stop the upward scan, or a limit of the number of steps, or Component reference to stop on.

Returns

:Ext.Container

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

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

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

beforeflexchange ( sender, value, oldValue, eOpts ) : Boolean

This event fires when flex changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String/Object

The current value of flex.

oldValue :  Number/String/Object

The previous value of flex.

eOpts : Object

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

Returns

:Boolean

Return false to cancel the change.

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

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

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

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

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

flexchange ( sender, value, oldValue, eOpts )

This event fires when flex changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String/Object

The current value of flex.

oldValue :  Number/String/Object

The previous value of flex.

eOpts : Object

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

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

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

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

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

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

widthchange ( sender, value, oldValue, eOpts )

This event fires when width changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of width.

oldValue :  Number/String

The previous value of width.

eOpts : Object

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

theme variables

$revealtrigger-background-color : color

Reveal Trigger background-color

Defaults to:

null

$revealtrigger-hovered-background-color : color

Reveal Trigger background-color when hovered

Defaults to:

null

$revealtrigger-hovered-icon-background-color : color

Reveal Trigger icon background-color when hovered

Defaults to:

null

$revealtrigger-hovered-icon-color : color

Reveal Trigger icon color when hovered

Defaults to:

null

$revealtrigger-icon : String

Reveal Trigger icon

Defaults to:

$fa-var-eye

$revealtrigger-icon-background-color : color

Reveal Trigger icon background-color

Defaults to:

null

$revealtrigger-icon-border-radius : Number / list

Reveal Trigger icon border-radius

Defaults to:

null

$revealtrigger-icon-color : color

Reveal Trigger icon color

Defaults to:

null

$revealtrigger-icon-font-size : Number

Reveal Trigger icon font-size

Defaults to:

null

$revealtrigger-icon-font-size-big : Number

Reveal Trigger icon font-size in the big sizing scheme

Defaults to:

null

$revealtrigger-icon-size : Number

Reveal Trigger icon size

Defaults to:

null

$revealtrigger-icon-size-big : Number

Reveal Trigger icon size in the big sizing scheme

Defaults to:

null

$revealtrigger-pressed-background-color : color

Reveal Trigger background-color when pressed

Defaults to:

null

$revealtrigger-pressed-icon-background-color : color

Reveal Trigger icon background-color when pressed

Defaults to:

null

$revealtrigger-pressed-icon-color : color

Reveal Trigger icon color when pressed

Defaults to:

null

$revealtrigger-width : Number

Reveal Trigger width

Defaults to:

null

$revealtrigger-width-big : Number

Reveal Trigger width in the big sizing scheme

Defaults to:

null

$trigger-alt-ui : map

Parameters for the "alt" textfield trigger UI.

$trigger-background-color : color

Trigger background-color

Defaults to:

null

$trigger-faded-ui : map

Parameters for the "faded" textfield trigger UI.

$trigger-grouped-align : 'horizontal' / 'vertical'

The alignment of grouped triggers

Defaults to:

vertical

$trigger-grouped-align-big : 'horizontal' / 'vertical'

The alignment of grouped triggers in the big sizing scheme

Defaults to:

horizontal

$trigger-hovered-background-color : color

Trigger background-color when hovered

Defaults to:

null

$trigger-hovered-icon-background-color : color

Trigger icon background-color when hovered

Defaults to:

null

$trigger-hovered-icon-color : color

Trigger icon color when hovered

Defaults to:

mix(#000, $trigger-icon-color, 8%)

$trigger-icon : String

Trigger icon

Defaults to:

$fa-var-caret-down

$trigger-icon-background-color : color

Trigger icon background-color

Defaults to:

null

$trigger-icon-border-radius : Number / list

Trigger icon border-radius

Defaults to:

null

$trigger-icon-color : color

Trigger icon color

Defaults to:

$neutral-dark-color

$trigger-icon-font-size : Number

Trigger icon font-size

Defaults to:

null

$trigger-icon-font-size-big : Number

Trigger icon font-size in the big sizing scheme

Defaults to:

null

$trigger-icon-size : Number

Trigger icon size

Defaults to:

16px

$trigger-icon-size-big : Number

Trigger icon size in the big sizing scheme

Defaults to:

20px

$trigger-pressed-background-color : color

Trigger background-color when pressed

Defaults to:

null

$trigger-pressed-icon-background-color : color

Trigger icon background-color when pressed

Defaults to:

null

$trigger-pressed-icon-color : color

Trigger icon color when pressed

Defaults to:

mix(#000, $trigger-icon-color, 15%)

$trigger-solo-ui : map

Parameters for the "solo" textfield trigger UI.

$trigger-width : Number

Trigger width

Defaults to:

22px

$trigger-width-big : Number

Trigger width in the big sizing scheme

Defaults to:

30px

theme mixins

revealtrigger-ui ( ...list... )

Creates a visual theme for a Reveal Trigger.

Parameters

$ui :  String

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

$xtype :  String (optional)

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

Defaults to: revealtrigger

$width :  Number

Reveal Trigger width

$width-big :  Number

Reveal Trigger width in the big sizing scheme

$background-color :  color

Reveal Trigger background-color

$hovered-background-color :  color

Reveal Trigger background-color when hovered

$pressed-background-color :  color

Reveal Trigger background-color when pressed

$icon :  String

Reveal Trigger icon

$icon-color :  color

Reveal Trigger icon color

$hovered-icon-color :  color

Reveal Trigger icon color when hovered

$pressed-icon-color :  color

Reveal Trigger icon color when pressed

$icon-background-color :  color

Reveal Trigger icon background-color

$hovered-icon-background-color :  color

Reveal Trigger icon background-color when hovered

$pressed-icon-background-color :  color

Reveal Trigger icon background-color when pressed

$icon-border-radius :  Number/list

Reveal Trigger icon border-radius

$icon-size :  Number

Reveal Trigger icon size

$icon-size-big :  Number

Reveal Trigger icon size in the big sizing scheme

$icon-font-size :  Number

Reveal Trigger icon font-size

$icon-font-size-big :  Number

Reveal Trigger icon font-size in the big sizing scheme

trigger-ui ( ...list... )

Creates a visual theme for a Trigger.

Parameters

$ui :  String

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

$xtype :  String (optional)

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

Defaults to: trigger

$width :  Number

Trigger width

$width-big :  Number

Trigger width in the big sizing scheme

$background-color :  color

Trigger background-color

$hovered-background-color :  color

Trigger background-color when hovered

$pressed-background-color :  color

Trigger background-color when pressed

$icon :  String

Trigger icon

$icon-color :  color

Trigger icon color

$hovered-icon-color :  color

Trigger icon color when hovered

$pressed-icon-color :  color

Trigger icon color when pressed

$icon-background-color :  color

Trigger icon background-color

$hovered-icon-background-color :  color

Trigger icon background-color when hovered

$pressed-icon-background-color :  color

Trigger icon background-color when pressed

$icon-border-radius :  Number/list

Trigger icon border-radius

$icon-size :  Number

Trigger icon size

$icon-size-big :  Number

Trigger icon size in the big sizing scheme

$icon-font-size :  Number

Trigger icon font-size

$icon-font-size-big :  Number

Trigger icon font-size in the big sizing scheme

ExtReact 6.5.1