Many classes have shortcut names used when creating (instantiating) a class with a
configuration object. The shortcut name is referred to as an alias (or xtype if the
class extends Ext.Component). The alias/xtype is listed next to the class name of
applicable classes for quick reference.
Framework classes or their members may be specified as private or protected. Else,
the class / member is public. Public, protected, and private are access
descriptors used to convey how and when the class or class member should be used.
Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public members intended to be used by the
owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.
static label next to the
method name. *See Static below.Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).
Let's look at each part of the member row:
lookupComponent in this example)( item ) in this example)Ext.Component in this case). This may be omitted for methods that do not
return anything other than undefined or may display as multiple possible values
separated by a forward slash / signifying that what is returned may depend on the
results of the method call (i.e. a method may return a Component if a get method calls is
successful or false if unsuccessful which would be displayed as
Ext.Component/Boolean).PROTECTED in
this example - see the Flags section below)Ext.container.Container in this example). The source
class will be displayed as a blue link if the member originates from the current class
and gray if it is inherited from an ancestor or mixed-in class.view source in the example)item : Object in the example).undefined a "Returns" section
will note the type of class or object returned and a description (Ext.Component in the
example)Available since 3.4.0 - not pictured in
the example) just after the member descriptionDefaults to: false)The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.
classInstance.method1().method2().etc();false is returned from
an event handler- Indicates a framework class
- A singleton framework class. *See the singleton flag for more information
- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)
- Indicates that the class, member, or guide is new in the currently viewed version
- Indicates a class member of type config
- Indicates a class member of type property
- Indicates a class member of type
method
- Indicates a class member of type event
- Indicates a class member of type
theme variable
- Indicates a class member of type
theme mixin
- Indicates that the class, member, or guide is new in the currently viewed version
Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.
Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.
Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.
Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.
If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.
Both API docs and guides can be searched for using the search field at the top of the page.
On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.
The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.
Clicking on an empty search field will show your last 10 searches for quick navigation.
Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:
Ext.button.Button class has an alternate class name of Ext.Button). Alternate class
names are commonly maintained for backward compatibility.Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.
Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.
Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:
The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.
Ext.Mixin
Ext.mixin.Identifiable
Ext.mixin.Observable
Ext.route.Mixin
Represents an Ext JS application, which is typically a single page app using a Viewport.
An application consists of one or more Views. The behavior of a View is managed by its corresponding Ext.app.ViewController and Ext.app.ViewModel.
Global activities are coordinated by Ext.app.Controller which are ultimately instantiated by an instance of this (or a derived) class.
Ext.application({
name: 'MyApp',
// The name of the initial view to create. With the classic toolkit this class
// will gain a "viewport" plugin if it does not extend Ext.Viewport. With the
// modern toolkit, the main view will be added to the Viewport.
//
//mainView: 'Main.view.main.Main'
});
This does several things. First it creates a global variable called 'MyApp' - all of your Application's classes (such as its Models, Views and Controllers) will reside under this single namespace, which drastically lowers the chances of colliding global variables.
The MyApp global will also have a getApplication method to get a reference to the current application:
var app = MyApp.getApplication();
Because an Ext.app.Application represents an entire app, we should tell it about the other parts of the app - namely the Models, Views and Controllers that are bundled with the application. Let's say we have a blog management app; we might have Models and Controllers for Posts and Comments, and Views for listing, adding and editing Posts and Comments. Here's how we'd tell our Application about all these things:
Ext.application({
name: 'Blog',
models: ['Post', 'Comment'],
controllers: ['Posts', 'Comments'],
launch: function() {
...
}
});
Note that we didn't actually list the Views directly in the Application itself. This is because Views are managed by Controllers, so it makes sense to keep those dependencies there. The Application will load each of the specified Controllers using the pathing conventions laid out in the application architecture guide
in this case expecting the controllers to reside in app/controller/Posts.js and app/controller/Comments.js. In turn, each Controller simply needs to list the Views it uses and they will be automatically loaded. Here's how our Posts controller like be defined:
Ext.define('MyApp.controller.Posts', {
extend: 'Ext.app.Controller',
views: ['posts.List', 'posts.Edit'],
// the rest of the Controller here
});
Because we told our Application about our Models and Controllers, and our Controllers about their Views, Ext JS will automatically load all of our app files for us. This means we don't have to manually add script tags into our html files whenever we add a new class, but more importantly it enables us to create a minimized build of our entire application using Sencha Cmd.
Typically, applications do not derive directly from Ext.app.Application. Rather, the
configuration passed to Ext.application mimics what you might do in a derived class.
In some cases, however, it can be desirable to share logic by using a derived class
from Ext.app.Application.
Derivation works as you would expect, but using the derived class should still be the
job of the Ext.application method.
Ext.define('MyApp.Application', {
extend: 'Ext.app.Application',
name: 'MyApp',
...
});
Ext.application('MyApp.Application');
For more information about writing Ext JS applications, please see the application architecture guide.
The path to the directory which contains all application's classes. This path will be registered via Ext.Loader#setPath for the namespace specified in the name config.
Defaults to:
"app"
The Ext.app.Application for this controller accessible via the getApplication method.
Defaults to:
null
Sets the value of application
application : Ext.app.Application
The name of a property to be assigned to the main namespace to gain a reference to this application. Can be set to an empty value to prevent the reference from being created
Ext.application({
name: 'MyApp',
appProperty: 'myProp',
launch: function() {
console.log(MyApp.myProp === this);
}
});
Defaults to:
'app'
Adds listeners to components selected via Ext.ComponentQuery. Accepts an object containing component paths mapped to a hash of listener functions. The function value may also be a string matching the name of a method on the controller.
In the following example the updateUser function is mapped to to the click
event on a button component, which is a child of the useredit component.
Ext.define('MyApp.controller.Users', {
extend: 'Ext.app.Controller',
control: {
'useredit button[action=save]': {
click: 'updateUser'
}
},
updateUser: function(button) {
console.log('clicked the Save button');
}
});
The method you pass to the listener will automatically be resolved on the controller.
In this case, the updateUser method that will get executed on the button click
event will resolve to the updateUser method on the controller,
See Ext.ComponentQuery for more information on component selectors.
Names of Ext.app.Controller that the app uses. By default, the framework will look for the controllers in the "controller" folder within the appFolder. Controller classes should be named using the syntax of "{appName}.controller.{ClassName}" with additional sub-folders under the "controller" folder specified within the class name following "controller.".
// by default, the following controller class would be located at:
// app/controller/Main.js
controllers: '.Main' // or 'MyApp.controller.Main'
// while the following would be located at:
// app/controller/customer/Main.js
controllers: 'customer.Main' // or 'MyApp.controller.customer.Main'
Note: If the controller has a different namespace than that of the application you will need to specify the full class name as well as define a path in the Loader's paths config or setPath method.
Defaults to:
null
Sets the value of currentProfile
currentProfile : Ext.app.Profile
The default token to be used at application launch
if one is not present. Often this is set to something like 'home'.
Defaults to:
null
A class name to use with the Ext.application call. The class must
also extend Ext.app.Application.
Ext.define('MyApp.Application', {
extend: 'Ext.app.Application',
launch: function() {
Ext.direct.Manager.addProvider(Ext.REMOTING_API);
}
});
Ext.application({
extend: 'MyApp.Application'
});
The glyphFontFamily to use for this application. Used as the default font-family
for all components that support a glyph config.
Defaults to:
null
Sets the value of glyphFontFamily
glyphFontFamily : String
The id of this controller. You can use this id when dispatching.
For an example of dispatching, see the examples under the listen config.
If an id is not explicitly set, it will default to the controller's full classname.
Defaults to:
undefined
Retrieves the id. This method Will auto-generate an id if one has not already
been configured.
id
Adds listeners to different event sources (also called "event domains"). The primary event domain is that of components, but there are also other event domains: Ext.app.domain.Global domain that intercepts events fired from Ext.GlobalEvents Observable instance, Ext.app.domain.Controller domain can be used to listen to events fired by other Controllers, Ext.app.domain.Store domain gives access to Store events, and Ext.app.domain.Direct domain can be used with Ext Direct Providers to listen to their events.
To listen to "bar" events fired by a controller with id="foo":
Ext.define('AM.controller.Users', {
extend: 'Ext.app.Controller',
listen: {
controller: {
'#foo': {
bar: 'onFooBar'
}
}
}
});
To listen to "bar" events fired by any controller, and "baz" events fired by Store with storeId="baz":
Ext.define('AM.controller.Users', {
extend: 'Ext.app.Controller',
listen: {
controller: {
'*': {
bar: 'onAnyControllerBar'
}
},
store: {
'#baz': {
baz: 'onStoreBaz'
}
}
}
});
To listen to "idle" events fired by Ext.GlobalEvents when other event processing is complete and Ext JS is about to return control to the browser:
Ext.define('AM.controller.Users', {
extend: 'Ext.app.Controller',
listen: {
global: { // Global events are always fired
idle: 'onIdle' // from the same object, so there
} // are no selectors
}
});
As this relates to components, the following example:
Ext.define('AM.controller.Users', {
extend: 'Ext.app.Controller',
listen: {
component: {
'useredit button[action=save]': {
click: 'updateUser'
}
}
}
});
Is equivalent to:
Ext.define('AM.controller.Users', {
extend: 'Ext.app.Controller',
control: {
'useredit button[action=save]': {
click: 'updateUser'
}
}
});
Of course, these can all be combined in a single call and used instead of
control, like so:
Ext.define('AM.controller.Users', {
extend: 'Ext.app.Controller',
listen: {
global: {
idle: 'onIdle'
},
controller: {
'*': {
foobar: 'onAnyFooBar'
},
'#foo': {
bar: 'onFooBar'
}
},
component: {
'useredit button[action=save]': {
click: 'updateUser'
}
},
store: {
'#qux': {
load: 'onQuxLoad'
}
}
}
});
Defaults to:
null
A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.
DOM events from Ext JS Ext.Component
While some Ext JS Component classes export selected DOM events (e.g. "click",
"mouseover" etc), this is usually only done when extra value can be added. For example
the DataViews itemclick
event passing the node clicked on. To access DOM events directly from a child element
of a Component, we need to specify the element option to identify the Component
property to add a DOM listener to:
new Ext.panel.Panel({
width: 400,
height: 200,
dockedItems: [{
xtype: 'toolbar'
}],
listeners: {
click: {
element: 'el', //bind to the underlying el property on the panel
fn: function(){ console.log('click el'); }
},
dblclick: {
element: 'body', //bind to the underlying body property on the panel
fn: function(){ console.log('dblclick body'); }
}
}
});
An alias for addListener. In versions prior to 5.1, listeners had a generated setter which could be called to add listeners. In 5.1 the listeners config is not processed using the config system and has no generated setter, so this method is provided for backward compatibility. The preferred way of adding listeners is to use the on method.
listeners : Object
The listeners
The application class to be used as the main viewport view for the application. The view will be configured with the viewport plugin to ensure the view takes up all available space in the browser viewport. The main view will be created after the application's init method is called and before the launch method. The main view should be an application class type and not a class from the framework.
The main view value may be:
main view class instance
Ext.define('MyApp.view.main.Main', {
extend: 'Ext.panel.Panel',
xtype: 'mainview',
title: 'Main Viewport View'
});
Ext.application({
name : 'MyApp',
mainView: 'MyApp.view.main.Main'
// mainView: 'main.Main'
// mainView: new MyApp.view.main.Main()
// mainView: { xtype: 'mainview' }
});
Note: You may also call setMainView at runtime if you require logic within the application's launch method to be processed prior to the creation of the main view.
Defaults to:
null
Sets the value of mainView
mainView : String / Object / Ext.Component
Array of models to require from AppName.model namespace. For example:
Ext.define("MyApp.controller.Foo", {
extend: "Ext.app.Controller",
models: ['User', 'Vehicle']
});
This is equivalent to:
Ext.define("MyApp.controller.Foo", {
extend: "Ext.app.Controller",
requires: ['MyApp.model.User', 'MyApp.model.Vehicle'],
getUserModel: function() {
return this.getModel("User");
},
getVehicleModel: function() {
return this.getModel("Vehicle");
}
});
Note: If the model has a different namespace than that of the application you will need to specify the full class name as well as define a path in the Loader's paths config or setPath method.
Defaults to:
null
Defaults to:
null
Sets the value of moduleClassName
moduleClassName : Object
The name of your application. This will also be the namespace for your views, controllers models and stores. Don't use spaces or special characters in the name. Application name is mandatory.
Defaults to:
''
The list of namespace prefixes used in the application to resolve dependencies like Views and Stores:
Ext.application({
name: 'MyApp',
namespaces: ['Common.code'],
controllers: [ 'Common.code.controller.Foo', 'Bar' ]
});
Ext.define('Common.code.controller.Foo', {
extend: 'Ext.app.Controller',
models: ['Foo'], // Loads Common.code.model.Foo
views: ['Bar'] // Loads Common.code.view.Bar
});
Ext.define('MyApp.controller.Bar', {
extend: 'Ext.app.Controller',
models: ['Foo'], // Loads MyApp.model.Foo
views: ['Bar'] // Loads MyApp.view.Bar
});
You don't need to include main namespace (MyApp), it will be added to the list automatically.
Defaults to:
[]
Additional load paths to add to Ext.Loader. See Ext.Loader#paths config for more details.
Defaults to:
null
true to enable quick tips to be read from the DOM and displayed
by the Ext.tip.Manager. Pass the object form as a configuration
for Ext.tip.Manager.
Defaults to:
false
Available since: 6.2.0
The refs config creates a getter method on the controller that internally
uses Ext.ComponentQuery to fetch the component instance using the configured
selector. The following example will add the getList method to
the controller and will return the first component in the application
hierarchy with an xtype of "grid". By default, undefined will be returned
when the query does not locate the target component.
Ext.define('MyApp.controller.Foo', {
extend: 'Ext.app.Controller',
refs: [{
ref: 'list',
selector: 'grid'
}]
});
The following fields may be used in the ref definition:
ref - name of the reference.selector - Ext.ComponentQuery selector to access the component.autoCreate - True to create the component automatically if not found on
page.forceCreate - True to force the creation of the component every time
reference is accessed (when get<REFNAME> is called).xtype - Used to create the component by its xtype with autoCreate or
forceCreate. If you don't provide xtype, an Ext.Component instance will
be created.The following example will create a getList and getUser method on the
controller.
Ext.define('MyApp.controller.Foo', {
extend: 'Ext.app.Controller',
refs: [{
list: 'grid',
user: {
autoCreate: true,
selector: 'form',
xtype: 'form'
}
}]
});
Defaults to:
null
A configuration object to apply onto the Ext.route.Router.
Defaults to:
null
Available since: 6.5.0
An object of routes to handle hash changes. A route can be defined in a simple way:
routes: {
'foo/bar': 'handleFoo',
'user/:id': 'showUser'
}
Where the property is the hash (which can accept a parameter defined by a colon) and the value is the method on the controller to execute. The parameters will get sent in the action method.
If no routes match a given hash, an Ext.GlobalEvents#unmatchedroute event will be fired. This can be listened to in four ways:
Ext.on('unmatchedroute', function(token) {});
Ext.define('MyApp.controller.Foo', {
extend: 'Ext.app.Controller',
listen: {
global: {
unmatchedroute: 'onUnmatchedRoute'
}
},
onUnmatchedRoute: function(token) {}
});
Ext.application({
name: 'MyApp',
listen: {
global: {
unmatchedroute: 'onUnmatchedRoute'
}
},
onUnmatchedRoute: function(token) {}
});
Ext.application({
name: 'MyApp',
listeners: {
unmatchedroute: 'onUnmatchedRoute'
},
onUnmatchedRoute: function(token) {}
});
There is also a complex means of defining a route where you can use a before action and even specify your own RegEx for the parameter:
routes: {
'foo/bar': {
action: 'handleFoo',
before: 'beforeHandleFoo'
},
'user/:id': {
action: 'showUser',
before: 'beforeShowUser',
conditions: {
':id': '([0-9]+)'
}
}
}
This will only match if the id parameter is a number.
The before action allows you to cancel an action. Every before action will get passed
an action argument with a resume and stop methods as the last argument of the
method and you MUST execute either method:
beforeHandleFoo: function (action) {
// some logic here
// this will allow the handleFoo action to be executed
action.resume();
},
handleFoo: function () {
// will get executed due to true being passed in callback in beforeHandleFoo
},
beforeShowUser: function (id, action) {
// allows for async process like an Ajax
Ext.Ajax.request({
url: 'foo.php',
success: function () {
// will not allow the showUser method to be executed
// but will continue other queued actions.
action.stop();
},
failure: function () {
// will not allow the showUser method to be executed
// and will not allow other queued actions to be executed.
action.stop(true);
}
});
},
showUser: function (id) {
// will not get executed due to false being passed in callback in beforeShowUser
}
You MUST execute the resume or
stop method on the action argument. Executing
action.resume(); will continue the action, action.stop(); will prevent
further execution.
The default RegEx that will be used is ([%a-zA-Z0-9\\-\\_\\s,]+) but you can specify
any that may suit what you need to accomplish. An example of an advanced condition
may be to make a parameter optional and case-insensitive:
routes: {
'user:id': {
action: 'showUser',
before: 'beforeShowUser',
conditions: {
':id': '(?:(?:\/){1}([%a-z0-9_,\s\-]+))?'
}
}
}
Each route can be named; this allows for the route to be looked up by name instead of
url. By default, the route's name will be the url you configure but you can provide
the name config to override the default:
routes: {
'user:id': {
action: 'showUser',
before: 'beforeShowUser',
name: 'user',
conditions: {
':id': '(?:(?:\/){1}([%a-z0-9_,\s\-]+))?'
}
}
}
The user:id route can not be looked up via the user name which is useful when using
redirectTo.
A wildcard route can also be defined which works exactly like any other route but will
always execute before any other route. To specify a wildcard route, use the *
as the url:
routes: {
'*': 'onToken'
}
Since a wildcard route will execute before any other route, it can delay the execution of other routes allowing for such things like a user session to be retrieved:
routes: {
'*': {
before: 'onBeforeToken'
}
},
onBeforeToken: function () {
return Ext.Ajax.request({
url: '/user/session'
});
}
In the above example, no other route will execute unless that request returns successfully.
You can also use a wildcard route if you need to defer routes until a store has been loaded when an application first starts up:
routes: {
'*': {
before: 'onBeforeToken'
}
},
onBeforeToken: function (action) {
var store = Ext.getStore('Settings');
if (store.loaded) {
action.resume();
} else {
store.on('load', action.resume, action, { single: true });
}
}
The valid options are configurations from Ext.route.Handler and Ext.route.Route.
Defaults to:
null
The scope to execute the launch function in. Defaults to the Application instance.
Defaults to:
undefined
Array of stores to require from AppName.store namespace and to generate getter methods for. For example:
Ext.define("MyApp.controller.Foo", {
extend: "Ext.app.Controller",
stores: ['Users', 'Vehicles']
});
This is equivalent to:
Ext.define("MyApp.controller.Foo", {
extend: "Ext.app.Controller",
requires: [
'MyApp.store.Users',
'MyApp.store.Vehicles'
]
getUsersStore: function() {
return this.getStore("Users");
},
getVehiclesStore: function() {
return this.getStore("Vehicles");
}
});
Note: If the store has a different namespace than that of the application you will need to specify the full class name as well as define a path in the Loader's paths config or setPath method.
Defaults to:
null
Any configuration to be passed on to the Ext.Viewport.
Defaults to:
null
Available since: 6.5.0
Array of views to require from AppName.view namespace and to generate getter methods for. For example:
Ext.define("MyApp.controller.Foo", {
extend: "Ext.app.Controller",
views: ['List', 'Detail']
});
This is equivalent to:
Ext.define("MyApp.controller.Foo", {
extend: "Ext.app.Controller",
requires: ['MyApp.view.List', 'MyApp.view.Detail'],
getListView: function() {
return this.getView("List");
},
getDetailView: function() {
return this.getView("Detail");
}
});
Note: If the view has a different namespace than that of the application you will need to specify the full class name as well as define a path in the Loader's paths config or setPath method.
Defaults to:
null
The value true causes config values to be stored on instances using a
property name prefixed with an underscore ("_") character. A value of false
stores config values as properties using their exact name (no prefix).
Defaults to:
true
Available since: 5.0.0
The value true instructs the initConfig method to only honor values for
properties declared in the config block of a class. When false, properties
that are not declared in a config block will be placed on the instance.
Defaults to:
true
Available since: 5.0.0
A prototype-chained object storing transform method names and priorities stored on the class prototype. On first instantiation, this object is converted into an array that is sorted by priority and stored on the constructor.
Defaults to:
{}
Matches options property names within a listeners specification object - property names which are never used as event names.
Defaults to:
{
scope: 1,
delay: 1,
buffer: 1,
onFrame: 1,
single: 1,
args: 1,
destroyable: 1,
priority: 1,
order: 1
}
We don't want the base destructor to clear the prototype because our destroyObservable handler must be called the very last. It will take care of the prototype after completing Observable destruction sequence.
Defaults to:
true
true indicates an id was auto-generated rather than provided by configuration.
Defaults to:
false
Available since: 6.7.0
Setting this property to false will prevent nulling object references
on a Class instance after destruction. Setting this to "async" will delay
the clearing for approx 50ms.
Defaults to:
true
Available since: 6.2.0
Setting this property to true will result in setting the object's
prototype to null after the destruction sequence is fully completed.
After that, most attempts at calling methods on the object instance
will result in "method not defined" exception. This can be very helpful
with tracking down otherwise hard to find bugs like runaway Ajax requests,
timed functions not cleared on destruction, etc.
Note that this option can only work in browsers that support Object.setPrototypeOf
method, and is only available in debugging mode.
Defaults to:
false
Available since: 6.2.0
This property is set to true after the destroy method is called.
Defaults to:
false
Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.
Defaults to:
0
This object holds a key for any event that has a listener. The listener may be set directly on the instance, or on its class or a super class (via observe) or on the Ext.app.EventBus. The values of this object are truthy (a non-zero number) and falsy (0 or undefined). They do not represent an exact count of listeners. The value for an event is truthy if the event must be fired and is falsy if there is no need to fire the event.
The intended use of this property is to avoid the expense of fireEvent calls when there are no listeners. This can be particularly helpful when one would otherwise have to call fireEvent hundreds or thousands of times. It is used like this:
if (this.hasListeners.foo) {
this.fireEvent('foo', this, arg1);
}
This property is set to true during the call to initConfig.
Defaults to:
false
Available since: 5.0.0
This property is set to true if this instance is the first of its class.
Defaults to:
false
Available since: 5.0.0
This value is true and is used to identify plain objects from instances of
a defined class.
Defaults to:
true
true in this class to identify an object as an instantiated Observable, or subclass
thereof.
Defaults to:
true
Get the reference to the current class from which this object was instantiated. Unlike
Ext.Base#statics, this.self is scope-dependent and it's meant to be used
for dynamic inheritance. See Ext.Base#statics for a detailed comparison
Ext.define('My.Cat', {
statics: {
speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
},
constructor: function() {
alert(this.self.speciesName); // dependent on 'this'
},
clone: function() {
return new this.self();
}
});
Ext.define('My.SnowLeopard', {
extend: 'My.Cat',
statics: {
speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'
}
});
var cat = new My.Cat(); // alerts 'Cat'
var snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'
var clone = snowLeopard.clone();
alert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'
Defaults to:
Base
Adds declarative listeners as nested arrays of listener objects.
listeners : Array
true if any listeners were added
Allow the controller to resume receiving events from the event bus. Routes will also be able to begin firing on this controller. Also see deactivate.
This method applies a versioned, deprecation declaration to this class. This
is typically called by the deprecated config.
deprecations : Object
The on method is shorthand for addListener.
Appends an event handler to this object. For example:
myGridPanel.on("itemclick", this.onItemClick, this);
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:
myGridPanel.on({
cellclick: this.onCellClick,
select: this.onSelect,
viewready: this.onViewReady,
scope: this // Important. Ensure "this" is correct during handler execution
});
One can also specify options for each event handler separately:
myGridPanel.on({
cellclick: {fn: this.onCellClick, scope: this, single: true},
viewready: {fn: panel.onViewReady, scope: panel}
});
Names of methods in a specified scope may also be used:
myGridPanel.on({
cellclick: {fn: 'onCellClick', scope: this, single: true},
viewready: {fn: 'onViewReady', scope: panel}
});
eventName : String/Object
The name of the event to listen for. May also be an object who's property names are event names.
fn : Function/String (optional)
The method the event invokes or the name of
the method within the specified scope. Will be called with arguments
given to Ext.util.Observable#fireEvent plus the options parameter described
below.
scope : Object (optional)
The scope (this reference) in which the handler function is
executed. If omitted, defaults to the object which fired the event.
options : Object (optional)
An object containing handler configuration.
Note: The options object will also be passed as the last argument to every event handler.
This object may contain any of the following properties:
scope : Object
The scope (this reference) in which the handler function is executed. If omitted,
defaults to the object which fired the event.
delay : Number
The number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
True to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
onFrame : Number
Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.
target : Ext.util.Observable
Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
element : String
This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.
This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.
For example, to add a click listener to a Panel's body:
var panel = new Ext.panel.Panel({
title: 'The title',
listeners: {
click: this.handlePanelClick,
element: 'body'
}
});
In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.
panel.body.un(...)
delegate : String (optional)
A simple selector to filter the event target or look for a descendant of the target.
The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).
See the delegate example below.
capture : Boolean (optional)
When set to true, the listener is fired in the capture phase of the event propagation
sequence, instead of the default bubble phase.
The capture option is only available on Ext.dom.Element instances (or
when attaching a listener to a Ext.dom.Element via a Component using the
element option).
stopPropagation : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call stopPropagation on the event
object before firing the handler.
preventDefault : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call preventDefault on the event
object before firing the handler.
stopEvent : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call stopEvent on the event object
before firing the handler.
args : Array (optional)
Optional set of arguments to pass to the handler function before the actual
fired event arguments. For example, if args is set to ['foo', 42],
the event handler function will be called with an arguments list like this:
handler('foo', 42, <actual event arguments>...);
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.
This syntax can be a helpful shortcut to using un; particularly when
removing multiple listeners. NOTE - not compatible when using the element
option. See un for the proper syntax for removing listeners added using the
element config.
Defaults to:
false
priority : Number (optional)
An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.
order : String (optional)
A legacy option that is provided for backward compatibility.
It is recommended to use the priority option instead. Available options are:
'before': equal to a priority of 100'current': equal to a priority of 0 or default priority'after': equal to a priority of -100Defaults to:
'current'
order : String (optional)
A shortcut for the order event option. Provided for backward compatibility.
Please use the priority event option instead.
Defaults to: 'current'
Only when the destroyable option is specified.
A Destroyable object. An object which implements the destroy method which removes
all listeners added in this call. For example:
this.btnListeners = = myButton.on({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.
Example:
Ext.define('Foo', {
extend: 'Ext.Component',
initComponent: function () {
this.addManagedListener(MyApp.SomeSharedMenu, 'show', this.doSomething);
this.callParent();
}
});
As you can see, when an instance of Foo is destroyed, it ensures that the 'show'
listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.
As of version 5.1 it is no longer necessary to use this method in most cases because
listeners are automatically managed if the scope object provided to
addListener is an Observable instance.
However, if the observable instance and scope are not the same object you
still need to use mon or addManagedListener if you want the listener to be
managed.
item : Ext.util.Observable/Ext.dom.Element
The item to which to add a listener/listeners.
ename : Object/String
The event name, or an object containing event name properties.
fn : Function/String (optional)
If the ename parameter was an event
name, this is the handler function or the name of a method on the specified
scope.
scope : Object (optional)
If the ename parameter was an event name, this is
the scope (this reference) in which the handler function is executed.
options : Object (optional)
If the ename parameter was an event name, this is
the addListener options.
Only when the destroyable option is specified.
A Destroyable object. An object which implements the destroy method which removes
all listeners added in this call. For example:
this.btnListeners = myButton.mon({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
As a convenience developers can locally qualify profile names (e.g. 'MyProfile' vs 'MyApp.profile.MyProfile'). This just makes sure everything ends up fully qualified.
profiles : Object
Call the original method that was previously overridden with Ext.Base#override
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
}
});
My.Cat.override({
constructor: function() {
alert("I'm going to be a cat!");
this.callOverridden();
alert("Meeeeoooowwww");
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
args : Array/Arguments
The arguments, either an array or the arguments object
from the current method, for example: this.callOverridden(arguments)
Returns the result of calling the overridden method
Deprecated since version 4.1.0
Use method-callParent instead.
Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext#define).
Ext.define('My.Base', {
constructor: function(x) {
this.x = x;
},
statics: {
method: function(x) {
return x;
}
}
});
Ext.define('My.Derived', {
extend: 'My.Base',
constructor: function() {
this.callParent([21]);
}
});
var obj = new My.Derived();
alert(obj.x); // alerts 21
This can be used with an override as follows:
Ext.define('My.DerivedOverride', {
override: 'My.Derived',
constructor: function(x) {
this.callParent([x*2]); // calls original My.Derived constructor
}
});
var obj = new My.Derived();
alert(obj.x); // now alerts 42
This also works with static and private methods.
Ext.define('My.Derived2', {
extend: 'My.Base',
// privates: {
statics: {
method: function(x) {
return this.callParent([x*2]); // calls My.Base.method
}
}
});
alert(My.Base.method(10)); // alerts 10
alert(My.Derived2.method(10)); // alerts 20
Lastly, it also works with overridden static methods.
Ext.define('My.Derived2Override', {
override: 'My.Derived2',
// privates: {
statics: {
method: function(x) {
return this.callParent([x*2]); // calls My.Derived2.method
}
}
});
alert(My.Derived2.method(10); // now alerts 40
To override a method and replace it and also call the superclass method, use method-callSuper. This is often done to patch a method to fix a bug.
args : Array/Arguments
The arguments, either an array or the arguments object
from the current method, for example: this.callParent(arguments)
Returns the result of calling the parent method
This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.
Consider:
Ext.define('Ext.some.Class', {
method: function() {
console.log('Good');
}
});
Ext.define('Ext.some.DerivedClass', {
extend: 'Ext.some.Class',
method: function() {
console.log('Bad');
// ... logic but with a bug ...
this.callParent();
}
});
To patch the bug in Ext.some.DerivedClass.method, the typical solution is to create an
override:
Ext.define('App.patches.DerivedClass', {
override: 'Ext.some.DerivedClass',
method: function() {
console.log('Fixed');
// ... logic but with bug fixed ...
this.callSuper();
}
});
The patch method cannot use method-callParent to call the superclass
method since that would call the overridden method containing the bug. In
other words, the above patch would only produce "Fixed" then "Good" in the
console log, whereas, using callParent would produce "Fixed" then "Bad"
then "Good".
args : Array/Arguments
The arguments, either an array or the arguments object
from the current method, for example: this.callSuper(arguments)
Returns the result of calling the superclass method
Creates new Application.
config : Object (optional)
Config object.
Adds listeners to components selected via Ext.ComponentQuery. Accepts an object containing component paths mapped to a hash of listener functions.
In the following example the updateUser function is mapped to to the click
event on a button component, which is a child of the useredit component.
Ext.define('AM.controller.Users', {
init: function() {
this.control({
'useredit button[action=save]': {
click: this.updateUser
}
});
},
updateUser: function(button) {
console.log('clicked the Save button');
}
});
Or alternatively one call control with two arguments:
this.control('useredit button[action=save]', {
click: this.updateUser
});
See Ext.ComponentQuery for more information on component selectors.
selectors : String/Object
If a String, the second argument is used as the listeners, otherwise an object of selectors -> listeners is assumed
listeners : Object (optional)
Config for listeners.
Create an instance of a controller by name.
name : String
The name of the controller. For a controller with the
full class name MyApp.controller.Foo, the name parameter should be Foo.
If the controller already exists, it will be returned.
controller
Creates an event handling function which re-fires the event from this object as the passed event name.
newName : String
The name under which to re-fire the passed parameters.
beginEnd : Array (optional)
The caller can specify on which indices to slice.
Prevent this controller from receiving events from the event bus. Routes will also not be triggered on inactive controllers unless the Ext.route.Route#allowInactive flag is set. Also see activate.
This method is called to cleanup an object and its resources. After calling this method, the object should not be used any further in any way, including access to its methods and properties.
To prevent potential memory leaks, all object references will be nulled
at the end of destruction sequence, unless clearPropertiesOnDestroy
is set to false.
Destroys a controller, any listeners are unbound.
controller : String/Ext.app.Controller
The controller
Destroys member properties by name.
If a property name is the name of a config, the getter is not invoked, so if the config has not been initialized, nothing will be done.
The property will be destroyed, and the corrected name (if the property is a config
and config names are prefixed) will set to null in this object's dictionary.
args : String...
One or more names of the properties to destroy and remove from the object.
Continue to fire event.
eventName : String
args : Array
bubbles : Boolean
Enables events fired by this Observable to bubble up an owner hierarchy by calling
this.getBubbleTarget() if present. There is no implementation in the Observable
base class.
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component#getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.
Example:
Ext.define('Ext.overrides.form.field.Base', {
override: 'Ext.form.field.Base',
// Add functionality to Field's initComponent to enable
// the change event to bubble
initComponent: function () {
this.callParent();
this.enableBubble('change');
}
});
var myForm = Ext.create('Ext.form.Panel', {
title: 'User Details',
items: [{
...
}],
listeners: {
change: function() {
// Title goes red if form has been modified.
myForm.header.setStyle('color', 'red');
}
}
});
eventNames : String/String[]
The event name to bubble, or an Array of event names.
Fires the specified event with the passed parameters and executes a function (action).
By default, the action function will be executed after any "before" event handlers
(as specified using the order option of
addListener), but before any other
handlers are fired. This gives the "before" handlers an opportunity to
cancel the event by returning false, and prevent the action function from
being called.
The action can also be configured to run after normal handlers, but before any "after"
handlers (as specified using the order event option) by passing 'after'
as the order parameter. This configuration gives any event handlers except
for "after" handlers the opportunity to cancel the event and prevent the action
function from being called.
eventName : String
The name of the event to fire.
args : Array
Arguments to pass to handlers and to the action function.
fn : Function
The action function.
scope : Object (optional)
The scope (this reference) in which the handler function is
executed. If omitted, defaults to the object which fired the event.
options : Object (optional)
Event options for the action function. Accepts any
of the options of addListener
order : String (optional)
The order to call the action function relative
too the event handlers ('before' or 'after'). Note that this option is
simply used to sort the action function relative to the event handlers by "priority".
An order of 'before' is equivalent to a priority of 99.5, while an order of
'after' is equivalent to a priority of -99.5. See the priority option
of addListener for more details.
Defaults to: 'before'
Deprecated since version 5.5
Use fireEventedAction instead.
Fires the specified event with the passed parameters (minus the event name, plus
the options object passed to addListener).
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component#getBubbleTarget) by calling enableBubble.
eventName : String
The name of the event to fire.
args : Object...
Variable number of parameters are passed to handlers.
returns false if any of the handlers return false otherwise it returns true.
Fires the specified event with the passed parameter list.
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component#getBubbleTarget) by calling enableBubble.
eventName : String
The name of the event to fire.
args : Object[]
An array of parameters which are passed to handlers.
returns false if any of the handlers return false otherwise it returns true.
Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow.
By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events.
eventName : String
The name of the event to fire.
args : Array
Arguments to pass to handlers and to the action function.
fn : Function/String
The action function.
scope : Object (optional)
The scope (this reference) in which the handler function is
executed. If omitted, defaults to the object which fired the event.
fnArgs : Array/Boolean (optional)
Optional arguments for the action fn. If not
given, the normal args will be used to call fn. If false is passed, the
args are used but if the first argument is this instance it will be removed
from the args passed to the action function.
Gets the bubbling parent for an Observable
The bubble parent. null is returned if no bubble target exists
Returns a specified config property value. If the name parameter is not passed, all current configuration options will be returned as key value pairs.
name : String (optional)
The name of the config property to get.
peek : Boolean (optional)
true to peek at the raw value without calling the getter.
Defaults to: false
ifInitialized : Boolean (optional)
true to only return the initialized property
value, not the raw config value, and not to trigger initialization. Returns
undefined if the property has not yet been initialized.
Defaults to: false
The config property value.
Get an application's controller based on name or id. Generally, the controller id will be the same as the name unless otherwise specified.
name : String
The name or id of the controller you are trying to retrieve
Returns the initial configuration passed to the constructor when instantiating this class.
Given this example Ext.button.Button definition and instance:
Ext.define('MyApp.view.Button', {
extend: 'Ext.button.Button',
xtype: 'mybutton',
scale: 'large',
enableToggle: true
});
var btn = Ext.create({
xtype: 'mybutton',
renderTo: Ext.getBody(),
text: 'Test Button'
});
Calling btn.getInitialConfig() would return an object including the config
options passed to the create method:
xtype: 'mybutton',
renderTo: // The document body itself
text: 'Test Button'
Calling btn.getInitialConfig('text')returns 'Test Button'.
name : String (optional)
Name of the config option to return.
The full config object or a single config value
when name parameter specified.
Returns a Ext.data.Model class with the given name.
modelName : String
A class ultimately derived from Ext.data.Model.
Returns instance of a Ext.app.Profile with the given name.
name : String
a profile instance.
Returns instance of a Ext.data.Store with the given name. When store doesn't exist yet, it's created.
name : String
a store instance.
Returns a View class with the given name. To create an instance of the view, you can use it like it's used by Application to create the Viewport:
this.getView('Viewport').create();
view : String
a view class.
Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer indicates whether the event needs firing or not.
eventName : String
The name of the event to check for
true if the event is being listened for or bubbles, else false
Returns true if a reference is registered.
ref : String
The name of the ref to check for.
A template method that is called when your application boots. It is called before the Ext.app.Applications launch function is executed so gives a hook point to run any code before your Viewport is created.
application : Ext.app.Application
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Initialize configuration for this class. a typical example:
Ext.define('My.awesome.Class', {
// The default config
config: {
name: 'Awesome',
isAwesome: true
},
constructor: function(config) {
this.initConfig(config);
}
});
var awesome = new My.awesome.Class({
name: 'Super Awesome'
});
alert(awesome.getName()); // 'Super Awesome'
instanceConfig : Object
this
Checks if this controller is active. See activate & deactivate.
true if this controller is active.
Checks if all events, or a specific event, is suspended.
event : String (optional)
The name of the specific event to check
true if events are suspended
Called automatically when the page has completely loaded. This is an empty function that should be overridden by each application that needs to take action on page load.
profile : String
The detected application profile
By default, the Application will dispatch to the configured startup controller and action immediately after running the launch function. Return false to prevent this behavior.
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Adds a "destroyable" object to an internal list of objects that will be destroyed
when this instance is destroyed (via destroy).
name : String
value : Object
The value passed.
Adds listeners to different event sources (also called "event domains"). The primary event domain is that of components, but there are also other event domains: Ext.app.domain.Global domain that intercepts events fired from Ext.GlobalEvents Observable instance, Ext.app.domain.Controller domain can be used to listen to events fired by other Controllers, Ext.app.domain.Store domain gives access to Store events, and Ext.app.domain.Direct domain can be used with Ext Direct Providers to listen to their events.
To listen to "bar" events fired by a controller with id="foo":
Ext.define('AM.controller.Users', {
init: function() {
this.listen({
controller: {
'#foo': {
bar: this.onFooBar
}
}
});
},
...
});
To listen to "bar" events fired by any controller, and "baz" events fired by Store with storeId="baz":
Ext.define('AM.controller.Users', {
init: function() {
this.listen({
controller: {
'*': {
bar: this.onAnyControllerBar
}
},
store: {
'#baz': {
baz: this.onStoreBaz
}
}
});
},
...
});
To listen to "idle" events fired by Ext.GlobalEvents when other event processing is complete and Ext JS is about to return control to the browser:
Ext.define('AM.controller.Users', {
init: function() {
this.listen({
global: { // Global events are always fired
idle: this.onIdle // from the same object, so there
} // are no selectors
});
}
});
As this relates to components, the following example:
Ext.define('AM.controller.Users', {
init: function() {
this.listen({
component: {
'useredit button[action=save]': {
click: this.updateUser
}
}
});
},
...
});
Is equivalent to:
Ext.define('AM.controller.Users', {
init: function() {
this.control({
'useredit button[action=save]': {
click: this.updateUser
}
});
},
...
});
Of course, these can all be combined in a single call and used instead of
control, like so:
Ext.define('AM.controller.Users', {
init: function() {
this.listen({
global: {
idle: this.onIdle
},
controller: {
'*': {
foobar: this.onAnyFooBar
},
'#foo': {
bar: this.onFooBar
}
},
component: {
'useredit button[action=save]': {
click: this.updateUser
}
},
store: {
'#qux': {
load: this.onQuxLoad
}
}
});
},
...
});
to : Object
Config object containing domains, selectors and listeners.
controller : Ext.app.Controller (optional)
The controller to add the listeners to. Defaults to the current controller.
Shorthand for addManagedListener. The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.
Example:
Ext.define('Foo', {
extend: 'Ext.Component',
initComponent: function () {
this.addManagedListener(MyApp.SomeSharedMenu, 'show', this.doSomething);
this.callParent();
}
});
As you can see, when an instance of Foo is destroyed, it ensures that the 'show'
listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.
As of version 5.1 it is no longer necessary to use this method in most cases because
listeners are automatically managed if the scope object provided to
addListener is an Observable instance.
However, if the observable instance and scope are not the same object you
still need to use mon or addManagedListener if you want the listener to be
managed.
item : Ext.util.Observable/Ext.dom.Element
The item to which to add a listener/listeners.
ename : Object/String
The event name, or an object containing event name properties.
fn : Function/String (optional)
If the ename parameter was an event
name, this is the handler function or the name of a method on the specified
scope.
scope : Object (optional)
If the ename parameter was an event name, this is
the scope (this reference) in which the handler function is executed.
options : Object (optional)
If the ename parameter was an event name, this is
the addListener options.
Only when the destroyable option is specified.
A Destroyable object. An object which implements the destroy method which removes
all listeners added in this call. For example:
this.btnListeners = myButton.mon({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
Shorthand for removeManagedListener. Removes listeners that were added by the mon method.
item : Ext.util.Observable/Ext.dom.Element
The item from which to remove a listener/listeners.
ename : Object/String
The event name, or an object containing event name properties.
fn : Function (optional)
If the ename parameter was an event name, this is
the handler function.
scope : Object (optional)
If the ename parameter was an event name, this is
the scope (this reference) in which the handler function is executed.
Takes either an object and transforms it into an array. The following are valid refs values:
refs: {
myComponent: 'container'
}
refs: {
myComponent: {
selector: 'container'
}
}
refs: [
{
ref: 'myComponent',
selector: 'container'
}
]
refs : Array/Object
The refs to normalize
The normalized array of refs
The on method is shorthand for addListener.
Appends an event handler to this object. For example:
myGridPanel.on("itemclick", this.onItemClick, this);
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:
myGridPanel.on({
cellclick: this.onCellClick,
select: this.onSelect,
viewready: this.onViewReady,
scope: this // Important. Ensure "this" is correct during handler execution
});
One can also specify options for each event handler separately:
myGridPanel.on({
cellclick: {fn: this.onCellClick, scope: this, single: true},
viewready: {fn: panel.onViewReady, scope: panel}
});
Names of methods in a specified scope may also be used:
myGridPanel.on({
cellclick: {fn: 'onCellClick', scope: this, single: true},
viewready: {fn: 'onViewReady', scope: panel}
});
eventName : String/Object
The name of the event to listen for. May also be an object who's property names are event names.
fn : Function/String (optional)
The method the event invokes or the name of
the method within the specified scope. Will be called with arguments
given to Ext.util.Observable#fireEvent plus the options parameter described
below.
scope : Object (optional)
The scope (this reference) in which the handler function is
executed. If omitted, defaults to the object which fired the event.
options : Object (optional)
An object containing handler configuration.
Note: The options object will also be passed as the last argument to every event handler.
This object may contain any of the following properties:
scope : Object
The scope (this reference) in which the handler function is executed. If omitted,
defaults to the object which fired the event.
delay : Number
The number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
True to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
onFrame : Number
Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.
target : Ext.util.Observable
Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
element : String
This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.
This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.
For example, to add a click listener to a Panel's body:
var panel = new Ext.panel.Panel({
title: 'The title',
listeners: {
click: this.handlePanelClick,
element: 'body'
}
});
In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.
panel.body.un(...)
delegate : String (optional)
A simple selector to filter the event target or look for a descendant of the target.
The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).
See the delegate example below.
capture : Boolean (optional)
When set to true, the listener is fired in the capture phase of the event propagation
sequence, instead of the default bubble phase.
The capture option is only available on Ext.dom.Element instances (or
when attaching a listener to a Ext.dom.Element via a Component using the
element option).
stopPropagation : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call stopPropagation on the event
object before firing the handler.
preventDefault : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call preventDefault on the event
object before firing the handler.
stopEvent : Boolean (optional)
This option is only valid for listeners bound to Ext.dom.Element.
true to call stopEvent on the event object
before firing the handler.
args : Array (optional)
Optional set of arguments to pass to the handler function before the actual
fired event arguments. For example, if args is set to ['foo', 42],
the event handler function will be called with an arguments list like this:
handler('foo', 42, <actual event arguments>...);
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.
This syntax can be a helpful shortcut to using un; particularly when
removing multiple listeners. NOTE - not compatible when using the element
option. See un for the proper syntax for removing listeners added using the
element config.
Defaults to:
false
priority : Number (optional)
An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.
order : String (optional)
A legacy option that is provided for backward compatibility.
It is recommended to use the priority option instead. Available options are:
'before': equal to a priority of 100'current': equal to a priority of 0 or default priority'after': equal to a priority of -100Defaults to:
'current'
order : String (optional)
A shortcut for the order event option. Provided for backward compatibility.
Please use the priority event option instead.
Defaults to: 'current'
Only when the destroyable option is specified.
A Destroyable object. An object which implements the destroy method which removes
all listeners added in this call. For example:
this.btnListeners = = myButton.on({
destroyable: true
mouseover: function() { console.log('mouseover'); },
mouseout: function() { console.log('mouseout'); },
click: function() { console.log('click'); }
});
And when those listeners need to be removed:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
Appends an after-event handler.
Same as addListener with order set
to 'after'.
eventName : String/String[]/Object
The name of the event to listen for.
fn : Function/String
The method the event invokes.
scope : Object (optional)
The scope for fn.
options : Object (optional)
An object containing handler configuration.
Called automatically when an update to either the Application Cache or the Local Storage Cache is detected. This is mainly used during production builds.
updateInfo : Object (optional)
updateInfo Update information object contains properties for checking which cache triggered the update
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Appends a before-event handler. Returning false from the handler will stop the event.
Same as addListener with order set
to 'before'.
eventName : String/String[]/Object
The name of the event to listen for.
fn : Function/String
The method the event invokes.
scope : Object (optional)
The scope for fn.
options : Object (optional)
An object containing handler configuration.
A template method like init, but called after the viewport is created. This is called after the launch method of Application is executed.
application : Ext.app.Application
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
Update the hash. By default, it will not execute the routes if the current token and the token passed are the same.
hash : String/Number/Object/Ext.data.Model
The hash to redirect to. The hash can be of several values:
1 is passed, forward function will be
executed. If -1 is passed, back function will be executed.Object An Object can be passed to control individual tokens in the full hash. The key should be an associated Ext.route.Routes name and the value should be the value of that token in the complete hash. For example, if you have two routes configured, each token in the hash that can be matched for each route can be individually controlled:
routes: {
'foo/bar': 'onFooBar',
'baz/:id': {
action: 'onBaz',
name: 'baz'
}
}
If you pass in a hash of #foo/bar|baz/1, each route will execute in response. If you want
to change only the baz route but leave the foo/bar route in the hash, you can pass only
the baz key in an object:
this.redirectTo({
baz : 'baz/5'
});
and the resulting hash will be #foo/bar/|baz/5 and only the baz route will execute
in reaction but the foo/bar will not react since it's associated token in the hash
remained the same. If you wanted to update the baz route and remove foo/bar
from the hash, you can set the value to null:
this.redirectTo({
'foo/bar': null,
baz: 'baz/3'
});
and the resulting hash will be #baz/3. Like before, the baz route will execute
in reaction.
opt : Object
An optional Object describing how to enact the hash being passed in.
Valid options are:
force Even if the hash will not change, setting this to true will force the
Ext.route.Router to react.replace When set to true, this will replace the current resource in the history stack
with the hash being set.For backwards compatibility, if true is passed instead of an Object, this will set
the force option to true.
Will return true if the token was updated.
Relays selected events from the specified Observable as if the events were fired
by this.
For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:
this.relayEvents(this.getStore(), ['load']);
The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword (unless the event is handled by a controller's control/listen event listener in which case 'this' will be the controller rather than the grid).
origin : Object
The Observable whose events this object is to relay.
events : String[]/Object
Array of event names to relay or an Object with key/value pairs translating to ActualEventName/NewEventName respectively. For example: this.relayEvents(this, {add:'push', remove:'pop'});
Would now redispatch the add event of this as a push event and the remove event as a pop event.
prefix : String (optional)
A common prefix to prepend to the event names. For example:
this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.
A Destroyable object. An object which implements the destroy method
which, when destroyed, removes all relayers. For example:
this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
Can be undone by calling
Ext.destroy(this.storeRelayers);
or this.store.relayers.destroy();
Removes an event handler.
eventName : String
The type of event the handler was associated with.
fn : Function
The handler to remove. This must be a reference to the function passed into the addListener call.
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable#addListener or the listener will not be removed.
Removes listeners that were added by the mon method.
item : Ext.util.Observable/Ext.dom.Element
The item from which to remove a listener/listeners.
ename : Object/String
The event name, or an object containing event name properties.
fn : Function (optional)
If the ename parameter was an event name, this is
the handler function.
scope : Object (optional)
If the ename parameter was an event name, this is
the scope (this reference) in which the handler function is executed.
Remove a single managed listener item
isClear : Boolean
True if this is being called during a clear
managedListener : Object
The managed listener item
item : Object
ename : String
fn : Function
scope : Object
See removeManagedListener for other args
Gets the default scope for firing late bound events (string names with no scope attached) at runtime.
defaultScope : Object (optional)
The default scope to return if none is found.
Defaults to: this
The default event scope
Resumes firing of the named event(s).
After calling this method to resume events, the events will fire when requested to fire.
Note that if the suspendEvent method is called multiple times for a certain event, this converse method will have to be called the same number of times for it to resume firing.
eventName : String...
Multiple event names to resume.
Resumes firing events (see suspendEvents).
If events were suspended using the queueSuspended parameter, then all events fired
during event suspension will be sent to any listeners now.
discardQueue : Boolean (optional)
true to prevent any previously queued events from firing
while we were suspended. See suspendEvents.
Sets a single/multiple configuration options.
name : String/Object
The name of the property to set, or a set of key value pairs to set.
value : Object (optional)
The value to set for the name parameter.
this
Get the reference to the class from which this object was instantiated. Note that unlike
Ext.Base#self, this.statics() is scope-independent and it always returns
the class from which it was called, regardless of what this points to during run-time
Ext.define('My.Cat', {
statics: {
totalCreated: 0,
speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
},
constructor: function() {
var statics = this.statics();
// always equals to 'Cat' no matter what 'this' refers to
// equivalent to: My.Cat.speciesName
alert(statics.speciesName);
alert(this.self.speciesName); // dependent on 'this'
statics.totalCreated++;
},
clone: function() {
var cloned = new this.self(); // dependent on 'this'
// equivalent to: My.Cat.speciesName
cloned.groupName = this.statics().speciesName;
return cloned;
}
});
Ext.define('My.SnowLeopard', {
extend: 'My.Cat',
statics: {
speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'
},
constructor: function() {
this.callParent();
}
});
var cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'
var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
var clone = snowLeopard.clone();
alert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'
alert(clone.groupName); // alerts 'Cat'
alert(My.Cat.totalCreated); // alerts 3
Suspends firing of the named event(s).
After calling this method to suspend events, the events will no longer fire when requested to fire.
Note that if this is called multiple times for a certain event, the converse method resumeEvent will have to be called the same number of times for it to resume firing.
eventName : String...
Multiple event names to suspend.
Suspends the firing of all events. (see resumeEvents)
queueSuspended : Boolean
true to queue up suspended events to be fired
after the resumeEvents call instead of discarding all suspended events.
Shorthand for removeListener. Removes an event handler.
eventName : String
The type of event the handler was associated with.
fn : Function
The handler to remove. This must be a reference to the function passed into the addListener call.
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable#addListener or the listener will not be removed.
Removes a before-event handler.
Same as removeListener with order set to 'after'.
eventName : String/String[]/Object
The name of the event the handler was associated with.
fn : Function/String
The handler to remove.
scope : Object (optional)
The scope originally specified for fn.
options : Object (optional)
Extra options object.
Removes a before-event handler.
Same as removeListener with order set to 'before'.
eventName : String/String[]/Object
The name of the event the handler was associated with.
fn : Function/String
The handler to remove.
scope : Object (optional)
The scope originally specified for fn.
options : Object (optional)
Extra options object.
Destroys a given set of linked objects. This is only needed if
the linked object is being destroyed before this instance.
names : String[]
The names of the linked objects to destroy.
this
Unregister a controller from the application.
controller : Ext.app.Controller
The controller to unregister
control : Object
The object to pass to the method-control method
Watches config properties.
instance.watchConfig({
title: 'onTitleChange',
scope: me
});
Available since: 6.7.0
name : Object
fn : Object
scope : Object
Adds new config properties to this class. This is called for classes when they are declared, then for any mixins that class may define and finally for any overrides defined that target the class.
config : Object
mixinClass : Ext.Class (optional)
The mixin class if the configs are from a mixin.
name : Object
member : Object
privacy : Object
Add methods / properties to the prototype of this class.
Ext.define('My.awesome.Cat', {
constructor: function() {
...
}
});
My.awesome.Cat.addMembers({
meow: function() {
alert('Meowww...');
}
});
var kitty = new My.awesome.Cat();
kitty.meow();
members : Object
The members to add to this class.
isStatic : Boolean (optional)
Pass true if the members are static.
Defaults to: false
privacy : Boolean (optional)
Pass true if the members are private. This
only has meaning in debug mode and only for methods.
Defaults to: false
Add / override static properties of this class.
Ext.define('My.cool.Class', {
...
});
My.cool.Class.addStatics({
someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'
method1: function() { ... }, // My.cool.Class.method1 = function() { ... };
method2: function() { ... } // My.cool.Class.method2 = function() { ... };
});
members : Object
this
Borrow another class' members to the prototype of this class.
Ext.define('Bank', {
money: '$$$',
printMoney: function() {
alert('$$$$$$$');
}
});
Ext.define('Thief', {
...
});
Thief.borrow(Bank, ['money', 'printMoney']);
var steve = new Thief();
alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'
fromClass : Ext.Base
The class to borrow members from
members : Array/String
The names of the members to borrow
this
Create a new instance of this Class.
Ext.define('My.cool.Class', {
...
});
My.cool.Class.create({
someConfig: true
});
All parameters are passed to the constructor of the class.
the created instance.
Create aliases for existing prototype methods. Example:
Ext.define('My.cool.Class', {
method1: function() { ... },
method2: function() { ... }
});
var test = new My.cool.Class();
My.cool.Class.createAlias({
method3: 'method1',
method4: 'method2'
});
test.method3(); // test.method1()
My.cool.Class.createAlias('method5', 'method3');
test.method5(); // test.method3() -> test.method1()
alias : String/Object
The new method name, or an object to set multiple aliases. See flexSetter
origin : String/Object
The original method name
Returns the Ext.Configurator for this class.
Get the current class' name in string format.
Ext.define('My.cool.Class', {
constructor: function() {
alert(this.self.getName()); // alerts 'My.cool.Class'
}
});
My.cool.Class.getName(); // 'My.cool.Class'
className
Used internally by the mixins pre-processor
name : Object
mixinClass : Object
Override members of this class. Overridden methods can be invoked via callParent.
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
}
});
My.Cat.override({
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
Direct use of this method should be rare. Use Ext.define instead:
Ext.define('My.CatOverride', {
override: 'My.Cat',
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).
members : Object
The properties to add to this class. This should be specified as an object literal containing one or more properties.
this class
Ext JS | Terms of Use