Ext JS 4.0.7 Sencha Docs

Ext.app.Controller

Hierarchy

Ext.Base
Ext.app.Controller

Mixins

Subclasses

Files

Controllers are the glue that binds an application together. All they really do is listen for events (usually from views) and take some action. Here's how we might create a Controller to manage Users:

Ext.define('MyApp.controller.Users', {
    extend: 'Ext.app.Controller',

    init: function() {
        console.log('Initialized Users! This happens before the Application launch function is called');
    }
});

The init function is a special 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.

The init function is a great place to set up how your controller interacts with the view, and is usually used in conjunction with another Controller function - control. The control function makes it easy to listen to events on your view classes and take some action with a handler function. Let's update our Users controller to tell us when the panel is rendered:

Ext.define('MyApp.controller.Users', {
    extend: 'Ext.app.Controller',

    init: function() {
        this.control({
            'viewport > panel': {
                render: this.onPanelRendered
            }
        });
    },

    onPanelRendered: function() {
        console.log('The panel was rendered');
    }
});

We've updated the init function to use this.control to set up listeners on views in our application. The control function uses the new ComponentQuery engine to quickly and easily get references to components on the page. If you are not familiar with ComponentQuery yet, be sure to check out the documentation. In brief though, it allows us to pass a CSS-like selector that will find every matching component on the page.

In our init function above we supplied 'viewport > panel', which translates to "find me every Panel that is a direct child of a Viewport". We then supplied an object that maps event names (just 'render' in this case) to handler functions. The overall effect is that whenever any component that matches our selector fires a 'render' event, our onPanelRendered function is called.

Using refs

One of the most useful parts of Controllers is the new ref system. These use the new Ext.ComponentQuery to make it really easy to get references to Views on your page. Let's look at an example of this now:

Ext.define('MyApp.controller.Users', {
    extend: 'Ext.app.Controller',

    refs: [
        {
            ref: 'list',
            selector: 'grid'
        }
    ],

    init: function() {
        this.control({
            'button': {
                click: this.refreshGrid
            }
        });
    },

    refreshGrid: function() {
        this.getList().store.load();
    }
});

This example assumes the existence of a Grid on the page, which contains a single button to refresh the Grid when clicked. In our refs array, we set up a reference to the grid. There are two parts to this - the 'selector', which is a ComponentQuery selector which finds any grid on the page and assigns it to the reference 'list'.

By giving the reference a name, we get a number of things for free. The first is the getList function that we use in the refreshGrid method above. This is generated automatically by the Controller based on the name of our ref, which was capitalized and prepended with get to go from 'list' to 'getList'.

The way this works is that the first time getList is called by your code, the ComponentQuery selector is run and the first component that matches the selector ('grid' in this case) will be returned. All future calls to getList will use a cached reference to that grid. Usually it is advised to use a specific ComponentQuery selector that will only match a single View in your application (in the case above our selector will match any grid on the page).

Bringing it all together, our init function is called when the application boots, at which time we call this.control to listen to any click on a button and call our refreshGrid function (again, this will match any button on the page so we advise a more specific selector than just 'button', but have left it this way for simplicity). When the button is clicked we use out getList function to refresh the grid.

You can create any number of refs and control any number of components this way, simply adding more functions to your Controller as you go. For an example of real-world usage of Controllers see the Feed Viewer example in the examples/app/feed-viewer folder in the SDK download.

Generated getter methods

Refs aren't the only thing that generate convenient getter methods. Controllers often have to deal with Models and Stores so the framework offers a couple of easy ways to get access to those too. Let's look at another example:

Ext.define('MyApp.controller.Users', {
    extend: 'Ext.app.Controller',

    models: ['User'],
    stores: ['AllUsers', 'AdminUsers'],

    init: function() {
        var User = this.getUserModel(),
            allUsers = this.getAllUsersStore();

        var ed = new User({name: 'Ed'});
        allUsers.add(ed);
    }
});

By specifying Models and Stores that the Controller cares about, it again dynamically loads them from the appropriate locations (app/model/User.js, app/store/AllUsers.js and app/store/AdminUsers.js in this case) and creates getter functions for them all. The example above will create a new User model instance and add it to the AllUsers Store. Of course, you could do anything in this function but in this case we just did something simple to demonstrate the functionality.

Further Reading

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

Available since: 4.0.0

Defined By

Config options

Ext.app.Controller
view source
: String
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

Ext.app.Controller
view source
: String[]
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']
});

Available since: 4.0.6

Ext.app.Controller
view source
: String[]
Array of stores to require from AppName.store namespace. ...

Array of stores to require from AppName.store namespace. 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']
});

Available since: 4.0.6

Ext.app.Controller
view source
: String[]
Array of views to require from AppName.view namespace. ...

Array of views to require from AppName.view namespace. 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']
});

Available since: 4.0.6

Defined By

Properties

Available since: 4.0.0

...

Defaults to: /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate|element|vertical|horizontal|freezeEvent)$/

Available since: 4.0.0

...

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'

        return 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

Methods

Defined By

Instance methods

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

Creates new Controller.

Available since: 4.0.0

Parameters

  • config : Object (optional)

    Config object.

Returns

Fires

    Overrides: Ext.util.Observable.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

    • o : 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. Usage:

      this.addEvents({
          storeloaded: true,
          storecleared: true
      });
      
    • more : String... (optional)

      Additional event names if multiple event names are being passed as separate parameters. Usage:

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

    Available since: 4.0.6

    Parameters

    Returns

    ( eventName, fn, [scope], [options] )
    Appends an event handler to this object. ...

    Appends an event handler to this object.

    Available since: 1.1.0

    Parameters

    • eventName : String

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

    • fn : Function

      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.

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

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

      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:

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

    Fires

      ( item, ename, [fn], [scope], [opt] )
      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.

      • opt : Object (optional)

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

      Fires

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

        Available since: 4.0.0

        Parameters

        • args : Array/Arguments

          The arguments, either an array or the arguments object

        Returns

        • Object

          Returns the result after calling the overridden method

        Call the parent's overridden method. ...

        Call the parent's overridden method. For example:

        Ext.define('My.own.A', {
            constructor: function(test) {
                alert(test);
            }
        });
        
        Ext.define('My.own.B', {
            extend: 'My.own.A',
        
            constructor: function(test) {
                alert(test);
        
                this.callParent([test + 1]);
            }
        });
        
        Ext.define('My.own.C', {
            extend: 'My.own.B',
        
            constructor: function() {
                alert("Going to call parent's overriden constructor...");
        
                this.callParent(arguments);
            }
        });
        
        var a = new My.own.A(1); // alerts '1'
        var b = new My.own.B(1); // alerts '1', then alerts '2'
        var c = new My.own.C(2); // alerts "Going to call parent's overriden constructor..."
                                 // alerts '2', then alerts '3'
        

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

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

            Continue to fire event.

            Available since: Ext JS 4.0.7

            Parameters

            Fires

              Ext.app.Controller
              view source
              ( selectors, listeners )
              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');
                  }
              });
              

              See Ext.ComponentQuery for more information on component selectors.

              Available since: 4.0.0

              Parameters

              • selectors : String/Object

                If a String, the second argument is used as the listeners, otherwise an object of selectors -> listeners is assumed

              • listeners : Object
              Ext.app.Controller
              view source
              ( type, refs )private
              ...

              Available since: 4.0.0

              Parameters

              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

              Returns

              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.override(Ext.form.field.Base, {
                  //  Add functionality to Field's initComponent to enable the change event to bubble
                  initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
                      this.enableBubble('change');
                  }),
              
                  //  We know that we want Field's events to bubble directly to the FormPanel.
                  getBubbleTarget : function() {
                      if (!this.formPanel) {
                          this.formPanel = this.findParentByType('form');
                      }
                      return this.formPanel;
                  }
              });
              
              var myForm = new Ext.formPanel({
                  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

              • events : 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

                Gets the bubbling parent for an Observable ...

                Gets the bubbling parent for an Observable

                Available since: Ext JS 4.0.7

                Returns

                Fires

                  Ext.app.Controller
                  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

                  Ext.app.Controller
                  view source
                  ( name ) : 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

                  Ext.app.Controller
                  view source
                  ( ref, info, config )private
                  ...

                  Available since: 4.0.0

                  Parameters

                  Ext.app.Controller
                  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

                  Ext.app.Controller
                  view source
                  ( name ) : 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

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

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

                  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, else false

                  Ext.app.Controller
                  view source
                  ( 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

                  ( config ) : Objectchainableprotected
                  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);
                  
                          return this;
                      }
                  });
                  
                  var awesome = new My.awesome.Class({
                      name: 'Super Awesome'
                  });
                  
                  alert(awesome.getName()); // 'Super Awesome'
                  

                  Available since: 4.0.0

                  Parameters

                  Returns

                  • Object

                    mixins The mixin prototypes as key - value pairs

                  Fires

                    ( name, cls )private
                    Used internally by the mixins pre-processor ...

                    Used internally by the mixins pre-processor

                    Available since: 4.0.6

                    Parameters

                    Fires

                      ( item, ename, [fn], [scope], [opt] )
                      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.

                      • opt : Object (optional)

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

                      ( 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] )
                      Shorthand for addListener. ...

                      Shorthand for addListener.

                      Available since: 1.1.0

                      Parameters

                      • eventName : String

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

                      • fn : Function

                        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.

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

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

                        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:

                        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}
                        });
                        
                      Ext.app.Controller
                      view source
                      ( application )template
                      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

                      ( name, value )private
                      ...

                      Available since: 4.0.6

                      Parameters

                      Fires

                        ( name, fn )private
                        ...

                        Available since: 4.0.0

                        Parameters

                        ...

                        Available since: 1.1.0

                        ...

                        Available since: 4.0.0

                        Ext.app.Controller
                        view source
                        ( refs )private
                        ...

                        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.

                        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

                        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

                              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 ) : Ext.Basechainableprivate
                              ...

                              Available since: 4.0.0

                              Parameters

                              Returns

                              Fires

                                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++;
                                
                                        return this;
                                    },
                                
                                    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

                                ( 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

                                ( fromClass, members ) : Ext.Basechainablestatic
                                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 : String/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

                                ( 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

                                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

                                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.implement({
                                     meow: function() {
                                        alert('Meowww...');
                                     }
                                 });
                                
                                 var kitty = new My.awesome.Cat;
                                 kitty.meow();
                                

                                Available since: 4.0.2

                                Parameters

                                ( members ) : Ext.Basechainablestatic
                                Override prototype members of this class. ...

                                Override prototype members of this class. Overridden methods can be invoked via callOverridden

                                Ext.define('My.Cat', {
                                    constructor: function() {
                                        alert("I'm a cat!");
                                
                                        return this;
                                    }
                                });
                                
                                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"
                                

                                Available since: 4.0.2

                                Parameters

                                Returns