Docs Help

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.

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

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

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.

Ext JS 6.6.0 - Classic Toolkit


top

Hierarchy

Requires

Ext.Promise

Summary

Deferreds are the mechanism used to create new Promises. A Deferred has a single associated Promise that can be safely returned to external consumers to ensure they do not interfere with the resolution or rejection of the deferred operation.

This implementation of Promises is an extension of the ECMAScript 6 Promises API as detailed [here][1]. For a compatible, though less full featured, API see Ext.Promise.

A Deferred is typically used within the body of a function that performs an asynchronous operation. When that operation succeeds, the Deferred should be resolved; if that operation fails, the Deferred should be rejected.

Each Deferred has an associated Promise. A Promise delegates then calls to its Deferred's then method. In this way, access to Deferred operations are divided between producer (Deferred) and consumer (Promise) roles.

Basic Usage

In it's most common form, a method will create and return a Promise like this:

 // A method in a service class which uses a Store and returns a Promise
 //
 loadCompanies: function () {
     var deferred = new Ext.Deferred(); // create the Ext.Deferred object

     this.companyStore.load({
         callback: function (records, operation, success) {
             if (success) {
                 // Use "deferred" to drive the promise:
                 deferred.resolve(records);
             }
             else {
                 // Use "deferred" to drive the promise:
                 deferred.reject("Error loading Companies.");
             }
         }
     });

     return deferred.promise;  // return the Promise to the caller
 }

You can see this method first creates a Ext.Deferred object. It then returns its Promise object for use by the caller. Finally, in the asynchronous callback, it resolves the deferred object if the call was successful, and rejects the deferred if the call failed.

When a Deferred's resolve method is called, it fulfills with the optionally specified value. If resolve is called with a then-able (i.e.a Function or Object with a then function, such as another Promise) it assimilates the then-able's result; the Deferred provides its own resolve and reject methods as the onFulfilled or onRejected arguments in a call to that then-able's then function. If an error is thrown while calling the then-able's then function (prior to any call back to the specified resolve or reject methods), the Deferred rejects with that error. If a Deferred's resolve method is called with its own Promise, it rejects with a TypeError.

When a Deferred's reject method is called, it rejects with the optionally specified reason.

Each time a Deferred's then method is called, it captures a pair of optional onFulfilled and onRejected callbacks and returns a Promise of the Deferred's future value as transformed by those callbacks.

See Ext.promise.Promise for an example of using the returned Promise.

No members found using the current filters

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

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

completeAction : String
private pri

The completion action (i.e. 'fulfill' or 'reject').

Defaults to:

null

completed : Boolean
private pri

Indicates whether this Deferred has been completed.

Defaults to:

false

completionValue : Mixed
private pri

The completion value (i.e. resolution value or rejection error).

Defaults to:

null

consequences : Ext.promise.Consequence[]
private pri

Pending Consequences chained to this Deferred.

Defaults to:

[]

destroyed : Boolean
protected pro

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

Defaults to:

false

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

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

promise : Ext.promise.Promise

Promise of the future value of this Deferred.

Defaults to:

null

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

Static Properties

$onExtended
static sta private pri

Defaults to:

[]

methods

Instance Methods

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

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

complete ( action, value )
private pri

Complete this Deferred with the specified action and value.

Parameters

action :  String

Completion action (i.e. 'fufill' or 'reject').

value :  Mixed

Fulfillment value or rejection reason.

destroy

This method is called to cleanup an object and its resources. After calling this method, the object should not be used any further in any way, including access to its methods and properties.

To prevent potential memory leaks, all object references will be nulled at the end of destruction sequence, unless clearPropertiesOnDestroy is set to false.

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.

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.

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.

hasConfig ( name )
private pri

Parameters

name :  String

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

reject ( reason )

Reject this Deferred with the specified reason.

Once a Deferred has been rejected, it is considered to be complete and subsequent calls to resolve or reject are ignored.

Parameters

reason :  Error

Rejection reason.

resolve ( value )

Resolve this Deferred with the (optional) specified value.

If called with a then-able (i.e.a Function or Object with a then function, such as another Promise) it assimilates the then-able's result; the Deferred provides its own resolve and reject methods as the onFulfilled or onRejected arguments in a call to that then-able's then function. If an error is thrown while calling the then-able's then function (prior to any call back to the specified resolve or reject methods), the Deferred rejects with that error. If a Deferred's resolve method is called with its own Promise, it rejects with a TypeError.

Once a Deferred has been fulfilled or rejected, it is considered to be complete and subsequent calls to resolve or reject are ignored.

Parameters

value :  Mixed

Value to resolve as either a fulfillment value or rejection reason.

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

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

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

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

        statics.totalCreated++;
    },

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

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

        return cloned;
    }
});


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

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

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

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

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

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

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

Returns

:Ext.Class

then ( [onFulfilled], [onRejected], [onProgress] ) :

Used to specify onFulfilled and onRejected callbacks that will be notified when the future value becomes available.

Those callbacks can subsequently transform the value that was fulfilled or the error that was rejected. Each call to then returns a new Promise of that transformed value; i.e., a Promise that is fulfilled with the callback return value or rejected with any error thrown by the callback.

Parameters

onFulfilled :  Function (optional)

Callback to execute to transform a fulfillment value.

onRejected :  Function (optional)

Callback to execute to transform a rejection reason.

onProgress :  Function (optional)

Callback to execute to transform a progress value.

Returns

:

Promise that is fulfilled with the callback return value or rejected with any error thrown by the callback.

update ( progress )

Updates progress for this Deferred, if it is still pending, triggering it to execute the onProgress callback and propagate the resulting transformed progress value to Deferreds that originate from this Deferred.

Parameters

progress :  Mixed

The progress value.

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 ) :
chainable ch static sta private pri

Parameters

name :  Object

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

all ( promisesOrValues ) : Ext.promise.Promise
static sta

Returns a new Promise that will only resolve once all the specified promisesOrValues have resolved.

The resolution value will be an Array containing the resolution value of each of the promisesOrValues.

Parameters

promisesOrValues :  Mixed[]/Ext.promise.Promise[]/Ext.promise.Promise

An Array of values or Promises, or a Promise of an Array of values or Promises.

Returns

:Ext.promise.Promise

A Promise of an Array of the resolved values.

any ( promisesOrValues ) : Ext.promise.Promise
static sta

Initiates a competitive race, returning a new Promise that will resolve when any one of the specified promisesOrValues have resolved, or will reject when all promisesOrValues have rejected or cancelled.

The resolution value will the first value of promisesOrValues to resolve.

Parameters

promisesOrValues :  Mixed[]/Ext.promise.Promise[]/Ext.promise.Promise

An Array of values or Promises, or a Promise of an Array of values or Promises.

Returns

:Ext.promise.Promise

A Promise of the first resolved value.

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

delay ( promiseOrValue, milliseconds ) : Ext.promise.Promise
static sta

Returns a new Promise that will automatically resolve with the specified Promise or value after the specified delay (in milliseconds).

Parameters

promiseOrValue :  Mixed

A Promise or value.

milliseconds :  Number

A delay duration (in milliseconds).

Returns

:Ext.promise.Promise

A Promise of the specified Promise or value that will resolve after the specified delay.

extend ( parentClass )
static sta private pri

Parameters

parentClass :  Object

getCachedRejected Ext.Promise
static sta private pri

Get a shared cached rejected promise. Assumes Promises have been required.

Available since: 6.5.0

Returns

:Ext.Promise

getCachedResolved Ext.Promise
static sta private pri

Get a shared cached resolved promise. Assumes Promises have been required.

Available since: 6.5.0

Returns

:Ext.Promise

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

map ( promisesOrValues, mapFn ) : Ext.promise.Promise
static sta

Traditional map function, similar to Array.prototype.map(), that allows input to contain promises and/or values.

The specified map function may return either a value or a promise.

Parameters

promisesOrValues :  Mixed[]/Ext.promise.Promise[]/Ext.promise.Promise

An Array of values or Promises, or a Promise of an Array of values or Promises.

mapFn :  Function

A Function to call to transform each resolved value in the Array.

Returns

:Ext.promise.Promise

A Promise of an Array of the mapped resolved values.

memoize ( fn, scope, hashFn ) : Function
static sta

Returns a new function that wraps the specified function and caches the results for previously processed inputs.

Similar to Ext.Function.memoize(), except it allows for parameters that are Promises and/or values.

Parameters

fn :  Function

A Function to wrap.

scope :  Object

An optional scope in which to execute the wrapped function.

hashFn :  Function

An optional function used to compute a hash key for storing the result, based on the arguments to the original function.

Returns

:Function

The new wrapper function.

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

parallel ( fns, scope ) : Ext.promise.Promise
static sta

Execute an Array (or Ext.promise.Promise of an Array) of functions in parallel.

The specified functions may optionally return their results as Ext.promise.Promise.

Parameters

fns :  Function[]/Ext.promise.Promise

The Array (or Promise of an Array) of functions to execute.

scope :  Object

Optional scope in which to execute the specified functions.

Returns

:Ext.promise.Promise

Promise of an Array of results for each function call (in the same order).

pipeline ( fns, initialValue, scope ) : Ext.promise.Promise
static sta

Execute an Array (or Ext.promise.Promise of an Array) of functions as a pipeline, where each function's result is passed to the subsequent function as input.

The specified functions may optionally return their results as Ext.promise.Promise.

Parameters

fns :  Function[]/Ext.promise.Promise

The Array (or Promise of an Array) of functions to execute.

initialValue :  Object

Initial value to be passed to the first function in the pipeline.

scope :  Object

Optional scope in which to execute the specified functions.

Returns

:Ext.promise.Promise

Promise of the result value for the final function in the pipeline.

race ( promises ) : Ext.promise.Promise
static sta

Returns a promise that resolves or rejects as soon as one of the promises in the array resolves or rejects, with the value or reason from that promise.

Available since: 6.5.0

Parameters

promises :  Ext.promise.Promise[]

The promises.

Returns

:Ext.promise.Promise

The promise to be resolved when the race completes.

reduce ( values, reduceFn, initialValue ) : Ext.promise.Promise
static sta

Traditional reduce function, similar to Array.reduce(), that allows input to contain promises and/or values.

Parameters

values :  Mixed[]/Ext.promise.Promise[]/Ext.promise.Promise

An Array of values or Promises, or a Promise of an Array of values or Promises.

reduceFn :  Function

A Function to call to transform each successive item in the Array into the final reduced value.

initialValue :  Mixed

An initial Promise or value.

Returns

:Ext.promise.Promise

A Promise of the reduced value.

rejected ( reason ) : Ext.promise.Promise
static sta

Convenience method that returns a new Promise rejected with the specified reason.

Parameters

reason :  Error

Rejection reason.

Returns

:Ext.promise.Promise

The rejected Promise.

resolved ( promiseOrValue ) : Ext.promise.Promise
static sta

Returns a new Promise that either

  • Resolves immediately for the specified value, or
  • Resolves or rejects when the specified promise (or third-party Promise or then()-able) is resolved or rejected.

Parameters

promiseOrValue :  Mixed

A Promise (or third-party Promise or then()-able) or value.

Returns

:Ext.promise.Promise

A Promise of the specified Promise or value.

sequence ( fns, scope ) : Ext.promise.Promise
static sta

Execute an Array (or Ext.promise.Promise of an Array) of functions sequentially.

The specified functions may optionally return their results as Ext.promise.Promise.

Parameters

fns :  Function[]/Ext.promise.Promise

The Array (or Promise of an Array) of functions to execute.

scope :  Object

Optional scope in which to execute the specified functions.

Returns

:Ext.promise.Promise

Promise of an Array of results for each function call (in the same order).

some ( promisesOrValues, howMany ) : Ext.promise.Promise
static sta

Initiates a competitive race, returning a new Promise that will resolve when howMany of the specified promisesOrValues have resolved, or will reject when it becomes impossible for howMany to resolve.

The resolution value will be an Array of the first howMany values of promisesOrValues to resolve.

Parameters

promisesOrValues :  Mixed[]/Ext.promise.Promise[]/Ext.promise.Promise

An Array of values or Promises, or a Promise of an Array of values or Promises.

howMany :  Number

The expected number of resolved values.

Returns

:Ext.promise.Promise

A Promise of the expected number of resolved values.

timeout ( promiseOrValue, milliseconds ) : Ext.promise.Promise
static sta

Returns a new Promise that will automatically reject after the specified timeout (in milliseconds) if the specified promise has not resolved or rejected.

Parameters

promiseOrValue :  Mixed

A Promise or value.

milliseconds :  Number

A timeout duration (in milliseconds).

Returns

:Ext.promise.Promise

A Promise of the specified Promise or value that enforces the specified timeout.

triggerExtended
static sta private pri

Ext JS 6.6.0 - Classic Toolkit