listeners : Object

A config object containing one or more event handlers to be added to this object during initialization. ...

A config object containing one or more event handlers to be added to this object during initialization. This\nshould be a valid listeners config object as specified in the addListener example for attaching multiple\nhandlers at once.

\n\n

DOM events from Ext JS Components

\n\n

While some Ext JS Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the element option to identify the Component property to add a\nDOM listener to:

\n\n

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

Properties

Defined By

Instance Properties

$className : Stringprivate

...

Defaults to: 'Ext.Base'

configMap : Objectprivate

...

Defaults to: {}

eventsSuspended : Numberprivate

Initial suspended call count. ...

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

Defaults to: 0

Ext.util.AbstractMixedCollection
view source

generation : Numberprivate

Mutation counter which is incremented upon add and remove. ...

Mutation counter which is incremented upon add and remove.

Defaults to: 0

hasListeners : Objectreadonly

This object holds a key for any event that has a listener. ...

This object holds a key for any event that has a listener. The listener may be set\ndirectly on the instance, or on its class or a super class (via observe) or\non the MVC EventBus. The values of this object are truthy\n(a non-zero number) and falsy (0 or undefined). They do not represent an exact count\nof listeners. The value for an event is truthy if the event must be fired and is\nfalsy if there is no need to fire the event.

\n\n

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

\n\n

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

Ext.util.AbstractMixedCollection
view source

indexGeneration : Numberprivate

Mutation counter for the index map which is synchronized with the collection's mutation counter\nwhen the index map is...

Mutation counter for the index map which is synchronized with the collection's mutation counter\nwhen the index map is interrogated and found to be out of sync and needed a rebuild.

Defaults to: 0

initConfigList : Arrayprivate

...

Defaults to: []

initConfigMap : Objectprivate

...

Defaults to: {}

isInstance : Booleanprivate

...

Defaults to: true

Ext.util.AbstractMixedCollection
view source

isMixedCollection : Boolean

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

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

Defaults to: true

isObservable : Boolean

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

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

Defaults to: true

self : Ext.Classprotected

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison

\n\n

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

Defined By

Static Properties

$onExtended : Arrayprivatestatic

...

Defaults to: []

Methods

Defined By

Instance Methods

Ext.util.AbstractMixedCollection
view source

newExt.util.AbstractMixedCollection( allowFunctions, keyFn ) : Ext.util.AbstractMixedCollection

...

Parameters

allowFunctions : Object
\n
keyFn : Object
\n

Returns

Ext.util.AbstractMixedCollection
\n

Ext.util.AbstractMixedCollection
view source

add( key, [obj] ) : Object

Adds an item to the collection. ...

Adds an item to the collection. Fires the add event when complete.

Available since: 1.1.0

Parameters

key : String/Object
The key to associate with the item, or the new item.
\n\n
If a getKey implementation was specified for this MixedCollection,\nor if the key of the stored items is in a property called id,\nthe MixedCollection will be able to derive the key for the new item.\nIn this case just pass the new item in this parameter.
\n
obj : Object (optional)
The item to add.
\n

Returns

Object
The item added.
\n

Ext.util.AbstractMixedCollection
view source

addAll( objs )

Adds all elements of an Array or an Object to the collection. ...

Adds all elements of an Array or an Object to the collection.

Available since: 1.1.0

Parameters

objs : Object/Array
An Object containing properties which will be added\nto the collection, or an Array of values, each of which are added to the collection.\nFunctions references will be added to the collection if allowFunctions\nhas been set to true.
\n

addEvents( eventNames )

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

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

Parameters

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

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

Appends an event handler to this object. ...

Appends an event handler to this object. For example:

\n\n

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

\n\n

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

\n\n

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

\n\n

One can also specify options for each event handler separately:

\n\n

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

\n\n

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

\n\n

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

Parameters

eventName : String/Object
The name of the event to listen for.\nMay also be an object who's property names are event names.
\n\n
fn : Function (optional)
The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.
\n\n
scope : Object (optional)
The scope (this reference) in which the handler function is\nexecuted. If omitted, defaults to the object which fired the event.
\n\n
options : Object (optional)
An object containing handler configuration.
\n\n\n\n\n
Note: Unlike in ExtJS 3.x, the options object will also be passed as the last\nargument to every event handler.
\n\n\n\n\n
This object may contain any of the following properties:
\n\n
- scope : Object
  The scope (this reference) in which the handler function is executed. If omitted,\n defaults to the object which fired the event.
  \n\n
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
  \n\n
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
  \n\n
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\n by the specified number of milliseconds. If the event fires again within that time,\n the original handler is not invoked, but the new handler is scheduled in its place.
  \n\n
- target : Ext.util.Observable
  Only call the handler if the event was fired on the target Observable, not if the event\n was bubbled up from a child Observable.
  \n\n
- element : String
  This option is only valid for listeners bound to Components.\n The name of a Component property which references an element to add a listener to.
  \n\n\n\n\n
  This option is useful during Component construction to add DOM event listeners to elements of\n Components which will exist only after the Component is rendered.\n For example, to add a click listener to a Panel's body:
  \n\n\n\n\n
```
  new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
```
  \n\n
- destroyable : Boolean (optional)
  When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.
  \n\n
  Defaults to: false
- priority : Number (optional)
  An optional numeric priority that determines the order in which event handlers\n are run. Event handlers with no priority will be run as if they had a priority\n of 0. Handlers with a higher priority will be prioritized to run sooner than\n those with a lower priority. Negative numbers can be used to set a priority\n lower than the default. Internally, the framework uses a range of 1000 or\n greater, and -1000 or lesser for handers that are intended to run before or\n after all others, so it is recommended to stay within the range of -999 to 999\n when setting the priority of event handlers in application-level code.
  \n\n\n\n\n
  Combining Options
  \n\n\n\n\n
  Using the options argument, it is possible to combine different types of listeners:
  \n\n\n\n\n
  A delayed, one-time listener.
  \n\n\n\n\n
```
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
```
  \n\n

Returns

Only when the destroyable option is specified.

\n\n\n\n\n

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

\n\n\n\n\n

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

\n\n\n\n\n

And when those listeners need to be removed:

\n\n\n\n\n

Ext.destroy(this.btnListeners);\n

\n\n\n\n\n

this.btnListeners.destroy();\n

\n\n

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

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

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

Parameters

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

Returns

Only when the destroyable option is specified.

\n\n\n\n\n

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

\n\n\n\n\n

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

\n\n\n\n\n

And when those listeners need to be removed:

\n\n\n\n\n

Ext.destroy(this.btnListeners);\n

\n\n\n\n\n

this.btnListeners.destroy();\n

\n\n

callOverridden( args ) : Objectdeprecatedprotected

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

Call the original method that was previously overridden with override

\n\n

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

This method has been deprecated

as of 4.1. Use callParent instead.

\n\n

Parameters

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

Returns

Object
Returns the result of calling the overridden method
\n

callParent( args ) : Objectprotected

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

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

\n\n

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

\n\n

This can be used with an override as follows:

\n\n

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

\n\n

This also works with static methods.

\n\n

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

\n\n

Lastly, it also works with overridden static methods.

\n\n

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

\n\n

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

Parameters

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

Returns

Object
Returns the result of calling the parent method
\n

callSuper( args ) : Objectprotected

This method is used by an override to call the superclass method but bypass any\noverridden method. ...

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

\n\n

Consider:

\n\n

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

\n\n

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

\n\n

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

\n\n

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

Parameters

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

Returns

Object
Returns the result of calling the superclass method
\n

captureArgs( o, fn, scope )private

...

Parameters

o : Object
\n
fn : Object
\n
scope : Object
\n

Ext.util.AbstractMixedCollection
view source

clear( )

Removes all items from the collection. ...

Removes all items from the collection. Fires the clear event when complete.

Available since: 1.1.0

clearListeners( )

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

Removes all listeners for this object including the managed listeners

clearManagedListeners( )

Removes all managed listeners for this object. ...

Removes all managed listeners for this object.

Ext.util.AbstractMixedCollection
view source

clone( ) : Ext.util.MixedCollection

Creates a shallow copy of this collection ...

Creates a shallow copy of this collection

Available since: 1.1.0

Returns

Ext.util.MixedCollection
\n

Ext.util.AbstractMixedCollection
view source

collect( property, [root], [allowBlank] ) : Array

Collects unique values of a particular property in this MixedCollection ...

Collects unique values of a particular property in this MixedCollection

Parameters

property : String
The property to collect on
\n
root : String (optional)
'root' property to extract the first argument from. This is used mainly when\nsumming fields in records, where the fields are all stored inside the 'data' object
\n
allowBlank : Boolean (optional)
Pass true to allow null, undefined or empty string values
\n

Returns

Array
The unique values
\n

configClass( )private

...

Ext.util.AbstractMixedCollection
view source

contains( o ) : Boolean

Returns true if the collection contains the passed Object as an item. ...

Returns true if the collection contains the passed Object as an item.

Available since: 1.1.0

Parameters

o : Object
The Object to look for in the collection.
\n

Returns

Boolean
True if the collection contains the Object as an item.
\n

Ext.util.AbstractMixedCollection
view source

containsKey( key ) : Boolean

Returns true if the collection contains the passed Object as a key. ...

Returns true if the collection contains the passed Object as a key.

Available since: 1.1.0

Parameters

key : String
The key to look for in the collection.
\n

Returns

Boolean
True if the collection contains the Object as a key.
\n

continueFireEvent( eventName, args, bubbles )private

Continue to fire event. ...

Continue to fire event.

Parameters

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

createRelayer( newName, [beginEnd] ) : Functionprivate

Creates an event handling function which refires the event from this object as the passed event name. ...

Creates an event handling function which refires the event from this object as the passed event name.

Parameters

newName : String
The name under which to refire the passed parameters.
\n
beginEnd : Array (optional)
The caller can specify on which indices to slice.
\n

Returns

Function
\n

Ext.util.AbstractMixedCollection
view source

createValueMatcher( value, anyMatch, caseSensitive, exactMatch )private

Returns a regular expression based on the given value and matching options. ...

Returns a regular expression based on the given value and matching options. This is used internally for finding and filtering,\nand by Ext.data.Store.filter

Available since: 3.4.0

Parameters

value : String
The value to create the regex for. This is escaped using Ext.escapeRe
\n
anyMatch : Boolean
True to allow any match - no regex start/end line anchors will be added. Defaults to false
\n
caseSensitive : Boolean
True to make the regex case sensitive (adds 'i' switch to regex). Defaults to false.
\n
exactMatch : Boolean
True to force exact match (^ and $ characters added to the regex). Defaults to false. Ignored if anyMatch is true.
\n

destroy( )private

...

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

Ext.util.AbstractMixedCollection
view source

doInsert( index, keys, objects )private

Private multi insert implementation. ...

Private multi insert implementation.

Parameters

index : Object
\n
keys : Object
\n
objects : Object
\n

Ext.util.AbstractMixedCollection
view source

each( fn, [scope] )

Executes the specified function once for every item in the collection. ...

Executes the specified function once for every item in the collection.\nThe function should return a boolean value.\nReturning false from the function will stop the iteration.

Available since: 1.1.0

Parameters

fn : Function
The function to execute for each item.
\n
Parameters
- item : Mixed
  The collection item.
  \n
- index : Number
  The index of item.
  \n
- len : Number
  Total length of collection.
  \n
scope : Object (optional)
The scope (this reference)\nin which the function is executed. Defaults to the current item in the iteration.
\n

Ext.util.AbstractMixedCollection
view source

eachKey( fn, [scope] )

Executes the specified function once for every key in the collection, passing each\nkey, and its associated item as th...

Executes the specified function once for every key in the collection, passing each\nkey, and its associated item as the first two parameters.

Available since: 1.1.0

Parameters

fn : Function
The function to execute for each item.
\n
Parameters
- key : String
  The key of collection item.
  \n
- item : Mixed
  The collection item.
  \n
- index : Number
  The index of item.
  \n
- len : Number
  Total length of collection.
  \n
scope : Object (optional)
The scope (this reference) in which the\nfunction is executed. Defaults to the browser window.
\n

enableBubble( eventNames )

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

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

\n\n

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

\n\n

Example:

\n\n

Ext.define('Ext.overrides.form.field.Base', {\n    override: 'Ext.form.field.Base',\n\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent: function () {\n        this.callParent();\n        this.enableBubble('change');\n    }\n});\n\nvar myForm = Ext.create('Ext.form.Panel', {\n    title: 'User Details',\n    items: [{\n        ...\n    }],\n    listeners: {\n        change: function() {\n            // Title goes red if form has been modified.\n            myForm.header.setStyle('color', 'red');\n        }\n    }\n});\n

Parameters

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

Ext.util.AbstractMixedCollection
view source

extractValues( property, [root] ) : Arrayprivate

Extracts all of the given property values from the items in the MC. ...

Extracts all of the given property values from the items in the MC. Mainly used as a supporting method for\nfunctions like sum and collect.

Parameters

property : String
The property to extract
\n
root : String (optional)
'root' property to extract the first argument from. This is used mainly when\nextracting field data from Model instances, where the fields are stored inside the 'data' object
\n

Returns

Array
The extracted values
\n

Ext.util.AbstractMixedCollection
view source

filter( property, value, [anyMatch], [caseSensitive] ) : Ext.util.MixedCollection

Filters the objects in this collection by a set of Filters, or by a single\nproperty/value pair with optional paramete...

Filters the objects in this collection by a set of Filters, or by a single\nproperty/value pair with optional parameters for substring matching and case sensitivity. See\nFilter for an example of using Filter objects (preferred). Alternatively,\nMixedCollection can be easily filtered by property like this:

\n\n\n

//create a simple store with a few people defined\n var people = new Ext.util.MixedCollection();\n people.addAll([

\n\n

   {id: 1, age: 25, name: 'Ed'},\n   {id: 2, age: 24, name: 'Tommy'},\n   {id: 3, age: 24, name: 'Arne'},\n   {id: 4, age: 26, name: 'Aaron'}\n

\n\n

]);

\n\n

//a new MixedCollection containing only the items where age == 24\n var middleAged = people.filter('age', 24);

Available since: 1.1.0

Parameters

property : Ext.util.Filter[]/String
A property on your objects, or an array of Filter objects
\n
value : String/RegExp
Either string that the property values\nshould start with or a RegExp to test against the property
\n
anyMatch : Boolean (optional)
True to match any part of the string, not just the beginning
\n
Defaults to: false
caseSensitive : Boolean (optional)
True for case sensitive comparison.
\n
Defaults to: false

Returns

Ext.util.MixedCollection
The new filtered collection
\n

Ext.util.AbstractMixedCollection
view source

filterBy( fn, [scope] ) : Ext.util.MixedCollection

Filter by a function. ...

Filter by a function. Returns a new collection that has been filtered.\nThe passed function will be called with each object in the collection.\nIf the function returns true, the value is included otherwise it is filtered.

Available since: 1.1.0

Parameters

fn : Function
The function to be called.
\n
Parameters
- item : Mixed
  The collection item.
  \n
- key : String
  The key of collection item.
  \n
scope : Object (optional)
The scope (this reference) in\nwhich the function is executed. Defaults to this MixedCollection.
\n

Returns

Ext.util.MixedCollection
The new filtered collection
\n

Ext.util.AbstractMixedCollection
view source

find( )deprecated

Returns the first item in the collection which elicits a true return value from the passed selection function. ...

Returns the first item in the collection which elicits a true return value from the passed selection function.

This method has been deprecated since 4.0

Use findBy instead.

\n\n

Available since: 1.1.0

Ext.util.AbstractMixedCollection
view source

findBy( fn, [scope] ) : Object

Returns the first item in the collection which elicits a true return value from the\npassed selection function. ...

Returns the first item in the collection which elicits a true return value from the\npassed selection function.

Parameters

fn : Function
The selection function to execute for each item.
\n
Parameters
- item : Mixed
  The collection item.
  \n
- key : String
  The key of collection item.
  \n
scope : Object (optional)
The scope (this reference) in which the\nfunction is executed. Defaults to the browser window.
\n

Returns

Object
The first item in the collection which returned true from the selection\nfunction, or null if none was found.
\n

Ext.util.AbstractMixedCollection
view source

findIndex( property, value, [start], [anyMatch], [caseSensitive] ) : Number

Finds the index of the first matching object in this collection by a specific property/value. ...

Finds the index of the first matching object in this collection by a specific property/value.

Available since: 2.3.0

Parameters

property : String
The name of a property on your objects.
\n
value : String/RegExp
A string that the property values\nshould start with or a RegExp to test against the property.
\n
start : Number (optional)
The index to start searching at.
\n
Defaults to: 0
anyMatch : Boolean (optional)
True to match any part of the string, not just the beginning.
\n
Defaults to: false
caseSensitive : Boolean (optional)
True for case sensitive comparison.
\n
Defaults to: false

Returns

Number
The matched index or -1
\n

Ext.util.AbstractMixedCollection
view source

findIndexBy( fn, [scope], [start] ) : Number

Find the index of the first matching object in this collection by a function. ...

Find the index of the first matching object in this collection by a function.\nIf the function returns true it is considered a match.

Available since: 2.3.0

Parameters

fn : Function
The function to be called.
\n
Parameters
- item : Mixed
  The collection item.
  \n
- key : String
  The key of collection item.
  \n
scope : Object (optional)
The scope (this reference) in which the function is executed. Defaults to this MixedCollection.
\n
start : Number (optional)
The index to start searching at.
\n
Defaults to: 0

Returns

Number
The matched index or -1
\n

fireEvent( eventName, args ) : Boolean

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

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

\n\n

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

Parameters

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

Returns

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

fireEventArgs( eventName, args ) : Boolean

Fires the specified event with the passed parameter list. ...

Fires the specified event with the passed parameter list.

\n\n

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

Parameters

eventName : String
The name of the event to fire.
\n
args : Object[]
An array of parameters which are passed to handlers.
\n

Returns

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

Ext.util.AbstractMixedCollection
view source

first( ) : Object

Returns the first item in the collection. ...

Returns the first item in the collection.

Available since: 1.1.0

Returns

Object
the first item in the collection..
\n

Ext.util.AbstractMixedCollection
view source

get( key ) : Object

Returns the item associated with the passed key OR index. ...

Returns the item associated with the passed key OR index.\nKey has priority over index. This is the equivalent\nof calling getByKey first, then if nothing matched calling getAt.

Available since: 1.1.0

Parameters

key : String/Number
The key or index of the item.
\n

Returns

Object
If the item is found, returns the item. If the item was not found, returns undefined.\nIf an item was found, but is a Class, returns null.
\n

Ext.util.AbstractMixedCollection
view source

getAt( index ) : Object

Returns the item at the specified index. ...

Returns the item at the specified index.

Parameters

index : Number
The index of the item.
\n

Returns

Object
The item at the specified index.
\n

getBubbleParent( ) : Ext.util.Observableprivate

Gets the bubbling parent for an Observable ...

Gets the bubbling parent for an Observable

Returns

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

Ext.util.AbstractMixedCollection
view source

getByKey( key ) : Object

Returns the item associated with the passed key. ...

Returns the item associated with the passed key.

Parameters

key : String/Number
The key of the item.
\n

Returns

Object
The item associated with the passed key.
\n

getConfig( name )private

...

Parameters

name : Object
\n

Ext.util.AbstractMixedCollection
view source

getCount( ) : Number

Returns the number of items in the collection. ...

Returns the number of items in the collection.

Available since: 1.1.0

Returns

Number
the number of items in the collection.
\n

getInitialConfig( [name] ) : Object/Mixed

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

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

Parameters

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

Returns

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

Ext.util.AbstractMixedCollection
view source

getKey( item ) : Objecttemplate

A function which will be called, passing a newly added object\nwhen the object is added without a separate id. ...

A function which will be called, passing a newly added object\nwhen the object is added without a separate id. The function\nshould yield the key by which that object will be indexed.

\n\n

If no key is yielded, then the object will be added, but it\ncannot be accessed or removed quickly. Finding it in this\ncollection for interrogation or removal will require a linear\nscan of this collection's items.

\n\n

The default implementation simply returns item.id but you can\nprovide your own implementation to return a different value as\nin the following examples:

\n\n

// normal way\nvar mc = new Ext.util.MixedCollection();\nmc.add(someEl.dom.id, someEl);\nmc.add(otherEl.dom.id, otherEl);\n//and so on\n\n// using getKey\nvar mc = new Ext.util.MixedCollection({\n    getKey: function(el){\n        return el.dom.id;\n    }\n});\nmc.add(someEl);\nmc.add(otherEl);\n

Available since: 1.1.0

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

Parameters

item : Object
The item for which to find the key.
\n

Returns

Object
The key for the passed item.
\n

Ext.util.AbstractMixedCollection
view source

getRange( [startIndex], [endIndex] ) : Array

Returns a range of items in this collection ...

Returns a range of items in this collection

Available since: 1.1.0

Parameters

startIndex : Number (optional)
The starting index. Defaults to 0.
\n
endIndex : Number (optional)
The ending index. Defaults to the last item.
\n

Returns

Array
An array of items
\n

hasConfig( config )private

...

Parameters

config : Object
\n

hasListener( eventName ) : Boolean

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. ...

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer\nindicates whether the event needs firing or not.

Parameters

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

Returns

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

Ext.util.AbstractMixedCollection
view source

hasRange( start, end )private

For API parity with Store's PageMap class. ...

For API parity with Store's PageMap class. Buffered rendering checks if the Store has the range\nrequired to render. The Store delegates this question to its backing data object which may be an instance\nof its private PageMap class, or a MixedCollection.

Parameters

start : Object
\n
end : Object
\n

Ext.util.AbstractMixedCollection
view source

indexOf( o ) : Number

Returns index within the collection of the passed Object. ...

Returns index within the collection of the passed Object.

Available since: 1.1.0

Parameters

o : Object
The item to find the index of.
\n

Returns

Number
index of the item. Returns -1 if not found.
\n

Ext.util.AbstractMixedCollection
view source

indexOfKey( key ) : Number

Returns index within the collection of the passed key. ...

Returns index within the collection of the passed key.

Available since: 1.1.0

Parameters

key : String
The key to find the index of.
\n

Returns

Number
index of the key.
\n

initConfig( config ) : Ext.Basechainableprotected

Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

\n\n

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

Parameters

config : Object
\n

Returns

Ext.Base
this
\n

Ext.util.AbstractMixedCollection
view source

insert( index, key, [o] ) : Object

Inserts an item at the specified index in the collection. ...

Inserts an item at the specified index in the collection. Fires the add event when complete.

Available since: 1.1.0

Parameters

index : Number
The index to insert the item at.
\n
key : String/Object/String[]/Object[]
The key to associate with the new item, or the item itself.\nMay also be an array of either to insert multiple items at once.
\n
o : Object/Object[] (optional)
If the second parameter was a key, the new item.\nMay also be an array to insert multiple items at once.
\n

Returns

Object
The item inserted or an array of items inserted.
\n

Ext.util.AbstractMixedCollection
view source

last( ) : Object

Returns the last item in the collection. ...

Returns the last item in the collection.

Available since: 1.1.0

Returns

Object
the last item in the collection..
\n

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

Shorthand for addManagedListener. ...

Shorthand for addManagedListener.

\n\n

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

Parameters

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

Returns

Only when the destroyable option is specified.

\n\n\n\n\n

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

\n\n\n\n\n

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

\n\n\n\n\n

And when those listeners need to be removed:

\n\n\n\n\n

Ext.destroy(this.btnListeners);\n

\n\n\n\n\n

this.btnListeners.destroy();\n

\n\n

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

Shorthand for removeManagedListener. ...

Shorthand for removeManagedListener.

\n\n

Removes listeners that were added by the mon method.

Parameters

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

on( eventName, [fn], [scope], [options] ) : Object

Shorthand for addListener. ...

Shorthand for addListener.

\n\n

Appends an event handler to this object. For example:

\n\n

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

\n\n

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

\n\n

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

\n\n

One can also specify options for each event handler separately:

\n\n

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

\n\n

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

\n\n

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

Parameters

eventName : String/Object
The name of the event to listen for.\nMay also be an object who's property names are event names.
\n\n
fn : Function (optional)
The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.
\n\n
scope : Object (optional)
The scope (this reference) in which the handler function is\nexecuted. If omitted, defaults to the object which fired the event.
\n\n
options : Object (optional)
An object containing handler configuration.
\n\n\n\n\n
Note: Unlike in ExtJS 3.x, the options object will also be passed as the last\nargument to every event handler.
\n\n\n\n\n
This object may contain any of the following properties:
\n\n
- scope : Object
  The scope (this reference) in which the handler function is executed. If omitted,\n defaults to the object which fired the event.
  \n\n
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
  \n\n
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
  \n\n
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\n by the specified number of milliseconds. If the event fires again within that time,\n the original handler is not invoked, but the new handler is scheduled in its place.
  \n\n
- target : Ext.util.Observable
  Only call the handler if the event was fired on the target Observable, not if the event\n was bubbled up from a child Observable.
  \n\n
- element : String
  This option is only valid for listeners bound to Components.\n The name of a Component property which references an element to add a listener to.
  \n\n\n\n\n
  This option is useful during Component construction to add DOM event listeners to elements of\n Components which will exist only after the Component is rendered.\n For example, to add a click listener to a Panel's body:
  \n\n\n\n\n
```
  new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
```
  \n\n
- destroyable : Boolean (optional)
  When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.
  \n\n
  Defaults to: false
- priority : Number (optional)
  An optional numeric priority that determines the order in which event handlers\n are run. Event handlers with no priority will be run as if they had a priority\n of 0. Handlers with a higher priority will be prioritized to run sooner than\n those with a lower priority. Negative numbers can be used to set a priority\n lower than the default. Internally, the framework uses a range of 1000 or\n greater, and -1000 or lesser for handers that are intended to run before or\n after all others, so it is recommended to stay within the range of -999 to 999\n when setting the priority of event handlers in application-level code.
  \n\n\n\n\n
  Combining Options
  \n\n\n\n\n
  Using the options argument, it is possible to combine different types of listeners:
  \n\n\n\n\n
  A delayed, one-time listener.
  \n\n\n\n\n
```
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
```
  \n\n

Returns

Only when the destroyable option is specified.

\n\n\n\n\n

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

\n\n\n\n\n

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

\n\n\n\n\n

And when those listeners need to be removed:

\n\n\n\n\n

Ext.destroy(this.btnListeners);\n

\n\n\n\n\n

this.btnListeners.destroy();\n

\n\n

onConfigUpdate( names, callback, scope )private

...

Parameters

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

prepareClass( T )private

Prepares a given class for observable instances. ...

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

Parameters

T : Function
The class constructor to prepare.
\n

Ext.util.AbstractMixedCollection
view source

rebuildIndexMap( )private

...

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

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

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

\n\n

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

\n\n

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

\n\n

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

Parameters

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

Returns

Object
A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:
\n\n
```
this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');\n
```
\n\n
Can be undone by calling
\n\n
```
Ext.destroy(this.storeRelayers);\n
```
\n\n
or
\n\n
```
this.store.relayers.destroy();\n
```
\n

Ext.util.AbstractMixedCollection
view source

remove( o ) : Object

Remove an item from the collection. ...

Remove an item from the collection.

Available since: 1.1.0

Parameters

o : Object
The item to remove.
\n

Returns

Object
The item removed or false if no item was removed.
\n

Ext.util.AbstractMixedCollection
view source

removeAll( [items] ) : Ext.util.MixedCollection

Remove all items in the collection. ...

Remove all items in the collection. Can also be used\nto remove only the items in the passed array.

Parameters

items : Array (optional)
An array of items to be removed.
\n

Returns

Ext.util.MixedCollection
this object
\n

Ext.util.AbstractMixedCollection
view source

removeAt( index ) : Object

Remove an item from a specified index in the collection. ...

Remove an item from a specified index in the collection. Fires the remove event when complete.

Available since: 1.1.0

Parameters

index : Number
The index within the collection of the item to remove.
\n

Returns

Object
The item removed or false if no item was removed.
\n

Ext.util.AbstractMixedCollection
view source

removeAtKey( key ) : Object

Removes an item associated with the passed key fom the collection. ...

Removes an item associated with the passed key fom the collection.

Parameters

key : String
The key of the item to remove. If null is passed,\nall objects which yielded no key from the configured getKey function are removed.
\n

Returns

Object
Only returned if removing at a specified key. The item removed or false if no item was removed.
\n

removeListener( eventName, fn, [scope] )

Removes an event handler. ...

Removes an event handler.

Parameters

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

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

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

Removes listeners that were added by the mon method.

Parameters

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

removeManagedListenerItem( isClear, managedListener )private

Remove a single managed listener item ...

Remove a single managed listener item

Parameters

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

Ext.util.AbstractMixedCollection
view source

removeRange( index, [removeCount] ) : Object

Remove a range of items starting at a specified index in the collection. ...

Remove a range of items starting at a specified index in the collection.\nDoes not fire the remove event.

Parameters

index : Number
The index within the collection of the item to remove.
\n
removeCount : Number (optional)
The nuber of items to remove beginning at the specified index.
\n
Defaults to: 1

Returns

Object
The last item removed or false if no item was removed.
\n

Ext.util.AbstractMixedCollection
view source

replace( key, o ) : Object

Replaces an item in the collection. ...

Replaces an item in the collection. Fires the replace event when complete.

Available since: 1.1.0

Parameters

key : String
The key associated with the item to replace, or the replacement item.
\n\n
If you supplied a getKey implementation for this MixedCollection, or if the key\nof your stored items is in a property called id, then the MixedCollection\nwill be able to derive the key of the replacement item. If you want to replace an item\nwith one having the same key value, then just pass the replacement item in this parameter.
\n
o : Object
{Object} o (optional) If the first parameter passed was a key, the item to associate\nwith that key.
\n

Returns

Object
The new item.
\n

resumeEvent( eventName )

Resumes firing of the named event(s). ...

Resumes firing of the named event(s).

\n\n

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

\n\n

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

Parameters

eventName : String...
Multiple event names to resume.
\n

resumeEvents( )

Resumes firing events (see suspendEvents). ...

Resumes firing events (see suspendEvents).

\n\n

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

setConfig( config, applyIfNotSet ) : Ext.Basechainableprivate

...

Parameters

config : Object
\n
applyIfNotSet : Object
\n

Returns

Ext.Base
this
\n

statics( ) : Ext.Classprotected

Get the reference to the class from which this object was instantiated. ...

Get the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time

\n\n

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

Returns

Ext.Class
\n

Ext.util.AbstractMixedCollection
view source

sum( property, [root], [start], [end] ) : Number

Collects all of the values of the given property and returns their sum ...

Collects all of the values of the given property and returns their sum

Parameters

property : String
The property to sum by
\n
root : String (optional)
'root' property to extract the first argument from. This is used mainly when\nsumming fields in records, where the fields are all stored inside the 'data' object
\n
start : Number (optional)
The record index to start at
\n
Defaults to: 0
end : Number (optional)
The record index to end at
\n
Defaults to: -1

Returns

Number
The total
\n

suspendEvent( eventName )

Suspends firing of the named event(s). ...

Suspends firing of the named event(s).

\n\n

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

\n\n

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

Parameters

eventName : String...
Multiple event names to suspend.
\n

suspendEvents( queueSuspended )

Suspends the firing of all events. ...

Suspends the firing of all events. (see resumeEvents)

Parameters

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

un( eventName, fn, [scope] )

Shorthand for removeListener. ...

Shorthand for removeListener.

\n\n

Removes an event handler.

Parameters

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

Ext.util.AbstractMixedCollection
view source

updateKey( oldKey, newKey )

Change the key for an existing item in the collection. ...

Change the key for an existing item in the collection. If the old key\ndoes not exist this is a no-op.

Parameters

oldKey : Object
The old key
\n
newKey : Object
The new key
\n

Defined By

Static Methods

addConfig( config )privatestatic

...

Parameters

config : Object
\n

addInheritableStatics( members )chainableprivatestatic

...

Parameters

members : Object
\n

addMember( name, member )chainableprivatestatic

...

Parameters

name : Object
\n
member : Object
\n

addMembers( members )chainablestatic

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

Add methods / properties to the prototype of this class.

\n\n

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

Parameters

members : Object
\n

addStatics( members ) : Ext.Basechainablestatic

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

Add / override static properties of this class.

\n\n

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

Parameters

members : Object
\n

Returns

Ext.Base
this
\n

addXtype( xtype )chainableprivatestatic

...

Parameters

xtype : Object
\n

borrow( fromClass, members ) : Ext.Basechainableprivatestatic

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

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

\n\n

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

Parameters

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

Returns

Ext.Base
this
\n

create( ) : Objectstatic

Create a new instance of this Class. ...

Create a new instance of this Class.

\n\n

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

\n\n

All parameters are passed to the constructor of the class.

Returns

Object
the created instance.
\n

createAlias( alias, origin )static

Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

\n\n

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

Parameters

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

extend( config )privatestatic

...

Parameters

config : Object
\n

getName( ) : Stringstatic

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

Get the current class' name in string format.

\n\n

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

Returns

String
className
\n

implement( )deprecatedstatic

Adds members to class. ...

Adds members to class.

This method has been deprecated since 4.1

Use addMembers instead.

\n\n

mixin( name, mixinClass )privatestatic

Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Parameters

name : Object
\n
mixinClass : Object
\n

onExtended( fn, scope )chainableprivatestatic

...

Parameters

fn : Object
\n
scope : Object
\n

override( members ) : Ext.Basechainabledeprecatedstatic

Override members of this class. ...

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

\n\n

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

\n\n

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

\n\n

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

\n\n

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

This method has been deprecated since 4.1.0

Use Ext.define instead

\n\n

Parameters

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

Returns

Ext.Base
this class
\n