Ext.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. 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. 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. Otherwise just like statics but subclasses inherit these methods.

Available since: 4.0.2

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

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

Defaults to: {}

Available since: 4.0.0

Available since: 4.1.0

Parameters

• Class : Object
• classData : Object
• onClassCreated : Object

Available since: 4.1.0

Available since: 4.1.0

Parameters

• Class : Object
• data : Object
• hooks : Object

Available since: 4.1.0

Parameters

• Class : Object
• data : Object
• onCreated : Object

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

Available since: 4.0.7

Parameters

• name : String

Returns

• Function

  preprocessor

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

  this

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

  this

Set the default array stack of default pre-processors

Available since: 4.0.7

Parameters

• preprocessors : Array

Returns

• Ext.Class

  this