The id of this controller. You can use this id when dispatching.

Available since: 4.0.0

A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.

DOM events from Ext JS Components

While some Ext JS Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

new Ext.panel.Panel({
    width: 400,
    height: 200,
    dockedItems: [{
        xtype: 'toolbar'
    }],
    listeners: {
        click: {
            element: 'el', //bind to the underlying el property on the panel
            fn: function(){ console.log('click el'); }
        },
        dblclick: {
            element: 'body', //bind to the underlying body property on the panel
            fn: function(){ console.log('dblclick body'); }
        }
    }
});

Available since: 1.1.0

Array of models to require from AppName.model namespace. For example:

Ext.define("MyApp.controller.Foo", {
    extend: "Ext.app.Controller",
    models: ['User', 'Vehicle']
});

This is equivalent of:

Ext.define("MyApp.controller.Foo", {
    extend: "Ext.app.Controller",
    requires: ['MyApp.model.User', 'MyApp.model.Vehicle'],
    getUserModel: function() {
        return this.getModel("User");
    },
    getVehicleModel: function() {
        return this.getModel("Vehicle");
    }
});

Available since: 4.0.6

Array of configs to build up references to views on page. For example:

Ext.define("MyApp.controller.Foo", {
    extend: "Ext.app.Controller",
    refs: [
        {
            ref: 'list',
            selector: 'grid'
        }
    ],
});

This will add method getList to the controller which will internally use Ext.ComponentQuery to reference the grid component on page.

The following fields can be used in ref definition:

• ref - name of the reference.
• selector - Ext.ComponentQuery selector to access the component.
• autoCreate - True to create the component automatically if not found on page.
• forceCreate - Forces the creation of the component every time reference is accessed (when get<REFNAME> is called).

Available since: 4.1.0

Array of stores to require from AppName.store namespace and to generate getter methods for. For example:

Ext.define("MyApp.controller.Foo", {
    extend: "Ext.app.Controller",
    stores: ['Users', 'Vehicles']
});

This is equivalent of:

Ext.define("MyApp.controller.Foo", {
    extend: "Ext.app.Controller",
    requires: ['MyApp.store.Users', 'MyApp.store.Vehicles']
    getUsersStore: function() {
        return this.getView("Users");
    },
    getVehiclesStore: function() {
        return this.getView("Vehicles");
    }
});

Available since: 4.0.6

Array of views to require from AppName.view namespace and to generate getter methods for. For example:

Ext.define("MyApp.controller.Foo", {
    extend: "Ext.app.Controller",
    views: ['List', 'Detail']
});

This is equivalent of:

Ext.define("MyApp.controller.Foo", {
    extend: "Ext.app.Controller",
    requires: ['MyApp.view.List', 'MyApp.view.Detail'],
    getListView: function() {
        return this.getView("List");
    },
    getDetailView: function() {
        return this.getView("Detail");
    }
});

Available since: 4.0.6

Defaults to: {}

Available since: 4.1.1

Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.

Defaults to: 0

Available since: 4.1.1

This object holds a key for any event that has a listener. The listener may be set directly on the instance, or on its class or a super class (via observe) or on the MVC EventBus. The values of this object are truthy (a non-zero number) and falsy (0 or undefined). They do not represent an exact count of listeners. The value for an event is truthy if the event must be fired and is falsy if there is no need to fire the event.

The intended use of this property is to avoid the expense of fireEvent calls when there are no listeners. This can be particularly helpful when one would otherwise have to call fireEvent hundreds or thousands of times. It is used like this:

 if (this.hasListeners.foo) {
     this.fireEvent('foo', this, arg1);
 }

Available since: 4.1.0

Defaults to: []

Available since: 4.1.1

Defaults to: {}

Available since: 4.1.1

Defaults to: true

Available since: 4.1.1

true in this class to identify an object as an instantiated Observable, or subclass thereof.

Defaults to: true

Available since: 4.0.0

Get the reference to the current class from which this object was instantiated. Unlike statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See 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'

Available since: 4.0.0

Adds the specified events to the list of events which this Observable may fire.

Available since: 1.1.0

Parameters

• eventNames : Object/String...

  Either an object with event names as properties with a value of true. For example:

  this.addEvents({
      storeloaded: true,
      storecleared: true
  });
  

  Or any number of event names as separate parameters. For example:

  this.addEvents('storeloaded', 'storecleared');
  

Appends an event handler to this object. For example:

myGridPanel.on("mouseover", this.onMouseOver, this);

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

myGridPanel.on({
    cellClick: this.onCellClick,
    mouseover: this.onMouseOver,
    mouseout: this.onMouseOut,
    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

myGridPanel.on({
    cellClick: {fn: this.onCellClick, scope: this, single: true},
    mouseover: {fn: panel.onMouseOver, scope: panel}
});

Names of methods in a specified scope may also be used. Note that scope MUST be specified to use this option:

myGridPanel.on({
    cellClick: {fn: 'onCellClick', scope: this, single: true},
    mouseover: {fn: 'onMouseOver', scope: panel}
});

Available since: 1.1.0

Parameters

• eventName : String/Object

  The name of the event to listen for. May also be an object who's property names are event names.

• fn : Function (optional)

  The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to fireEvent plus the options parameter described below.

• scope : Object (optional)

  The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

• options : Object (optional)

  An object containing handler configuration.

  Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

  This object may contain any of the following properties:

  • scope : Object

    The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

  • delay : Number

    The number of milliseconds to delay the invocation of the handler after the event fires.

  • single : Boolean

    True to add a handler to handle just the next firing of the event, and then remove itself.

  • buffer : Number

    Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

  • target : Ext.util.Observable

    Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

  • element : String

    This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

    This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

      new Ext.panel.Panel({
          title: 'The title',
          listeners: {
              click: this.handlePanelClick,
              element: 'body'
          }
      });
    

  • destroyable : Boolean (optional)

    When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

    Combining Options

    Using the options argument, it is possible to combine different types of listeners:

    A delayed, one-time listener.

    myPanel.on('hide', this.handleClick, this, {
        single: true,
        delay: 100
    });
    

    Defaults to: false

Returns

• Object

  Only when the destroyable option is specified.

  A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

  this.btnListeners =  = myButton.on({
      destroyable: true
      mouseover:   function() { console.log('mouseover'); },
      mouseout:    function() { console.log('mouseout'); },
      click:       function() { console.log('click'); }
  });
  

  And when those listeners need to be removed:

  Ext.destroy(this.btnListeners);
  

  or

  this.btnListeners.destroy();
  

Overrides: Ext.AbstractComponent.addListener

Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destroyed.

Available since: 4.0.0

Parameters

• item : Ext.util.Observable/Ext.Element

  The item to which to add a listener/listeners.

• ename : Object/String

  The event name, or an object containing event name properties.

• fn : Function (optional)

  If the ename parameter was an event name, this is the handler function.

• scope : Object (optional)

  If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

• options : Object (optional)

  If the ename parameter was an event name, this is the addListener options.

Returns

• Object

  Only when the destroyable option is specified.

  A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

  this.btnListeners =  = myButton.mon({
      destroyable: true
      mouseover:   function() { console.log('mouseover'); },
      mouseout:    function() { console.log('mouseout'); },
      click:       function() { console.log('click'); }
  });
  

  And when those listeners need to be removed:

  Ext.destroy(this.btnListeners);
  

  or

  this.btnListeners.destroy();
  

Registers a reference.

Available since: 4.1.0

Parameters

• ref : Object

Call the original method that was previously overridden with 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"

Available since: 4.0.0

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

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.

Available since: 4.0.0

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

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', {
     method: function () {
         console.log('Bad');

         // ... logic but with a bug ...

         this.callParent();
     }
 });

To patch the bug in DerivedClass.method, the typical solution is to create an override:

 Ext.define('App.paches.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".

Available since: Ext JS 4.1.3

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

Removes all listeners for this object including the managed listeners

Available since: 4.0.0

Removes all managed listeners for this object.

Available since: 4.0.0

Available since: 4.1.1

Continue to fire event.

Available since: 4.0.7

Parameters

• eventName : String
• args : Array
• bubbles : Boolean

Creates an event handling function which refires the event from this object as the passed event name.

Available since: 4.0.0

Parameters

• newName : Object
• beginEnd : Array (optional)

  The caller can specify on which indices to slice

Returns

• Function

Available since: 4.1.1

Overrides: Ext.util.ElementContainer.destroy, Ext.AbstractComponent.destroy, Ext.AbstractPlugin.destroy

Available since: Ext JS 4.1.3

Parameters

• app : Object

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. There is no implementation in the Observable base class.

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

Example:

Ext.define('Ext.overrides.form.field.Base', {
    override: 'Ext.form.field.Base',

    //  Add functionality to Field's initComponent to enable the change event to bubble
    initComponent: function () {
        this.callParent();
        this.enableBubble('change');
    }
});

var myForm = Ext.create('Ext.form.Panel', {
    title: 'User Details',
    items: [{
        ...
    }],
    listeners: {
        change: function() {
            // Title goes red if form has been modified.
            myForm.header.setStyle('color', 'red');
        }
    }
});

Available since: 3.4.0

Parameters

• eventNames : String/String[]

  The event name to bubble, or an Array of event names.

Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addListener).

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble.

Available since: 1.1.0

Parameters

• eventName : String

  The name of the event to fire.

• args : Object...

  Variable number of parameters are passed to handlers.

Returns

• Boolean

  returns false if any of the handlers return false otherwise it returns true.

Gets the bubbling parent for an Observable

Available since: 4.0.7

Returns

• Ext.util.Observable

  The bubble parent. null is returned if no bubble target exists

Available since: 4.1.0

Parameters

• name : Object

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

Available since: 4.1.0

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.

Available since: 4.0.0

Parameters

• ref : Object
• info : Object
• config : Object

Available since: 4.1.0

Parameters

• config : Object

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer indicates whether the event needs firing or not.

Available since: 1.1.0

Parameters

• eventName : String

  The name of the event to check for

Returns

• Boolean

  true if the event is being listened for or bubbles, else false

Returns true if a reference is registered.

Available since: 4.1.0

Parameters

• ref : Object

Returns

• Boolean

A template method that is called when your application boots. It is called before the Application's launch function is executed so gives a hook point to run any code before your Viewport is created.

Available since: 4.0.0

Parameters

• application : Ext.app.Application

Available since: Ext JS 4.1.3

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'

Available since: 4.0.0

Parameters

• config : Object

Returns

• Ext.Base

  this

Shorthand for addManagedListener.

Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destroyed.

Available since: 4.0.2

Parameters

• item : Ext.util.Observable/Ext.Element

  The item to which to add a listener/listeners.

• ename : Object/String

  The event name, or an object containing event name properties.

• fn : Function (optional)

  If the ename parameter was an event name, this is the handler function.

• scope : Object (optional)

  If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

• options : Object (optional)

  If the ename parameter was an event name, this is the addListener options.

Returns

• Object

  Only when the destroyable option is specified.

  A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

  this.btnListeners =  = myButton.mon({
      destroyable: true
      mouseover:   function() { console.log('mouseover'); },
      mouseout:    function() { console.log('mouseout'); },
      click:       function() { console.log('click'); }
  });
  

  And when those listeners need to be removed:

  Ext.destroy(this.btnListeners);
  

  or

  this.btnListeners.destroy();
  

Shorthand for removeManagedListener.

Removes listeners that were added by the mon method.

Available since: 4.0.2

Parameters

• item : Ext.util.Observable/Ext.Element

  The item from which to remove a listener/listeners.

• ename : Object/String

  The event name, or an object containing event name properties.

• fn : Function (optional)

  If the ename parameter was an event name, this is the handler function.

• scope : Object (optional)

  If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

Shorthand for addListener.

Appends an event handler to this object. For example:

myGridPanel.on("mouseover", this.onMouseOver, this);

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

myGridPanel.on({
    cellClick: this.onCellClick,
    mouseover: this.onMouseOver,
    mouseout: this.onMouseOut,
    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

myGridPanel.on({
    cellClick: {fn: this.onCellClick, scope: this, single: true},
    mouseover: {fn: panel.onMouseOver, scope: panel}
});

Names of methods in a specified scope may also be used. Note that scope MUST be specified to use this option:

myGridPanel.on({
    cellClick: {fn: 'onCellClick', scope: this, single: true},
    mouseover: {fn: 'onMouseOver', scope: panel}
});

Available since: 1.1.0

Parameters

• eventName : String/Object

  The name of the event to listen for. May also be an object who's property names are event names.

• fn : Function (optional)

  The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to fireEvent plus the options parameter described below.

• scope : Object (optional)

  The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

• options : Object (optional)

  An object containing handler configuration.

  Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

  This object may contain any of the following properties:

  • scope : Object

    The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

  • delay : Number

    The number of milliseconds to delay the invocation of the handler after the event fires.

  • single : Boolean

    True to add a handler to handle just the next firing of the event, and then remove itself.

  • buffer : Number

    Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

  • target : Ext.util.Observable

    Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

  • element : String

    This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

    This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

      new Ext.panel.Panel({
          title: 'The title',
          listeners: {
              click: this.handlePanelClick,
              element: 'body'
          }
      });
    

  • destroyable : Boolean (optional)

    When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

    Combining Options

    Using the options argument, it is possible to combine different types of listeners:

    A delayed, one-time listener.

    myPanel.on('hide', this.handleClick, this, {
        single: true,
        delay: 100
    });
    

    Defaults to: false

Returns

• Object

  Only when the destroyable option is specified.

  A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

  this.btnListeners =  = myButton.on({
      destroyable: true
      mouseover:   function() { console.log('mouseover'); },
      mouseout:    function() { console.log('mouseout'); },
      click:       function() { console.log('click'); }
  });
  

  And when those listeners need to be removed:

  Ext.destroy(this.btnListeners);
  

  or

  this.btnListeners.destroy();
  

Available since: 4.1.0

Parameters

• names : Object
• callback : Object
• scope : Object

A template method like init, but called after the viewport is created. This is called after the launch method of Application is executed.

Available since: 4.0.0

Parameters

• application : Ext.app.Application

Prepares a given class for observable instances. This method is called when a class derives from this class or uses this class as a mixin.

Available since: 4.1.0

Parameters

• T : Function

  The class constructor to prepare.

Available since: 4.0.0

Parameters

• refs : Object

Relays selected events from the specified Observable as if the events were fired by this.

For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:

this.relayEvents(this.getStore(), ['load']);

The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword.

Available since: 2.3.0

Parameters

• origin : Object

  The Observable whose events this object is to relay.

• events : String[]

  Array of event names to relay.

• prefix : String (optional)

  A common prefix to prepend to the event names. For example:

  this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
  

  Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.

Returns

• Object

  A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:

  this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
  

  Can be undone by calling

  Ext.destroy(this.storeRelayers);
  

  or

  this.store.relayers.destroy();
  

Removes an event handler.

Available since: 1.1.0

Parameters

• eventName : String

  The type of event the handler was associated with.

• fn : Function

  The handler to remove. This must be a reference to the function passed into the addListener call.

• scope : Object (optional)

  The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

Removes listeners that were added by the mon method.

Available since: 4.0.0

Parameters

• item : Ext.util.Observable/Ext.Element

  The item from which to remove a listener/listeners.

• ename : Object/String

  The event name, or an object containing event name properties.

• fn : Function (optional)

  If the ename parameter was an event name, this is the handler function.

• scope : Object (optional)

  If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

Remove a single managed listener item

Available since: 4.0.1

Parameters

• isClear : Boolean

  True if this is being called during a clear

• managedListener : Object

  The managed listener item See removeManagedListener for other args

Overrides: Ext.AbstractComponent.removeManagedListenerItem

Resumes firing events (see suspendEvents).

If events were suspended using the queueSuspended parameter, then all events fired during event suspension will be sent to any listeners now.

Available since: 2.3.0

Available since: 4.0.0

Parameters

• config : Object
• applyIfNotSet : Object

Returns

• Ext.Base

  this

Get the reference to the class from which this object was instantiated. Note that unlike 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

Available since: 4.0.0

Returns

• Ext.Class

Suspends the firing of all events. (see resumeEvents)

Available since: 2.3.0

Parameters

• queueSuspended : Boolean

  Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events.

Shorthand for removeListener.

Removes an event handler.

Available since: 1.1.0

Parameters

• eventName : String

  The type of event the handler was associated with.

• fn : Function

  The handler to remove. This must be a reference to the function passed into the addListener call.

• scope : Object (optional)

  The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

Available since: 4.1.1

Parameters

• members : Object

Available since: 4.1.1

Parameters

• name : Object
• member : Object

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

Available since: 4.1.0

Parameters

• members : Object

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() { ... };
});

Available since: 4.0.2

Parameters

• members : Object

Returns

• Ext.Base

  this

Available since: 4.1.1

Parameters

• xtype : Object

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

Available since: 4.0.2

Parameters

• fromClass : Ext.Base

  The class to borrow members from

• members : Array/String

  The names of the members to borrow

Returns

• Ext.Base

  this

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.

Available since: 4.0.2

Returns

• Object

  the created instance.

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

Available since: 4.0.2

Parameters

• alias : String/Object

  The new method name, or an object to set multiple aliases. See flexSetter

• origin : String/Object

  The original method name

Available since: 4.1.1

Parameters

• config : Object

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'

Available since: 4.0.4

Returns

• String

  className

Adds members to class.

Available since: 4.0.2

Used internally by the mixins pre-processor

Available since: 4.1.1

Parameters

• name : Object
• mixinClass : Object

Available since: 4.1.1

Parameters

• fn : Object
• scope : Object

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"

As of 4.1, direct use of this method is deprecated. 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).

Available since: 4.0.2

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

Available since: 4.1.1