Ext JS 4.1.3 Sencha Docs

Ext.app.Application

Hierarchy

Ext.Base
Ext.app.Controller
Ext.app.Application

Inherited mixins

Requires

Files

Represents an Ext JS 4 application, which is typically a single page app using a Viewport. A typical Ext.app.Application might look like this:

Ext.application({
    name: 'MyApp',
    launch: function() {
        Ext.create('Ext.container.Viewport', {
            items: {
                html: 'My App'
            }
        });
    }
});

This does several things. First it creates a global variable called 'MyApp' - all of your Application's classes (such as its Models, Views and Controllers) will reside under this single namespace, which drastically lowers the chances of colliding global variables. The MyApp global will also have a getApplication method to get a reference to the current application:

var app = MyApp.getApplication();

When the page is ready and all of your JavaScript has loaded, your Application's launch function is called, at which time you can run the code that starts your app. Usually this consists of creating a Viewport, as we do in the example above.

Telling Application about the rest of the app

Because an Ext.app.Application represents an entire app, we should tell it about the other parts of the app - namely the Models, Views and Controllers that are bundled with the application. Let's say we have a blog management app; we might have Models and Controllers for Posts and Comments, and Views for listing, adding and editing Posts and Comments. Here's how we'd tell our Application about all these things:

Ext.application({
    name: 'Blog',
    models: ['Post', 'Comment'],
    controllers: ['Posts', 'Comments'],

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

Note that we didn't actually list the Views directly in the Application itself. This is because Views are managed by Controllers, so it makes sense to keep those dependencies there. The Application will load each of the specified Controllers using the pathing conventions laid out in the application architecture guide - in this case expecting the controllers to reside in app/controller/Posts.js and app/controller/Comments.js. In turn, each Controller simply needs to list the Views it uses and they will be automatically loaded. Here's how our Posts controller like be defined:

Ext.define('MyApp.controller.Posts', {
    extend: 'Ext.app.Controller',
    views: ['posts.List', 'posts.Edit'],

    //the rest of the Controller here
});

Because we told our Application about our Models and Controllers, and our Controllers about their Views, Ext JS will automatically load all of our app files for us. This means we don't have to manually add script tags into our html files whenever we add a new class, but more importantly it enables us to create a minimized build of our entire application using Sencha Cmd.

Deriving from Ext.app.Application

Typically, applications do not derive directly from Ext.app.Application. Rather, the configuration passed to Ext.application mimics what you might do in a derived class. In some cases, however, it can be desirable to share logic by using a derived class from Ext.app.Application.

Derivation works as you would expect, but using the derived class should still be the job of the Ext.application method.

Ext.define('MyApp.app.Application', {
    extend: 'Ext.app.Application',
    ...
});

Ext.application({
    extend: 'MyApp.app.Application',

    name: 'Blog',
    models: ['Post', 'Comment'],
    controllers: ['Posts', 'Comments'],

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

For more information about writing Ext JS 4 applications, please see the application architecture guide.

Available since: 4.0.0

Defined By

Config options

Ext.app.Application
view source
: String
The path to the directory which contains all application's classes. ...

The path to the directory which contains all application's classes. This path will be registered via Ext.Loader.setPath for the namespace specified in the name config.

Defaults to: 'app'

Available since: 4.0.0

Ext.app.Application
view source
: String
The name of a property to be assigned to the main namespace to gain a reference to this application. ...

The name of a property to be assigned to the main namespace to gain a reference to this application. Can be set to an empty value to prevent the reference from being created

Ext.application({
    name: 'MyApp',
    appProperty: 'myProp',

    launch: function() {
        console.log(MyApp.myProp === this);
    }
});

Defaults to: 'app'

Available since: Ext JS 4.1.3

True to automatically load and instantiate AppName.view.Viewport before firing the launch function. ...

True to automatically load and instantiate AppName.view.Viewport before firing the launch function.

Defaults to: false

Available since: 4.0.0

Ext.app.Application
view source
: String[]

Names of controllers that the app uses.

Names of controllers that the app uses.

Available since: 4.1.0

Ext.app.Application
view source
: Boolean
True to automatically set up Ext.tip.QuickTip support. ...

True to automatically set up Ext.tip.QuickTip support.

Defaults to: true

Available since: 4.0.0

The id of this controller. ...

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

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

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

Ext.app.Application
view source
: String
The name of your application. ...

The name of your application. This will also be the namespace for your views, controllers models and stores. Don't use spaces or special characters in the name.

Available since: 4.0.0

Ext.app.Application
view source
: Object
Additional load paths to add to Ext.Loader. ...

Additional load paths to add to Ext.Loader. See Ext.Loader.paths config for more details.

Available since: 4.1.1

Array of configs to build up references to views on page. ...

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

Ext.app.Application
view source
: Object
The scope to execute the launch function in. ...

The scope to execute the launch function in. Defaults to the Application instance.

Available since: 4.0.0

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

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

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

Properties

Defined By

Instance properties

...

Defaults to: 'Ext.Base'

Available since: 4.1.1

...

Defaults to: {}

Available since: 4.1.1

Initial suspended call count. ...

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

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

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

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

Defined By

Static properties

...

Defaults to: []

Available since: 4.1.1

Methods

Defined By

Instance methods

Ext.app.Application
view source
new( [config] ) : Ext.app.Application
Creates new Application. ...

Creates new Application.

Available since: 4.0.0

Parameters

  • config : Object (optional)

    Config object.

Returns

Fires

  • launch

Overrides: Ext.app.Controller.constructor

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

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');
    
( eventName, [fn], [scope], [options] ) : Object
Appends an event handler to this object. ...

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

Fires

    Overrides: Ext.AbstractComponent.addListener

    ( item, ename, [fn], [scope], [options] ) : Object
    Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destr...

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

    Fires

      Registers a reference. ...

      Registers a reference.

      Available since: 4.1.0

      Parameters

      Fires

        ( args ) : Objectdeprecatedprotected
        Call the original method that was previously overridden with override Ext.define('My.Cat', { constructor: functi...

        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

        This method has been deprecated

        as of 4.1. Use callParent instead.

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

        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

        ( args ) : Objectprotected
        This method is used by an override to call the superclass method but bypass any overridden 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 ...

        Removes all listeners for this object including the managed listeners

        Available since: 4.0.0

        Fires

          Removes all managed listeners for this object. ...

          Removes all managed listeners for this object.

          Available since: 4.0.0

          Fires

            ...

            Available since: 4.1.1

            ( eventName, args, bubbles )private
            Continue to fire event. ...

            Continue to fire event.

            Available since: 4.0.7

            Parameters

            Fires

              Ext.app.Application
              view source
              ( selectors, listeners, controller )
              Adds listeners to components selected via Ext.ComponentQuery. ...

              Adds listeners to components selected via Ext.ComponentQuery. Accepts an object containing component paths mapped to a hash of listener functions.

              In the following example the updateUser function is mapped to to the click event on a button component, which is a child of the useredit component.

              Ext.define('AM.controller.Users', {
                  init: function() {
                      this.control({
                          'useredit button[action=save]': {
                              click: this.updateUser
                          }
                      });
                  },
              
                  updateUser: function(button) {
                      console.log('clicked the Save button');
                  }
              });
              

              Or alternatively one call control with two arguments:

              this.control('useredit button[action=save]', {
                  click: this.updateUser
              });
              

              See Ext.ComponentQuery for more information on component selectors.

              Available since: 4.0.0

              Parameters

              Overrides: Ext.app.Controller.control

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

              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

              ...

              Available since: Ext JS 4.1.3

              Parameters

              Fires

                Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. ...

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

                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.

                Fires

                  Ext.app.Application
                  view source
                  ( ) : Ext.app.Applicationchainable
                  Returns the base Ext.app.Application for this controller. ...

                  Returns the base Ext.app.Application for this controller.

                  Available since: 4.1.2

                  Returns

                  Overrides: Ext.app.Controller.getApplication

                  Gets the bubbling parent for an Observable ...

                  Gets the bubbling parent for an Observable

                  Available since: 4.0.7

                  Returns

                  Fires

                    ...

                    Available since: 4.1.0

                    Parameters

                    Ext.app.Application
                    view source
                    ( name ) : Ext.app.Controller
                    Returns instance of a controller with the given name. ...

                    Returns instance of a controller with the given name. When controller doesn't exist yet, it's created.

                    Available since: 4.0.0

                    Parameters

                    Returns

                    Fires

                      Overrides: Ext.app.Controller.getController

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

                      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.

                      Ext.app.Application
                      view source
                      ( model ) : Ext.data.Model
                      Returns a Model class with the given name. ...

                      Returns a Model class with the given name. A shorthand for using Ext.ModelManager.getModel.

                      Available since: 4.0.0

                      Parameters

                      Returns

                      Fires

                        Overrides: Ext.app.Controller.getModel

                        Ext.app.Application
                        view source
                        ( name, kind )private
                        ...

                        Available since: 4.0.0

                        Parameters

                        ( ref, info, config )private
                        ...

                        Available since: 4.0.0

                        Parameters

                        Ext.app.Application
                        view source
                        ( name ) : Ext.data.Store
                        Returns instance of a Store with the given name. ...

                        Returns instance of a Store with the given name. When store doesn't exist yet, it's created.

                        Available since: 4.0.0

                        Parameters

                        Returns

                        Fires

                          Overrides: Ext.app.Controller.getStore

                          Ext.app.Application
                          view source
                          ( view ) : Ext.Base
                          Returns a View class with the given name. ...

                          Returns a View class with the given name. To create an instance of the view, you can use it like it's used by Application to create the Viewport:

                          this.getView('Viewport').create();
                          

                          Available since: 4.0.0

                          Parameters

                          Returns

                          Fires

                            Overrides: Ext.app.Controller.getView

                            ...

                            Available since: 4.1.0

                            Parameters

                            Checks to see if this object has any listeners for a specified event, or whether the event bubbles. ...

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

                            Returns true if a reference is registered.

                            Available since: 4.1.0

                            Parameters

                            Returns

                            ( application )template
                            A template method that is called when your application boots. ...

                            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

                            This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                            Parameters

                            ...

                            Available since: Ext JS 4.1.3

                            ( config ) : Ext.Basechainableprotected
                            Initialize configuration for this class. ...

                            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

                            Returns

                            Ext.app.Application
                            view source
                            ( profile ) : Booleantemplate
                            Called automatically when the page has completely loaded. ...

                            Called automatically when the page has completely loaded. This is an empty function that should be overridden by each application that needs to take action on page load.

                            Available since: 4.1.0

                            This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                            Parameters

                            • profile : String

                              The detected application profile

                            Returns

                            • Boolean

                              By default, the Application will dispatch to the configured startup controller and action immediately after running the launch function. Return false to prevent this behavior.

                            ( item, ename, [fn], [scope], [options] ) : Object
                            Shorthand for addManagedListener. ...

                            Shorthand for addManagedListener.

                            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();
                              
                            ( item, ename, [fn], [scope] )
                            Shorthand for removeManagedListener. ...

                            Shorthand for removeManagedListener.

                            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.

                            ( eventName, [fn], [scope], [options] ) : Object
                            Shorthand for addListener. ...

                            Shorthand for addListener.

                            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();
                              
                            Ext.app.Application
                            view source
                            ( )private
                            ...

                            Available since: 4.0.0

                            Fires

                            • launch
                            Ext.app.Application
                            view source
                            ( cls, data, hooks )private
                            NOTE - this config has to be processed by Ext.application ...

                            NOTE - this config has to be processed by Ext.application

                            Available since: 4.0.0

                            Parameters

                            ( names, callback, scope )private
                            ...

                            Available since: 4.1.0

                            Parameters

                            A template method like init, but called after the viewport is created. ...

                            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

                            This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                            Parameters

                            Prepares a given class for observable instances. ...

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

                            Parameters

                            • T : Function

                              The class constructor to prepare.

                            ...

                            Available since: 4.0.0

                            Parameters

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

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

                            Fires

                              Removes an event handler. ...

                              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.

                              Fires

                                Removes listeners that were added by the mon method. ...

                                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.

                                Fires

                                  Remove a single managed listener item ...

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

                                  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

                                  ( config, applyIfNotSet ) : Ext.Basechainableprivate
                                  ...

                                  Available since: 4.0.0

                                  Parameters

                                  Returns

                                  Get the reference to the class from which this object was instantiated. ...

                                  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

                                  Suspends the firing of all events. ...

                                  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.

                                  ( eventName, fn, [scope] )
                                  Shorthand for removeListener. ...

                                  Shorthand for removeListener.

                                  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.

                                  Defined By

                                  Static methods

                                  ( config )privatestatic
                                  ...

                                  Available since: 4.1.1

                                  Parameters

                                  ( members )chainableprivatestatic
                                  ...

                                  Available since: 4.1.1

                                  Parameters

                                  ( name, member )chainableprivatestatic
                                  ...

                                  Available since: 4.1.1

                                  Parameters

                                  ( members )chainablestatic
                                  Add methods / properties to the prototype of this class. ...

                                  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 ) : Ext.Basechainablestatic
                                  Add / override static properties of this class. ...

                                  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

                                  Returns

                                  ( xtype )chainableprivatestatic
                                  ...

                                  Available since: 4.1.1

                                  Parameters

                                  ( fromClass, members ) : Ext.Basechainableprivatestatic
                                  Borrow another class' members to the prototype of this class. ...

                                  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

                                  Create a new instance of this Class. ...

                                  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

                                  Overrides: Ext.layout.Layout.create

                                  ( alias, origin )static
                                  Create aliases for existing prototype methods. ...

                                  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

                                  ( config )privatestatic
                                  ...

                                  Available since: 4.1.1

                                  Parameters

                                  Get the current class' name in string format. ...

                                  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

                                  ( )deprecatedstatic
                                  Adds members to class. ...

                                  Adds members to class.

                                  Available since: 4.0.2

                                  This method has been deprecated since 4.1

                                  Use addMembers instead.

                                  ( name, mixinClass )chainableprivatestatic
                                  Used internally by the mixins pre-processor ...

                                  Used internally by the mixins pre-processor

                                  Available since: 4.1.1

                                  Parameters

                                  ( fn, scope )chainableprivatestatic
                                  ...

                                  Available since: 4.1.1

                                  Parameters

                                  ( members ) : Ext.Basechainabledeprecatedstatic
                                  Override members of this class. ...

                                  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

                                  This method has been deprecated since 4.1.0

                                  Use Ext.define instead

                                  Parameters

                                  • members : Object

                                    The properties to add to this class. This should be specified as an object literal containing one or more properties.

                                  Returns

                                  ...

                                  Available since: 4.1.1