Ext.data.JsonP.Ext_app_Controller({"alternateClassNames":[],"aliases":{},"enum":null,"parentMixins":[],"tagname":"class","subclasses":["Ext.app.Application"],"extends":"Ext.Base","uses":["Ext.app.domain.Controller"],"html":"
Hierarchy
Ext.Base
Ext.app.Controller
Mixins
Ext.util.Observable
Requires
Ext.ComponentManager
Ext.ModelManager
Ext.app.EventBus
Ext.app.domain.Component
Ext.app.domain.Global
Ext.app.domain.Store
Ext.data.StoreManager
Subclasses
Ext.app.Application
Uses
Ext.app.domain.Controller
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 ' +\n                     '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 control method to set up listeners on views\nin our application. The control method uses the ComponentQuery engine to quickly and easily get references to components\non the page. If you are not familiar with ComponentQuery yet, be sure to check out the\ndocumentation. In brief though, it allows us to pass a CSS-like selector that will find\nevery 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

Event domains

\n\n

In Ext JS 4.2, we introduced the concept of event domains. In terms of MVC, an event domain\nis one or more base classes that fire events to which a Controller wants to listen. Besides\nComponent event domain that encompass Ext.Component-descended Views, Controllers now\ncan listen to events from data Stores, Ext.Direct Providers, other Controllers, and Ext.globalEvents.\nThis feature provides a way to communicate between parts of the whole application without the need\nto bind controllers together tightly, and allows to develop and test application parts in isolation.

\n\n

See usage examples in listen method documentation.

\n\n

Using refs

\n\n

One of the most useful parts of Controllers is the ref system. These use the 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         ref: 'list',\n         selector: 'grid'\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, allUsers, ed;\n\n         User = this.getUserModel();\n         allUsers = this.getAllUsersStore();\n\n         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

Further Reading

\n\n

For more information about writing Ext JS 4 applications, please see the\napplication architecture guide. Also see the Ext.app.Application\ndocumentation.

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

\n
Ext.util.Observable
view source
: Object
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\nshould be a valid listeners config object as specified in the addListener example for attaching multiple\nhandlers at once.

\n\n

DOM events from Ext JS Components

\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
\n
Ext.app.Controller
view source
: String/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\n     getUserModel: function() {\n         return this.getModel(\"User\");\n     },\n\n     getVehicleModel: function() {\n         return this.getModel(\"Vehicle\");\n     }\n });\n
\n
Ext.app.Controller
view source
: 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\n     refs: [{\n         ref: 'list',\n         selector: 'grid'\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
    \n
  • ref - name of the reference.
    • \n
  • selector - Ext.ComponentQuery selector to access the component.
    • \n
  • autoCreate - True to create the component automatically if not found on page.
    • \n
  • forceCreate - Forces the creation of the component every time reference is accessed\n(when get<REFNAME> is called).
    • \n
  • xtype - Used to create component by its xtype with autoCreate or forceCreate. If\nyou don't provide xtype, an Ext.Component instance will be created.
    • \n
\n\n
Ext.app.Controller
view source
: String/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 to:

\n\n
 Ext.define(\"MyApp.controller.Foo\", {\n     extend: \"Ext.app.Controller\",\n\n     requires: [\n         'MyApp.store.Users',\n         'MyApp.store.Vehicles'\n     ]\n\n     getUsersStore: function() {\n         return this.getStore(\"Users\");\n     },\n\n     getVehiclesStore: function() {\n         return this.getStore(\"Vehicles\");\n     }\n });\n
\n
Ext.app.Controller
view source
: String/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\n     getListView: function() {\n         return this.getView(\"List\");\n     },\n\n     getDetailView: function() {\n         return this.getView(\"Detail\");\n     }\n });\n
\n

Properties

Defined By

Instance Properties

Ext.Base
view source
: Stringprivate
...
\n

Defaults to: 'Ext.Base'

Ext.app.Controller
view source
application : Ext.app.Applicationreadonly

The Ext.app.Application for this controller.

\n

The Ext.app.Application for this controller.

\n
Ext.Base
view source
: Objectprivate
...
\n

Defaults to: {}

Ext.util.Observable
view source
: Numberprivate
Initial suspended call count. ...

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

\n

Defaults to: 0

Ext.util.Observable
view source
: 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
\n
Ext.Base
view source
: Arrayprivate
...
\n

Defaults to: []

Ext.Base
view source
: Objectprivate
...
\n

Defaults to: {}

Ext.Base
view source
: Booleanprivate
...
\n

Defaults to: true

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

\n

Defaults to: true

Ext.Base
view source
: 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
\n
Defined By

Static Properties

Ext.Base
view source
: Arrayprivatestatic
...
\n

Defaults to: []

Ext.app.Controller
view source
: RegExpprivatestatic
...
\n

Defaults to: /^(.*)\\.controller\\./

Ext.app.Controller
view source
: Objectprivatestatic
...
\n

Defaults to: {model: {getter: 'getModel', upper: 'Model'}, view: {getter: 'getView', upper: 'View'}, controller: {getter: 'getController', upper: 'Controller'}, store: {getter: 'getStore', upper: 'Store'}}

Methods

Defined By

Instance Methods

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

Creates new Controller.

\n

Parameters

  • config : Object (optional)

    Configuration object.

    \n

Returns

Ext.util.Observable
view source
( 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.

\n

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
( eventName, [fn], [scope], [options] ) : Object
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
\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
    • destroyable : Boolean (optional)

      When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

      \n\n

      Defaults to: false

    • priority : Number (optional)

      An optional numeric priority that determines the order in which event handlers\n are run. Event handlers with no priority will be run as if they had a priority\n of 0. Handlers with a higher priority will be prioritized to run sooner than\n those with a lower priority. Negative numbers can be used to set a priority\n lower than the default. Internally, the framework uses a range of 1000 or\n greater, and -1000 or lesser for handers that are intended to run before or\n after all others, so it is recommended to stay within the range of -999 to 999\n when setting the priority of event handlers in application-level code.

      \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

Returns

  • Object

    Only when the destroyable option is specified.

    \n\n\n\n\n

    A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

    \n\n\n\n\n
    this.btnListeners =  = myButton.on({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n
    \n\n\n\n\n

    And when those listeners need to be removed:

    \n\n\n\n\n
    Ext.destroy(this.btnListeners);\n
    \n\n\n\n\n

    or

    \n\n\n\n\n
    this.btnListeners.destroy();\n
    \n\n
Ext.util.Observable
view source
( item, ename, [fn], [scope], [options] ) : Object
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.

\n

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
  • options : Object (optional)

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

    \n\n

Returns

  • Object

    Only when the destroyable option is specified.

    \n\n\n\n\n

    A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

    \n\n\n\n\n
    this.btnListeners =  = myButton.mon({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n
    \n\n\n\n\n

    And when those listeners need to be removed:

    \n\n\n\n\n
    Ext.destroy(this.btnListeners);\n
    \n\n\n\n\n

    or

    \n\n\n\n\n
    this.btnListeners.destroy();\n
    \n\n
Ext.app.Controller
view source
( refs )
Registers one or more references. ...

Registers one or more references.

\n

Parameters

Ext.Base
view source
( 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
\n
\n

This method has been deprecated

\n

as of 4.1. Use callParent instead.

\n\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
( 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
\n\n

To override a method and replace it and also call the superclass method, use\ncallSuper. This is often done to patch a method to fix a bug.

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

This method is used by an override to call the superclass method but bypass any\noverridden method. This is often done to \"patch\" a method that contains a bug\nbut for whatever reason cannot be fixed directly.

\n\n

Consider:

\n\n
 Ext.define('Ext.some.Class', {\n     method: function () {\n         console.log('Good');\n     }\n });\n\n Ext.define('Ext.some.DerivedClass', {\n     method: function () {\n         console.log('Bad');\n\n         // ... logic but with a bug ...\n\n         this.callParent();\n     }\n });\n
\n\n

To patch the bug in DerivedClass.method, the typical solution is to create an\noverride:

\n\n
 Ext.define('App.paches.DerivedClass', {\n     override: 'Ext.some.DerivedClass',\n\n     method: function () {\n         console.log('Fixed');\n\n         // ... logic but with bug fixed ...\n\n         this.callSuper();\n     }\n });\n
\n\n

The patch method cannot use callParent to call the superclass method since\nthat would call the overridden method containing the bug. In other words, the\nabove patch would only produce \"Fixed\" then \"Good\" in the console log, whereas,\nusing callParent would produce \"Fixed\" then \"Bad\" then \"Good\".

\n

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object\nfrom the current method, for example: this.callSuper(arguments)

    \n

Returns

  • Object

    Returns the result of calling the superclass method

    \n
Ext.util.Observable
view source
( o, fn, scope )private
...
\n

Parameters

Ext.util.Observable
view source
( )
Removes all listeners for this object including the managed listeners ...

Removes all listeners for this object including the managed listeners

\n
Ext.util.Observable
view source
( )
Removes all managed listeners for this object. ...

Removes all managed listeners for this object.

\n
Ext.Base
view source
( )private
...
\n
Ext.util.Observable
view source
( eventName, args, bubbles )private
Continue to fire event. ...

Continue to fire event.

\n

Parameters

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

Or alternatively one call control with two arguments:

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

See Ext.ComponentQuery for more information on component selectors.

\n

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

    Config for listeners.

    \n
Ext.util.Observable
view source
( newName, [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.

\n

Parameters

  • newName : String

    The name under which to refire the passed parameters.

    \n
  • beginEnd : Array (optional)

    The caller can specify on which indices to slice.

    \n

Returns

Ext.Base
view source
( )private
...
\n

Overrides: Ext.state.Stateful.destroy, Ext.util.ElementContainer.destroy, Ext.AbstractComponent.destroy, Ext.AbstractPlugin.destroy

Ext.app.Controller
view source
( app )private
...
\n

Parameters

Ext.util.Observable
view source
( 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.define('Ext.overrides.form.field.Base', {\n    override: 'Ext.form.field.Base',\n\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent: function () {\n        this.callParent();\n        this.enableBubble('change');\n    }\n});\n\nvar myForm = Ext.create('Ext.form.Panel', {\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
\n

Parameters

  • eventNames : String/String[]

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

    \n
Ext.app.Controller
view source
( app )private
...
\n

Parameters

Ext.util.Observable
view source
( eventName, 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.

\n

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
( eventName, args ) : Boolean
Fires the specified event with the passed parameter list. ...

Fires the specified event with the passed parameter list.

\n\n

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

\n

Parameters

  • eventName : String

    The name of the event to fire.

    \n
  • args : Object[]

    An array of parameters which are passed to handlers.

    \n

Returns

  • Boolean

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

    \n
Ext.app.Controller
view source
( ) : Ext.app.Application
Returns the base Ext.app.Application for this controller. ...

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

\n

Returns

Ext.util.Observable
view source
( ) : Ext.util.Observableprivate
Gets the bubbling parent for an Observable ...

Gets the bubbling parent for an Observable

\n

Returns

Ext.Base
view source
( name )private
...
\n

Parameters

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

Returns instance of a Controller with the given id.\nWhen controller doesn't exist yet, it's created. Note that this method depends\non Application instance and will return undefined when Application is not\naccessible. The only exception is when this Controller instance's id is requested;\nin that case we always return the instance even if Application is no available.

\n

Parameters

Returns

Ext.Base
view source
( [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.

\n

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

\n

Parameters

Returns

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

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.\nWhen store doesn't exist yet, it's created.

\n

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

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

Parameters

Returns

Ext.Base
view source
( config )private
...
\n

Parameters

Ext.util.Observable
view source
( 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.

\n

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
( ref ) : Boolean
Returns true if a reference is registered. ...

Returns true if a reference is registered.

\n

Parameters

Returns

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\nApplication's launch function is executed so gives a hook point\nto run any code before your Viewport is created.

\n
\n

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

\n
\n

Parameters

Ext.app.Controller
view source
( )private
...
\n
Ext.Base
view source
( config ) : Ext.Basechainableprotected
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
\n

Parameters

Returns

Ext.app.Controller
view source
( to )
Adds listeners to different event sources (also called \"event domains\"). ...

Adds listeners to different event sources (also called \"event domains\"). The\nprimary event domain is that of components, but there are also other event domains:\nGlobal domain that intercepts events fired from\nExt.globalEvents Observable instance, Controller\ndomain can be used to listen to events fired by other Controllers,\nStore domain gives access to Store events, and\nDirect domain can be used with Ext.Direct Providers\nto listen to their events.

\n\n

To listen to \"bar\" events fired by a controller with id=\"foo\":

\n\n
 Ext.define('AM.controller.Users', {\n     init: function() {\n         this.listen({\n             controller: {\n                 '#foo': {\n                    bar: this.onFooBar\n                 }\n             }\n         });\n     },\n     ...\n });\n
\n\n

To listen to \"bar\" events fired by any controller, and \"baz\" events\nfired by Store with storeId=\"baz\":

\n\n
 Ext.define('AM.controller.Users', {\n     init: function() {\n         this.listen({\n             controller: {\n                 '*': {\n                    bar: this.onAnyControllerBar\n                 }\n             },\n             store: {\n                 '#baz': {\n                     baz: this.onStoreBaz\n                 }\n             }\n         });\n     },\n     ...\n });\n
\n\n

To listen to \"idle\" events fired by Ext.globalEvents when other event\nprocessing is complete and Ext JS is about to return control to the browser:

\n\n
 Ext.define('AM.controller.Users', {\n     init: function() {\n         this.listen({\n             global: {               // Global events are always fired\n                 idle: this.onIdle   // from the same object, so there\n             }                       // are no selectors\n         });\n     }\n });\n
\n\n

As this relates to components, the following example:

\n\n
 Ext.define('AM.controller.Users', {\n     init: function() {\n         this.listen({\n             component: {\n                 'useredit button[action=save]': {\n                    click: this.updateUser\n                 }\n             }\n         });\n     },\n     ...\n });\n
\n\n

Is equivalent to:

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

Of course, these can all be combined in a single call and used instead of\ncontrol, like so:

\n\n
 Ext.define('AM.controller.Users', {\n     init: function() {\n         this.listen({\n             global: {\n                 idle: this.onIdle\n             },\n             controller: {\n                 '*': {\n                    foobar: this.onAnyFooBar\n                 },\n                 '#foo': {\n                    bar: this.onFooBar\n                 }\n             },\n             component: {\n                 'useredit button[action=save]': {\n                    click: this.updateUser\n                 }\n             },\n             store: {\n                 '#qux': {\n                     load: this.onQuxLoad\n                 }\n             }\n         });\n     },\n     ...\n });\n
\n

Parameters

  • to : Object

    Config object containing domains, selectors and listeners.

    \n
Ext.util.Observable
view source
( item, ename, [fn], [scope], [options] ) : Object
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.

\n

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
  • options : Object (optional)

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

    \n\n

Returns

  • Object

    Only when the destroyable option is specified.

    \n\n\n\n\n

    A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

    \n\n\n\n\n
    this.btnListeners =  = myButton.mon({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n
    \n\n\n\n\n

    And when those listeners need to be removed:

    \n\n\n\n\n
    Ext.destroy(this.btnListeners);\n
    \n\n\n\n\n

    or

    \n\n\n\n\n
    this.btnListeners.destroy();\n
    \n\n
Ext.util.Observable
view source
( item, ename, [fn], [scope] )
Shorthand for removeManagedListener. ...

Shorthand for removeManagedListener.

\n\n

Removes listeners that were added by the mon method.

\n

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
( eventName, [fn], [scope], [options] ) : Object
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
\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
    • destroyable : Boolean (optional)

      When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

      \n\n

      Defaults to: false

    • priority : Number (optional)

      An optional numeric priority that determines the order in which event handlers\n are run. Event handlers with no priority will be run as if they had a priority\n of 0. Handlers with a higher priority will be prioritized to run sooner than\n those with a lower priority. Negative numbers can be used to set a priority\n lower than the default. Internally, the framework uses a range of 1000 or\n greater, and -1000 or lesser for handers that are intended to run before or\n after all others, so it is recommended to stay within the range of -999 to 999\n when setting the priority of event handlers in application-level code.

      \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

Returns

  • Object

    Only when the destroyable option is specified.

    \n\n\n\n\n

    A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

    \n\n\n\n\n
    this.btnListeners =  = myButton.on({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n
    \n\n\n\n\n

    And when those listeners need to be removed:

    \n\n\n\n\n
    Ext.destroy(this.btnListeners);\n
    \n\n\n\n\n

    or

    \n\n\n\n\n
    this.btnListeners.destroy();\n
    \n\n
Ext.Base
view source
( names, callback, scope )private
...
\n

Parameters

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

\n
\n

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

\n
\n

Parameters

Ext.util.Observable
view source
( 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.

\n

Parameters

  • T : Function

    The class constructor to prepare.

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

Parameters

Ext.util.Observable
view source
( origin, events, [prefix] ) : Object
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.

\n

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

Returns

  • Object

    A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:

    \n\n
    this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');\n
    \n\n

    Can be undone by calling

    \n\n
    Ext.destroy(this.storeRelayers);\n
    \n\n

    or

    \n\n
    this.store.relayers.destroy();\n
    \n
Ext.util.Observable
view source
( eventName, fn, [scope] )
Removes an event handler. ...

Removes an event handler.

\n

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
( item, ename, [fn], [scope] )
Removes listeners that were added by the mon method. ...

Removes listeners that were added by the mon method.

\n

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
( isClear, managedListener )private
Remove a single managed listener item ...

Remove a single managed listener item

\n

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
( eventName )
Resumes firing of the named event(s). ...

Resumes firing of the named event(s).

\n\n

After calling this method to resume events, the events will fire when requested to fire.

\n\n

Note that if the suspendEvent method is called multiple times for a certain event,\nthis converse method will have to be called the same number of times for it to resume firing.

\n

Parameters

  • eventName : String...

    Multiple event names to resume.

    \n
Ext.util.Observable
view source
( )
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.

\n
Ext.Base
view source
( config, applyIfNotSet ) : Ext.Basechainableprivate
...
\n

Parameters

Returns

Ext.Base
view source
( ) : 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
\n

Returns

Ext.util.Observable
view source
( eventName )
Suspends firing of the named event(s). ...

Suspends firing of the named event(s).

\n\n

After calling this method to suspend events, the events will no longer fire when requested to fire.

\n\n

Note that if this is called multiple times for a certain event, the converse method\nresumeEvent will have to be called the same number of times for it to resume firing.

\n

Parameters

  • eventName : String...

    Multiple event names to suspend.

    \n
Ext.util.Observable
view source
( queueSuspended )
Suspends the firing of all events. ...

Suspends the firing of all events. (see resumeEvents)

\n

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
( eventName, fn, [scope] )
Shorthand for removeListener. ...

Shorthand for removeListener.

\n\n

Removes an event handler.

\n

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
( config )privatestatic
...
\n

Parameters

Ext.Base
view source
( members )chainableprivatestatic
...
\n

Parameters

Ext.Base
view source
( name, member )chainableprivatestatic
...
\n

Parameters

Ext.Base
view source
( members )chainablestatic
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
\n

Parameters

Ext.Base
view source
( members ) : Ext.Basechainablestatic
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
\n

Parameters

Returns

Ext.Base
view source
( xtype )chainableprivatestatic
...
\n

Parameters

Ext.Base
view source
( fromClass, members ) : Ext.Basechainableprivatestatic
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
\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
view source
( ) : 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.

\n

Returns

Ext.Base
view source
( alias, 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
\n

Parameters

Ext.app.Controller
view source
( baseGetter, name )privatestatic
...
\n

Parameters

Ext.Base
view source
( config )privatestatic
...
\n

Parameters

Ext.app.Controller
view source
( name, kind, namespace )privatestatic
...
\n

Parameters

Ext.app.Controller
view source
( name, kindUpper )privatestatic
...
\n

Parameters

Ext.Base
view source
( ) : 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
\n

Returns

Ext.Base
view source
( )deprecatedstatic
Adds members to class. ...

Adds members to class.

\n
\n

This method has been deprecated since 4.1

\n

Use addMembers instead.

\n\n
\n
Ext.Base
view source
( name, mixinClass )privatestatic
Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

\n

Parameters

Ext.Base
view source
( fn, scope )chainableprivatestatic
...
\n

Parameters

Ext.Base
view source
( members ) : Ext.Basechainabledeprecatedstatic
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).

\n
\n

This method has been deprecated since 4.1.0

\n

Use Ext.define instead

\n\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.app.Controller
view source
( cls, requires, namespace, kind, names )privatestatic
This method is called like so:\n\n Ext.app.Controller.processDependencies(proto, requiresArray, 'MyApp', 'model', [\n ...

This method is called like so:

\n\n
 Ext.app.Controller.processDependencies(proto, requiresArray, 'MyApp', 'model', [\n     'User',\n     'Item',\n     'Foo@Common.model',\n     'Bar.Baz@Common.model'\n ]);\n
\n\n

Required dependencies are added to requiresArray.

\n

Parameters

Ext.Base
view source
( )privatestatic
...
\n
","superclasses":["Ext.Base"],"meta":{"docauthor":["Ed Spencer"]},"code_type":"ext_define","requires":["Ext.ComponentManager","Ext.ModelManager","Ext.app.EventBus","Ext.app.domain.Component","Ext.app.domain.Global","Ext.app.domain.Store","Ext.data.StoreManager"],"html_meta":{"docauthor":null},"statics":{"property":[{"tagname":"property","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"$onExtended","id":"static-property-S-onExtended"},{"tagname":"property","owner":"Ext.app.Controller","meta":{"static":true,"private":true},"name":"controllerRegex","id":"property-controllerRegex"},{"tagname":"property","owner":"Ext.app.Controller","meta":{"static":true,"private":true},"name":"strings","id":"property-strings"}],"cfg":[],"css_var":[],"method":[{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"addConfig","id":"static-method-addConfig"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"addInheritableStatics","id":"static-method-addInheritableStatics"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"addMember","id":"static-method-addMember"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true},"name":"addMembers","id":"static-method-addMembers"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true},"name":"addStatics","id":"static-method-addStatics"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"addXtype","id":"static-method-addXtype"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"borrow","id":"static-method-borrow"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true},"name":"create","id":"static-method-create"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true},"name":"createAlias","id":"static-method-createAlias"},{"tagname":"method","owner":"Ext.app.Controller","meta":{"static":true,"private":true},"name":"createGetter","id":"method-createGetter"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"extend","id":"static-method-extend"},{"tagname":"method","owner":"Ext.app.Controller","meta":{"static":true,"private":true},"name":"getFullName","id":"method-getFullName"},{"tagname":"method","owner":"Ext.app.Controller","meta":{"static":true,"private":true},"name":"getGetterName","id":"method-getGetterName"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true},"name":"getName","id":"static-method-getName"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"deprecated":{"text":"Use {@link #addMembers} instead.","version":"4.1"}},"name":"implement","id":"static-method-implement"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"mixin","id":"static-method-mixin"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"private":true},"name":"onExtended","id":"static-method-onExtended"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"chainable":true,"markdown":true,"deprecated":{"text":"Use {@link Ext#define Ext.define} instead","version":"4.1.0"}},"name":"override","id":"static-method-override"},{"tagname":"method","owner":"Ext.app.Controller","meta":{"static":true,"private":true},"name":"processDependencies","id":"method-processDependencies"},{"tagname":"method","owner":"Ext.Base","meta":{"static":true,"private":true},"name":"triggerExtended","id":"static-method-triggerExtended"}],"event":[],"css_mixin":[]},"files":[{"href":"Controller.html#Ext-app-Controller","filename":"Controller.js"}],"linenr":1,"members":{"property":[{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"$className","id":"property-S-className"},{"tagname":"property","owner":"Ext.app.Controller","meta":{"readonly":true},"name":"application","id":"property-application"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"configMap","id":"property-configMap"},{"tagname":"property","owner":"Ext.util.Observable","meta":{"private":true},"name":"eventsSuspended","id":"property-eventsSuspended"},{"tagname":"property","owner":"Ext.util.Observable","meta":{"readonly":true},"name":"hasListeners","id":"property-hasListeners"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"initConfigList","id":"property-initConfigList"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"initConfigMap","id":"property-initConfigMap"},{"tagname":"property","owner":"Ext.Base","meta":{"private":true},"name":"isInstance","id":"property-isInstance"},{"tagname":"property","owner":"Ext.util.Observable","meta":{},"name":"isObservable","id":"property-isObservable"},{"tagname":"property","owner":"Ext.Base","meta":{"protected":true},"name":"self","id":"property-self"}],"cfg":[{"tagname":"cfg","owner":"Ext.app.Controller","meta":{},"name":"id","id":"cfg-id"},{"tagname":"cfg","owner":"Ext.util.Observable","meta":{},"name":"listeners","id":"cfg-listeners"},{"tagname":"cfg","owner":"Ext.app.Controller","meta":{},"name":"models","id":"cfg-models"},{"tagname":"cfg","owner":"Ext.app.Controller","meta":{},"name":"refs","id":"cfg-refs"},{"tagname":"cfg","owner":"Ext.app.Controller","meta":{},"name":"stores","id":"cfg-stores"},{"tagname":"cfg","owner":"Ext.app.Controller","meta":{},"name":"views","id":"cfg-views"}],"css_var":[],"method":[{"tagname":"method","owner":"Ext.app.Controller","meta":{},"name":"constructor","id":"method-constructor"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"addEvents","id":"method-addEvents"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"addListener","id":"method-addListener"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"addManagedListener","id":"method-addManagedListener"},{"tagname":"method","owner":"Ext.app.Controller","meta":{},"name":"addRef","id":"method-addRef"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true,"deprecated":{"text":"as of 4.1. Use {@link #callParent} instead."}},"name":"callOverridden","id":"method-callOverridden"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true},"name":"callParent","id":"method-callParent"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true},"name":"callSuper","id":"method-callSuper"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"captureArgs","id":"method-captureArgs"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"clearListeners","id":"method-clearListeners"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"clearManagedListeners","id":"method-clearManagedListeners"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"configClass","id":"method-configClass"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"continueFireEvent","id":"method-continueFireEvent"},{"tagname":"method","owner":"Ext.app.Controller","meta":{},"name":"control","id":"method-control"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"createRelayer","id":"method-createRelayer"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"destroy","id":"method-destroy"},{"tagname":"method","owner":"Ext.app.Controller","meta":{"private":true},"name":"doInit","id":"method-doInit"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"enableBubble","id":"method-enableBubble"},{"tagname":"method","owner":"Ext.app.Controller","meta":{"private":true},"name":"finishInit","id":"method-finishInit"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"fireEvent","id":"method-fireEvent"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"fireEventArgs","id":"method-fireEventArgs"},{"tagname":"method","owner":"Ext.app.Controller","meta":{},"name":"getApplication","id":"method-getApplication"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"getBubbleParent","id":"method-getBubbleParent"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"getConfig","id":"method-getConfig"},{"tagname":"method","owner":"Ext.app.Controller","meta":{},"name":"getController","id":"method-getController"},{"tagname":"method","owner":"Ext.Base","meta":{},"name":"getInitialConfig","id":"method-getInitialConfig"},{"tagname":"method","owner":"Ext.app.Controller","meta":{},"name":"getModel","id":"method-getModel"},{"tagname":"method","owner":"Ext.app.Controller","meta":{"private":true},"name":"getRef","id":"method-getRef"},{"tagname":"method","owner":"Ext.app.Controller","meta":{},"name":"getStore","id":"method-getStore"},{"tagname":"method","owner":"Ext.app.Controller","meta":{},"name":"getView","id":"method-getView"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"hasConfig","id":"method-hasConfig"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"hasListener","id":"method-hasListener"},{"tagname":"method","owner":"Ext.app.Controller","meta":{},"name":"hasRef","id":"method-hasRef"},{"tagname":"method","owner":"Ext.app.Controller","meta":{"template":true},"name":"init","id":"method-init"},{"tagname":"method","owner":"Ext.app.Controller","meta":{"private":true},"name":"initAutoGetters","id":"method-initAutoGetters"},{"tagname":"method","owner":"Ext.Base","meta":{"chainable":true,"protected":true},"name":"initConfig","id":"method-initConfig"},{"tagname":"method","owner":"Ext.app.Controller","meta":{},"name":"listen","id":"method-listen"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"mon","id":"method-mon"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"mun","id":"method-mun"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"on","id":"method-on"},{"tagname":"method","owner":"Ext.Base","meta":{"private":true},"name":"onConfigUpdate","id":"method-onConfigUpdate"},{"tagname":"method","owner":"Ext.app.Controller","meta":{"template":true},"name":"onLaunch","id":"method-onLaunch"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"prepareClass","id":"method-prepareClass"},{"tagname":"method","owner":"Ext.app.Controller","meta":{"private":true},"name":"ref","id":"method-ref"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"relayEvents","id":"method-relayEvents"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"removeListener","id":"method-removeListener"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"removeManagedListener","id":"method-removeManagedListener"},{"tagname":"method","owner":"Ext.util.Observable","meta":{"private":true},"name":"removeManagedListenerItem","id":"method-removeManagedListenerItem"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"resumeEvent","id":"method-resumeEvent"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"resumeEvents","id":"method-resumeEvents"},{"tagname":"method","owner":"Ext.Base","meta":{"chainable":true,"private":true},"name":"setConfig","id":"method-setConfig"},{"tagname":"method","owner":"Ext.Base","meta":{"protected":true},"name":"statics","id":"method-statics"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"suspendEvent","id":"method-suspendEvent"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"suspendEvents","id":"method-suspendEvents"},{"tagname":"method","owner":"Ext.util.Observable","meta":{},"name":"un","id":"method-un"}],"event":[],"css_mixin":[]},"inheritable":null,"private":null,"component":false,"name":"Ext.app.Controller","singleton":false,"override":null,"inheritdoc":null,"id":"class-Ext.app.Controller","mixins":["Ext.util.Observable"],"mixedInto":[]});