Ext JS 4.1.3 Sencha Docs

Ext.Class

Files

Handles class creation throughout the framework. This is a low level factory that is used by Ext.ClassManager and generally should not be used directly. If you choose to use Ext.Class you will lose out on the namespace, aliasing and depency loading features made available by Ext.ClassManager. The only time you would use Ext.Class directly is to create an anonymous class.

If you wish to create a class you should use Ext.define which aliases Ext.ClassManager.create to enable namespacing and dynamic dependency resolution.

Ext.Class is the factory and not the superclass of everything. For the base class that all Ext classes inherit from, see Ext.Base.

Available since: 4.0.0

Defined By

Config options

List of short aliases for class names. ...

List of short aliases for class names. Most useful for defining xtypes for widgets:

Ext.define('MyApp.CoolPanel', {
    extend: 'Ext.panel.Panel',
    alias: ['widget.coolpanel'],
    title: 'Yeah!'
});

// Using Ext.create
Ext.create('widget.coolpanel');

// Using the shorthand for defining widgets by xtype
Ext.widget('panel', {
    items: [
        {xtype: 'coolpanel', html: 'Foo'},
        {xtype: 'coolpanel', html: 'Bar'}
    ]
});

Besides "widget" for xtype there are alias namespaces like "feature" for ftype and "plugin" for ptype.

Available since: 4.0.2

Defines alternate names for this class. ...

Defines alternate names for this class. For example:

Ext.define('Developer', {
    alternateClassName: ['Coder', 'Hacker'],
    code: function(msg) {
        alert('Typing... ' + msg);
    }
});

var joe = Ext.create('Developer');
joe.code('stackoverflow');

var rms = Ext.create('Hacker');
rms.code('hack hack');

Available since: 4.0.2

List of configuration options with their default values, for which automatically accessor methods are generated. ...

List of configuration options with their default values, for which automatically accessor methods are generated. For example:

Ext.define('SmartPhone', {
     config: {
         hasTouchScreen: false,
         operatingSystem: 'Other',
         price: 500
     },
     constructor: function(cfg) {
         this.initConfig(cfg);
     }
});

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

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

Available since: 4.0.2

The parent class that this class extends. ...

The parent class that this class extends. For example:

Ext.define('Person', {
    say: function(text) { alert(text); }
});

Ext.define('Developer', {
    extend: 'Person',
    say: function(text) { this.callParent(["print "+text]); }
});

Available since: 4.0.2

List of inheritable static methods for this class. ...

List of inheritable static methods for this class. Otherwise just like statics but subclasses inherit these methods.

Available since: 4.0.2

List of classes to mix into this class. ...

List of classes to mix into this class. For example:

Ext.define('CanSing', {
     sing: function() {
         alert("I'm on the highway to hell...")
     }
});

Ext.define('Musician', {
     mixins: ['CanSing']
})

In this case the Musician class will get a sing method from CanSing mixin.

But what if the Musician already has a sing method? Or you want to mix in two classes, both of which define sing? In such a cases it's good to define mixins as an object, where you assign a name to each mixin:

Ext.define('Musician', {
     mixins: {
         canSing: 'CanSing'
     },

     sing: function() {
         // delegate singing operation to mixin
         this.mixins.canSing.sing.call(this);
     }
})

In this case the sing method of Musician will overwrite the mixed in sing method. But you can access the original mixed in method through special mixins property.

Available since: 4.0.2

List of classes that have to be loaded before instantiating this class. ...

List of classes that have to be loaded before instantiating this class. For example:

Ext.define('Mother', {
    requires: ['Child'],
    giveBirth: function() {
        // we can be sure that child class is available.
        return new Child();
    }
});

Available since: 4.0.2

When set to true, the class will be instantiated as singleton. ...

When set to true, the class will be instantiated as singleton. For example:

Ext.define('Logger', {
    singleton: true,
    log: function(msg) {
        console.log(msg);
    }
});

Logger.log('Hello');

Available since: 4.0.2

List of static methods for this class. ...

List of static methods for this class. For example:

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

Available since: 4.0.2

Ext.Class
view source
: String[]
List of optional classes to load together with this class. ...

List of optional classes to load together with this class. These aren't neccessarily loaded before this class is created, but are guaranteed to be available before Ext.onReady listeners are invoked. For example:

Ext.define('Mother', {
    uses: ['Child'],
    giveBirth: function() {
        // This code might, or might not work:
        // return new Child();

        // Instead use Ext.create() to load the class at the spot if not loaded already:
        return Ext.create('Child');
    }
});

Available since: 4.0.2

Defined By

Properties

...

Defaults to: []

Available since: 4.1.0

...

Defaults to: {}

Available since: 4.0.0

Methods

Defined By

Instance methods

Ext.Class
view source
new( data, onCreated ) : Ext.Base
Create a new anonymous class. ...

Create a new anonymous class.

Available since: 4.0.0

Parameters

  • data : Object

    An object represent the properties of this class

  • onCreated : Function

    Optional, the callback function to be executed when this class is fully created. Note that the creation process can be asynchronous depending on the pre-processors used.

Returns

Ext.Class
view source
( Class, classData, onClassCreated )private
...

Available since: 4.1.0

Parameters

Ext.Class
view source
( )private
...

Available since: 4.1.0

Ext.Class
view source
( Class, data, hooks )private
...

Available since: 4.1.0

Parameters

Ext.Class
view source
( Class, data, onCreated )private
...

Available since: 4.1.0

Parameters

Fires

    Defined By

    Static methods

    Ext.Class
    view source
    ( ) : Function[]privatestatic
    Retrieve the array stack of default pre-processors ...

    Retrieve the array stack of default pre-processors

    Available since: 4.0.7

    Returns

    Ext.Class
    view source
    ( name ) : Functionprivatestatic
    Retrieve a pre-processor callback function by its name, which has been registered before ...

    Retrieve a pre-processor callback function by its name, which has been registered before

    Available since: 4.0.7

    Parameters

    Returns

    Ext.Class
    view source
    ( name, fn ) : Ext.Classchainableprivatestatic
    Register a new pre-processor to be used during the class creation process ...

    Register a new pre-processor to be used during the class creation process

    Available since: 4.0.7

    Parameters

    • name : String

      The pre-processor's name

    • fn : Function

      The callback function to be executed. Typical format:

      function(cls, data, fn) {
          // Your code here
      
          // Execute this when the processing is finished.
          // Asynchronous processing is perfectly ok
          if (fn) {
              fn.call(this, cls, data);
          }
      });
      

      Parameters

      • cls : Function

        The created class

      • data : Object

        The set of properties passed in Ext.Class constructor

      • fn : Function

        The callback function that must to be executed when this pre-processor finishes, regardless of whether the processing is synchronous or aynchronous.

    Returns

    Ext.Class
    view source
    ( name, offset, relativeName ) : Ext.Classchainableprivatestatic
    Insert this pre-processor at a specific position in the stack, optionally relative to any existing pre-processor. ...

    Insert this pre-processor at a specific position in the stack, optionally relative to any existing pre-processor. For example:

    Ext.Class.registerPreprocessor('debug', function(cls, data, fn) {
        // Your code here
    
        if (fn) {
            fn.call(this, cls, data);
        }
    }).setDefaultPreprocessorPosition('debug', 'last');
    

    Available since: 4.0.7

    Parameters

    • name : String

      The pre-processor name. Note that it needs to be registered with registerPreprocessor 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.Class
    view source
    ( preprocessors ) : Ext.Classchainableprivatestatic
    Set the default array stack of default pre-processors ...

    Set the default array stack of default pre-processors

    Available since: 4.0.7

    Parameters

    Returns