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.2.1 - Classic Toolkit


top

Ext.data.schema.Schema alias: schema.default

Summary

A Schema is a collection of related Ext.data.Model and their respective Ext.data.schema.Association.

Schema Instances

By default a single instance of this class is created which serves as the schema for all entities that do not have an explicit schema config either specified or inherited. This is sufficient in most cases.

When an entity does specify a schema, however, that looks up (or creates) an instance for that entity class which is then inherited.

Important: All related entities must belong to a single schema instance in order to properly link up their associations.

Configuring Schemas

The best way to control the configuration of your schema is to define a base class for all of your entities and use the schema config like this:

 Ext.define('MyApp.model.Base', {
     extend: 'Ext.data.Model',

     // This configures the default schema because we don't assign an "id":
     schema: {
         // configs go here
     }
 });

Note: Only one explicit configuration can be applied to the default schema. In most applications this will not be an issue.

By using a base class for your entities you can ensure that the default schema is fully configured before declaration of your classes proceeds. This is especially helpful if you need to set the namespace for your schema (see below).

Relative Naming

When describing associations between entities, it is desirable to use shorthand names that do not contain the common namespace portion. This is called the entityName as opposed to its class name. By default, the entityName is the full class name. However, if a namespace is used, the common portion can be discarded and we can derive a shorter name. In the following code, "MyApp.model.Foo" has an entityName of "Foo" and the schema has a namespace of "MyApp.model".

If you use deeper nesting for entities, you may need to set the namespace config to account for this. For example:

 Ext.define('MyApp.model.Base', {
     extend: 'Ext.data.Model',

     schema: {
         namespace: 'MyApp.model'
     }
 });

Your derived classes now will generate proper default entityName values even if they have further namespaces. For example, "MyApp.model.foo.Thing" will produce "foo.Thing" as the entityName given the above as a base class.

Association Naming

There are various terms involved when describing associations. Perhaps the simplest example that will clarify these terms is that of the common many-to-many association of User and Group.

  • entityName - The names "User" and "Group" are the entityName values associated with these two classes. These are derived from their full classnames (perhaps something like "App.model.User" and "App.model.Group").

  • associationName - When talking about associations, especially the many-to-many variety, it is important to give them names. Associations are not owned by either of the entities involved, so this name is similar to an entityName. In the case of "User" and "Group", the default associationName would be "GroupUsers".

  • left and right - Associations describe a relationship between two entities. To talk about specific associations we would use the entityName of the parties (such as "User" or "Group"). When discussing associations in the abstract, however, it is very helpful to be able to talk about the entities in an association in a general way. In the case of the "GroupUsers" association, "User" is said to be the left while "Group" is said to be the right. In a many-to-many association the selection of left and right is arbitrary. When a foreign-key is involved, the left entity is the one containing the foreign-key.

Custom Naming Conventions

One of the jobs the the Schema is to manage name generation (such as entityName). This job is delegated to a class called the namer. If you need to generate names in other ways, you can provide a custom namer for your classes:

 Ext.define('MyApp.model.Base', {
     extend: 'Ext.data.Model',

     schema: {
         namespace: 'MyApp.model',
         namer: 'custom'
     }
 });

This will create a class using the alias "namer.custom". For example:

 Ext.define('MyApp.model.CustomNamer', {
     extend: 'Ext.data.schema.Namer',

     alias: 'namer.custom',
     ...
 });

For details see the documentation for Ext.data.schema.Namer.

No members found using the current filters

configs

Optional Configs

defaultIdentifier : Object

This config is used to initialize the Ext.data.Model#identifier config for classes that do not define one.

Defaults to:

null

getDefaultIdentifier : Object

Returns the value of defaultIdentifier

Returns

Object

setDefaultIdentifier (defaultIdentifier)

Sets the value of defaultIdentifier

Parameters

defaultIdentifier :  Object

keyCheckDelay : Number
private pri

The time to wait (in ms) before checking for null foreign keys on records that will cause them to be dropped. This is useful for allowing records to be moved to a different source.

Defaults to:

10

Available since: 5.0.1

getKeyCheckDelay : Number

Returns the value of keyCheckDelay

Returns

Number

setKeyCheckDelay (keyCheckDelay)

Sets the value of keyCheckDelay

Parameters

keyCheckDelay :  Number

namer : String / Object / Ext.data.schema.Namer

Specifies or configures the name generator for the schema.

Defaults to:

'default'

getNamer : String / Object / Ext.data.schema.Namer

Returns the value of namer

Returns

String / Object / Ext.data.schema.Namer

setNamer (namer)

Sets the value of namer

Parameters

namer :  String / Object / Ext.data.schema.Namer

namespace : String

The namespace for entity classes in this schema.

Defaults to:

null

getNamespace : String

Returns the value of namespace

Returns

String

setNamespace (namespace)

Sets the value of namespace

Parameters

namespace :  String

proxy : Object / Ext.util.ObjectTemplate

This is a template used to produce Ext.data.proxy.Proxy configurations for Models that do not define an explicit proxy.

This template is processed with the Model class as the data object which means any static properties of the Model are available. The most useful of these are

  • prefix - The urlPrefix property of this instance.
  • entityName - The name of the Model (for example, "User").
  • schema - This instance.

Defaults to:

{
    type: 'ajax',
    url: '{prefix}/{entityName}'
}

setProxy (proxy)

Sets the value of proxy

Parameters

proxy :  Object / Ext.util.ObjectTemplate

urlPrefix : String

This is the URL prefix used for all requests to the server. It could be something like "/~api". This value is included in the proxy template data as "prefix".

Defaults to:

""

getUrlPrefix : String

Returns the value of urlPrefix

Returns

String

setUrlPrefix (urlPrefix)

Sets the value of urlPrefix

Parameters

urlPrefix :  String

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

assocCount : Number
readonly ro

The number of Ext.data.schema.Association in this schema.

Defaults to:

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

destroyed : Boolean
protected pro

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

Defaults to:

false

entityCount : Number
readonly ro

The number of Ext.data.Model in this schema.

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.

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

type : String
readonly ro

The name of the schema's type. This should be the suffix of the alias for this class following the "schema." prefix. For example, if the alias for a schema is "schema.foo" then type should "foo". If an alias is specified on the derived class, this property is set automatically.

Defaults to:

'default'

Static Properties

$onExtended
static sta private pri

Defaults to:

[]

instances : Object
readonly ro static sta private pri

A collection of Schema instances keyed by its type.

 var mySchema = Ext.data.schema.Schema.instances.mySchema;

If the Schema may not have been created yet, use the get method to create the instance on first request:

 var mySchema = Ext.data.schema.Schema.get('mySchema');

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

addEntity ( entityType )
private pri

Adds an Ext.data.Model to this schema.

Parameters

entityType :  Ext.Class

A class derived from Ext.data.Model.

addMatrices ( entityType, matrices )
private pri

Adds the matrix associations of an Ext.data.Model to this schema.

Parameters

entityType :  Ext.Class

A class derived from Ext.data.Model.

matrices :  Object/String[]

The manyToMany matrices for the class.

addMatrix ( entityType, matrixName, [relation], left, right )
protected pro

Adds an entry from a Ext.data.schema.ManyToMany declared by an entity.

This is the ideal method to override in a derived class if the standard, default naming conventions need to be adjusted. In the override, apply whatever logic is appropriate to determine the missing values and pass along the proper results to this method in the callParent.

Parameters

entityType :  Ext.Class

A class derived from Ext.data.Model.

matrixName :  String

The name of the matrix association.

relation :  String (optional)

A base name for the matrix. For information about the meaning of this see Ext.data.Schema#ManyToMany.

left :  Object

The descriptor for the "left" of the matrix.

type :  String

The type of the entity on the "left" of the matrix.

field :  String (optional)

The name of the field in the matrix table for the "left" side entity. If not provided, this defaults to the left.type name singularized and uncapitalized followed by "Id". For example, "userId" for a left.type of "Users".

role :  String (optional)

The name of the relationship from the left.type to the right.type. If not provided, this defaults to the left.type name pluralized and uncapitalized. For example, "users" for a left.type of "User".

right :  Object

The descriptor for the "right" of the matrix.

type :  String

The type of the entity on the "right" of the matrix.

field :  String (optional)

The name of the field in the matrix table for the "right" side entity. If not provided, this defaults in the same way as left.field except this is based on right.type.

role :  String (optional)

The name of the relationship from the right.type to the left.type. If not provided, this defaults in the same way as left.role except this is based on right.type.

addMatrixDescr ( entityType, [matrixName], matrixDef )
private pri

Adds an entry from a Ext.data.schema.ManyToMany declared by an Ext.data.Model.

Parameters

entityType :  Ext.Class

A class derived from Ext.data.Model.

matrixName :  String (optional)

The name of the matrix association.

matrixDef :  String/Object

addReference ( entityType, referenceField, [descr], [unique] )
protected pro

Adds a reference field association for an entity to this schema.

This is the ideal method to override in a derived class if the standard, default naming conventions need to be adjusted. In the override, apply whatever logic is appropriate to determine the missing values and pass along the proper results to this method in the callParent.

Parameters

entityType :  Ext.Class

A class derived from Ext.data.Model.

referenceField :  Ext.data.field.Field

The field with the reference config.

descr :  Object (optional)

The reference descriptor from the referenceField if one was given in the field definition.

association :  String (optional)

The name of the association. If empty or null, this will be derived from entityType, role, inverse and referenceField.unique.

role :  String (optional)

The name of the relationship from entityType to the target type. If not specified, the default is the referenceField.name (minus any "Id" suffix if present).

inverse :  String (optional)

The name of the relationship from the target type to the entityType. If not specified, this is derived from the entityName of the entityType (singularized or pluralized based on referenceField.unique).

type :  String

The entityName of the target of the reference.

unique :  Boolean (optional)

Indicates if the reference is one-to-one.

Defaults to: false

addReferenceDescr ( entityType, referenceField )
private pri

Adds a reference field association for an entity to this schema. This method decodes the reference config of the referenceField and calls addReference.

Parameters

entityType :  Ext.Class

A class derived from Ext.data.Model.

referenceField :  Ext.data.field.Field

The field with the reference config.

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

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.

getAssociation ( name ) : Ext.data.schema.Association

Returns an Association by name.

Parameters

name :  String

The name of the association.

Returns

:Ext.data.schema.Association

The association instance.

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.

getEntity ( name ) : Ext.data.Model

Returns an entity by name.

Parameters

name :  String

The name of the entity

Returns

:Ext.data.Model

The entity class.

getEntityName ( cls ) : String

Get the entity name taking into account the namespace.

Parameters

cls :  String/Ext.data.Model

The model class or name of the class.

Returns

:String

The entity name

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.

hasAssociations ( name ) : Boolean

Checks if the passed entity has attached associations that need to be read when using nested loading.

Parameters

name :  String/Ext.Class/Ext.data.Model

The name, instance, or Model class.

Returns

:Boolean

true if there are associations attached to the entity.

hasConfig ( name )
private pri

Parameters

name :  String

hasEntity ( entity ) : Boolean

Checks if an entity is defined

Parameters

entity :  String/Ext.data.Model

The name or model

Returns

:Boolean

True if this entity is defined

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

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

get ( config ) : Ext.data.schema.Schema
static sta

Returns the Schema instance given its id or config object. If only the id is specified, that Schema instance is looked up and returned. If there is no instance already created, the id is assumed to be the type. For example:

 schema: 'foo'

Would be created from the alias "schema.foo" and assigned the id of "foo" as well.

Parameters

config :  String/Object

The id, type or config object of the schema.

type :  String (optional)

The type alias of the schema. A "schema." prefix is added to this string, if provided, to complete the alias. This should match match the "alias" of some class derived from Ext.data.schema.Schema.

Returns

:Ext.data.schema.Schema

The previously existing or newly created instance.

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 Ext.Base#callParent.

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

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

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

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

Direct use of this method should be rare. Use Ext.define instead:

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

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

Parameters

members :  Object

The properties to add to this class. This should be specified as an object literal containing one or more properties.

Returns

:Ext.Base

this class

triggerExtended
static sta private pri

Ext JS 6.2.1 - Classic Toolkit