Docs Help

Terms, Icons, and Labels

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.

Access Levels

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.

Member Types

Member Syntax

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

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

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.

Class Icons

- 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

Member Icons

- 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

Class Member Quick-Nav Menu

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.

Getter and Setter Methods

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.

History Bar

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.

Search and Filters

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.

API Doc Class Metadata

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:

Expanding and Collapsing Examples and Class Members

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.

Desktop -vs- Mobile View

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:

Viewing the Class Source

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 JS 5.0.1


top

Ext.data.proxy.Proxy alias: proxy.proxy

Summary

Proxies are used by Ext.data.Store to handle the loading and saving of Ext.data.Model data. Usually developers will not need to create or interact with proxies directly.

Types of Proxy

There are two main types of Proxy - Ext.data.proxy.Client and Ext.data.proxy.Server. The Client proxies save their data locally and include the following subclasses:

The Server proxies save their data by sending requests to some remote server. These proxies include:

Proxies operate on the principle that all operations performed are either Create, Read, Update or Delete. These four operations are mapped to the methods create, read, update and erase respectively. Each Proxy subclass implements these functions.

The CRUD methods each expect an Ext.data.operation.Operation object as the sole argument. The Operation encapsulates information about the action the Store wishes to perform, the Ext.data.Model instances that are to be modified, etc. See the Ext.data.operation.Operation documentation for more details. Each CRUD method also accepts a callback function to be called asynchronously on completion.

Proxies also support batching of Operations via a Ext.data.Batch object, invoked by the batch method.

No members found using the current filters

configs

Optional Configs

batchActions : Boolean

True to batch actions of a particular type when synchronizing the store. Defaults to true.

Defaults to:

true

getBatchActions : Boolean

Returns the value of batchActions

Returns

Boolean

setBatchActions (batchActions)

Sets the value of batchActions

Parameters

batchActions :  Boolean

batchOrder : String

Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this to set a different order for the batched CRUD actions to be executed in. Defaults to 'create,update,destroy'.

Defaults to:

'create,update,destroy'

getBatchOrder : String

Returns the value of batchOrder

Returns

String

setBatchOrder (batchOrder)

Sets the value of batchOrder

Parameters

batchOrder :  String

bubbleEvents : String / String[]

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

Defaults to:

null

getBubbleEvents : String / String[]

Returns the value of bubbleEvents

Returns

String / String[]

setBubbleEvents (bubbleEvents)

Sets the value of bubbleEvents

Parameters

bubbleEvents :  String / String[]

listeners : Object

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.

See the Event guide for more

Note: It is bad practice to specify a listener's config when you are defining a class using Ext.define(). Instead, only specify listeners when you are instantiating your class with Ext.create().

Defaults to:

null

getListeners : Object

Returns the value of listeners

Returns

Object

setListeners (listeners)

Sets the value of listeners

Parameters

listeners :  Object

model : String / Ext.data.Model

The name of the Model to tie to this Proxy. Can be either the string name of the Model, or a reference to the Model constructor. Required.

Defaults to:

undefined

getModel : String / Ext.data.Model

Returns the value of model

Returns

String / Ext.data.Model

setModel (model)

Sets the value of model

Parameters

model :  String / Ext.data.Model

reader : Object / String / Ext.data.reader.Reader

The Ext.data.reader.Reader to use to decode the server's response or data read from client. This can either be a Reader instance, a config object or just a valid Reader type name (e.g. 'json', 'xml').

Defaults to:

{
    type: 'json'
}

setReader (reader)

Sets the value of reader

Parameters

reader :  Object / String / Ext.data.reader.Reader

writer : Object / String / Ext.data.writer.Writer

The Ext.data.writer.Writer to use to encode any request sent to the server or saved to client. This can either be a Writer instance, a config object or just a valid Writer type name (e.g. 'json', 'xml').

Defaults to:

{
    type: 'json'
}

setWriter (writer)

Sets the value of writer

Parameters

writer :  Object / String / Ext.data.writer.Writer

properties

Instance Properties

$className
private pri

Defaults to:

'Ext.Base'

$configPrefixed : Boolean
private pri

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:

false

Available since: 5.0.0

$configStrict : Boolean
private pri

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

factoryConfig : Object

If this property is specified by the target class of this mixin its properties are used to configure the created Ext.Factory.

hasListeners : Object
readonly ro

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

isConfiguring : Boolean
readonly ro protected pro

This property is set to true during the call to initConfig.

Defaults to:

false

Available since: 5.0.0

isFirstInstance : Boolean
readonly ro protected pro

This property is set to true if this instance is the first of its class.

Defaults to:

false

Available since: 5.0.0

isInstance : Boolean
readonly ro protected pro

This value is true and is used to identify plain objects from instances of a defined class.

Defaults to:

true

isProxy : Boolean

true in this class to identify an object as an instantiated Proxy, or subclass thereof.

Defaults to:

true

isSynchronous : Boolean

Identifies the proxy as (a)synchronous.

Defaults to:

false

self : Ext.Class
protected pro

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

Static Properties

$onExtended
static sta private pri

Defaults to:

[]

methods

Instance Methods

addAfterListener ( eventName, fn, [scope], [options] )

Appends an after-event handler.

Same as addListener with order set to 'after'.

Parameters

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.

addBeforeListener ( eventName, fn, [scope], [options] )

Appends a before-event handler. Returning false from the handler will stop the event.

Same as addListener with order set to 'before'.

Parameters

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.

addDeprecations ( deprecations )
private pri

This method applies a versioned, deprecation declaration to this class. This is typically called by the deprecated config.

Parameters

deprecations :  Object

addEvents ( eventNames )
deprecated dep

Adds the specified events to the list of events which this Observable may fire.

Parameters

eventNames :  Object/String...

Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters.

Deprecated since version 2.0
It's no longer needed to add events before firing.

addListener ( eventName, fn, [scope], [options], [order] )

Appends an event handler to this object. You can review the available handlers by looking at the 'events' section of the documentation for the component you are working with.

Combining Options

Using the options argument, it is possible to combine different types of listeners:

A delayed, one-time listener:

container.addListener('tap', this.handleTap, this, {
    single: true,
    delay: 100
});

Attaching multiple handlers in 1 call

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

container.addListener({
    tap  : this.onTap,
    swipe: this.onSwipe,

    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

container.addListener({
    tap  : { fn: this.onTap, scope: this, single: true },
    swipe: { fn: button.onSwipe, scope: button }
});

See the Events Guide for more.

Parameters

eventName :  String/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

The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

scope :  Object (optional)

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

options :  Object (optional)

An object containing handler configuration.

This object may contain any of the following properties:

scope :  Object (optional)

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

delay :  Number (optional)

The number of milliseconds to delay the invocation of the handler after the event fires.

single :  Boolean (optional)

true to add a handler to handle just the next firing of the event, and then remove itself.

order :  String (optional)

The order of when the listener should be added into the listener queue.

If you set an order of before and the event you are listening to is preventable, you can return false and it will stop the event.

Available options are before, current and after.

Defaults to:

current

buffer :  Number (optional)

Causes the handler to be 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.

element :  String (optional)

If this observable is a Component, allows you to add a listener onto a element of the component using the element's reference.

Ext.create('Ext.Component', {
    listeners: {
        element: 'element',
        tap: function() {
            alert('element tap!');
        }
    }
});

In Sencha Touch, All components have the element reference, which is the outer most element of the component. Ext.Container also has the innerElement element which contains all children. In most cases element is adequate.

delegate :  String (optional)

For Ext.dom.Element, a simple DOM selector to filter the target or look for a descendant of the target.

Sencha Touch Components can use Ext.ComponentQuery selectors to filter child Components.

// Create a container with a two children; a button and a toolbar
var container = Ext.create('Ext.Container', {
    items: [
        {
            xtype: 'toolbar',
            docked: 'top',
            title: 'My Toolbar'
        },
        {
           xtype: 'button',
           text: 'My Button'
        }
    ]
});

container.addListener({
    // Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
    delegate: 'button',

    tap: function() {
        alert('Button tapped!');
    }
});

capture :  Boolean

true to initiate capture which will fire the listeners on the target Element before any descendant Elements. Normal events start with the target element and propagate upward to ancestor elements, whereas captured events propagate from the top of the DOM downward to descendant elements. This option achieves the same result as the useCapture parameter in the standard JavaScript addEventListener method.

order :  String (optional)

The order of when the listener should be added into the listener queue. Possible values are before, current and after.

Defaults to: 'current'

addManagedListener ( object, eventName, [fn], [scope], [options] )
deprecated dep

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

Parameters

object :  Ext.mixin.Observable/HTMLElement

The item to which to add a listener/listeners.

eventName :  Object/String

The event name, or an object containing event name properties.

fn :  Function (optional)

If the eventName parameter was an event name, this is the handler function.

scope :  Object (optional)

If the eventName parameter was an event name, this is the scope in which the handler function is executed.

options :  Object (optional)

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

Deprecated since version 2.0
All listeners are now automatically managed where necessary. Simply use addListener.

batch ( options ) : Ext.data.Batch

Performs a batch of Ext.data.operation.Operation, in the order specified by batchOrder. Used internally by Ext.data.Store's sync method. Example usage:

myProxy.batch({
    create : [myModel1, myModel2],
    update : [myModel3],
    destroy: [myModel4, myModel5]
});

Where the myModel* above are Ext.data.Model instances - in this case 1 and 2 are new instances and have not been saved before, 3 has been saved previously but needs to be updated, and 4 and 5 have already been saved but should now be destroyed.

Note that the previous version of this method took 2 arguments (operations and listeners). While this is still supported for now, the current signature is now a single options argument that can contain both operations and listeners, in addition to other options. The multi-argument signature will likely be deprecated in a future release.

Parameters

options :  Object

Object containing one or more properties supported by the batch method:

operations :  Object

Object containing the Model instances to act upon, keyed by action name

listeners :  Object (optional)

Event listeners object passed straight through to the Batch - see Ext.data.Batch for details

batch :  Ext.data.Batch / Object (optional)

A Ext.data.Batch object (or batch config to apply to the created batch). If unspecified a default batch will be auto-created.

callback :  Function (optional)

The function to be called upon completion of processing the batch. The callback is called regardless of success or failure and is passed the following parameters:

batch :  Ext.data.Batch

The Ext.data.Batch that was processed, containing all operations in their current state after processing

options :  Object

The options argument that was originally passed into batch

success :  Function (optional)

The function to be called upon successful completion of the batch. The success function is called only if no exceptions were reported in any operations. If one or more exceptions occurred then the failure function will be called instead. The success function is called with the following parameters:

batch :  Ext.data.Batch

The Ext.data.Batch that was processed, containing all operations in their current state after processing

options :  Object

The options argument that was originally passed into batch

failure :  Function (optional)

The function to be called upon unsuccessful completion of the batch. The failure function is called when one or more operations returns an exception during processing (even if some operations were also successful). In this case you can check the batch's exceptions array to see exactly which operations had exceptions. The failure function is called with the following parameters:

batch :  Ext.data.Batch

The Ext.data.Batch that was processed, containing all operations in their current state after processing

options :  Object

The options argument that was originally passed into batch

scope :  Object (optional)

The scope in which to execute any callbacks (i.e. the this object inside the callback, success and/or failure functions). Defaults to the proxy.

Returns

:Ext.data.Batch

The newly created Batch

callParent ( args ) : Object
protected pro

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

 Ext.define('My.Derived2', {
     extend: 'My.Base',

     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',

     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 callSuper. This is often done to patch a method to fix a bug.

Parameters

args :  Array/Arguments

The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

:Object

Returns the result of calling the parent method

callSuper ( args ) : Object
protected pro

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

Parameters

args :  Array/Arguments

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

Returns

:Object

Returns the result of calling the superclass method

changeListener ( actionFn, eventName, fn, scope, options, order ) :
chainable ch private pri

Parameters

actionFn :  Object

eventName :  Object

fn :  Object

scope :  Object

options :  Object

order :  Object

Returns

:

clearListeners

Removes all listeners for this object.

constructor ( [config] )

Creates the Proxy

Parameters

config :  Object (optional)

Config object.

create ( operation )

Performs the given create operation.

Parameters

operation :  Ext.data.operation.Operation

The Operation to perform

createEventRelayer ( newName ) : Function
private pri

Creates an event handling function which re-fires the event from this object as the passed event name.

Parameters

newName :  String

Returns

:Function

destroy
protected pro

This method is called to cleanup an object and its resources. After calling this method, the object should not be used any further.

doAddListener ( name, fn, scope, options, order ) : Boolean
private pri

Parameters

name :  Object

fn :  Object

scope :  Object

options :  Object

order :  Object

Returns

:Boolean

enableBubble ( events )

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.

Parameters

events :  String/String[]

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

erase ( operation )

Performs the given destroy operation.

Parameters

operation :  Ext.data.operation.Operation

The Operation to perform

fireAction ( eventName, args, fn, scope ) : Object

Fires the specified event with the passed parameters and execute a function (action) at the end if there are no listeners that return false.

Parameters

eventName :  String

The name of the event to fire.

args :  Array

Arguments to pass to handers.

fn :  Function

Action.

scope :  Object

Scope of fn.

Returns

:Object

fireEvent ( eventName, args ) : Boolean

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

The first argument is the name of the event. Every other argument passed will be available when you listen for the event.

Example

Firstly, we set up a listener for our new event.

this.on('myevent', function(arg1, arg2, arg3, arg4, options, e) {
    console.log(arg1); // true
    console.log(arg2); // 2
    console.log(arg3); // { test: 'foo' }
    console.log(arg4); // 14
    console.log(options); // the options added when adding the listener
    console.log(e); // the event object with information about the event
});

And then we can fire off the event.

this.fireEvent('myevent', true, 2, { test: 'foo' }, 14);

An event may be set to bubble up an Observable parent hierarchy by calling enableBubble.

Parameters

eventName :  String

The name of the event to fire.

args :  Object...

Variable number of parameters are passed to handlers.

Returns

:Boolean

Returns false if any of the handlers return false.

fireEventArgs ( eventName, args ) : Boolean

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.

Parameters

eventName :  String

The name of the event to fire.

args :  Object[]

An array of parameters which are passed to handlers.

Returns

:Boolean

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

getConfig ( [name], [peek] ) : Object

Returns a specified config property value. If the name parameter is not passed, all current configuration options will be returned as key value pairs.

Parameters

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

Returns

:Object

The config property value.

getId String

Retrieves the id of this component. Will autogenerate an id if one has not already been set.

Returns

:String

id

getInitialConfig ( [name] ) : Object/Mixed

Returns the initial configuration passed to constructor when instantiating this class.

Parameters

name :  String (optional)

Name of the config option to return.

Returns

:Object/Mixed

The full config object or a single config value when name parameter specified.

hasConfig ( config )
private pri

Parameters

config :  Object

hasListener ( eventName ) : Boolean

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

Parameters

eventName :  String

The name of the event to check for

Returns

:Boolean

True if the event is being listened for, else false

initConfig ( instanceConfig ) : Ext.Base
chainable ch protected pro

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'

Parameters

instanceConfig :  Object

Returns

:Ext.Base

this

isSuspended ( [eventName] ) : Boolean

Checks if all events, or a specific event, is suspended.

Parameters

eventName :  String (optional)

The name of the specific event to check

Returns

:Boolean

true if events are suspended

mon ( object, eventName, [fn], [scope], [options] )
deprecated dep

Alias for addManagedListener. Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.

Parameters

object :  Ext.mixin.Observable/HTMLElement

The item to which to add a listener/listeners.

eventName :  Object/String

The event name, or an object containing event name properties.

fn :  Function (optional)

If the eventName parameter was an event name, this is the handler function.

scope :  Object (optional)

If the eventName parameter was an event name, this is the scope in which the handler function is executed.

options :  Object (optional)

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

Deprecated since version 2.0.0
This is now done automatically

mun ( object, eventName, [fn], [scope] )
deprecated dep

Alias for removeManagedListener. Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.

Parameters

object :  Ext.mixin.Observable/HTMLElement

The item to which to add a listener/listeners.

eventName :  Object/String

The event name, or an object containing event name properties.

fn :  Function (optional)

If the eventName parameter was an event name, this is the handler function.

scope :  Object (optional)

If the eventName parameter was an event name, this is the scope in which the handler function is executed.

Deprecated since version 2.0.0
This is now done automatically

on ( eventName, fn, [scope], [options], [order] )

Alias for addListener. Appends an event handler to this object. You can review the available handlers by looking at the 'events' section of the documentation for the component you are working with.

Combining Options

Using the options argument, it is possible to combine different types of listeners:

A delayed, one-time listener:

container.addListener('tap', this.handleTap, this, {
    single: true,
    delay: 100
});

Attaching multiple handlers in 1 call

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

container.addListener({
    tap  : this.onTap,
    swipe: this.onSwipe,

    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

container.addListener({
    tap  : { fn: this.onTap, scope: this, single: true },
    swipe: { fn: button.onSwipe, scope: button }
});

See the Events Guide for more.

Parameters

eventName :  String/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

The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

scope :  Object (optional)

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

options :  Object (optional)

An object containing handler configuration.

This object may contain any of the following properties:

scope :  Object (optional)

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

delay :  Number (optional)

The number of milliseconds to delay the invocation of the handler after the event fires.

single :  Boolean (optional)

true to add a handler to handle just the next firing of the event, and then remove itself.

order :  String (optional)

The order of when the listener should be added into the listener queue.

If you set an order of before and the event you are listening to is preventable, you can return false and it will stop the event.

Available options are before, current and after.

Defaults to:

current

buffer :  Number (optional)

Causes the handler to be 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.

element :  String (optional)

If this observable is a Component, allows you to add a listener onto a element of the component using the element's reference.

Ext.create('Ext.Component', {
    listeners: {
        element: 'element',
        tap: function() {
            alert('element tap!');
        }
    }
});

In Sencha Touch, All components have the element reference, which is the outer most element of the component. Ext.Container also has the innerElement element which contains all children. In most cases element is adequate.

delegate :  String (optional)

For Ext.dom.Element, a simple DOM selector to filter the target or look for a descendant of the target.

Sencha Touch Components can use Ext.ComponentQuery selectors to filter child Components.

// Create a container with a two children; a button and a toolbar
var container = Ext.create('Ext.Container', {
    items: [
        {
            xtype: 'toolbar',
            docked: 'top',
            title: 'My Toolbar'
        },
        {
           xtype: 'button',
           text: 'My Button'
        }
    ]
});

container.addListener({
    // Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
    delegate: 'button',

    tap: function() {
        alert('Button tapped!');
    }
});

capture :  Boolean

true to initiate capture which will fire the listeners on the target Element before any descendant Elements. Normal events start with the target element and propagate upward to ancestor elements, whereas captured events propagate from the top of the DOM downward to descendant elements. This option achieves the same result as the useCapture parameter in the standard JavaScript addEventListener method.

order :  String (optional)

The order of when the listener should be added into the listener queue. Possible values are before, current and after.

Defaults to: 'current'

onAfter ( eventName, fn, [scope], [options] )

Alias for addAfterListener. Appends an after-event handler.

Same as addListener with order set to 'after'.

Parameters

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.

onBatchComplete ( batchOptions, batch )
private pri

The internal callback that the proxy uses to call any specified user callbacks after completion of a batch

Parameters

batchOptions :  Object

batch :  Object

onBefore ( eventName, fn, [scope], [options] )

Alias for addBeforeListener. Appends a before-event handler. Returning false from the handler will stop the event.

Same as addListener with order set to 'before'.

Parameters

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.

onMetaChange ( meta )
private pri

Called each time the reader's onMetaChange is called so that the proxy can fire the metachange event

Parameters

meta :  Object

read ( operation )

Performs the given read operation.

Parameters

operation :  Ext.data.operation.Operation

The Operation to perform

relayEvent ( args, fn, scope, options, order )
private pri

Parameters

args :  Object

fn :  Object

scope :  Object

options :  Object

order :  Object

relayEvents ( object, events ) :
chainable ch

Relays selected events from the specified Observable as if the events were fired by this.

Parameters

object :  Object

The Observable whose events this object is to relay.

events :  String/Array/Object

Array of event names to relay.

Returns

:

removeAfterListener ( eventName, fn, [scope], [options] )

Removes a before-event handler.

Same as removeListener with order set to 'after'.

Parameters

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.

removeBeforeListener ( eventName, fn, [scope], [options] )

Removes a before-event handler.

Same as removeListener with order set to 'before'.

Parameters

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.

removeListener ( eventName, fn, [scope], [options], [order] )

Removes an event handler.

Parameters

eventName :  String/String[]/Object

The type of event the handler was associated with.

fn :  Function/String

The handler to remove. This must be a reference to the function passed into the addListener call.

scope :  Object (optional)

The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

options :  Object (optional)

Extra options object. See addListener for details.

order :  String (optional)

The order of the listener to remove. Possible values are before, current and after.

Defaults to: 'current'

removeManagedListener ( object, eventName, [fn], [scope] )
deprecated dep

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

Parameters

object :  Ext.mixin.Observable/HTMLElement

The item to which to add a listener/listeners.

eventName :  Object/String

The event name, or an object containing event name properties.

fn :  Function (optional)

If the eventName parameter was an event name, this is the handler function.

scope :  Object (optional)

If the eventName parameter was an event name, this is the scope in which the handler function is executed.

Deprecated since version 2.0
All listeners are now automatically managed where necessary. Simply use removeListener.

resolveListenerScope ( [defaultScope] ) : Object
protected pro

This method determines the scope (the this pointer) of named listeners that have not be given a specific scope. For example:

 component.on({
     click: 'onClick'
 });

The default implementation of this method returns this object. Components and other observable objects that have natural hierarchies can override this method to pick the desired scope using other means.

Available since: 5.0.0

Parameters

defaultScope :  Object (optional)

The default scope to return if none is found.

Defaults to: this

Returns

:Object

The object on which non-scoped, named listeners should be fired.

resumeEvent ( eventName )

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.

Parameters

eventName :  String...

Multiple event names to resume.

resumeEvents ( discardQueuedEvents )

Resumes firing events (see suspendEvents).

Parameters

discardQueuedEvents :  Boolean

Pass as true to discard any queued events.

setConfig ( name, [value] ) : Ext.Base
chainable ch

Sets a single/multiple configuration options.

Parameters

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.

Returns

:Ext.Base

this

statics Ext.Class
protected pro

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

        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                        // equivalent to: My.Cat.speciesName

        alert(this.self.speciesName);   // dependent on 'this'

        statics.totalCreated++;
    },

    clone: function() {
        var cloned = new this.self();   // dependent on 'this'

        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName

        return cloned;
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',

    statics: {
        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
    },

    constructor: function() {
        this.callParent();
    }
});

var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'

var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
alert(clone.groupName);                 // alerts 'Cat'

alert(My.Cat.totalCreated);             // alerts 3

Returns

:Ext.Class

suspendEvent ( eventName )

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.

Parameters

eventName :  String...

Multiple event names to suspend.

suspendEvents ( queueSuspended )

Suspends the firing of all events. (see resumeEvents)

Parameters

queueSuspended :  Boolean

true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events.

un ( eventName, fn, [scope], [options], [order] )

Alias for removeListener. Removes an event handler.

Parameters

eventName :  String/String[]/Object

The type of event the handler was associated with.

fn :  Function/String

The handler to remove. This must be a reference to the function passed into the addListener call.

scope :  Object (optional)

The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

options :  Object (optional)

Extra options object. See addListener for details.

order :  String (optional)

The order of the listener to remove. Possible values are before, current and after.

Defaults to: 'current'

unAfter ( eventName, fn, [scope], [options] )

Alias for removeAfterListener. Removes a before-event handler.

Same as removeListener with order set to 'after'.

Parameters

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.

unBefore ( eventName, fn, [scope], [options] )

Alias for removeBeforeListener. Removes a before-event handler.

Same as removeListener with order set to 'before'.

Parameters

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.

update ( operation )

Performs the given update operation.

Parameters

operation :  Ext.data.operation.Operation

The Operation to perform

Static Methods

addConfig ( config, [mixinClass] )
static sta private pri

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.

Parameters

config :  Object

mixinClass :  Class (optional)

The mixin class if the configs are from a mixin.

addInheritableStatics ( members ) :
chainable ch static sta private pri

Parameters

members :  Object

Returns

:

addMember ( name, member ) :
chainable ch static sta private pri

Parameters

name :  Object

member :  Object

Returns

:

addMembers ( members, [isStatic], [privacy] ) :
chainable ch static sta

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

Parameters

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

Returns

:

addStatics ( members ) : Ext.Base
chainable ch static sta

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() { ... };
});

Parameters

members :  Object

Returns

:Ext.Base

this

borrow ( fromClass, members ) : Ext.Base
static sta private pri

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 '$$$$$$$'

Parameters

fromClass :  Ext.Base

The class to borrow members from

members :  Array/String

The names of the members to borrow

Returns

:Ext.Base

this

callParent ( args )
static sta protected pro

Parameters

args :  Object

callSuper ( args )
static sta protected pro

Parameters

args :  Object

create Object
static sta

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.

Returns

:Object

the created instance.

createAlias ( alias, origin )
static sta

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

Parameters

alias :  String/Object

The new method name, or an object to set multiple aliases. See flexSetter

origin :  String/Object

The original method name

extend ( parentClass )
static sta private pri

Parameters

parentClass :  Object

getConfigurator Ext.Configurator
static sta private pri

Returns the Ext.Configurator for this class.

Returns

:Ext.Configurator

getName String
static sta

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'

Returns

:String

className

mixin ( name, mixinClass ) :
chainable ch static sta private pri

Used internally by the mixins pre-processor

Parameters

name :  Object

mixinClass :  Object

Returns

:

onExtended ( fn, scope ) :
chainable ch static sta private pri

Parameters

fn :  Object

scope :  Object

Returns

:

override ( members ) : Ext.Base
chainable ch static sta

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

Parameters

members :  Object

The properties to add to this class. This should be specified as an object literal containing one or more properties.

Returns

:Ext.Base

this class

triggerExtended
static sta private pri

events

metachange ( this, meta, eOpts )

Fires when this proxy's reader provides new metadata. Metadata usually consists of new field definitions, but can include any configuration data required by an application, and can be processed as needed in the event handler. This event is currently only fired for JsonReaders. Note that this event is also propagated by Ext.data.Store, which is typically where it would be handled.

Parameters

this :  Ext.data.proxy.Proxy

meta :  Object

The JSON metadata

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Ext JS 5.0.1