The Application instance this Controller is attached to. This is automatically provided when using the MVC architecture so should rarely need to be set directly.

Defaults to: {}

Provides a mapping of Controller functions to filter functions that are run before them when dispatched to from a route. These are usually used to run pre-processing functions like authentication before a certain function is executed. They are only called when dispatching from a route. Example usage:

Ext.define('MyApp.controller.Products', {
    config: {
        before: {
            editProduct: 'authenticate'
        },

        routes: {
            'product/edit/:id': 'editProduct'
        }
    },

    //this is not directly because our before filter is called first
    editProduct: function() {
        //... performs the product editing logic
    },

    //this is run before editProduct
    authenticate: function(action) {
        MyApp.authenticate({
            success: function() {
                action.resume();
            },
            failure: function() {
                Ext.Msg.alert('Not Logged In', "You can't do that, you're not logged in");
            }
        });
    }
});

Defaults to: {}

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

Provides a mapping of Controller functions that should be called whenever certain Component events are fired. The Components can be specified using ComponentQuery selectors or refs. Example usage:

control: {
    'button[action=logout]': {
        tap: 'doLogout'
    },
    main: {
        activeitemchange: 'doUpdate'
    }
}

The first item uses a ComponentQuery selector to run the Controller's doLogout function whenever any Button with action=logout is tapped on. The second calls the Controller's doUpdate function whenever the activeitemchange event is fired by the Component referenced by our 'main' ref. In this case main is a tab panel (see refs for how to set that reference up).

Defaults to: {}

Called by the Controller's application to initialize the Controller. This is always called before the Application launches, giving the Controller a chance to run any pre-launch logic. See also launch, which is called after the Application's launch function

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.

See the Event guide for more

Note: It is bad practice to specify a listener's config when you are defining a class using Ext.define(). Instead, only specify listeners when you are instantiating your class with Ext.create().

The set of models to load for this Application. Each model is expected to exist inside the app/model directory and define a class following the convention AppName.model.ModelName. For example, in the code below, the classes AppName.model.User, AppName.model.Group and AppName.model.Product will be loaded. Note that we are able to specify either the full class name (as with AppName.model.Product) or just the final part of the class name and leave Application to automatically prepend AppName.model. to each:

models: [
    'User',
    'Group',
    'AppName.model.Product',
    'SomeCustomNamespace.model.Order'
]

Defaults to: []

A collection of named ComponentQuery selectors that makes it easy to get references to key Components on your page. Example usage:

refs: {
    main: '#mainTabPanel',
    loginButton: '#loginWindow button[action=login]',

    infoPanel: {
        selector: 'infopanel',
        xtype: 'infopanel',
        autoCreate: true
    }
}

The first two are simple ComponentQuery selectors, the third (infoPanel) also passes in the autoCreate and xtype options, which will first run the ComponentQuery to see if a Component matching that selector exists on the page. If not, it will automatically create one using the xtype provided:

someControllerFunction: function() {
    //if the info panel didn't exist before, calling its getter will instantiate
    //it automatically and return the new instance
    this.getInfoPanel().show();
}

Defaults to: {}

Provides a mapping of urls to Controller actions. Whenever the specified url is matched in the address bar, the specified Controller action is called. Example usage:

routes: {
    'login': 'showLogin',
    'users/:id': 'showUserById'
}

The first route will match against http://myapp.com/#login and call the Controller's showLogin function. The second route contains a wildcard (':id') and will match all urls like http://myapp.com/#users/123, calling the showUserById function with the matched ID as the first argument.

Defaults to: {}

The set of stores to load for this Application. Each store is expected to exist inside the app/store directory and define a class following the convention AppName.store.StoreName. For example, in the code below, the AppName.store.Users class will be loaded. Note that we are able to specify either the full class name (as with AppName.store.Groups) or just the final part of the class name and leave Application to automatically prepend AppName.store.' to each:

stores: [
    'Users',
    'AppName.store.Groups',
    'SomeCustomNamespace.store.Orders'
]

Defaults to: []

The set of views to load for this Application. Each view is expected to exist inside the app/view directory and define a class following the convention AppName.view.ViewName. For example, in the code below, the classes AppName.view.Users, AppName.view.Groups and AppName.view.Products will be loaded. Note that we are able to specify either the full class name (as with AppName.view.Products) or just the final part of the class name and leave Application to automatically prepend AppName.view. to each:

views: [
    'Users',
    'Groups',
    'AppName.view.Products',
    'SomeCustomNamespace.view.Orders'
]

Defaults to: []

Defaults to: '-'

Defaults to: false

Defaults to: /\.|[^\w\-]/g

Defaults to: true

Defaults to: true

Defaults to: /^(?:delegate|single|delay|buffer|args|prepend)$/

Defaults to: {id: 'observable', hooks: {destroy: 'destroy'}}

Overrides: Ext.mixin.Sortable.mixinConfig

Defaults to: 'identifiable'

Defaults to: '#'

Defaults to: 'observable'

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'

Defaults to: /^([\w\-]+)$/

Appends an after-event handler.

Same as addListener with order set to 'after'.

Parameters

• eventName : String/String[]/Object

  The name of the event to listen for.

• fn : Function/String

  The method the event invokes.

• scope : Object (optional)

  The scope for fn.

• options : Object (optional)

  An object containing handler configuration.

Fires

Appends a before-event handler. Returning false from the handler will stop the event.

Same as addListener with order set to 'before'.

Parameters

• eventName : String/String[]/Object

  The name of the event to listen for.

• fn : Function/String

  The method the event invokes.

• scope : Object (optional)

  The scope for fn.

• options : Object (optional)

  An object containing handler configuration.

Fires

Parameters

• selector : Object
• name : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

Fires

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

Parameters

• eventNames : Object/String...

  Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters.

Appends an event handler to this object. You can review the available handlers by looking at the 'events' section of the documentation for the component you are working with.

Combining Options

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

A delayed, one-time listener:

container.addListener('tap', this.handleTap, this, {
    single: true,
    delay: 100
});

Attaching multiple handlers in 1 call

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

container.addListener({
    tap  : this.onTap,
    swipe: this.onSwipe,

    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

container.addListener({
    tap  : { fn: this.onTap, scope: this, single: true },
    swipe: { fn: button.onSwipe, scope: button }
});

See the Events Guide for more.

Parameters

• eventName : String/String[]/Object

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

• fn : Function/String (optional)

  The method the event invokes. 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.

  This object may contain any of the following properties:

  • scope : Object (optional)

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

  • delay : Number (optional)

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

  • single : Boolean (optional)

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

  • order : String (optional)

    The order of when the listener should be added into the listener queue.

    If you set an order of before and the event you are listening to is preventable, you can return false and it will stop the event.

    Available options are before, current and after.

    Defaults to: current

  • buffer : Number (optional)

    Causes the handler to be 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.

  • element : String (optional)

    Allows you to add a listener onto a element of this component using the elements reference.

    Ext.create('Ext.Component', {
        listeners: {
            element: 'element',
            tap: function() {
                alert('element tap!');
            }
        }
    });
    

    All components have the element reference, which is the outer most element of the component. Ext.Container also has the innerElement element which contains all children. In most cases element is adequate.

  • delegate : String (optional)

    Uses Ext.ComponentQuery to delegate events to a specified query selector within this item.

    // Create a container with a two children; a button and a toolbar
    var container = Ext.create('Ext.Container', {
        items: [
            {
                xtype: 'toolbar',
                docked: 'top',
                title: 'My Toolbar'
            },
            {
               xtype: 'button',
               text: 'My Button'
            }
        ]
    });
    
    container.addListener({
        // Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
        delegate: 'button',
    
        tap: function() {
            alert('Button tapped!');
        }
    });
    

• order : String (optional)

  The order of when the listener should be added into the listener queue. Possible values are before, current and after.

  Defaults to: 'current'

Fires

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

Parameters

• object : Ext.mixin.Observable/HTMLElement

  The item to which to add a listener/listeners.

• eventName : Object/String

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

• fn : Function (optional)

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

• scope : Object (optional)

  If the eventName parameter was an event name, this is the scope in which the handler function is executed.

• options : Object (optional)

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

Massages the before filters into an array of function references for each controller action

Parameters

• before : Object

Parameters

• bubbleEvents : Object

Fires

Parameters

• config : Object

Fires

Parameters

• listeners : Object

Fires

As a convenience developers can locally qualify model names (e.g. 'MyModel' vs 'MyApp.model.MyModel'). This just makes sure everything ends up fully qualified

Parameters

• models : Object

Fires

Parameters

• refs : Object

Fires

Adds any routes specified in this Controller to the global Application router

Parameters

• routes : Object

Fires

As a convenience developers can locally qualify store names (e.g. 'MyStore' vs 'MyApp.store.MyStore'). This just makes sure everything ends up fully qualified

Parameters

• stores : Object

Fires

As a convenience developers can locally qualify view names (e.g. 'MyView' vs 'MyApp.view.MyView'). This just makes sure everything ends up fully qualified

Parameters

• views : Object

Fires

Call the original method that was previously overridden with override,

This method is deprecated as callParent does the same thing.

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

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

        var instance = this.callOverridden();

        alert("Meeeeoooowwww");

        return instance;
    }
});

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

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.

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

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

Parameters

• actionFn : Object
• eventName : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

Returns

• Ext.mixin.Observable

  this

Removes all listeners for this object.

Fires

Parameters

• object : Object

Fires

Parameters

• name : Object

Fires

Creates an event handling function which re-fires the event from this object as the passed event name.

Parameters

• newName : String

Returns

• Function

Fires

Fires

• destroy

Overrides: Ext.Base.destroy, Ext.mixin.Observable.destroy, Ext.util.Collection.destroy

Parameters

• name : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

Returns

• Boolean

Fires

Parameters

• eventName : Object
• args : Object
• action : Object
• connectedController : Object

Fires

Parameters

• name : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

Fires

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.

Parameters

• events : String/String[]

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

Fires

Executes an Ext.app.Action by giving it the correct before filters and kicking off execution

Parameters

• action : Object
• skipFilters : Object

Fires

Fires the specified event with the passed parameters and execute a function (action) at the end if there are no listeners that return false.

Parameters

• eventName : String

  The name of the event to fire.

• args : Array

  Arguments to pass to handers.

• fn : Function

  Action.

• scope : Object

  Scope of fn.

Returns

• Object

Fires

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

The first argument is the name of the event. Every other argument passed will be available when you listen for the event.

Example

Firstly, we set up a listener for our new event.

this.on('myevent', function(arg1, arg2, arg3, arg4, options, e) {
    console.log(arg1); // true
    console.log(arg2); // 2
    console.log(arg3); // { test: 'foo' }
    console.log(arg4); // 14
    console.log(options); // the options added when adding the listener
    console.log(e); // the event object with information about the event
});

And then we can fire off the event.

this.fireEvent('myevent', true, 2, { test: 'foo' }, 14);

An event may be set to bubble up an Observable parent hierarchy by calling enableBubble.

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.

Fires

Returns the value of application.

Returns

• Ext.app.Application

Returns the value of before.

Returns

• Object

Returns the value of bubbleEvents.

Returns

• String/String[]

Parameters

• name : Object

Returns the value of control.

Returns

• Object

Fires

Returns the fully qualified name for any class name variant. This is used to find the FQ name for the model, view, controller, store and profiles listed in a Controller or Application.

Parameters

• items : String[]

  The array of strings to get the FQ name for

• namespace : String

  If the name happens to be an application class, add it to this namespace

Returns

• String

  The fully-qualified name of the class

Fires

Retrieves the id of this component. Will autogenerate an id if one has not already been set.

Returns

• String

  id

Fires

Returns the initial configuration passed to constructor.

Parameters

• name : String (optional)

  When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

• Object/Mixed

Returns the value of listeners.

Returns

• Object

Parameters

• object : Object
• eventName : Object

Returns a reference to a Model.

Parameters

• modelName : String

Returns

• Object

Fires

Returns the value of models.

Returns

• String[]

Fires

Parameters

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

Returns the value of refs.

Returns

• Object

Returns the value of routes.

Returns

• Object

Returns the value of stores.

Returns

• String[]

Returns the value of views.

Returns

• Array

Parameters

• name : Object

Checks to see if this object has any listeners for a specified event

Parameters

• eventName : String

  The name of the event to check for

Returns

• Boolean

  True if the event is being listened for, else false

Fires

Parameters

• ref : Object

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

• Object

  mixins The mixin prototypes as key - value pairs

Fires

Parameters

• name : String
• value : Mixed

Returns

• Mixed

Alias for addManagedListener.

Parameters

• object : Ext.mixin.Observable/HTMLElement

  The item to which to add a listener/listeners.

• eventName : Object/String

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

• fn : Function (optional)

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

• scope : Object (optional)

  If the eventName parameter was an event name, this is the scope in which the handler function is executed.

• options : Object (optional)

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

Alias for removeManagedListener.

Parameters

• object : Ext.mixin.Observable/HTMLElement

  The item to which to add a listener/listeners.

• eventName : Object/String

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

• fn : Function (optional)

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

• scope : Object (optional)

  If the eventName parameter was an event name, this is the scope in which the handler function is executed.

Alias for addListener.

Parameters

• eventName : String/String[]/Object

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

• fn : Function/String (optional)

  The method the event invokes. 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.

  This object may contain any of the following properties:

  • scope : Object (optional)

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

  • delay : Number (optional)

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

  • single : Boolean (optional)

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

  • order : String (optional)

    The order of when the listener should be added into the listener queue.

    If you set an order of before and the event you are listening to is preventable, you can return false and it will stop the event.

    Available options are before, current and after.

    Defaults to: current

  • buffer : Number (optional)

    Causes the handler to be 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.

  • element : String (optional)

    Allows you to add a listener onto a element of this component using the elements reference.

    Ext.create('Ext.Component', {
        listeners: {
            element: 'element',
            tap: function() {
                alert('element tap!');
            }
        }
    });
    

    All components have the element reference, which is the outer most element of the component. Ext.Container also has the innerElement element which contains all children. In most cases element is adequate.

  • delegate : String (optional)

    Uses Ext.ComponentQuery to delegate events to a specified query selector within this item.

    // Create a container with a two children; a button and a toolbar
    var container = Ext.create('Ext.Container', {
        items: [
            {
                xtype: 'toolbar',
                docked: 'top',
                title: 'My Toolbar'
            },
            {
               xtype: 'button',
               text: 'My Button'
            }
        ]
    });
    
    container.addListener({
        // Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
        delegate: 'button',
    
        tap: function() {
            alert('Button tapped!');
        }
    });
    

• order : String (optional)

  The order of when the listener should be added into the listener queue. Possible values are before, current and after.

  Defaults to: 'current'

Alias for addAfterListener.

Parameters

• eventName : String/String[]/Object

  The name of the event to listen for.

• fn : Function/String

  The method the event invokes.

• scope : Object (optional)

  The scope for fn.

• options : Object (optional)

  An object containing handler configuration.

Alias for addBeforeListener.

Parameters

• eventName : String/String[]/Object

  The name of the event to listen for.

• fn : Function/String

  The method the event invokes.

• scope : Object (optional)

  The scope for fn.

• options : Object (optional)

  An object containing handler configuration.

Parameters

• cls : Object
• members : Object

Fires

Overrides: Ext.mixin.Mixin.onClassExtended

Parameters

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

1.x-inspired ref implementation

Parameters

• refs : Object

Parameters

• args : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

Fires

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

Parameters

• object : Object

  The Observable whose events this object is to relay.

• events : String/Array/Object

  Array of event names to relay.

Returns

• Ext.mixin.Observable

  this

Fires

Removes a before-event handler.

Same as removeListener with order set to 'after'.

Parameters

• eventName : String/String[]/Object

  The name of the event the handler was associated with.

• fn : Function/String

  The handler to remove.

• scope : Object (optional)

  The scope originally specified for fn.

• options : Object (optional)

  Extra options object.

Fires

Removes a before-event handler.

Same as removeListener with order set to 'before'.

Parameters

• eventName : String/String[]/Object

  The name of the event the handler was associated with.

• fn : Function/String

  The handler to remove.

• scope : Object (optional)

  The scope originally specified for fn.

• options : Object (optional)

  Extra options object.

Fires

Parameters

• selector : Object
• name : Object
• fn : Object
• scope : Object
• order : Object

Fires

Removes an event handler.

Parameters

• eventName : String/String[]/Object

  The type of event the handler was associated with.

• fn : Function/String

  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.

• options : Object (optional)

  Extra options object. See addListener for details.

• order : String (optional)

  The order of the listener to remove. Possible values are before, current and after.

  Defaults to: 'current'

Fires

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

Parameters

• object : Ext.mixin.Observable/HTMLElement

  The item to which to add a listener/listeners.

• eventName : Object/String

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

• fn : Function (optional)

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

• scope : Object (optional)

  If the eventName parameter was an event name, this is the scope in which the handler function is executed.

Resumes firing events (see suspendEvents).

Parameters

• discardQueuedEvents : Boolean

  Pass as true to discard any queued events.

Sets the value of application.

Parameters

• application : Ext.app.Application

Sets the value of before.

Parameters

• before : Object

Sets the value of bubbleEvents.

Parameters

• bubbleEvents : String/String[]

Parameters

• config : Object
• applyIfNotSet : Object

Returns

• Ext.Base

  this

Sets the value of control.

Parameters

• control : Object

Parameters

• id : Object

Sets the value of listeners.

Parameters

• listeners : Object

Sets the value of models.

Parameters

• models : String[]

Sets the value of refs.

Parameters

• refs : Object

Sets the value of routes.

Parameters

• routes : Object

Sets the value of stores.

Parameters

• stores : String[]

Sets the value of views.

Parameters

• views : Array

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

Returns

• Ext.Class

Suspends the firing of all events.

All events will be queued but you can discard the queued events by passing false in the resumeEvents call

Parameters

• toggle : Object
• eventName : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

Fires

Alias for removeListener.

Parameters

• eventName : String/String[]/Object

  The type of event the handler was associated with.

• fn : Function/String

  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.

• options : Object (optional)

  Extra options object. See addListener for details.

• order : String (optional)

  The order of the listener to remove. Possible values are before, current and after.

  Defaults to: 'current'

Alias for removeAfterListener.

Parameters

• eventName : String/String[]/Object

  The name of the event the handler was associated with.

• fn : Function/String

  The handler to remove.

• scope : Object (optional)

  The scope originally specified for fn.

• options : Object (optional)

  Extra options object.

Alias for removeBeforeListener.

Parameters

• eventName : String/String[]/Object

  The name of the event the handler was associated with.

• fn : Function/String

  The handler to remove.

• scope : Object (optional)

  The scope originally specified for fn.

• options : Object (optional)

  Extra options object.

Returns

• Ext.Base

  this

Fires

Parameters

• members : Object

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

Parameters

• members : Object

Add / override static properties of this class.

Ext.define('My.cool.Class', {
    // this.se
});

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

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

Parameters

• fromClass : Ext.Base

  The class to borrow members from

• members : Array/String

  The names of the members to borrow

Returns

• Ext.Base

  this

Parameters

• args : Object

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.

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

Parameters

• parent : 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'

Returns

• String

  className

Used internally by the mixins pre-processor

Parameters

• name : Object
• mixinClass : Object

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!");

        var instance = this.callParent(arguments);

        alert("Meeeeoooowwww");

        return instance;
    }
});

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

As of 2.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!");

        var instance = this.callParent(arguments);

        alert("Meeeeoooowwww");

        return instance;
    }
});

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