Hierarchy
Ext.BaseExt.app.Controller
Mixins
Ext.util.Observable
Subclasses
Ext.app.Application
Files
Controller.js

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

\n\n

Ext.define('MyApp.controller.Users', {\n    extend: 'Ext.app.Controller',\n\n    init: function() {\n        console.log('Initialized Users! This happens before the Application launch function is called');\n    }\n});\n

\n\n

The init function is a special method that is called when your application boots. It is called before the\nApplication's launch function is executed so gives a hook point to run any code before\nyour Viewport is created.

\n\n

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

\n\n

Ext.define('MyApp.controller.Users', {\n    extend: 'Ext.app.Controller',\n\n    init: function() {\n        this.control({\n            'viewport > panel': {\n                render: this.onPanelRendered\n            }\n        });\n    },\n\n    onPanelRendered: function() {\n        console.log('The panel was rendered');\n    }\n});\n

\n\n

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

\n\n

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

\n\n

Using refs

\n\n

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

\n\n

Ext.define('MyApp.controller.Users', {\n    extend: 'Ext.app.Controller',\n\n    refs: [\n        {\n            ref: 'list',\n            selector: 'grid'\n        }\n    ],\n\n    init: function() {\n        this.control({\n            'button': {\n                click: this.refreshGrid\n            }\n        });\n    },\n\n    refreshGrid: function() {\n        this.getList().store.load();\n    }\n});\n

\n\n

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

\n\n

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

\n\n

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

\n\n

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

\n\n

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

\n\n

Generated getter methods

\n\n

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

\n\n

Ext.define('MyApp.controller.Users', {\n    extend: 'Ext.app.Controller',\n\n    models: ['User'],\n    stores: ['AllUsers', 'AdminUsers'],\n\n    init: function() {\n        var User = this.getUserModel(),\n            allUsers = this.getAllUsersStore();\n\n        var ed = new User({name: 'Ed'});\n        allUsers.add(ed);\n    }\n});\n

\n\n

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

\n\n

While some Ext JS Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly 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\nchild element of a Component, we need to specify the element option to identify the Component property to add a\nDOM listener to:

\n\n

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

Ext.app.Controller
view source

models : String[]

Array of models to require from AppName.model namespace. ...

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

\n\n

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

\n\n

This is equivalent of:

\n\n

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

Ext.app.Controller
view source

refs : Object[]

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

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

\n\n

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

\n\n

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

\n\n

The following fields can be used in ref definition:

\n\n

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\n(when get<REFNAME> is called).

\n\n

Ext.app.Controller
view source

stores : String[]

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.\nFor example:

\n\n

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

\n\n

This is equivalent of:

\n\n

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

Ext.app.Controller
view source

views : String[]

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.\nFor example:

\n\n

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

\n\n

This is equivalent of:

\n\n

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

Properties

Defined By

Instance Properties

Ext.Base
view source

$className : Stringprivate

...

Defaults to: "Ext.Base"

Ext.Base
view source

configMap : Objectprivate

...

Defaults to: {}

Ext.util.Observable
view source

eventsSuspended : Numberprivate

Initial suspended call count. ...

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

Defaults to: 0

Ext.util.Observable
view source

hasListeners : Objectreadonly

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\ndirectly on the instance, or on its class or a super class (via observe) or\non the MVC EventBus. The values of this object are truthy\n(a non-zero number) and falsy (0 or undefined). They do not represent an exact count\nof listeners. The value for an event is truthy if the event must be fired and is\nfalsy if there is no need to fire the event.

\n\n

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

\n\n

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

Ext.Base
view source

initConfigList : Arrayprivate

...

Defaults to: []

Ext.Base
view source

initConfigMap : Objectprivate

...

Defaults to: {}

Ext.Base
view source

isInstance : Booleanprivate

...

Defaults to: true

Ext.util.Observable
view source

isObservable : Boolean

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

Ext.Base
view source

self : Ext.Classprotected

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,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison

\n\n

Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); // dependent on 'this'\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n

Defined By

Static Properties

Ext.Base
view source

$onExtended : Arrayprivatestatic

...

Defaults to: []

Methods

Defined By

Instance Methods

Ext.app.Controller
view source

newExt.app.Controller( [Object config] ) : Object

Creates new Controller. ...

Creates new Controller.

Parameters

config : Object (optional)
Config object.
\n

Returns

Object
\n

Ext.util.Observable
view source

addEvents( Object/String... eventNames )

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.

Parameters

eventNames : Object/String...
Either an object with event names as properties with\na value of true. For example:
\n\n
```
this.addEvents({\n    storeloaded: true,\n    storecleared: true\n});\n
```
\n\n
Or any number of event names as separate parameters. For example:
\n\n
```
this.addEvents('storeloaded', 'storecleared');\n
```
\n

Ext.util.Observable
view source

addListener( String/Object eventName, [Function fn], [Object scope], [Object options] )

Appends an event handler to this object. ...

Appends an event handler to this object. For example:

\n\n

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

\n\n

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

\n\n

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

\n\n

One can also specify options for each event handler separately:

\n\n

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

\n\n

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

\n\n

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

Parameters

eventName : String/Object
The name of the event to listen for.\nMay also be an object who's property names are event names.
\n\n
fn : Function (optional)
The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.
\n\n
scope : Object (optional)
The scope (this reference) in which the handler function is\nexecuted. If omitted, defaults to the object which fired the event.
\n\n
options : Object (optional)
An object containing handler configuration.
\n\n\n\n\n
Note: Unlike in ExtJS 3.x, the options object will also be passed as the last\nargument to every event handler.
\n\n\n\n\n
This object may contain any of the following properties:
\n\n
- scope : Object
  The scope (this reference) in which the handler function is executed. If omitted,\n defaults to the object which fired the event.
  \n\n
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
  \n\n
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
  \n\n
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\n by the specified number of milliseconds. If the event fires again within that time,\n the original handler is not invoked, but the new handler is scheduled in its place.
  \n\n
- target : Ext.util.Observable
  Only call the handler if the event was fired on the target Observable, not if the event\n was bubbled up from a child Observable.
  \n\n
- element : String
  This option is only valid for listeners bound to Components.\n The name of a Component property which references an element to add a listener to.
  \n\n\n\n\n
  This option is useful during Component construction to add DOM event listeners to elements of\n Components which will exist only after the Component is rendered.\n For example, to add a click listener to a Panel's body:
  \n\n\n\n\n
```
  new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
```
  \n\n\n\n\n
  Combining Options
  \n\n\n\n\n
  Using the options argument, it is possible to combine different types of listeners:
  \n\n\n\n\n
  A delayed, one-time listener.
  \n\n\n\n\n
```
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
```
  \n\n

Ext.util.Observable
view source

addManagedListener( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope], [Object opt] )

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

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

Parameters

item : Ext.util.Observable/Ext.Element
The item to which to add a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n
opt : Object (optional)
If the ename parameter was an event name, this is the\naddListener options.
\n\n

Ext.app.Controller
view source

addRef( Object ref )

Registers a reference. ...

Registers a reference.

Parameters

ref : Object
\n

Ext.Base
view source

callOverridden( Array/Arguments args ) : Objectdeprecatedprotected

Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n constructor: functi...

Call the original method that was previously overridden with override

\n\n

Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n

This method has been deprecated

as of 4.1. Use callParent instead.

\n\n

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callOverridden(arguments)
\n

Returns

Object
Returns the result of calling the overridden method
\n

Ext.Base
view source

callParent( Array/Arguments args ) : Objectprotected

Call the \"parent\" method of the current method. ...

Call the \"parent\" method of the current method. That is the method previously\noverridden by derivation or by an override (see Ext.define).

\n\n

 Ext.define('My.Base', {\n     constructor: function (x) {\n         this.x = x;\n     },\n\n     statics: {\n         method: function (x) {\n             return x;\n         }\n     }\n });\n\n Ext.define('My.Derived', {\n     extend: 'My.Base',\n\n     constructor: function () {\n         this.callParent([21]);\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // alerts 21\n

\n\n

This can be used with an override as follows:

\n\n

 Ext.define('My.DerivedOverride', {\n     override: 'My.Derived',\n\n     constructor: function (x) {\n         this.callParent([x*2]); // calls original My.Derived constructor\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // now alerts 42\n

\n\n

This also works with static methods.

\n\n

 Ext.define('My.Derived2', {\n     extend: 'My.Base',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Base.method\n         }\n     }\n });\n\n alert(My.Base.method(10);     // alerts 10\n alert(My.Derived2.method(10); // alerts 20\n

\n\n

Lastly, it also works with overridden static methods.

\n\n

 Ext.define('My.Derived2Override', {\n     override: 'My.Derived2',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Derived2.method\n         }\n     }\n });\n\n alert(My.Derived2.method(10); // now alerts 40\n

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)
\n

Returns

Object
Returns the result of calling the parent method
\n

Ext.util.Observable
view source

clearListeners( )

Removes all listeners for this object including the managed listeners ...

Removes all listeners for this object including the managed listeners

Ext.util.Observable
view source

clearManagedListeners( )

Removes all managed listeners for this object. ...

Removes all managed listeners for this object.

Ext.Base
view source

configClass( )private

...

Ext.util.Observable
view source

continueFireEvent( String eventName, Array args, Boolean bubbles )private

Continue to fire event. ...

Continue to fire event.

Parameters

eventName : String
\n
args : Array
\n
bubbles : Boolean
\n

Ext.app.Controller
view source

control( String/Object selectors, Object listeners )

Adds listeners to components selected via Ext.ComponentQuery. ...

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

\n\n

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

\n\n

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

\n\n

See Ext.ComponentQuery for more information on component selectors.

Parameters

selectors : String/Object
If a String, the second argument is used as the\nlisteners, otherwise an object of selectors -> listeners is assumed
\n
listeners : Object
\n

Ext.util.Observable
view source

createRelayer( Object newName, [Array beginEnd] ) : Functionprivate

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.

Parameters

newName : Object
\n
beginEnd : Array (optional)
The caller can specify on which indices to slice
\n

Returns

Function
\n

Ext.Base
view source

destroy( )private

...

Overrides: Ext.AbstractComponent.destroy, Ext.AbstractPlugin.destroy, Ext.layout.Layout.destroy

Ext.util.Observable
view source

enableBubble( String/String[] eventNames )

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

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

\n\n

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

\n\n

Example:

\n\n

Ext.override(Ext.form.field.Base, {\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n        this.enableBubble('change');\n    }),\n\n    //  We know that we want Field's events to bubble directly to the FormPanel.\n    getBubbleTarget : function() {\n        if (!this.formPanel) {\n            this.formPanel = this.findParentByType('form');\n        }\n        return this.formPanel;\n    }\n});\n\nvar myForm = new Ext.formPanel({\n    title: 'User Details',\n    items: [{\n        ...\n    }],\n    listeners: {\n        change: function() {\n            // Title goes red if form has been modified.\n            myForm.header.setStyle('color', 'red');\n        }\n    }\n});\n

Parameters

eventNames : String/String[]
The event name to bubble, or an Array of event names.
\n

Ext.util.Observable
view source

fireEvent( String eventName, Object... args ) : Boolean

Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...

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

\n\n

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

Parameters

eventName : String
The name of the event to fire.
\n
args : Object...
Variable number of parameters are passed to handlers.
\n

Returns

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

Ext.util.Observable
view source

getBubbleParent( ) : Ext.util.Observableprivate

Gets the bubbling parent for an Observable ...

Gets the bubbling parent for an Observable

Returns

Ext.util.Observable
The bubble parent. null is returned if no bubble target exists
\n

Ext.Base
view source

getConfig( Object name )private

...

Parameters

name : Object
\n

Ext.app.Controller
view source

getController( String name ) : Ext.app.Controller

Returns instance of a controller with the given name. ...

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

Parameters

name : String
\n

Returns

Ext.app.Controller
a controller instance.
\n

Ext.Base
view source

getInitialConfig( [String name] ) : Object/Mixed

Returns the initial configuration passed to constructor when instantiating\nthis class. ...

Returns the initial configuration passed to constructor when instantiating\nthis class.

Parameters

name : String (optional)
Name of the config option to return.
\n

Returns

Object/Mixed
The full config object or a single config value\nwhen name parameter specified.
\n

Ext.app.Controller
view source

getModel( String name ) : Ext.data.Model

Returns a Model class with the given name. ...

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

Parameters

name : String
\n

Returns

Ext.data.Model
a model class.
\n

Ext.app.Controller
view source

getStore( String name ) : Ext.data.Store

Returns instance of a Store with the given name. ...

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

Parameters

name : String
\n

Returns

Ext.data.Store
a store instance.
\n

Ext.app.Controller
view source

getView( String 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,\nyou can use it like it's used by Application to create the Viewport:

\n\n

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

Parameters

name : String
\n

Returns

Ext.Base
a view class.
\n

Ext.Base
view source

hasConfig( Object config )private

...

Parameters

config : Object
\n

Ext.util.Observable
view source

hasListener( String eventName ) : Boolean

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\nindicates whether the event needs firing or not.

Parameters

eventName : String
The name of the event to check for
\n

Returns

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

Ext.app.Controller
view source

hasRef( Object ref ) : Boolean

Returns true if a reference is registered. ...

Returns true if a reference is registered.

Parameters

ref : Object
\n

Returns

Boolean
\n

Ext.app.Controller
view source

init( Ext.app.Application 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\nApplication's launch function is executed so gives a hook point to run any code before\nyour Viewport is created.

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

Parameters

application : Ext.app.Application
\n

Ext.Base
view source

initConfig( Object config ) : Ext.Baseprotected

Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

\n\n

Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n

Parameters

config : Object
\n

Returns

Ext.Base
this
\n

Ext.util.Observable
view source

mon( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope], [Object opt] )

Shorthand for addManagedListener. ...

Shorthand for addManagedListener.

\n\n

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

Parameters

item : Ext.util.Observable/Ext.Element
The item to which to add a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n
opt : Object (optional)
If the ename parameter was an event name, this is the\naddListener options.
\n\n

Ext.util.Observable
view source

mun( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope] )

Shorthand for removeManagedListener. ...

Shorthand for removeManagedListener.

\n\n

Removes listeners that were added by the mon method.

Parameters

item : Ext.util.Observable/Ext.Element
The item from which to remove a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n

Ext.util.Observable
view source

on( String/Object eventName, [Function fn], [Object scope], [Object options] )

Shorthand for addListener. ...

Shorthand for addListener.

\n\n

Appends an event handler to this object. For example:

\n\n

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

\n\n

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

\n\n

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

\n\n

One can also specify options for each event handler separately:

\n\n

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

\n\n

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

\n\n

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

Parameters

eventName : String/Object
The name of the event to listen for.\nMay also be an object who's property names are event names.
\n\n
fn : Function (optional)
The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.
\n\n
scope : Object (optional)
The scope (this reference) in which the handler function is\nexecuted. If omitted, defaults to the object which fired the event.
\n\n
options : Object (optional)
An object containing handler configuration.
\n\n\n\n\n
Note: Unlike in ExtJS 3.x, the options object will also be passed as the last\nargument to every event handler.
\n\n\n\n\n
This object may contain any of the following properties:
\n\n
- scope : Object
  The scope (this reference) in which the handler function is executed. If omitted,\n defaults to the object which fired the event.
  \n\n
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
  \n\n
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
  \n\n
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\n by the specified number of milliseconds. If the event fires again within that time,\n the original handler is not invoked, but the new handler is scheduled in its place.
  \n\n
- target : Ext.util.Observable
  Only call the handler if the event was fired on the target Observable, not if the event\n was bubbled up from a child Observable.
  \n\n
- element : String
  This option is only valid for listeners bound to Components.\n The name of a Component property which references an element to add a listener to.
  \n\n\n\n\n
  This option is useful during Component construction to add DOM event listeners to elements of\n Components which will exist only after the Component is rendered.\n For example, to add a click listener to a Panel's body:
  \n\n\n\n\n
```
  new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
```
  \n\n\n\n\n
  Combining Options
  \n\n\n\n\n
  Using the options argument, it is possible to combine different types of listeners:
  \n\n\n\n\n
  A delayed, one-time listener.
  \n\n\n\n\n
```
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
```
  \n\n

Ext.Base
view source

onConfigUpdate( Object names, Object callback, Object scope )private

...

Parameters

names : Object
\n
callback : Object
\n
scope : Object
\n

Ext.app.Controller
view source

onLaunch( Ext.app.Application 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.\nThis is called after the launch method of Application is executed.

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

Parameters

application : Ext.app.Application
\n

Ext.util.Observable
view source

prepareClass( Function T )private

Prepares a given class for observable instances. ...

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

Parameters

T : Function
The class constructor to prepare.
\n

Ext.util.Observable
view source

relayEvents( Object origin, String[] events, [String prefix] )

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.

\n\n

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

\n\n

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

\n\n

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

Parameters

origin : Object
The Observable whose events this object is to relay.
\n
events : String[]
Array of event names to relay.
\n
prefix : String (optional)
A common prefix to prepend to the event names. For example:
\n\n
```
this.relayEvents(this.getStore(), ['load', 'clear'], 'store');\n
```
\n\n
Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.
\n

Ext.util.Observable
view source

removeListener( String eventName, Function fn, [Object scope] )

Removes an event handler. ...

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
\n\n
fn : Function
The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\n
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\n

Ext.util.Observable
view source

removeManagedListener( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope] )

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

Removes listeners that were added by the mon method.

Parameters

item : Ext.util.Observable/Ext.Element
The item from which to remove a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n

Ext.util.Observable
view source

removeManagedListenerItem( Boolean isClear, Object managedListener )private

Remove a single managed listener item ...

Remove a single managed listener item

Parameters

isClear : Boolean
True if this is being called during a clear
\n
managedListener : Object
The managed listener item\nSee removeManagedListener for other args
\n

Ext.util.Observable
view source

resumeEvents( )

Resumes firing events (see suspendEvents). ...

Resumes firing events (see suspendEvents).

\n\n

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

Ext.Base
view source

setConfig( Object config, Object applyIfNotSet )private

...

Parameters

config : Object
\n
applyIfNotSet : Object
\n

Ext.Base
view source

statics( ) : Ext.Classprotected

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,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time

\n\n

Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n

Returns

Ext.Class
\n

Ext.util.Observable
view source

suspendEvents( Boolean queueSuspended )

Suspends the firing of all events. ...

Suspends the firing of all events. (see resumeEvents)

Parameters

queueSuspended : Boolean
Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\n

Ext.util.Observable
view source

un( String eventName, Function fn, [Object scope] )

Shorthand for removeListener. ...

Shorthand for removeListener.

\n\n

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
\n\n
fn : Function
The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\n
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\n

Defined By

Static Methods

Ext.Base
view source

addConfig( Object config )privatestatic

...

Parameters

config : Object
\n

Ext.Base
view source

addInheritableStatics( Object members )privatestatic

...

Parameters

members : Object
\n

Ext.Base
view source

addMember( Object name, Object member )privatestatic

...

Parameters

name : Object
\n
member : Object
\n

Ext.Base
view source

addMembers( Object members )static

Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

\n\n

Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.addMembers({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n

Parameters

members : Object
\n

Ext.Base
view source

addStatics( Object members ) : Ext.Basestatic

Add / override static properties of this class. ...

Add / override static properties of this class.

\n\n

Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.addStatics({\n    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'\n    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };\n    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };\n});\n

Parameters

members : Object
\n

Returns

Ext.Base
this
\n

Ext.Base
view source

addXtype( Object xtype )privatestatic

...

Parameters

xtype : Object
\n

Ext.Base
view source

borrow( Ext.Base fromClass, Array/String members ) : Ext.Baseprivatestatic

Borrow another class' members to the prototype of this class. ...

Borrow another class' members to the prototype of this class.

\n\n

Ext.define('Bank', {\n    money: '$$$',\n    printMoney: function() {\n        alert('$$$$$$$');\n    }\n});\n\nExt.define('Thief', {\n    ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n

Parameters

fromClass : Ext.Base
The class to borrow members from
\n
members : Array/String
The names of the members to borrow
\n

Returns

Ext.Base
this
\n

Ext.Base
view source

create( ) : Objectstatic

Create a new instance of this Class. ...

Create a new instance of this Class.

\n\n

Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n

\n\n

All parameters are passed to the constructor of the class.

Returns

Object
the created instance.
\n

Ext.Base
view source

createAlias( String/Object alias, String/Object origin )static

Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

\n\n

Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n

Parameters

alias : String/Object
The new method name, or an object to set multiple aliases. See\nflexSetter
\n
origin : String/Object
The original method name
\n

Ext.Base
view source

extend( Object config )privatestatic

...

Parameters

config : Object
\n

Ext.Base
view source

getName( ) : Stringstatic

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

Get the current class' name in string format.

\n\n

Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n

Returns

String
className
\n

Ext.Base
view source

implement( )deprecatedstatic

Adds members to class. ...

Adds members to class.

This method has been deprecated since 4.1

Use addMembers instead.

\n\n

Ext.Base
view source

mixin( Object name, Object mixinClass )privatestatic

Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Parameters

name : Object
\n
mixinClass : Object
\n

Ext.Base
view source

onExtended( Object fn, Object scope )privatestatic

...

Parameters

fn : Object
\n
scope : Object
\n

Ext.Base
view source

override( Object members ) : Ext.Basedeprecatedstatic

Override members of this class. ...

Override members of this class. Overridden methods can be invoked via\ncallParent.

\n\n

Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n

\n\n

As of 4.1, direct use of this method is deprecated. Use Ext.define\ninstead:

\n\n

Ext.define('My.CatOverride', {\n    override: 'My.Cat',\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n

\n\n

The above accomplishes the same result but can be managed by the Ext.Loader\nwhich can properly order the override and its target class and the build process\ncan determine whether the override is needed based on the required state of the\ntarget class (My.Cat).

This method has been deprecated since 4.1.0

Use Ext.define instead

\n\n

Parameters

members : Object
The properties to add to this class. This should be\nspecified as an object literal containing one or more properties.
\n

Returns

Ext.Base
this class
\n

Ext.Base
view source

triggerExtended( )privatestatic

...

Hierarchy

Mixins

Subclasses

Files

Using refs

Generated getter methods

Further Reading

Config options

Properties

Instance Properties

Static Properties

Methods

Instance Methods

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Static Methods

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Returns

Parameters

Parameters

Returns

Parameters

Parameters