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.

ExtWebComponents 7.1.0


top
No members found using the current filters

configs

Optional Configs

alignSelf : String
bindable bind

Specifies the self alignment of this widget in a box layout

Defaults to:

null

getAlignSelf : String

Returns the value of alignSelf

Returns

String

setAlignSelf (alignSelf)

Sets the value of alignSelf

Parameters

alignSelf :  String

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.

Defaults to:

null

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.

background : Object
bindable bind

Background sprite config of the surface.

Defaults to:

null

getBackground : Object

Returns the value of background

Returns

Object

setBackground (background)

Sets the value of background

Parameters

background :  Object

bind : Object / String
bindable bind

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

getBind : Object / String

Returns the value of bind

Returns

Object / String

setBind (bind)

Sets the value of bind

Parameters

bind :  Object / String

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

Using style:

Ext.Viewport.add({
    centered: true,
    width: 100,
    height: 100,

    style: 'border: 1px solid blue;'
    // ...
});

Using CSS:

Ext.Viewport.add({
    centered: true,
    width: 100,
    height: 100,

    cls: 'my-component'
    // ...
});

And your CSS file:

.my-component {
    border: 1px solid red;
}

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

Defaults to:

null

setConstrainAlign (constrainAlign)

Sets the value of constrainAlign

Parameters

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

controller : String / Object / Ext.app.ViewController
bindable bind

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

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

setController (controller)

Sets the value of controller

Parameters

controller :  String / Object / Ext.app.ViewController

defaultListenerScope : Boolean
bindable bind

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

getDefaultListenerScope : Boolean

Returns the value of defaultListenerScope

Returns

Boolean

setDefaultListenerScope (defaultListenerScope)

Sets the value of defaultListenerScope

Parameters

defaultListenerScope :  Boolean

dirty : Boolean
bindable bind

Indicates whether the surface needs to redraw.

Defaults to:

false

getDirty : Boolean

Returns the value of dirty

Returns

Boolean

setDirty (dirty)

Sets the value of dirty

Parameters

dirty :  Boolean

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

eventHandlers : Object
deprecated dep bindable bind private pri

A map of event type to the corresponding handler method name. This is used internally by native event handling mechanism.

Defaults to:

{
    focus: 'handleFocusEvent',
    blur: 'handleBlurEvent'
}

Deprecated since version 6.6.0
Inline event handlers are deprecated

getEventHandlers : Object

Returns the value of eventHandlers

Returns

Object

setEventHandlers (eventHandlers)

Sets the value of eventHandlers

Parameters

eventHandlers :  Object

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
}

Defaults to:

null

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

flipRtlText : Boolean
bindable bind

If the surface is in the RTL mode, text will render with the RTL direction, but the alignment and position of the text won't change by default. Setting this config to 'true' will get text alignment and its position within a surface mirrored.

Defaults to:

false

getFlipRtlText : Boolean

Returns the value of flipRtlText

Returns

Boolean

setFlipRtlText (flipRtlText)

Sets the value of flipRtlText

Parameters

flipRtlText :  Boolean

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'

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'

highPrecision : Boolean
bindable bind

True to have the Canvas use JavaScript Number instead of single precision floating point for transforms.

For example, when using data with big numbers to plot line series, the transformation matrix of the canvas will have big elements. Due to the implementation of the SVGMatrix, the elements are represented by 32-bits floats, which will work incorrectly. To compensate for that, we enable the canvas context to perform all the transformations in JavaScript.

Do not use this if you are not encountering 32-bit floating point errors problem, since this will result in a performance penalty.

Defaults to:

false

getHighPrecision : Boolean

Returns the value of highPrecision

Returns

Boolean

setHighPrecision (highPrecision)

Sets the value of highPrecision

Parameters

highPrecision :  Boolean

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 <ext-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. This method Will auto-generate an id if one has not already been configured.

Returns

:String

id

instanceCls : String / String[]
bindable bind private pri

An extra CSS class or classes to augment the classCls on an individual instance

Defaults to:

null

Available since: 6.5.0

getInstanceCls : String / String[]

Returns the value of instanceCls

Returns

String / String[]

setInstanceCls (instanceCls)

Sets the value of instanceCls

Parameters

instanceCls :  String / String[]

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.

Defaults to:

undefined

getItemId : String

Returns the value of itemId

Returns

String

setItemId (itemId)

Sets the value of itemId

Parameters

itemId :  String

items : Array
bindable bind

Array of sprite instances.

Defaults to:

[]

getItems : Array

Returns the value of items

Returns

Array

setItems (items)

Sets the value of items

Parameters

items :  Array

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.

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.

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

keyMapTarget : String
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'

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

margin : Number / String
bindable bind

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

getMargin : Number / String

Returns the value of margin

Returns

Number / String

setMargin (margin)

Sets the value of margin

Parameters

margin :  Number / String

name : String

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

Defaults to:

null

nameable : Boolean

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

Defaults to:

false

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

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

setPlugins (plugins)

Sets the value of plugins

Parameters

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

publishes : String / String[] / Object
bindable bind

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

getPublishes : String / String[] / Object

Returns the value of publishes

Returns

String / String[] / Object

setPublishes (publishes)

Sets the value of publishes

Parameters

publishes :  String / String[] / Object

rect : Array
bindable bind

The [x, y, width, height] rect of the surface related to its container.

Defaults to:

null

getRect : Array

Returns the value of rect

Returns

Array

setRect (rect)

Sets the value of rect

Parameters

rect :  Array

reference : String

Specifies a name for this component inside its component hierarchy. This name must be unique within its view or its Ext.app.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

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
bindable bind

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

Defaults to:

null

getRenderTo : Ext.dom.Element

Returns the value of renderTo

Returns

Ext.dom.Element

setRenderTo (renderTo)

Sets the value of renderTo

Parameters

renderTo :  Ext.dom.Element

ripple : Boolean / Object / String
bindable bind

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

Defaults to:

null

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

session : Boolean / Object / Ext.data.Session
bindable bind

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

getSession : Boolean / Object / Ext.data.Session

Returns the value of session

Returns

Boolean / Object / Ext.data.Session

setSession (session)

Sets the value of session

Parameters

session :  Boolean / Object / Ext.data.Session

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.

Defaults to:

null

Available since: 6.2.0

getShadow : Boolean

Returns the value of shadow

Returns

Boolean

setShadow (shadow)

Sets the value of shadow

Parameters

shadow :  Boolean

shareableName : Boolean

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

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

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
bindable bind

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

getTouchAction : Object

Returns the value of touchAction

Returns

Object

setTouchAction (touchAction)

Sets the value of touchAction

Parameters

touchAction :  Object

translatable : Object
bindable bind private pri

Defaults to:

null

getTranslatable : Object

Returns the value of translatable

Returns

Object

setTranslatable (translatable)

Sets the value of translatable

Parameters

translatable :  Object

twoWayBindable : String / String[] / Object
bindable bind

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

getTwoWayBindable : String / String[] / Object

Returns the value of twoWayBindable

Returns

String / String[] / Object

setTwoWayBindable (twoWayBindable)

Sets the value of twoWayBindable

Parameters

twoWayBindable :  String / String[] / Object

ui : String / String[]
bindable bind

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

getUi : String / String[]

Returns the value of ui

Returns

String / String[]

setUi (ui)

Sets the value of ui

Parameters

ui :  String / String[]

userCls : String / String[]
bindable bind

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

getUserCls : String / String[]

Returns the value of userCls

Returns

String / String[]

setUserCls (userCls)

Sets the value of userCls

Parameters

userCls :  String / String[]

viewModel : String / Object / Ext.app.ViewModel
bindable bind

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

getViewModel : String / Object / Ext.app.ViewModel

Returns the value of viewModel

Returns

String / Object / Ext.app.ViewModel

setViewModel (viewModel)

Sets the value of viewModel

Parameters

viewModel :  String / Object / Ext.app.ViewModel

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

$className
private pri

Defaults to:

'Ext.Base'

$configPrefixed : Boolean
private pri

The value true causes config values to be stored on instances using a property name prefixed with an underscore ("_") character. A value of false stores config values as properties using their exact name (no prefix).

Defaults to:

true

Available since: 5.0.0

$configStrict : Boolean
private pri

The value true instructs the initConfig method to only honor values for properties declared in the config block of a class. When false, properties that are not declared in a config block will be placed on the instance.

Defaults to:

true

Available since: 5.0.0

$configTransforms : Object / Array
private pri

A prototype-chained object storing transform method names and priorities stored on the class prototype. On first instantiation, this object is converted into an array that is sorted by priority and stored on the constructor.

Defaults to:

{}

$eventOptions
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
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

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

ariaRenderAttributes : Object
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.

autoGenId : Boolean
private pri

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

Defaults to:

false

Available since: 6.7.0

baseCls
protected pro

The base CSS class to apply to this widget's element. Used as the prefix for ui-specific class names. Defaults to the value of classCls or (x- + the xtype) of the widget if classCls is null

Defaults to:

null

classCls
protected pro

A CSS class to apply to the main element that will be inherited down the class hierarchy. Subclasses may override this property on their prototype to add their own CSS class in addition to the CSS classes inherited from ancestor classes via the prototype chain. For example

Ext.define('Foo', {
    extend: 'Ext.Widget',
    classCls: 'foo'
});

Ext.define('Bar', {
    extend: 'Foo',
    classCls: 'bar'
});

var bar = new Bar();

console.log(bar.element.className); // outputs 'foo bar'

Defaults to:

null

classClsRoot
protected pro

When set to true during widget class definition, that class will be the "root" for classCls inheritance. Derived classes may set this to true to avoid inheriting a classCls from their superclass.

Defaults to:

true

clearPropertiesOnDestroy : Boolean / "async"
protected pro

Setting this property to false will prevent nulling object references on a Class instance after destruction. Setting this to "async" will delay the clearing for approx 50ms.

Defaults to:

true

Available since: 6.2.0

clearPrototypeOnDestroy : Boolean
private pri

Setting this property to true will result in setting the object's prototype to null after the destruction sequence is fully completed. After that, most attempts at calling methods on the object instance will result in "method not defined" exception. This can be very helpful with tracking down otherwise hard to find bugs like runaway Ajax requests, timed functions not cleared on destruction, etc.

Note that this option can only work in browsers that support Object.setPrototypeOf method, and is only available in debugging mode.

Defaults to:

false

Available since: 6.2.0

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

defaultBindProperty : String
protected pro

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:

null

destroyed : Boolean

This property is set to true after the destroy method is called.

Defaults to:

false

devicePixelRatio

The reported device pixel density. devicePixelRatio is only supported from IE11, so we use deviceXDPI and logicalXDPI that are supported from IE6.

Defaults to:

window.devicePixelRatio || window.screen.deviceXDPI / window.screen.logicalXDPI

element : Object

A configuration object for Ext.Element.create() that is used to create the Element template. Subclasses should avoid overriding this property and instead add elements using template.

Supports all the standard options of a Ext.Element.create() config and adds 3 additional options:

  1. reference - this option specifies a name for Element references. These references names become properties of the Widget instance and refer to Ext.Element instances that were created using the template:

      element: {
          reference: 'element',
          children: [{
              reference: 'innerElement'
          }]
      }
    

After construction of a widget the reference elements are accessible as follows:

var foo = new FooWidget(),
    innerEl = foo.innerElement; // an Ext.Element that wraps the innerElement

The reference attribute is optional, but all Widgets must have a 'element' reference on some element within the template (usually the outermost one).

  1. listeners - a standard listeners object as specified by Ext.mixin.Observable.

      element: {
          reference: 'element',
          listeners: {
              click: 'onClick'
          },
          children: [{
              reference: 'innerElement',
              listeners: {
                  click: 'onInnerClick'
              }
          }]
      }
    

Since listeners cannot be attached without an Ext.Element reference the reference property MUST be specified in order to use listeners.

The Widget instance is used as the scope for all listeners specified in this way, so it is invalid to use the scope option in the listeners config since it will always be overwritten using this.

  1. uiCls - a suffix to be appended to the ui-specific CSS class for each ui for this widget. These ui classes are constructed by appending the ui to each classCls or baseCls for the widget. As such, uiCls should never be used on the main element reference, as its uiCls is computed automatically.

For example, assume a widget is defined with a ui of 'alt action' and a uiCls of 'inner-el' on its innerElement reference element:

     Ext.define('Doodad', {
         extend: 'Ext.Widget',
         xtype: 'doodad',

         classCls: 'x-doodad',

         ui: 'alt action',

         element: {
             reference: 'element',

             children: [{
                 reference: 'innerElement',
                 cls: 'x-inner-el',
                 uiCls: 'inner-el'
             }]
         }
     });

This would result in the following markup when rendered:

<div class="x-doodad x-doodad-alt x-doodad-action">
    <div class="x-inner-el x-doodad-inner-el x-doodad-alt-inner-el x-doodad-action-inner-el"></div>
</div>

These additional classes can be used to style the reference element for a particular ui; however, use of uiCls is not typically necessary or recommended. Reference elements should usually be styled using simple descendant selectors:

.x-doodad-alt .x-inner-el {
    color: red;
}

When there is a possibility that widgets can be nested it is best to use direct child selectors to avoid the possibility of selecting all descendants instead of just the reference element for the intended widget:

.x-doodad-alt > .x-inner-el {
    color: red;
}

Only use uiCls when there is a possibility of nesting, AND there may be a variable number of elements between the main element and the reference element in question. For example, Ext.Container with docked items has a different number of elements in between its element and its bodyElement than a Container without docked items because of the wrapping elements that are dynamically added to support docking. To ensure it does not style all descendants it must use a uiCls to style its bodyElement:

.x-container-alt-body-el {
    background: #fff;
}

Note that when uiCls is specified it also adds a class name that does not contain the ui using just the classCls and/or baseCls as the prefix. This class name can be used for base-level styling that does not relate to any particular UI:

.x-container-body-el {
    position: relative;
}

Defaults to:

{
    reference: 'element',
    children: [
        {
            reference: 'bodyElement',
            style: {
                width: '100%',
                height: '100%',
                position: 'relative'
            }
        }
    ]
}

eventsSuspended
private pri

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

Defaults to:

0

factoryConfig : Object

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

floatedSelector : String
readonly ro private pri

The CSS selector to match floated elements.

Defaults to:

".x-floated"

floatingCls : String
readonly ro private pri

The CSS class to add to this component when it is floated at the viewport level.

Defaults to:

"x-floated"

floatWrapCls : String
readonly ro private pri

The CSS class to add to this component's floatWrap when it's created.

Defaults to:

"x-float-wrap"

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

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'

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 Ext.app.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);
 }

inheritUi : Boolean / String

Set to true on widgets that should inherit ui from their parent container. This property is typically set on the class body, but can be set on an instance as long as it is set prior to the instance being added to its container. This property is inspected at the moment a widget is added to a container, and any UIs on the container are added to the widget at that time. Inherited UIs are in addition to the widget's own ui, and are updated when the container's UI changes.

Defaults to:

false

initFocusable
protected pro

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

Defaults to:

Ext.emptyFn

isConfiguring : Boolean
readonly ro protected pro

This property is set to true during the call to initConfig.

Defaults to:

false

Available since: 5.0.0

isFirstInstance : Boolean
readonly ro protected pro

This property is set to true if this instance is the first of its class.

Defaults to:

false

Available since: 5.0.0

isInner
private pri

Defaults to:

true

isInstance : Boolean
readonly ro protected pro

This value is true and is used to identify plain objects from instances of a defined class.

Defaults to:

true

isObservable : Boolean

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

Defaults to:

true

isPendingRenderFrame
private pri

This flag is used to indicate that predecessors surfaces that should render before this surface renders are dirty, and to call renderFrame when all predecessors have their renderFrame called (i.e. not dirty anymore). This flag indicates that current surface has surfaces that are yet to render before current surface can render. When all the predecessors surfaces have rendered, i.e. when dirtyPredecessorCount reaches zero,

Defaults to:

false

lastKeyMapEvent : Ext.event.Event

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

Available since: 6.6.0

noBorderCls : String
readonly ro private pri

The CSS class to add to this component should not have a border.

Defaults to:

Ext.baseCSSPrefix + 'noborder-trbl'

self : Ext.Class
protected pro

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

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

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

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


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

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

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'

Defaults to:

Base

shadowCls : String
readonly ro private pri

The CSS class to add to this component when it has a shadow.

Defaults to:

Ext.baseCSSPrefix + 'shadow'

shimCls : String
readonly ro private pri

The CSS class to add to this component's shim element if enabled.

Defaults to:

"x-shim"

template : Array
protected pro

An array of child elements to use as the children of the main element in the element template. Only used if "children" are not specified explicitly in the element template.

Defaults to:

[]

toSave
private pri

Properties to be saved/restored in the save and restore methods.

Defaults to:

[
    'fillGradient',
    'strokeGradient'
]

uiReferences : Object
private pri

A map that tracks all reference elements configured with a uiCls. Contains the element reference by default since the element always gets non-suffixed ui-specific CSS class names added to it (see syncUiCls)

validRefRe : RegExp
private pri

Regular expression used for validating reference values.

Defaults to:

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

Static Properties

$onExtended
static sta private pri

Defaults to:

[]

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.

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.

add ( sprite ) : Ext.draw.sprite.Sprite/Ext.draw.sprite.Sprite[]

Add a Sprite to the surface. You can put any number of objects as the parameter. See Ext.draw.sprite.Sprite for the configuration object to be passed into this method.

For example:

drawContainer.getSurface().add({
    type: 'circle',
    fill: '#ffc',
    radius: 100,
    x: 100,
    y: 100
});
drawContainer.renderFrame();

Parameters

sprite :  Object/Object[]

Returns

:Ext.draw.sprite.Sprite/Ext.draw.sprite.Sprite[]

addCls ( cls, [prefix], [suffix] )

Adds a CSS class (or classes) to this Component's rendered element.

Parameters

cls :  String/String[]

The CSS class(es) to add.

prefix :  String (optional)

Optional prefix to add to each class.

Defaults to: ""

suffix :  String (optional)

Optional suffix to add to each class.

Defaults to: ""

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

addDeprecations ( deprecations )
private pri

This method applies a versioned, deprecation declaration to this class. This is typically called by the deprecated config.

Parameters

deprecations :  Object

addElementReference ( name, domNode ) : Ext.dom.Element
private pri

Adds an element reference to this Widget instance.

Parameters

name :  String

The name of the reference

domNode :  HTMLElement

Returns

:Ext.dom.Element

addElementReferenceOnDemand ( name, domNode )
private pri

Reduces instantiation time for a Widget by lazily instantiating Ext.Element references the first time they are used. This optimization only works for elements with no listeners specified.

Parameters

name :  String

The name of the reference

domNode :  HTMLElement

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.

afterRender
template tpl

This method is called after the component is initially added to the DOM. If this component <ext-container/> other components, the afterRender method for child components is called before the parent's afterRender.

Implementations of this method should avoid reading from the DOM but are free to write to the DOM as needed. To read the DOM, consider implementing onRender instead.

This method is not generally needed because components always have their own DOM element and these are maintained by config property updaters prior to insertion in the DOM. In general, it is always best to manipulate the component's elements outside the DOM where there is no associated reflow or layout cost. This method is useful for situations where the component's elements must be in the DOM in order to be manipulated correctly.

Available since: 6.5.0

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

alignTo ( component, alignment, options )
private pri

Parameters

component :  Object

alignment :  Object

options :  Object

appendPath ( path )

Uses the given path commands to begin a new path on the canvas.

Parameters

path :  Object

applyBind ( binds, currentBindings ) : Object
private pri

Available since: 5.0.0

Parameters

binds :  String/Object

currentBindings :  Object

Returns

:Object

applyItems ( items )
private pri

Parameters

items :  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

applyStyle ( style, oldStyle )
protected pro

Parameters

style :  Object

oldStyle :  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

arc ( x, y, radius, startAngle, endAngle, anticlockwise )

Adds points to the subpath such that the arc described by the circumference of the circle described by the arguments, starting at the given start angle and ending at the given end angle, going in the given direction (defaulting to clockwise), is added to the path, connected to the previous point by a straight line.

Parameters

x :  Object

y :  Object

radius :  Object

startAngle :  Object

endAngle :  Object

anticlockwise :  Object

arcTo ( x1, y1, x2, y2, radius )

Adds an arc with the given control points and radius to the current subpath, connected to the previous point by a straight line. If two radii are provided, the first controls the width of the arc's ellipse, and the second controls the height. If only one is provided, or if they are the same, the arc is from a circle.

In the case of an ellipse, the rotation argument controls the clockwise inclination of the ellipse relative to the x-axis.

Parameters

x1 :  Object

y1 :  Object

x2 :  Object

y2 :  Object

radius :  Object

bezierCurveTo ( c1x, c1y, c2x, c2y, x, y ) : *

Adds the given point to the current subpath, connected to the previous one by a cubic Bézier curve with the given control points.

Parameters

c1x :  Object

c1y :  Object

c2x :  Object

c2y :  Object

x :  Object

y :  Object

Returns

:*

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.

callOverridden ( args ) : Object
deprecated dep protected pro

Call the original method that was previously overridden with Ext.Base#override

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

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

        this.callOverridden();

        alert("Meeeeoooowwww");
    }
});

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

Parameters

args :  Array/Arguments

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

Returns

:Object

Returns the result of calling the overridden method

Deprecated since version 4.1.0
Use method-callParent instead.

callParent ( args ) : Object
protected pro

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

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

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

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

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

 var obj = new My.Derived();

 alert(obj.x);  // alerts 21

This can be used with an override as follows:

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

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

 var obj = new My.Derived();

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

This also works with static and private methods.

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

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

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

Lastly, it also works with overridden static methods.

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

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

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

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

Parameters

args :  Array/Arguments

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

Returns

:Object

Returns the result of calling the parent method

callSuper ( args ) : Object
protected pro

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

Consider:

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

 Ext.define('Ext.some.DerivedClass', {
     extend: 'Ext.some.Class',

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

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

         this.callParent();
     }
 });

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

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

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

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

         this.callSuper();
     }
 });

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

Parameters

args :  Array/Arguments

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

Returns

:Object

Returns the result of calling the superclass method

clear

Empty the surface content (without touching the sprites.)

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.

clearListeners

Removes all listeners for this object including the managed listeners

clearManagedListeners

Removes all managed listeners for this object.

clearRect ( x, y, w, h )

Clears all pixels on the canvas in the given rectangle to transparent black.

Parameters

x :  Object

y :  Object

w :  Object

h :  Object

clearTransform

Clears the current transformation state on the surface.

createCanvas
private pri

Creates the canvas element.

createItem ( config )
private pri

Creates an item and appends it to the surface. Called as an internal method when calling add.

Parameters

config :  Object

createLinearGradient ( x0, y0, x1, y1 ) : *

Returns an object that represents a linear gradient that paints along the line given by the coordinates represented by the arguments.

Parameters

x0 :  Object

y0 :  Object

x1 :  Object

y1 :  Object

Returns

:*

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

createRadialGradient ( x0, y0, r0, x1, y1, r1 ) : *

Returns a CanvasGradient object that represents a radial gradient that paints along the cone given by the circles represented by the arguments. If either of the radii are negative, throws an IndexSizeError exception.

Parameters

x0 :  Object

y0 :  Object

r0 :  Object

x1 :  Object

y1 :  Object

r1 :  Object

Returns

:*

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

destroy

Destroys the Canvas element and prepares it for Garbage Collection.

destroyMembers ( args )

Destroys member properties by name.

If a property name is the name of a config, the getter is not invoked, so if the config has not been initialized, nothing will be done.

The property will be destroyed, and the corrected name (if the property is a config and config names are prefixed) will set to null in this object's dictionary.

Parameters

args :  String...

One or more names of the properties to destroy and remove from the 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.

disable

Disables this Component

disablePrecisionCompensation ( ctx )
private pri

Clears canvas of compensation for canvas' use of single precision floating point.

Parameters

ctx :  CanvasRenderingContext2D

The canvas context.

doAddListener ( name, fn, scope, options, order, caller, manager )
private pri

Parameters

name :  Object

fn :  Object

scope :  Object

options :  Object

order :  Object

caller :  Object

manager :  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 or Widget.

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

drawImage ( img_elem, arg1, arg2, arg3, arg4, dst_x, dst_y, dw, dh ) : *

Draws the given image onto the canvas. If the first argument isn't an img, canvas, or video element, throws a TypeMismatchError exception. If the image has no image data, throws an InvalidStateError exception. If the one of the source rectangle dimensions is zero, throws an IndexSizeError exception. If the image isn't yet fully decoded, then nothing is drawn.

Parameters

img_elem :  Object

arg1 :  Object

arg2 :  Object

arg3 :  Object

arg4 :  Object

dst_x :  Object

dst_y :  Object

dw :  Object

dh :  Object

Returns

:*

ellipse ( cx, cy, rx, ry, rotation, start, end, anticlockwise )

Adds points to the subpath such that the arc described by the circumference of the ellipse described by the arguments, starting at the given start angle and ending at the given end angle, going in the given direction (defaulting to clockwise), is added to the path, connected to the previous point by a straight line.

Parameters

cx :  Object

cy :  Object

rx :  Object

ry :  Object

rotation :  Object

start :  Object

end :  Object

anticlockwise :  Object

enable

Enables this Component

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.

enablePrecisionCompensation ( ctx )
private pri

Compensate for canvas' use of single precision floating point.

Parameters

ctx :  CanvasRenderingContext2D

The canvas context.

fill

Fills the subpaths of the current default path or the given path with the current fill style.

fill

Fills the subpaths of the current default path or the given path with the current fill style.

fillRect ( x, y, w, h )

Paints the given rectangle onto the canvas, using the current fill style.

Parameters

x :  Object

y :  Object

w :  Object

h :  Object

fillStroke ( attr, transformFillStroke )

Parameters

attr :  Object

transformFillStroke :  Object

fillText ( text, x, y, maxWidth )

Fills the given text at the given position. If a maximum width is provided, the text will be scaled to fit that width if necessary.

Parameters

text :  Object

x :  Object

y :  Object

maxWidth :  Object

findFloatParent ( needsShow )
private pri

The method finds this floated component's floatParent. That means a DOM positioning container which acts as a root element for sibling floated components, and allows allows floated components to be absolutely positioned, and their encapsulating elements to be reordered to produce a visual stacking effect.

This component's element is appended to its floatParent.

There is a global floatParent element, created on demand when the first top level floated component is shown. This may be an item child of a container configured with cfg-floated: true, or a free floated component which is programatically shown.

Child items of components inside a floated component may also be configured floated. These are give a floatParent which is created on demand wrapping the nearest floated ancestor. This means that when that ancestor's element is brought to the top of the stack (by moving its element to the end of its own floatParent), the descendant elements will automatically remain above.

Parameters

needsShow :  Object

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.

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

flatten ( size, surfaces ) : Object

Flattens the given drawing surfaces into a single image and returns an object containing the data (in the DataURL format) and the type (e.g. 'png' or 'svg') of that image.

Parameters

size :  Object

The size of the final image.

width :  Number

height :  Number

surfaces :  Ext.draw.Surface[]

The surfaces to flatten.

Returns

:Object

data :  String

The DataURL of the flattened image.

type :  String

The type of the image.

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.

get ( id ) : Ext.draw.sprite.Sprite

Get the sprite by id or index. It will first try to find a sprite with the given id, otherwise will try to use the id as an index.

Parameters

id :  String/Number

Returns

:Ext.draw.sprite.Sprite

getAlignRegion ( component, alignment, options )
private pri

Parameters

component :  Object

alignment :  Object

options :  Object

getAlignmentInfo ( component, alignment )
protected pro

Prepares information on aligning this to component using alignment. Also checks to see if this is already aligned to component according to alignment.

Parameters

component :  Object

alignment :  Object

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

getBBox ( sprites, [isWithoutTransform] ) :

Return the minimal bounding box that contains all the sprites bounding boxes in the given list of sprites.

Parameters

sprites :  Ext.draw.sprite.Sprite[]/Ext.draw.sprite.Sprite

isWithoutTransform :  Boolean (optional)

Defaults to: false

Returns

:

{{x: Number, y: Number, width: number, height: number}}

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

getConfig ( [name], [peek], [ifInitialized] ) : Object

Returns a specified config property value. If the name parameter is not passed, all current configuration options will be returned as key value pairs.

Parameters

name :  String (optional)

The name of the config property to get.

peek :  Boolean (optional)

true to peek at the raw value without calling the getter.

Defaults to: false

ifInitialized :  Boolean (optional)

true to only return the initialized property value, not the raw config value, and not to trigger initialization. Returns undefined if the property has not yet been initialized.

Defaults to: false

Returns

:Object

The config property value.

getCurrentAlignmentInfo
private pri

Current Alignment information from the last alignTo call

getElementConfig Object
protected pro

A template method for modifying the element config before it is processed. By default adds the result of this.getTemplate() as the children array of element if children were not specified in the original element config. Typically this method should not need to be implemented in subclasses. Instead the element property should be use to configure the element template for a given Widget subclass.

This method is called once when the first instance of each Widget subclass is created. The element config object that is returned is cached and used as the template for all successive instances. The scope object for this method is the class prototype, not the instance.

Returns

:Object

the element config object

getEventXY ( e )
private pri

Converts event's page coordinates into surface coordinates. Note: surface's x-coordinates always go LTR, regardless of RTL mode.

Parameters

e :  Object

getFloatParent Ext.Component
private pri

For cfg-floated components only.

Finds the owning cfg-floated component (if any) responsible for the base z-index stack position of this compoonent, and, if that component is cfg-relative, for the coordinate system in which this component is positioned.

If this is a top level floated component, this method will return null

Returns

:Ext.Component

The owning floated component or null if this component is top level floated.

getFloatWrap Ext.dom.Element
private pri

This method returns, or creates on demand the floatWrap element which wraps the passed floated component. It enables that floated component to act as a host for descendant floated components.

Returns

:Ext.dom.Element

The passed component's floatWrap element.

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

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.

getInitialConfig ( [name] ) : Object/Mixed

Returns the initial configuration passed to the constructor when instantiating this class.

Given this example Ext.button.Button definition and instance:

Ext.define('MyApp.view.Button', {
    extend: 'Ext.button.Button',
    xtype: 'mybutton',

    scale: 'large',
    enableToggle: true
});

var btn = Ext.create({
    xtype: 'mybutton',
    renderTo: Ext.getBody(),
    text: 'Test Button'
});

Calling btn.getInitialConfig() would return an object including the config options passed to the create method:

xtype: 'mybutton',
renderTo: // The document body itself
text: 'Test Button'

Calling btn.getInitialConfig('text')returns 'Test Button'.

Parameters

name :  String (optional)

Name of the config option to return.

Returns

:Object/Mixed

The full config object or a single config value when name parameter specified.

getOwnerBody Ext.dom.Element
private pri

The body element of the chart or the draw container (doesn't include docked items like a legend). Draw Container is a Panel in Classic (to allow for docked items) and a Container in Modern, so the body is retrieved differently.

Returns

:Ext.dom.Element

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.

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.

getSize Object

Returns the height and width of the Component.

Returns

:Object

The current height and width of the Component.

width :  Number

height :  Number

getTabIndex Number

Return the actual tabIndex for this Focusable.

Returns

:Number

tabIndex attribute value

handleBlurEvent ( info )
private pri

Parameters

info :  Object

handleFocusEvent ( info )
private pri

Parameters

info :  Object

hasCls ( className ) : Boolean

Checks if the specified CSS class exists on this element's DOM node.

Parameters

className :  String

The CSS class to check for.

Returns

:Boolean

true if the class exists, else false.

hasConfig ( name )
private pri

Parameters

name :  String

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

hitTest ( point, options ) : Object

Performs a hit test on all sprites in the surface, returning the first matching one.

Parameters

point :  Array

A two-item array containing x and y coordinates of the point in surface coordinate system.

options :  Object

Hit testing options.

Returns

:Object

A hit result object that contains more information about what exactly was hit or null if nothing was hit.

hitTestEvent ( event, options ) : Object

Performs a hit test on all sprites in the surface, returning the first matching one. Since hit testing is typically performed on mouse events, this convenience method converts event's page coordinates to surface coordinates before calling hitTest.

Parameters

event :  Object

An event object.

options :  Object

Hit testing options.

Returns

:Object

A hit result object that contains more information about what exactly was hit or null if nothing was hit.

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

initConfig ( instanceConfig ) : Ext.Base
chainable ch protected pro

Initialize configuration for this class. a typical example:

Ext.define('My.awesome.Class', {
    // The default config
    config: {
        name: 'Awesome',
        isAwesome: true
    },

    constructor: function(config) {
        this.initConfig(config);
    }
});

var awesome = new My.awesome.Class({
    name: 'Super Awesome'
});

alert(awesome.getName()); // 'Super Awesome'

Parameters

instanceConfig :  Object

Returns

:Ext.Base

this

initElement
protected pro

Initializes the Element for this Widget instance. If this is the first time a Widget of this type has been instantiated the element config will be processed to create an Element. This Element is then cached on the prototype (see afterCachedConfig) so that future instances can obtain their element by simply cloning the Element that was cached by the first instance.

initElementListeners ( elementConfig )
private pri

Called for the first instance of this Widget to create an object that contains the listener configs for all of the element references keyed by reference name. The object is cached on the prototype and has the following shape:

_elementListeners: {
    element: {
        click: 'onClick',
        scope: this
    },
    fooReference: {
        tap: {
            fn: someFunction,
            delay: 100
        }
    }
}

The returned object is prototype chained to the _elementListeners object of its superclass, and each key in the object is prototype chained to object with the corresponding key in the superclass _elementListeners. This allows element listeners to be inherited and overridden when subclassing widgets.

This method is invoked with the prototype object as the scope

Parameters

elementConfig :  Object

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, [inheritedStateInner] )
protected pro

This method is called to initialize the inheritedState objects for this instance. This amounts to typically copying certain properties from the instance to the given object.

Available since: 5.0.0

Parameters

inheritedState :  Object

The state object for this instance.

inheritedStateInner :  Object (optional)

This object is only provided for containers.

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.

initUiReference ( referenceName, uiCls, [isInstance] )
private pri

Initializes a "uiReference". Ui rerefences are reference elements that have classCls and ui info in their CSS class names. They can be used by setting uiCls in the template, or by invoking this method to setup the ui reference after element/template initialization (Toolable uses this for its dock wrapper)

Parameters

referenceName :  String

uiCls :  String

isInstance :  Boolean (optional)

pass false if this is not an instance-level reference

Defaults to: false

insertFloatedDom ( needsShow )
private pri

This method inserts this floated component's DOM into its owning floatParent.

Parameters

needsShow :  Object

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

Tests whether this Widget matches a Ext.ComponentQuery selector string.

Parameters

selector :  String

The selector string to test against.

Returns

:Boolean

true if this Widget matches the selector.

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.

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.

isDisabled Boolean

Returns true if this Component is currently disabled.

Returns

:Boolean

true if currently disabled.

isEnabled Boolean

Returns true if this Component is not currently disabled.

Returns

:Boolean

true if not currently disabled.

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

isHidden ( [deep] ) : Boolean

Returns true if this Component is currently hidden.

Parameters

deep :  Boolean/Ext.Widget (optional)

true to check if this component is hidden because a parent container is hidden. Alternatively, a reference to the top-most parent at which to stop climbing.

Defaults to: false

Returns

:Boolean

true if currently hidden.

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.

isVisible ( [deep] ) : Boolean

Returns true if this Component is currently visible.

A Widget is visible if its element is not hidden, and has been rendered and has not been destroyed.

Parameters

deep :  Boolean (optional)

true to check if this component is visible and all parents are also visible.

Contrast this with the isHidden method which just checks the hidden state of the component.

Defaults to: false

Returns

:Boolean

true if currently visible.

isXType ( xtype, [shallow] ) : Boolean

Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended from the xtype (default) or whether it is directly of the xtype specified (shallow = true). **If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes.__

For a list of all available xtypes, see the <ext-component/> header.

Example usage:

var t = new Ext.field.Text();
var isText = t.isXType('textfield'); // true
var isBoxSubclass = t.isXType('field'); // true, descended from Ext.field.Field
var isBoxInstance = t.isXType('field', true); // false, not a direct
                                              // Ext.field.Field instance

Parameters

xtype :  String

The xtype to check for this Component.

shallow :  Boolean (optional)

false to check whether this Component is descended from the xtype (this is the default), or true to check whether this Component is directly of the specified xtype.

Returns

:Boolean

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

lineTo ( x, y )

Adds the given point to the current subpath, connected to the previous one by a straight line.

Parameters

x :  Object

y :  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

lookupTpl ( name ) : Ext.XTemplate

Gets a named template instance for this class. See Ext.XTemplate#getTpl.

Available since: 6.2.0

Parameters

name :  String

The name of the property that holds the template.

Returns

:Ext.XTemplate

The template, null if not found.

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

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

moveTo ( x, y )

Creates a new subpath with the given point.

Parameters

x :  Object

y :  Object

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

onAdd ( sprite )
protected pro

Invoked when a sprite is added to the surface.

Parameters

sprite :  Ext.draw.sprite.Sprite

The sprite to be added.

onAdded ( parent, instanced )
private pri

Parameters

parent :  Object

instanced :  Object

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

onRender
template tpl

This method is called the first time a component is inserted into the DOM. If this component <ext-container/> other components, the onRender method for child components is called after the parent's onRender.

Implementations of this method should avoid modifying the DOM but are free to read from and measure elements as needed. To adjust the DOM, consider implementing afterRender instead.

If this method is overridden, be sure to use callParent to call the base class version.

 onRender: function() {
     this.callParent();

     // custom actions
 }

This method is not generally needed because components always have their own DOM element and these are maintained by config property updaters prior to insertion in the DOM. In general, it is always best to interrogate the component's elements outside the DOM where there is no associated reflow or layout cost. This method is useful for situations where the component's elements must be in the DOM. For example to be measured correctly.

Available since: 6.5.0

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

orderByZIndex
private pri

Order the items by their z-index if any of that has been changed since last sort.

owns ( element )
private pri

Returns true if the passed element is within the container tree of this component.

For example if a menu's submenu contains an Ext.form.field.Date, that top level menu owns the elements of the date picker. Using this method, you can tell if an event took place within a certain component tree.

Parameters

element :  Object

processElementConfig Object
private pri

Recursively processes the element templates for this class and its superclasses, ascending the hierarchy until it reaches a superclass whose element template has already been processed. This method is invoked using the prototype as the scope.

Returns

:Object

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.

quadraticCurveTo ( cx, cy, x, y ) : *

Adds the given point to the current subpath, connected to the previous one by a quadratic Bézier curve with the given control point.

Parameters

cx :  Object

cy :  Object

x :  Object

y :  Object

Returns

:*

realign ( component, alignment, options )
private pri

Parameters

component :  Object

alignment :  Object

options :  Object

rect ( x, y, w, h ) : *

Adds a new closed subpath to the path, representing the given rectangle.

Parameters

x :  Object

y :  Object

w :  Object

h :  Object

Returns

:*

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

remove ( sprite, [isDestroy] ) : Ext.draw.sprite.Sprite

Remove a given sprite from the surface, optionally destroying the sprite in the process. You can also call the sprite's own remove method.

For example:

 drawContainer.surface.remove(sprite);
 // or...
 sprite.remove();

Parameters

sprite :  Ext.draw.sprite.Sprite/String

A sprite instance or its ID.

isDestroy :  Boolean (optional)

If true, the sprite will be destroyed.

Defaults to: false

Returns

:Ext.draw.sprite.Sprite

Returns the removed/destroyed sprite or null otherwise.

removeAll ( [isDestroy] )

Remove all sprites from the surface, optionally destroying the sprites in the process.

For example:

drawContainer.getSurface('main').removeAll();

Parameters

isDestroy :  Boolean (optional)

Defaults to: false

removeCls ( cls, [prefix], [suffix] )

Removes the given CSS class(es) from this widget's primary element.

Parameters

cls :  String/String[]

The class(es) to remove.

prefix :  String (optional)

Optional prefix to prepend before each class.

Defaults to: ""

suffix :  String (optional)

Optional suffix to append to each class.

Defaults to: ""

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.

renderFrame

Triggers the re-rendering of the canvas.

renderSprite ( sprite ) : Boolean

Renders a single sprite into the surface. Do not call it from outside renderFrame method.

Parameters

sprite :  Ext.draw.sprite.Sprite

The Sprite to be rendered.

Returns

:Boolean

returns false to stop the rendering to continue.

repaint

Force the element to redraw.

replaceCls ( oldCls, newCls, [prefix], [suffix] )

Replaces specified classes with the newly specified classes. It uses the addCls and removeCls methods, so if the class(es) you are removing don't exist, it will still add the new classes.

Parameters

oldCls :  String/String[]

The class(es) to remove.

newCls :  String/String[]

The class(es) to add.

prefix :  String (optional)

Optional prefix to prepend before each class.

Defaults to: ""

suffix :  String (optional)

Optional suffix to append to each class.

Defaults to: ""

resetTransform

Reset the matrix of the surface.

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

restore

Pops the state stack and restores the state.

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

rotate ( radians ) : *

Rotates the transformation matrix.

Parameters

radians :  Object

Returns

:*

roundPixel ( num ) : Number

Round the number to align to the pixels on device.

Parameters

num :  Number

The number to align.

Returns

:Number

The resultant alignment.

save

Pushes the context state to the state stack.

scale ( sx, sy ) : *

Scales the transformation matrix.

Parameters

sx :  Object

sy :  Object

Returns

:*

setConfig ( name, [value] ) : Ext.Base
chainable ch

Sets a single/multiple configuration options.

Parameters

name :  String/Object

The name of the property to set, or a set of key value pairs to set.

value :  Object (optional)

The value to set for the name parameter.

Returns

:Ext.Base

this

setCurrentAlignmentInfo ( alignmentInfo )
private pri

Sets the current Alignment information, called by alignTo

Parameters

alignmentInfo :  Object

setGradientBBox ( bbox )

Parameters

bbox :  Object

setLineDash ( dashList )

2D Canvas context in IE (up to IE10, inclusive) doesn't support the setLineDash method and the lineDashOffset property.

Parameters

dashList :  Object

An even number of non-negative numbers specifying a dash list.

setRendered ( rendered, [root] )
private pri

All Components need a potentially recursive setRendered because some are pseudo containers, such as grid <ext-gridrow/>, and some mix in Ext.mixin.Toolable.

Parameters

rendered :  Boolean

root :  Boolean (optional)

setSize ( width, height )

Sets the size of the Component.

Parameters

width :  Number

The new width for the Component.

height :  Number

The new height for the Component.

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

setTransform ( x2x, x2y, y2x, y2y, newDx, newDy )

Changes the transformation matrix to the matrix given by the arguments as described below.

Parameters

x2x :  Object

x2y :  Object

y2x :  Object

y2y :  Object

newDx :  Object

newDy :  Object

statics Ext.Class
protected pro

Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base#self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

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

    constructor: function() {
        var statics = this.statics();

        // always equals to 'Cat' no matter what 'this' refers to
        // equivalent to: My.Cat.speciesName
        alert(statics.speciesName);


        alert(this.self.speciesName);   // dependent on 'this'

        statics.totalCreated++;
    },

    clone: function() {
        var cloned = new this.self();   // dependent on 'this'

        // equivalent to: My.Cat.speciesName
        cloned.groupName = this.statics().speciesName;

        return cloned;
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',

    statics: {
        speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'
    },

    constructor: function() {
        this.callParent();
    }
});

var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'

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

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
alert(clone.groupName);                 // alerts 'Cat'

alert(My.Cat.totalCreated);             // alerts 3

Returns

:Ext.Class

stroke

Strokes the subpaths of the current default path or the given path with the current stroke style.

stroke

Strokes the subpaths of the current default path or the given path with the current stroke style.

strokeRect ( x, y, w, h )

Paints the box that outlines the given rectangle onto the canvas, using the current stroke style.

Parameters

x :  Object

y :  Object

w :  Object

h :  Object

strokeText ( text, x, y, maxWidth )

Strokes the given text at the given position. If a maximum width is provided, the text will be scaled to fit that width if necessary.

Parameters

text :  Object

x :  Object

y :  Object

maxWidth :  Object

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.

syncAlwaysOnTop Boolean
private pri

Fixes up the alwaysOnTop order of this floated widget within its siblings.

Returns

:Boolean

true if this was the topmost widget among its siblings.

syncFloatWrap
private pri

Synchronizes the size and position of the floatWrap when this Widget is resized

toFront Ext.Component
chainable ch

Brings a cfg-floated Component to the front of any other visible, floated Components while honoring all alwaysOnTop settings. This may not become topmost if another visible floated component has a higher alwaysOnTop value.

If this Component becomes the topmost modal floated component, the the shared modal mask is moved to just below this Component.

Returns

:Ext.Component

this

toggleCls ( className, [state] ) :
chainable ch

Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).

Parameters

className :  String

The CSS class to toggle.

state :  Boolean (optional)

If specified as true, causes the class to be added. If specified as false, causes the class to be removed.

Returns

:

transform ( x2x, x2y, y2x, y2y, newDx, newDy )

Changes the transformation matrix to apply the matrix given by the arguments as described below.

Parameters

x2x :  Object

x2y :  Object

y2x :  Object

y2y :  Object

newDx :  Object

newDy :  Object

translate ( dx, dy ) : *

Translates the transformation matrix.

Parameters

dx :  Object

dy :  Object

Returns

:*

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.

Returns

:

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

updateCls ( newCls, oldCls )
private pri

All cls methods directly report to the cls configuration, so anytime it changes, updateCls will be called

Parameters

newCls :  Object

oldCls :  Object

updateHeight ( height )
protected pro

Parameters

height :  Object

updateRect ( rect )

Normally, a surface will have a single canvas. However, on certain platforms/browsers there's a limit to how big a canvas can be. 'splitThreshold' is used to determine maximum width/height of a single canvas element. When a surface is wider/taller than the splitThreshold, extra canvas element(s) will be created and tiled inside the surface.

Parameters

rect :  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

updateWidth ( width )
protected pro

Parameters

width :  Object

waitFor ( surface )

Mark the surface to render after another surface is updated.

Parameters

surface :  Ext.draw.Surface

The surface to wait for.

watchConfig ( name, fn, scope )
private pri

Watches config properties.

 instance.watchConfig({
     title: 'onTitleChange',
     scope: me
 });

Available since: 6.7.0

Parameters

name :  Object

fn :  Object

scope :  Object

Static Methods

addConfig ( config, [mixinClass] )
static sta private pri

Adds new config properties to this class. This is called for classes when they are declared, then for any mixins that class may define and finally for any overrides defined that target the class.

Parameters

config :  Object

mixinClass :  Ext.Class (optional)

The mixin class if the configs are from a mixin.

addInheritableStatics ( members ) :
chainable ch static sta private pri

Parameters

members :  Object

Returns

:

addMember ( name, member, privacy ) :
chainable ch static sta private pri

Parameters

name :  Object

member :  Object

privacy :  Object

Returns

:

addMembers ( members, [isStatic], [privacy] ) :
chainable ch static sta

Add methods / properties to the prototype of this class.

Ext.define('My.awesome.Cat', {
    constructor: function() {
        ...
    }
});

 My.awesome.Cat.addMembers({
     meow: function() {
        alert('Meowww...');
     }
 });

 var kitty = new My.awesome.Cat();
 kitty.meow();

Parameters

members :  Object

The members to add to this class.

isStatic :  Boolean (optional)

Pass true if the members are static.

Defaults to: false

privacy :  Boolean (optional)

Pass true if the members are private. This only has meaning in debug mode and only for methods.

Defaults to: false

Returns

:

addStatics ( members ) : Ext.Base
chainable ch static sta

Add / override static properties of this class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.addStatics({
    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
});

Parameters

members :  Object

Returns

:Ext.Base

this

borrow ( fromClass, members ) : Ext.Base
static sta private pri

Borrow another class' members to the prototype of this class.

Ext.define('Bank', {
    money: '$$$',
    printMoney: function() {
        alert('$$$$$$$');
    }
});

Ext.define('Thief', {
    ...
});

Thief.borrow(Bank, ['money', 'printMoney']);

var steve = new Thief();

alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'

Parameters

fromClass :  Ext.Base

The class to borrow members from

members :  Array/String

The names of the members to borrow

Returns

:Ext.Base

this

callParent ( args )
static sta protected pro

Parameters

args :  Object

callSuper ( args )
static sta protected pro

Parameters

args :  Object

create Object
static sta

Create a new instance of this Class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.create({
    someConfig: true
});

All parameters are passed to the constructor of the class.

Returns

:Object

the created instance.

createAlias ( alias, origin )
static sta

Create aliases for existing prototype methods. Example:

Ext.define('My.cool.Class', {
    method1: function() { ... },
    method2: function() { ... }
});

var test = new My.cool.Class();

My.cool.Class.createAlias({
    method3: 'method1',
    method4: 'method2'
});

test.method3(); // test.method1()

My.cool.Class.createAlias('method5', 'method3');

test.method5(); // test.method3() -> test.method1()

Parameters

alias :  String/Object

The new method name, or an object to set multiple aliases. See flexSetter

origin :  String/Object

The original method name

extend ( parentClass )
static sta private pri

Parameters

parentClass :  Object

getConfigurator Ext.Configurator
static sta private pri

Returns the Ext.Configurator for this class.

Returns

:Ext.Configurator

getName String
static sta

Get the current class' name in string format.

Ext.define('My.cool.Class', {
    constructor: function() {
        alert(this.self.getName()); // alerts 'My.cool.Class'
    }
});

My.cool.Class.getName(); // 'My.cool.Class'

Returns

:String

className

mixin ( name, mixinClass ) :
chainable ch static sta private pri

Used internally by the mixins pre-processor

Parameters

name :  Object

mixinClass :  Object

Returns

:

onExtended ( fn, scope ) :
chainable ch static sta private pri

Parameters

fn :  Object

scope :  Object

Returns

:

override ( members ) : Ext.Base
chainable ch static sta

Override members of this class. Overridden methods can be invoked via callParent.

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

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

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

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

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.

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.

beforetofront ( this, eOpts )

Fires before a cfg-floated component is brought to the front of the visual stack.

Parameters

this :  Ext.Component

The component instance

eOpts : Object

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

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.

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.

tofront ( this, eOpts )

Fires when a cfg-floated component has been brought to the front of the visual stack.

Parameters

this :  Ext.Component

The component instance

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.

ExtWebComponents 7.1.0