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 5.1.0


top

Summary

This class manages models and their associations. Instances of Session are typically associated with some Component (perhaps the Viewport or a Window) and then used by their Ext.app.ViewModel to enable data binding.

The primary job of a Session is to manage a collection of records of many different types and their associations. This often starts by loading records when requested (via bind - see below) and culminates when it is time to save to the server.

Because the Session tracks all records it loads, it ensures that for any given type of model, only one record exists with a given id. This means that all edits of that record are properly targeted at that one instance.

Similarly, when associations are loaded, the Ext.data.Store created to hold the associated records is tracked by the Session. So all requests for the "OrderItems" of a particular Order id will result in the same Store. Adding and removing items from that Order then is sure to remain consistent.

Data

Since the Session is managing all this data, there are several methods it provides to give convenient access to that data. The most important of these is update and getChanges.

The update and getChanges methods both operate on object that contains a summary of records and associations and different CRUD operations.

Saving

There are two basic ways to save the contents of a Session: getChanges and getSaveBatch. We've already seen getChanges. The data contained in the CRUD object can be translated into whatever shape is needed by the server.

To leverage the proxy facilities defined by each Model class, there is the getSaveBatch method. That method returns an Ext.data.Batch object populated with the necessary create, update and destory operations to save all of the changes in the Session.

No members found using the current filters

configs

Optional Configs

autoDestroy : Boolean

true to automatically destroy this session when a component it is attached to is destroyed. This should be set to false if the session is intended to be used across multiple root level components.

Defaults to:

true

Available since: 5.0.1

getAutoDestroy : Boolean

Returns the value of autoDestroy

Returns

Boolean

setAutoDestroy (autoDestroy)

Sets the value of autoDestroy

Parameters

autoDestroy :  Boolean

parent : Ext.data.Session

The parent session for this session.

Defaults to:

null

getParent : Ext.data.Session

Returns the value of parent

Returns

Ext.data.Session

setParent (parent)

Sets the value of parent

Parameters

parent :  Ext.data.Session

schema : String / Ext.data.schema.Schema

Defaults to:

'default'

getSchema : String / Ext.data.schema.Schema

Returns the value of schema

Returns

String / Ext.data.schema.Schema

setSchema (schema)

Sets the value of schema

Parameters

schema :  String / Ext.data.schema.Schema

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

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

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

add ( record )
private pri

Add a record instance to this session. Called by model.

Parameters

record :  Ext.data.Model

The record.

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

adopt ( record )

Adds an existing record instance to the session. The record may not belong to another session. The record cannot be a phantom record, instead use createRecord.

Parameters

record :  Ext.data.Model

The record to adopt.

afterErase ( record )
private pri

Template method, will be called by Model after a record is dropped.

Parameters

record :  Ext.data.Model

The record.

applySchema ( schema )
private pri

Parameters

schema :  Object

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

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

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

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

checkModelType ( name )
private pri

Checks if the model type being referenced is valid for this session. That includes checking if the model name is correct & is one used in this schema for this session. Will raise an exception if the model type is not correct.

Parameters

name :  String/Ext.Class

The model name or model type.

commit

Marks the session as "clean" by calling Ext.data.Model#commit on each record that is known to the session.

  • Phantom records will no longer be phantom.
  • Modified records will no longer be dirty.
  • Dropped records will be erased.

Available since: 5.1.0

createEntities ( entityType, items )
private pri

Process a create block of entities from the update method.

Parameters

entityType :  Ext.Class

The entity type.

items :  Object[]

The data objects to create.

createRecord ( type, [data] ) : Ext.data.Model

Creates a new record and tracks it in this session.

Parameters

type :  String/Ext.Class

The entityName or the actual class of record to create.

data :  Object (optional)

The data for the record.

Returns

:Ext.data.Model

The new record.

destroy
protected pro

This method is called to cleanup an object and its resources. After calling this method, the object should not be used any further.

dropEntities ( entityType, ids )
private pri

Process a drop block for entities from the update method.

Parameters

entityType :  Ext.Class

The entity type.

ids :  Object[]

The identifiers of the items to drop.

evict ( record )
private pri

Remove a record and any references from the session.

Parameters

record :  Ext.data.Model

The record

getChanges Object

Returns an object describing all of the modified fields, created or dropped records and many-to-many association changes maintained by this session.

Returns

:Object

An object in the CRUD format (see the intro docs). null if there are no changes.

getChangesForParent Object
protected pro

The same functionality as getChanges, however we also take into account our parent session.

Returns

:Object

An object in the CRUD format (see the intro docs). null if there are no changes.

getConfig ( [name], [peek] ) : 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

Returns

:Object

The config property value.

getEntityList ( entityType, ids ) : Ext.data.Model[]
private pri

Transforms a list of ids into a list of records for a particular type.

Parameters

entityType :  Ext.Class

The entity type.

ids :  Object[]

The ids to transform.

Returns

:Ext.data.Model[]

The models corresponding to the ids.

getEntry ( type, id ) : Object
private pri

Return an entry for the data property for a particular type/id.

Parameters

type :  String/Ext.Class

The entity name or model type.

id :  Object

The id of the record

Returns

:Object

The data entry.

getInitialConfig ( [name] ) : Object/Mixed

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

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.

getModelIdentifier ( entityType, id ) : String
private pri

Gets a user friendly identifier for a Model.

Parameters

entityType :  Ext.Class

The entity type.

id :  Object

The id of the entity.

Returns

:String

The identifier.

getRecord ( type, id, [autoLoad] ) : Ext.data.Model

Get a cached record from the session. If the record does not exist, it will be created. If the autoLoad parameter is not set to false, the record will be loaded via the proxy of the Model.

If this session is configured with a parent session, a copy of any existing record in the parent will be adopted into this session. If the parent does not contain the record, the record will be created and not inserted into the parent.

See also peekRecord.

Parameters

type :  String/Ext.Class

The entityName or the actual class of record to create.

id :  Object

The id of the record.

autoLoad :  Boolean/Object (optional)

false to prevent the record from being loaded if it does not exist. If this parameter is an object, it will be passed to the Ext.data.Model#load call.

Defaults to: true

Returns

:Ext.data.Model

The record.

getSaveBatch ( [sort] ) : Ext.data.Batch

Returns an Ext.data.Batch containing the Ext.data.operation.Operation instances that are needed to save all of the changes in this session. This sorting is based on operation type, associations and foreign keys. Generally speaking the operations in the batch can be committed to a server sequentially and the server will never be sent a request with an invalid (client-generated) id in a foreign key field.

Parameters

sort :  Boolean (optional)

Pass false to disable the batch operation sort.

Defaults to: true

Returns

:Ext.data.Batch

hasConfig ( config )
private pri

Parameters

config :  Object

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

onInvalidAssociationEntity ( entityType, id )
template tpl protected pro

Triggered when an associated item from update references a record that does not exist in the session.

Parameters

entityType :  Ext.Class

The entity type.

id :  Object

The id of the model.

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

onInvalidEntityCreate ( entityType, id )
template tpl protected pro

Triggered when an drop block from update tries to create a record that already exists.

Parameters

entityType :  Ext.Class

The entity type.

id :  Object

The id of the model.

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

onInvalidEntityDrop ( entityType, id )
template tpl protected pro

Triggered when an drop block from update references a record that does not exist in the session.

Parameters

entityType :  Ext.Class

The entity type.

id :  Object

The id of the model.

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

onInvalidEntityRead ( entityType, id )
template tpl protected pro

Triggered when an drop block from update tries to create a record that already exists.

Parameters

entityType :  Ext.Class

The entity type.

id :  Object

The id of the model.

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

onInvalidEntityUpdate ( entityType, id, dropped )
template tpl protected pro

Triggered when an update block from update references a record that does not exist in the session.

Parameters

entityType :  Ext.Class

The entity type.

id :  Object

The id of the model.

dropped :  Boolean

true if the record was dropped.

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

peekRecord ( type, id, [deep] ) : Ext.data.Model

Gets an existing record from the session. The record will not be created if it does not exist.

See also: getRecord.

Parameters

type :  String/Ext.Class

The entityName or the actual class of record to create.

id :  Object

The id of the record.

deep :  Boolean (optional)

true to consult

Defaults to: false

Returns

:Ext.data.Model

The record, null if it does not exist.

readEntities ( entityType, items )
private pri

Process a read block of entities from the update method.

Parameters

entityType :  Ext.Class

The entity type.

items :  Object[]

The data objects to read.

save

Save any changes in this session to a parent session.

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

spawn Ext.data.Session

Create a child session with this session as the parent.

Returns

:Ext.data.Session

The copied session.

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

update ( data )

Complete a bulk update for this session.

Parameters

data :  Object

Data in the CRUD format (see the intro docs).

updateEntities ( entityType, items )
private pri

Process an update block for entities from the update method.

Parameters

entityType :  Ext.Class

The entity type.

items :  Object[]

The data objects to update.

visitData ( visitor ) : Object
private pri

Walks the internal data tracked by this session and calls methods on the provided visitor object. The visitor can then accumulate whatever data it finds important. The visitor object can provide a number of methods, but all are optional.

This method does not enumerate associations since these can be traversed given the records that are enumerated. For many-to-many associations, however, this method does enumerate the changes because these changes are not "owned" by either side of such associations.

Parameters

visitor :  Object

onCleanRecord :  Function (optional)

This method is called to describe a record that is known but unchanged.

record :  Ext.data.Model

The unmodified record.

onDirtyRecord :  Function (optional)

This method is called to describe a record that has either been created, dropped or modified.

record :  Ext.data.Model

The modified record.

onMatrixChange :  Function (optional)

This method is called to describe a change in a many-to-many association (a "matrix").

association :  Ext.data.schema.Association

The object describing the many-to-many ("matrix") association.

leftId :  Mixed

The idProperty of the record on the "left" of the association.

rightId :  Mixed

The idProperty of the record on the "right" of the association.

state :  Number

A negative number if the two records are being disassociated or a positive number if they are being associated. For example, when adding User 10 to Group 20, this would be 1. When removing the User this argument would be -1.

Returns

:Object

The visitor instance

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

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

triggerExtended
static sta private pri

Ext JS 5.1.0