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


top

Ext.ClassManager singleton

Hierarchy

Ext.ClassManager

Summary

Ext.ClassManager manages all classes and handles mapping from string class name to actual class objects throughout the whole framework. It is not generally accessed directly, rather through these convenient shorthands:

Basic syntax:

Ext.define(className, properties);

in which properties is an object represent a collection of properties that apply to the class. See Ext.ClassManager#create for more detailed instructions.

Ext.define('Person', {
     name: 'Unknown',

     constructor: function(name) {
         if (name) {
             this.name = name;
         }
     },

     eat: function(foodType) {
         alert("I'm eating: " + foodType);

         return this;
     }
});

var aaron = new Person("Aaron");
aaron.eat("Sandwich"); // alert("I'm eating: Sandwich");

Ext.Class has a powerful set of extensible pre-processors which takes care of everything related to class creation, including but not limited to inheritance, mixins, configuration, statics, etc.

Inheritance:

Ext.define('Developer', {
     extend: 'Person',

     constructor: function(name, isGeek) {
         this.isGeek = isGeek;

         // Apply a method from the parent class' prototype
         this.callParent([name]);
     },

     code: function(language) {
         alert("I'm coding in: " + language);

         this.eat("Bugs");

         return this;
     }
});

var jacky = new Developer("Jacky", true);
jacky.code("JavaScript"); // alert("I'm coding in: JavaScript");
                          // alert("I'm eating: Bugs");

See Ext.Base#callParent for more details on calling superclass' methods

Mixins:

Ext.define('CanPlayGuitar', {
     playGuitar: function() {
        alert("F#...G...D...A");
     }
});

Ext.define('CanComposeSongs', {
     composeSongs: function() { ... }
});

Ext.define('CanSing', {
     sing: function() {
         alert("For he's a jolly good fellow...")
     }
});

Ext.define('Musician', {
     extend: 'Person',

     mixins: {
         canPlayGuitar: 'CanPlayGuitar',
         canComposeSongs: 'CanComposeSongs',
         canSing: 'CanSing'
     }
})

Ext.define('CoolPerson', {
     extend: 'Person',

     mixins: {
         canPlayGuitar: 'CanPlayGuitar',
         canSing: 'CanSing'
     },

     sing: function() {
         alert("Ahem....");

         this.mixins.canSing.sing.call(this);

         alert("[Playing guitar at the same time...]");

         this.playGuitar();
     }
});

var me = new CoolPerson("Jacky");

me.sing(); // alert("Ahem...");
           // alert("For he's a jolly good fellow...");
           // alert("[Playing guitar at the same time...]");
           // alert("F#...G...D...A");

Config:

Ext.define('SmartPhone', {
     config: {
         hasTouchScreen: false,
         operatingSystem: 'Other',
         price: 500
     },

     isExpensive: false,

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

     applyPrice: function(price) {
         this.isExpensive = (price > 500);

         return price;
     },

     applyOperatingSystem: function(operatingSystem) {
         if (!(/^(iOS|Android|BlackBerry)$/i).test(operatingSystem)) {
             return 'Other';
         }

         return operatingSystem;
     }
});

var iPhone = new SmartPhone({
     hasTouchScreen: true,
     operatingSystem: 'iOS'
});

iPhone.getPrice(); // 500;
iPhone.getOperatingSystem(); // 'iOS'
iPhone.getHasTouchScreen(); // true;

iPhone.isExpensive; // false;
iPhone.setPrice(600);
iPhone.getPrice(); // 600
iPhone.isExpensive; // true;

iPhone.setOperatingSystem('AlienOS');
iPhone.getOperatingSystem(); // 'Other'

Statics:

Ext.define('Computer', {
     statics: {
         factory: function(brand) {
            // 'this' in static methods refer to the class itself
             return new this(brand);
         }
     },

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

var dellComputer = Computer.factory('Dell');

Also see Ext.Base#statics and Ext.Base#self for more details on accessing static properties within class methods

No members found using the current filters

configs

Optional Configs

debugHooks : Object

A collection of diagnostic methods to decorate the real methods of the class. These methods are applied as an override if this class has debug enabled as defined by Ext.isDebugEnabled.

These will be automatically removed by the Sencha Cmd compiler for production builds.

Example usage:

 Ext.define('Foo.bar.Class', {
     foo: function (a, b, c) {
         ...
     },

     bar: function (a, b) {
         ...
         return 42;
     },

     debugHooks: {
         foo: function (a, b, c) {
             // check arguments...
             return this.callParent(arguments);
         }
     }
 });

If you specify a $enabled property in the debugHooks object that will be used as the default enabled state for the hooks. If the Ext#manifest contains a debug object of if Ext#debugConfig is specified, the $enabled flag will override its "*" value.

deprecated : Object

The object given has properties that describe the versions at which the deprecations apply.

The purpose of the deprecated declaration is to enable development mode to give suitable error messages when deprecated methods or properties are used. Methods can always be injected to provide this feedback, but properties can only be handled on some browsers (those that support Object.defineProperty).

In some cases, deprecated methods can be restored to their previous behavior or added back if they have been removed.

The structure of a deprecated declaration is this:

 Ext.define('Foo.bar.Class', {
     ...

     deprecated: {
         // Optional package name - default is the framework (ext or touch)
         name: 'foobar',

         '5.0': {
             methods: {
                 // Throws: '"removedMethod" is deprecated.'
                 removedMethod: null,

                 // Throws: '"oldMethod" is deprecated. Please use "newMethod" instead.'
                 oldMethod: 'newMethod',

                 // When this block is enabled, this method is applied as an
                 // override. Otherwise you get same as "removeMethod".
                 method: function () {
                     // Do what v5 "method" did. If "method" exists in newer
                     // versions callParent can call it. If 5.1 has "method"
                     // then it would be next in line, otherwise 5.2 and last
                     // would be the current class.
                 },

                 moreHelpful: {
                     message: 'Something helpful to do instead.',
                     fn: function () {
                         // The v5 "moreHelpful" method to use when enabled.
                     }
                 }
             },
             properties: {
                 // Throws: '"removedProp" is deprecated.'
                 removedProp: null,

                 // Throws: '"oldProp" is deprecated. Please use "newProp" instead.'
                 oldProp: 'newProp',

                 helpful: {
                     message: 'Something helpful message about what to do.'
                 }
                 ...
             },
             statics: {
                 methods: {
                     ...
                 },
                 properties: {
                     ...
                 },
             }
         },

         '5.1': {
             ...
         },

         '5.2': {
             ...
         }
     }
 });

The primary content of deprecated are the version number keys. These indicate a version number where methods or properties were deprecated. These versions are compared to the version reported by Ext.getCompatVersion to determine the action to take for each "block".

When the compatibility version is set to a value less than a version number key, that block is said to be "enabled". For example, if a method was deprecated in version 5.0 but the desired compatibility level is 4.2 then the block is used to patch methods and (to some degree) restore pre-5.0 compatibility.

When multiple active blocks have the same method name, each method is applied as an override in reverse order of version. In the above example, if a method appears in the "5.0", "5.1" and "5.2" blocks then the "5.2" method is applied as an override first, followed by the "5.1" method and finally the "5.0" method. This means that the callParent from the "5.0" method calls the "5.1" method which calls the "5.2" method which can (if applicable) call the current version.

properties

Instance Properties

$namespaceCache
private pri

Supports namespace rewriting.

Defaults to:

namespaceCache

classes : Object
private pri

All classes which were defined through the ClassManager. Keys are the name of the classes and the values are references to the classes.

Defaults to:

{}

createdListeners
private pri

Defaults to:

[]

defaultPostprocessors
private pri

Defaults to:

[]

existCache
private pri

Defaults to:

{}

existsListeners
private pri

Defaults to:

[]

instantiators
private pri

Defaults to:

[]

nameCreatedListeners
private pri

Defaults to:

{}

nameExistsListeners
private pri

Defaults to:

{}

overrideMap
private pri

Defaults to:

{}

postprocessors
private pri

Defaults to:

{}

methods

Instance Methods

addListener ( fn, scope, className, listeners, nameListeners )
private pri

Parameters

fn :  Object

scope :  Object

className :  Object

listeners :  Object

nameListeners :  Object

addNameAliasMappings ( aliases )

Adds a batch of class name to alias mappings.

Parameters

aliases :  Object

The set of mappings of the form. className : [values...]

addNameAlternateMappings ( alternates )

Parameters

alternates :  Object

The set of mappings of the form className : [values...]

addRootNamespaces ( namespaces )
private pri

See Ext.addRootNamespaces.

Available since: 6.0.0

Parameters

namespaces :  Object

clearNamespaceCache
private pri

Clears the namespace lookup cache. After application launch, this cache can often contain several hundred entries that are unlikely to be needed again. These will be rebuilt as needed, so it is harmless to clear this cache even if its results will be used again.

Available since: 6.0.0

create ( className, data, createdFn )
deprecated dep private pri

Defines a class.

Parameters

className :  Object

data :  Object

createdFn :  Object

Deprecated since version 4.1

dynInstantiate ( name, args )
private pri

Parameters

name :  Object

args :  Object

get ( name ) : Ext.Class

Retrieve a class by its name.

Parameters

name :  String

Returns

:Ext.Class

class

getByAlias ( alias ) : Ext.Class

Get a reference to the class by its alias.

Parameters

alias :  String

Returns

:Ext.Class

class

getByConfig ( config, [aliasPrefix] ) : Ext.Class
private pri

Get a component class name from a config object.

Parameters

config :  Object

The config object.

aliasPrefix :  String (optional)

A prefix to use when getting a class name by alias.

Returns

:Ext.Class

The class.

getClass ( object ) : Ext.Class

Get the class of the provided object; returns null if it's not an instance of any class created with Ext.define. This is usually invoked by the shorthand Ext#getClass.

var component = new Ext.Component();

Ext.getClass(component); // returns Ext.Component

Parameters

object :  Object

Returns

:Ext.Class

class

getDisplayName ( object ) : String

Returns the displayName property or className or object. When all else fails, returns "Anonymous".

Parameters

object :  Object

Returns

:String

getInstantiator ( length )
private pri

Parameters

length :  Object

getName ( object ) : String

Get the name of the class by its reference or its instance. This is usually invoked by the shorthand Ext#getClassName.

Ext.ClassManager.getName(Ext.Action); // returns "Ext.Action"

Parameters

object :  Ext.Class / Object

Returns

:String

className

getNamespaceEntry ( namespace ) : Object
private pri

Return the namespace cache entry for the given a class name or namespace (e.g., "Ext.grid.Panel").

Available since: 6.0.0

Parameters

namespace :  String

The namespace or class name to lookup.

Returns

:Object

The cache entry.

name :  String

The leaf name ("Panel" for "Ext.grid.Panel").

parent :  Object

The entry of the parent namespace (i.e., "Ext.grid").

value :  Object

The namespace object. This is only set for top-level namespace entries to support renaming them for sandboxing ("Ext6" vs "Ext").

instantiate ( name, args ) : Object
deprecated dep

Instantiate a class by either full name, alias or alternate name

Parameters

name :  String

args :  Mixed

Additional arguments after the name will be passed to the class' constructor.

Returns

:Object

instance

Deprecated since version 5.0

instantiateByAlias ( alias, args ) : Object

Instantiate a class by its alias. This is usually invoked by the shorthand Ext#createByAlias.

If Ext.Loader is enabled and the class has not been defined yet, it will attempt to load the class via synchronous loading.

var window = Ext.createByAlias('widget.window', { width: 600, height: 800 });

Parameters

alias :  String

args :  Object...

Additional arguments after the alias will be passed to the class constructor.

Returns

:Object

instance

isCreated ( className ) : Boolean

Checks if a class has already been created.

Parameters

className :  String

Returns

:Boolean

exist

lookupName ( namespace, [autoCreate] ) : Object
private pri

Return the value of the given "dot path" name. This supports remapping (for use in sandbox builds) as well as auto-creating of namespaces.

Available since: 6.0.0

Parameters

namespace :  String

The name of the namespace or class.

autoCreate :  Boolean (optional)

Pass true to create objects for undefined names.

Returns

:Object

The object that is the namespace or class name.

notify ( className, listeners, nameListeners )
private pri

Parameters

className :  Object

listeners :  Object

nameListeners :  Object

onCreated ( fn, scope, className )
private pri

Parameters

fn :  Object

scope :  Object

className :  Object

registerPostprocessor ( name, fn, properties, position, relativeTo ) :
chainable ch private pri

Register a post-processor function.

Parameters

name :  String

fn :  Function

properties :  String / String[]

position :  String

relativeTo :  String

Returns

:

set ( name, value ) : Ext.ClassManager

Sets a name reference to a class.

Parameters

name :  String

value :  Object

Returns

:Ext.ClassManager

this

setDefaultPostprocessorPosition ( name, offset, relativeName ) : Ext.ClassManager
chainable ch private pri

Insert this post-processor at a specific position in the stack, optionally relative to any existing post-processor

Parameters

name :  String

The post-processor name. Note that it needs to be registered with Ext.ClassManager#registerPostprocessor before this

offset :  String

The insertion position. Four possible values are: 'first', 'last', or: 'before', 'after' (relative to the name provided in the third argument)

relativeName :  String

Returns

:Ext.ClassManager

this

setDefaultPostprocessors ( postprocessors ) : Ext.ClassManager
chainable ch private pri

Set the default post processors array stack which are applied to every class.

Parameters

postprocessors :  String / Array

The name of a registered post processor or an array of registered names.

Returns

:Ext.ClassManager

this

setNamespace ( namespace, value )

Creates a namespace and assign the value to the created object.

Ext.ClassManager.setNamespace('MyCompany.pkg.Example', someObject);

alert(MyCompany.pkg.Example === someObject); // alerts true

Parameters

namespace :  String

value :  Object

setXType ( cls, xtype )
private pri

Changes the mapping of an xtype to map to the specified component class.

Available since: 6.0.1

Parameters

cls :  String / Ext.Class

The class or class name to which xtype is mapped.

xtype :  String

The xtype to map or redefine as cls.

triggerCreated ( className, state )
private pri

Parameters

className :  Object

state :  Object

undefine ( className )
private pri

Undefines a class defined using the #define method. Typically used for unit testing where setting up and tearing down a class multiple times is required. For example:

// define a class
Ext.define('Foo', {
   ...
});

// run test

// undefine the class
Ext.undefine('Foo');

Parameters

className :  String

The class name to undefine in string dot-namespaced format.

Ext JS 6.2.1 - Modern Toolkit