Clear Up
SharpKit Reference

Controller Class

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.

Namespace: Ext.app

Base Types

Base Interfaces

Derived Types

Constructors

Name Description
Controller(object) Creates new Controller.
Controller(ControllerConfig)
Controller(Object[])

Methods

Name Description
addEvents(object) Adds the specified events to the list of events which this Observable may fire.
addListener(object, Delegate, object, 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}
            });
            
addManagedListener(object, object, Delegate, object, object) Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destroyed.
addRef(object) Registers a reference.
clearListeners() Removes all listeners for this object including the managed listeners
clearManagedListeners() Removes all managed listeners for this object.
continueFireEvent(JsString, object, object) Continue to fire event.
control(object, object) 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.
createRelayer(object, object) Creates an event handling function which refires the event from this object as the passed event name.
enableBubble(object) Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. There is no implementation in the Observable base class. This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly. Example:
  Ext.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');
            }
            }
            });
            
fireEvent(JsString, Object[]) 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.
getBubbleParent() Gets the bubbling parent for an Observable
getController(JsString) Returns instance of a controller with the given name. When controller doesn't exist yet, it's created.
getModel(JsString) Returns a Model class with the given name. A shorthand for using Ext.ModelManager.getModel.
getStore(JsString) Returns instance of a Store with the given name. When store doesn't exist yet, it's created.
getView(JsString) 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();
            
hasListener(JsString) 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.
hasRef(object) Returns true if a reference is registered.
init(Application) 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.

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

mon(object, object, Delegate, object, object) Shorthand for addManagedListener. Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destroyed.
mun(object, object, Delegate, object) Shorthand for removeManagedListener. Removes listeners that were added by the mon method.
on(object, Delegate, object, object) Shorthand for addListener. Appends an event handler to this object. For example:
myGridPanel.on("mouseover", this.onMouseOver, this);
            
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:
myGridPanel.on({
            cellClick: this.onCellClick,
            mouseover: this.onMouseOver,
            mouseout: this.onMouseOut,
            scope: this // Important. Ensure "this" is correct during handler execution
            });
            
One can also specify options for each event handler separately:
myGridPanel.on({
            cellClick: {fn: this.onCellClick, scope: this, single: true},
            mouseover: {fn: panel.onMouseOver, scope: panel}
            });
            
Names of methods in a specified scope may also be used. Note that scope MUST be specified to use this option:
myGridPanel.on({
            cellClick: {fn: 'onCellClick', scope: this, single: true},
            mouseover: {fn: 'onMouseOver', scope: panel}
            });
            
onLaunch(Application) A template method like init, but called after the viewport is created. This is called after the launch method of Application is executed.

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

prepareClass(Delegate) 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.
relayEvents(object, JsArray<T>, object) Relays selected events from the specified Observable as if the events were fired by this. For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:
this.relayEvents(this.getStore(), ['load']);
            
The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword.
removeListener(JsString, Delegate, object) Removes an event handler.
removeManagedListener(object, object, Delegate, object) Removes listeners that were added by the mon method.
removeManagedListenerItem(bool, object) Remove a single managed listener item
resumeEvents() 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.
suspendEvents(bool) Suspends the firing of all events. (see resumeEvents)
un(JsString, Delegate, object) Shorthand for removeListener. Removes an event handler.

Properties

Name Description
eventsSuspended Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called. Defaults to: 0
hasListeners 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);
           }
            
isObservable true in this class to identify an object as an instantiated Observable, or subclass thereof. Defaults to: true

Fields

Name Description
id The id of this controller. You can use this id when dispatching.
listeners 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'); }
            }
            }
            });
            
models 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");
            }
            });
            
refs 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).
  • stores 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");
                }
                });
                
    views 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");
                }
                });
                
    © Copyright 2005-2011 SharpKit. All rights reserved.