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 6.2.1 - Modern Toolkit


top

Ext.google.data.EventsProxy proxy: proxy.google-events

No members found using the current filters

configs

Optional Configs

api : Object

Specific urls to call on CRUD action methods "create", "read", "update" and "destroy". Defaults to:

api: {
    create  : undefined,
    read    : undefined,
    update  : undefined,
    destroy : undefined
}

The url is built based upon the action being executed [create|read|update|destroy] using the commensurate api property, or if undefined default to the configured Ext.data.Store.url.

For example:

api: {
    create  : '/controller/new',
    read    : '/controller/load',
    update  : '/controller/update',
    destroy : '/controller/destroy_action'
}

If the specific URL for a given CRUD action is undefined, the CRUD action request will be directed to the configured url.

Defaults to:

{
    create: undefined,
    read: undefined,
    update: undefined,
    destroy: undefined
}

getApi : Object

Returns the value of api

Returns

Object

setApi (api)

Sets the value of api

Parameters

api :  Object

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

cacheString : String

The name of the cache param added to the url when using noCache. Defaults to "_dc".

Defaults to:

"_dc"

getCacheString : String

Returns the value of cacheString

Returns

String

setCacheString (cacheString)

Sets the value of cacheString

Parameters

cacheString :  String

directionParam : String

The name of the direction parameter to send in a request. This is only used when simpleSortMode is set to true.

Defaults to:

"dir"

getDirectionParam : String

Returns the value of directionParam

Returns

String

setDirectionParam (directionParam)

Sets the value of directionParam

Parameters

directionParam :  String

extraParams : Object

Extra parameters that will be included on every request. Individual requests with params of the same name will override these params when they are in conflict.

Defaults to:

{}

getExtraParams : Object

Returns the value of extraParams

Returns

Object

setExtraParams (extraParams)

Sets the value of extraParams

Parameters

extraParams :  Object

filterParam : String

The name of the 'filter' parameter to send in a request. Defaults to 'filter'. Set this to '' if you don't want to send a filter parameter.

Defaults to:

"filter"

getFilterParam : String

Returns the value of filterParam

Returns

String

setFilterParam (filterParam)

Sets the value of filterParam

Parameters

filterParam :  String

groupDirectionParam : String

The name of the direction parameter to send in a request. This is only used when simpleGroupMode is set to true.

Defaults to:

"groupDir"

getGroupDirectionParam : String

Returns the value of groupDirectionParam

Returns

String

setGroupDirectionParam (groupDirectionParam)

Sets the value of groupDirectionParam

Parameters

groupDirectionParam :  String

groupParam : String

The name of the 'group' parameter to send in a request. Defaults to 'group'. Set this to '' if you don't want to send a group parameter.

Defaults to:

"group"

getGroupParam : String

Returns the value of groupParam

Returns

String

setGroupParam (groupParam)

Sets the value of groupParam

Parameters

groupParam :  String

idParam : String

The name of the parameter which carries the id of the entity being operated upon.

Defaults to:

"id"

getIdParam : String

Returns the value of idParam

Returns

String

setIdParam (idParam)

Sets the value of idParam

Parameters

idParam :  String

limitParam : String

The name of the 'limit' parameter to send in a request. Defaults to 'limit'. Set this to '' if you don't want to send a limit parameter.

Defaults to:

"limit"

getLimitParam : String

Returns the value of limitParam

Returns

String

setLimitParam (limitParam)

Sets the value of limitParam

Parameters

limitParam :  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.

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 DataView's itemclick event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

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

setListeners ( listeners )

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.

Parameters

listeners :  Object

The listeners

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

noCache : Boolean

Disable caching by adding a unique parameter name to the request. Set to false to allow caching. Defaults to true.

Defaults to:

true

getNoCache : Boolean

Returns the value of noCache

Returns

Boolean

setNoCache (noCache)

Sets the value of noCache

Parameters

noCache :  Boolean

pageParam : String

The name of the 'page' parameter to send in a request. Defaults to 'page'. Set this to '' if you don't want to send a page parameter.

Defaults to:

"page"

getPageParam : String

Returns the value of pageParam

Returns

String

setPageParam (pageParam)

Sets the value of pageParam

Parameters

pageParam :  String

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

simpleGroupMode : Boolean

Enabling simpleGroupMode in conjunction with remoteGroup will only send one group property and a direction when a remote group is requested. The groupDirectionParam and groupParam will be sent with the property name and either 'ASC' or 'DESC'.

Defaults to:

false

getSimpleGroupMode : Boolean

Returns the value of simpleGroupMode

Returns

Boolean

setSimpleGroupMode (simpleGroupMode)

Sets the value of simpleGroupMode

Parameters

simpleGroupMode :  Boolean

simpleSortMode : Boolean

Enabling simpleSortMode in conjunction with remoteSort will only send one sort property and a direction when a remote sort is requested. The directionParam and sortParam will be sent with the property name and either 'ASC' or 'DESC'.

Defaults to:

false

getSimpleSortMode : Boolean

Returns the value of simpleSortMode

Returns

Boolean

setSimpleSortMode (simpleSortMode)

Sets the value of simpleSortMode

Parameters

simpleSortMode :  Boolean

sortParam : String

The name of the 'sort' parameter to send in a request. Defaults to 'sort'. Set this to '' if you don't want to send a sort parameter.

Defaults to:

"sort"

getSortParam : String

Returns the value of sortParam

Returns

String

setSortParam (sortParam)

Sets the value of sortParam

Parameters

sortParam :  String

startParam : String

The name of the 'start' parameter to send in a request. Defaults to 'start'. Set this to '' if you don't want to send a start parameter.

Defaults to:

"start"

getStartParam : String

Returns the value of startParam

Returns

String

setStartParam (startParam)

Sets the value of startParam

Parameters

startParam :  String

timeout : Number

The number of milliseconds to wait for a response. Defaults to 30000 milliseconds (30 seconds).

Defaults to:

30000

getTimeout : Number

Returns the value of timeout

Returns

Number

setTimeout (timeout)

Sets the value of timeout

Parameters

timeout :  Number

url : String

The URL from which to request the data object.

Defaults to:

''

getUrl ( request ) : String
private pri

Get the url for the request taking into account the order of priority,

  • The request
  • The api
  • The url

Parameters

request :  Ext.data.Request

The request

Returns

:String
The url

setUrl (url)

Sets the value of url

Parameters

url :  String

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:

true

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

$eventOptions
private pri

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
}

$vetoClearingPrototypeOnDestroy
private pri

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

clearPropertiesOnDestroy : Boolean / "async"
protected pro

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

clearPrototypeOnDestroy : Boolean
private pri

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

destroyed : Boolean
protected pro

This property is set to true after the destroy method is called.

Defaults to:

false

eventsSuspended
private pri

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

Defaults to:

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

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

isObservable : Boolean

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

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

_addDeclaredListeners ( listeners ) : Boolean
private pri

Adds declarative listeners as nested arrays of listener objects.

Parameters

listeners :  Array

Returns

:Boolean
`true` if any listeners were added

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

addListener ( eventName, [fn], [scope], [options], [order] ) : Object
chainable ch

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

Parameters

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

Defaults to:

'current'

order :  String (optional)

A shortcut for the `order` event option. Provided for backward compatibility. Please use the `priority` event option instead. **Combining Options** Using the options argument, it is possible to combine different types of listeners: A delayed, one-time listener. myPanel.on('hide', this.handleClick, 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 handlers and handler configs. grid.on({ itemclick: 'onItemClick', itemcontextmenu: grid.onItemContextmenu, destroy: { fn: function () { // function called within the 'altCmp' scope instead of grid }, scope: altCmp // unique scope for the destroy handler }, scope: grid // default scope - provided for example clarity }); **Delegate** This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example: var panel = Ext.create({ xtype: 'panel', renderTo: document.body, title: 'Delegate Handler Example', frame: true, height: 220, width: 220, html: '

BODY TITLE

Body content' }); // The click handler will only be called when the click occurs on the // delegate: h1.myTitle ("h1" tag with class "myTitle") panel.on({ click: function (e) { console.log(e.getTarget().innerHTML); }, element: 'body', delegate: 'h1.myTitle' });

Defaults to: 'current'

Returns

:Object
**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();

addManagedListener ( item, ename, [fn], [scope], [options] ) : Object

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

Parameters

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.

Returns

:Object
**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();

afterRequest ( request, success )
template tpl protected pro

Optional callback function which can be used to clean up after a request has been completed.

Parameters

request :  Ext.data.Request

The Request object

success :  Boolean

True if the request was successful

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

applyEncoding ( value ) : Object
protected pro

Encode any values being sent to the server. Can be overridden in subclasses.

Parameters

value :  Array

An array of sorters/filters.

Returns

:Object
The encoded value

batch ( options, [listeners] ) : 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.

listeners :  Object (optional)

If `options` is the `operations`, this parameter is the listeners. Instead of passing these two arguments, the proper form is to pass them as: batch({ operations: ... listeners: ... });

Returns

:Ext.data.Batch
The newly created Batch

buildApiRequests ( request ) : Object[]
protected pro

Returns a list of API request(s), not executed.

Parameters

request :  Ext.data.Request

The data request

Returns

:Object[]
API request(s)

buildRequest ( operation ) : Ext.data.Request

Creates an Ext.data.Request object from Ext.data.operation.Operation.

This gets called from doRequest methods in subclasses of Server proxy.

Parameters

operation :  Ext.data.operation.Operation

The operation to execute

Returns

:Ext.data.Request
The request object

buildUrl ( request ) : String
protected pro

Generates a url based on a given Ext.data.Request object. By default, ServerProxy's buildUrl will add the cache-buster param to the end of the url. Subclasses may need to perform additional modifications to the url.

Parameters

request :  Ext.data.Request

The request object

Returns

:String
The url

callOverridden ( args ) : Object
deprecated dep protected pro

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"

Parameters

args :  Array/Arguments

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

Returns

:Object
Returns the result of calling the overridden method

Deprecated since version 4.1.0

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

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

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

clearListeners

Removes all listeners for this object including the managed listeners

clearManagedListeners

Removes all managed 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

createRelayer ( newName, [beginEnd] ) : Function
private pri

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

Parameters

newName :  String

The name under which to re-fire the passed parameters.

beginEnd :  Array (optional)

The caller can specify on which indices to slice.

Returns

:Function

destroy

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.

doFireEvent ( eventName, args, bubbles )
private pri

Continue to fire event.

Parameters

eventName :  String

args :  Array

bubbles :  Boolean

doRequest ( operation )
protected pro

In ServerProxy subclasses, the method-create, method-read, method-update and method-erase methods all pass through to doRequest. Each ServerProxy subclass must implement the doRequest method - see Ext.data.proxy.JsonP and Ext.data.proxy.Ajax for examples. This method carries the same signature as each of the methods that delegate to it.

Parameters

operation :  Ext.data.operation.Operation

The Ext.data.operation.Operation object

enableBubble ( eventNames )

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

Parameters

eventNames :  String/String[]

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

encodeFilters ( filters ) : String

Encodes the array of Ext.util.Filter objects into a string to be sent in the request url. By default, this simply JSON-encodes the filter data

Parameters

filters :  Ext.util.Filter[]

The array of Ext.util.Filter objects

Returns

:String
The encoded filters

encodeSorters ( sorters, [preventArray] ) : String

Encodes the array of Ext.util.Sorter objects into a string to be sent in the request url. By default, this simply JSON-encodes the sorter data

Parameters

sorters :  Ext.util.Sorter[]

The array of Ext.util.Sorter objects

preventArray :  Boolean (optional)

Prevents the items from being output as an array.

Defaults to: false

Returns

:String
The encoded sorters

erase ( operation )

Performs the given destroy operation.

Parameters

operation :  Ext.data.operation.Operation

The Operation to perform

extractResponseData ( response ) : Object
protected pro

Template method to allow subclasses to specify how to get the response for the reader.

Parameters

response :  Object

The server response

Returns

:Object
The response data to be used by the reader

fireAction ( eventName, args, fn, [scope], [options], [order] )
deprecated dep

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.

Parameters

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

fireEvent ( eventName, args ) : Boolean

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.

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 otherwise it returns true.

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.

fireEventedAction ( eventName, args, fn, [scope], [fnArgs] ) : Boolean

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.

Parameters

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.

Returns

:Boolean

getBubbleParent Ext.util.Observable
private pri

Gets the bubbling parent for an Observable

Returns

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

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

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.

getParams ( operation )
private pri

Copy any sorters, filters etc into the params so they can be sent over the wire

Parameters

operation :  Object

hasConfig ( name )
private pri

Parameters

name :  String

hasListener ( eventName ) : Boolean

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.

Parameters

eventName :  String

The name of the event to check for

Returns

:Boolean
`true` if the event is being listened for or bubbles, 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 ( [event] ) : Boolean

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

Parameters

event :  String (optional)

The name of the specific event to check

Returns

:Boolean
`true` if events are suspended

mon ( item, ename, [fn], [scope], [options] ) : Object

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

Parameters

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.

Returns

:Object
**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();

mun ( item, ename, [fn], [scope] )

Shorthand for removeManagedListener. Removes listeners that were added by the mon method.

Parameters

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.

on ( eventName, [fn], [scope], [options], [order] ) : 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}
});

Parameters

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

Defaults to:

'current'

order :  String (optional)

A shortcut for the `order` event option. Provided for backward compatibility. Please use the `priority` event option instead. **Combining Options** Using the options argument, it is possible to combine different types of listeners: A delayed, one-time listener. myPanel.on('hide', this.handleClick, 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 handlers and handler configs. grid.on({ itemclick: 'onItemClick', itemcontextmenu: grid.onItemContextmenu, destroy: { fn: function () { // function called within the 'altCmp' scope instead of grid }, scope: altCmp // unique scope for the destroy handler }, scope: grid // default scope - provided for example clarity }); **Delegate** This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example: var panel = Ext.create({ xtype: 'panel', renderTo: document.body, title: 'Delegate Handler Example', frame: true, height: 220, width: 220, html: '

BODY TITLE

Body content' }); // The click handler will only be called when the click occurs on the // delegate: h1.myTitle ("h1" tag with class "myTitle") panel.on({ click: function (e) { console.log(e.getTarget().innerHTML); }, element: 'body', delegate: 'h1.myTitle' });

Defaults to: 'current'

Returns

:Object
**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();

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

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

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

processResponse ( success, operation, request, response )
protected pro

Processes response, which may involve updating or committing records, each of which will inform the owning stores and their interested views. Finally, we may perform an additional layout if the data shape has changed.

Parameters

success :  Object

operation :  Object

request :  Object

response :  Object

read ( operation )

Performs the given read operation.

Parameters

operation :  Ext.data.operation.Operation

The Operation to perform

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

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

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

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

The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword (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).

Parameters

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

Returns

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

removeListener ( eventName, fn, [scope] ) :
chainable ch

Removes an event handler.

Parameters

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. **Convenience Syntax** You can use the addListener `destroyable: true` config option in place of calling un(). For example: var listeners = cmp.on({ scope: cmp, afterrender: cmp.onAfterrender, beforehide: cmp.onBeforeHide, destroyable: true }); // Remove listeners listeners.destroy(); // or cmp.un( scope: cmp, afterrender: cmp.onAfterrender, beforehide: cmp.onBeforeHide ); **Exception - DOM event handlers using the element config option** You must go directly through the element to detach an event handler attached using the addListener _element_ option. panel.on({ element: 'body', click: 'onBodyCLick' }); panel.body.un({ click: 'onBodyCLick' });

Returns

:

removeManagedListener ( item, ename, [fn], [scope] )

Removes listeners that were added by the mon method.

Parameters

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.

removeManagedListenerItem ( isClear, managedListener )
private pri

Remove a single managed listener item

Parameters

isClear :  Boolean

True if this is being called during a clear

managedListener :  Object

The managed listener item See removeManagedListener for other args

resolveListenerScope ( [defaultScope] ) : Object
protected pro

Gets the default scope for firing late bound events (string names with no scope attached) at runtime.

Parameters

defaultScope :  Object (optional)

The default scope to return if none is found.

Defaults to: this

Returns

:Object
The default event scope

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 ( [discardQueue] )

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.

Parameters

discardQueue :  Boolean (optional)

`true` to prevent any previously queued events from firing while we were suspended. See suspendEvents.

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

setException ( operation, response )
private pri

Sets up an exception on the operation

Parameters

operation :  Ext.data.operation.Operation

The operation

response :  Object

The response

setExtraParam ( name, value )

Sets a value in the underlying extraParams.

Parameters

name :  String

The key for the new value

value :  Object

The value

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] ) :

Shorthand for removeListener. Removes an event handler.

Parameters

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. **Convenience Syntax** You can use the addListener `destroyable: true` config option in place of calling un(). For example: var listeners = cmp.on({ scope: cmp, afterrender: cmp.onAfterrender, beforehide: cmp.onBeforeHide, destroyable: true }); // Remove listeners listeners.destroy(); // or cmp.un( scope: cmp, afterrender: cmp.onAfterrender, beforehide: cmp.onBeforeHide ); **Exception - DOM event handlers using the element config option** You must go directly through the element to detach an event handler attached using the addListener _element_ option. panel.on({ element: 'body', click: 'onBodyCLick' }); panel.body.un({ click: 'onBodyCLick' });

Returns

:

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

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

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 :  Ext.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 Ext.Base#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

exception ( this, response, operation, eOpts )

Fires when the server returns an exception. This event may also be listened to in the event that a request has timed out or has been aborted.

Parameters

this :  Ext.data.proxy.Proxy

response :  Ext.data.Response

The response that was received

operation :  Ext.data.operation.Operation

The operation that triggered the request

eOpts : Object

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

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 6.2.1 - Modern Toolkit