X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..HEAD:/docs/output/Ext.data.StoreManager.js diff --git a/docs/output/Ext.data.StoreManager.js b/docs/output/Ext.data.StoreManager.js index 06f2b467..41b13655 100644 --- a/docs/output/Ext.data.StoreManager.js +++ b/docs/output/Ext.data.StoreManager.js @@ -1,2625 +1 @@ -Ext.data.JsonP.Ext_data_StoreManager({ - "allMixins": [ - "Ext.util.Sortable", - "Ext.util.Observable" - ], - "deprecated": null, - "docauthor": "Evan Trimboli ", - "members": { - "cfg": [ - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-cfg-allowFunctions", - "shortDoc": "Specify true if the addAll\nfunction should add function references to the collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "name": "allowFunctions", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

Specify true if the addAll\nfunction should add function references to the collection. Defaults to\nfalse.

\n", - "linenr": 62, - "html_filename": "AbstractMixedCollection.html" - }, - { - "type": "Object", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Observable.html#Ext-util-Observable-cfg-listeners", - "shortDoc": "A config object containing one or more event handlers to be added to this object during initialization. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "name": "listeners", - "owner": "Ext.util.Observable", - "doc": "

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 ExtJS Components

\n\n

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

\n\n
new Ext.panel.Panel({\n    width: 400,\n    height: 200,\n    dockedItems: [{\n        xtype: 'toolbar'\n    }],\n    listeners: {\n        click: {\n            element: 'el', //bind to the underlying el property on the panel\n            fn: function(){ console.log('click el'); }\n        },\n        dblclick: {\n            element: 'body', //bind to the underlying body property on the panel\n            fn: function(){ console.log('dblclick body'); }\n        }\n    }\n});\n
\n", - "linenr": 102, - "html_filename": "Observable.html" - } - ], - "method": [ - { - "deprecated": null, - "alias": null, - "href": "MixedCollection.html#Ext-util-MixedCollection-method-constructor", - "tagname": "method", - "protected": false, - "shortDoc": "Creates new MixedCollection. ...", - "static": false, - "params": [ - { - "type": "Boolean", - "optional": false, - "doc": "

Specify true if the addAll\nfunction should add function references to the collection. Defaults to\nfalse.

\n", - "name": "allowFunctions" - }, - { - "type": "Function", - "optional": false, - "doc": "

A function that can accept an item of the type(s) stored in this MixedCollection\nand return the key value for that item. This is used when available to look up the key on items that\nwere passed without an explicit key parameter to a MixedCollection method. Passing this parameter is\nequivalent to providing an implementation for the getKey method.

\n", - "name": "keyFn" - } - ], - "private": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/MixedCollection.js", - "doc": "

Creates new MixedCollection.

\n", - "owner": "Ext.util.MixedCollection", - "name": "StoreManager", - "html_filename": "MixedCollection.html", - "return": { - "type": "Object", - "doc": "\n" - }, - "linenr": 40 - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-add", - "shortDoc": "Adds an item to the collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The key to associate with the item, or the new item.

\n\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\n", - "name": "key" - }, - { - "type": "Object", - "optional": false, - "doc": "

The item to add.

\n", - "name": "o" - } - ], - "name": "add", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

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

\n", - "linenr": 69, - "return": { - "type": "Object", - "doc": "

The item added.

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-addAll", - "shortDoc": "Adds all elements of an Array or an Object to the collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "Object/Array", - "optional": false, - "doc": "

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", - "name": "objs" - } - ], - "name": "addAll", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

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

\n", - "linenr": 166, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-addEvents", - "shortDoc": "Adds the specified events to the list of events which this Observable may fire. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Object/String", - "optional": false, - "doc": "

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

\n\n
this.addEvents({\n    storeloaded: true,\n    storecleared: true\n});\n
\n", - "name": "o" - }, - { - "type": "String...", - "optional": false, - "doc": "

Optional additional event names if multiple event names are being passed as separate\nparameters. Usage:

\n\n
this.addEvents('storeloaded', 'storecleared');\n
\n", - "name": "more" - } - ], - "name": "addEvents", - "owner": "Ext.util.Observable", - "doc": "

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

\n", - "linenr": 494, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-addListener", - "shortDoc": "Appends an event handler to this object. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The name of the event to listen for. May also be an object who's property names are\nevent names.

\n", - "name": "eventName" - }, - { - "type": "Function", - "optional": false, - "doc": "

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

\n", - "name": "handler" - }, - { - "type": "Object", - "optional": true, - "doc": "

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

\n", - "name": "scope" - }, - { - "type": "Object", - "optional": true, - "doc": "

(optional) An object containing handler configuration.

\n\n

Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

\n\n

This object may contain any of the following properties:

\n\n\n\n\n

Combining Options

\n\n

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

\n\n

A delayed, one-time listener.

\n\n
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
\n\n

Attaching multiple handlers in 1 call

\n\n

The method also allows for a single argument to be passed which is a config object containing properties which\nspecify 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", - "name": "options" - } - ], - "name": "addListener", - "owner": "Ext.util.Observable", - "doc": "

Appends an event handler to this object.

\n", - "linenr": 278, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-addManagedListener", - "shortDoc": "Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Observable/Element", - "optional": false, - "doc": "

The item to which to add a listener/listeners.

\n", - "name": "item" - }, - { - "type": "Object/String", - "optional": false, - "doc": "

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

\n", - "name": "ename" - }, - { - "type": "Function", - "optional": true, - "doc": "

(optional) If the ename parameter was an event name, this is the handler function.

\n", - "name": "fn" - }, - { - "type": "Object", - "optional": true, - "doc": "

(optional) If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

\n", - "name": "scope" - }, - { - "type": "Object", - "optional": true, - "doc": "

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

\n", - "name": "opt" - } - ], - "name": "addManagedListener", - "owner": "Ext.util.Observable", - "doc": "

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

\n", - "linenr": 156, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-addStatics", - "shortDoc": "Add / override static properties of this class. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "members" - } - ], - "name": "addStatics", - "owner": "Ext.Base", - "doc": "

Add / override static properties of this class.

\n\n
Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.addStatics({\n    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'\n    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };\n    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };\n});\n
\n", - "linenr": 388, - "return": { - "type": "Ext.Base", - "doc": "

this

\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-callOverridden", - "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n constructo...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "Array/Arguments", - "optional": false, - "doc": "

The arguments, either an array or the arguments object

\n", - "name": "args" - } - ], - "name": "callOverridden", - "owner": "Ext.Base", - "doc": "

Call the original method that was previously overridden with Ext.Base.override

\n\n
Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\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", - "linenr": 269, - "return": { - "type": "Mixed", - "doc": "

Returns the result after calling the overridden method

\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": true, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-callParent", - "shortDoc": "Call the parent's overridden method. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "Array/Arguments", - "optional": false, - "doc": "

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

\n", - "name": "args" - } - ], - "name": "callParent", - "owner": "Ext.Base", - "doc": "

Call the parent's overridden method. For example:

\n\n
Ext.define('My.own.A', {\n    constructor: function(test) {\n        alert(test);\n    }\n});\n\nExt.define('My.own.B', {\n    extend: 'My.own.A',\n\n    constructor: function(test) {\n        alert(test);\n\n        this.callParent([test + 1]);\n    }\n});\n\nExt.define('My.own.C', {\n    extend: 'My.own.B',\n\n    constructor: function() {\n        alert(\"Going to call parent's overriden constructor...\");\n\n        this.callParent(arguments);\n    }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n                         // alerts '2', then alerts '3'\n
\n", - "linenr": 124, - "return": { - "type": "Mixed", - "doc": "

Returns the result from the superclass' method

\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-capture", - "shortDoc": "Starts capture on the specified Observable. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Observable", - "optional": false, - "doc": "

The Observable to capture events from.

\n", - "name": "o" - }, - { - "type": "Function", - "optional": false, - "doc": "

The function to call when an event is fired.

\n", - "name": "fn" - }, - { - "type": "Object", - "optional": true, - "doc": "

(optional) The scope (this reference) in which the function is executed. Defaults to\nthe Observable firing the event.

\n", - "name": "scope" - } - ], - "name": "capture", - "owner": "Ext.util.Observable", - "doc": "

Starts capture on the specified Observable. All events will be passed to the supplied function with the event\nname + standard signature of the event before the event is fired. If the supplied function returns false,\nthe event will not fire.

\n", - "linenr": 54, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-clear", - "shortDoc": "Removes all items from the collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - - ], - "name": "clear", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

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

\n", - "linenr": 435, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-clearListeners", - "shortDoc": "Removes all listeners for this object including the managed listeners ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - - ], - "name": "clearListeners", - "owner": "Ext.util.Observable", - "doc": "

Removes all listeners for this object including the managed listeners

\n", - "linenr": 425, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners", - "shortDoc": "Removes all managed listeners for this object. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - - ], - "name": "clearManagedListeners", - "owner": "Ext.util.Observable", - "doc": "

Removes all managed listeners for this object.

\n", - "linenr": 454, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-clone", - "shortDoc": "Creates a shallow copy of this collection ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - - ], - "name": "clone", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

Creates a shallow copy of this collection

\n", - "linenr": 727, - "return": { - "type": "MixedCollection", - "doc": "\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-collect", - "shortDoc": "Collects unique values of a particular property in this MixedCollection ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The property to collect on

\n", - "name": "property" - }, - { - "type": "String", - "optional": false, - "doc": "

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", - "name": "root" - }, - { - "type": "Boolean", - "optional": true, - "doc": "

(optional) Pass true to allow null, undefined or empty string values

\n", - "name": "allowBlank" - } - ], - "name": "collect", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

Collects unique values of a particular property in this MixedCollection

\n", - "linenr": 489, - "return": { - "type": "Array", - "doc": "

The unique values

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-contains", - "shortDoc": "Returns true if the collection contains the passed Object as an item. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

The Object to look for in the collection.

\n", - "name": "o" - } - ], - "name": "contains", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

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

\n", - "linenr": 417, - "return": { - "type": "Boolean", - "doc": "

True if the collection contains the Object as an item.

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-containsKey", - "shortDoc": "Returns true if the collection contains the passed Object as a key. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The key to look for in the collection.

\n", - "name": "key" - } - ], - "name": "containsKey", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

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

\n", - "linenr": 426, - "return": { - "type": "Boolean", - "doc": "

True if the collection contains the Object as a key.

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-create", - "shortDoc": "Create a new instance of this Class. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - - ], - "name": "create", - "owner": "Ext.Base", - "doc": "

Create a new instance of this Class.

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

All parameters are passed to the constructor of the class.

\n", - "linenr": 329, - "return": { - "type": "Object", - "doc": "

the created instance.

\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-createAlias", - "shortDoc": "Create aliases for existing prototype methods. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "String/Object", - "optional": false, - "doc": "

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

\n", - "name": "alias" - }, - { - "type": "String/Object", - "optional": false, - "doc": "

The original method name

\n", - "name": "origin" - } - ], - "name": "createAlias", - "owner": "Ext.Base", - "doc": "

Create aliases for existing prototype methods. Example:

\n\n
Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\n", - "linenr": 648, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-each", - "shortDoc": "Executes the specified function once for every item in the collection, passing the following arguments:\n\n\nitem : Mixe...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "Function", - "optional": false, - "doc": "

The function to execute for each item.

\n", - "name": "fn" - }, - { - "type": "Object", - "optional": true, - "doc": "

(optional) The scope (this reference) in which the function is executed. Defaults to the current item in the iteration.

\n", - "name": "scope" - } - ], - "name": "each", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

Executes the specified function once for every item in the collection, passing the following arguments:

\n\n
\n\n\n

The function should return a boolean value. Returning false from the function will stop the iteration.

\n", - "linenr": 196, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-eachKey", - "shortDoc": "Executes the specified function once for every key in the collection, passing each\nkey, and its associated item as th...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "Function", - "optional": false, - "doc": "

The function to execute for each item.

\n", - "name": "fn" - }, - { - "type": "Object", - "optional": true, - "doc": "

(optional) The scope (this reference) in which the function is executed. Defaults to the browser window.

\n", - "name": "scope" - } - ], - "name": "eachKey", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

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

\n", - "linenr": 221, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-enableBubble", - "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "String/[String]", - "optional": false, - "doc": "

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

\n", - "name": "events" - } - ], - "name": "enableBubble", - "owner": "Ext.util.Observable", - "doc": "

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.override(Ext.form.field.Base, {\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n        this.enableBubble('change');\n    }),\n\n    //  We know that we want Field's events to bubble directly to the FormPanel.\n    getBubbleTarget : function() {\n        if (!this.formPanel) {\n            this.formPanel = this.findParentByType('form');\n        }\n        return this.formPanel;\n    }\n});\n\nvar myForm = new Ext.formPanel({\n    title: 'User Details',\n    items: [{\n        ...\n    }],\n    listeners: {\n        change: function() {\n            // Title goes red if form has been modified.\n            myForm.header.setStyle('color', 'red');\n        }\n    }\n});\n
\n", - "linenr": 609, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-filter", - "shortDoc": "Filters the objects in this collection by a set of Filters, or by a single\nproperty/value pair with optional paramete...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "Array/String", - "optional": false, - "doc": "

A property on your objects, or an array of Filter objects

\n", - "name": "property" - }, - { - "type": "String/RegExp", - "optional": false, - "doc": "

Either string that the property values\nshould start with or a RegExp to test against the property

\n", - "name": "value" - }, - { - "type": "Boolean", - "optional": true, - "doc": "

(optional) True to match any part of the string, not just the beginning

\n", - "name": "anyMatch" - }, - { - "type": "Boolean", - "optional": true, - "doc": "

(optional) True for case sensitive comparison (defaults to False).

\n", - "name": "caseSensitive" - } - ], - "name": "filter", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

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\nvar people = new Ext.util.MixedCollection();\npeople.addAll([\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//a new MixedCollection containing only the items where age == 24\nvar middleAged = people.filter('age', 24);\n
\n\n", - "linenr": 566, - "return": { - "type": "MixedCollection", - "doc": "

The new filtered collection

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-filterBy", - "shortDoc": "Filter by a function. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "Function", - "optional": false, - "doc": "

The function to be called, it will receive the args o (the object), k (the key)

\n", - "name": "fn" - }, - { - "type": "Object", - "optional": true, - "doc": "

(optional) The scope (this reference) in which the function is executed. Defaults to this MixedCollection.

\n", - "name": "scope" - } - ], - "name": "filterBy", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

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.

\n", - "linenr": 630, - "return": { - "type": "MixedCollection", - "doc": "

The new filtered collection

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-findBy", - "shortDoc": "Returns the first item in the collection which elicits a true return value from the\npassed selection function. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "Function", - "optional": false, - "doc": "

The selection function to execute for each item.

\n", - "name": "fn" - }, - { - "type": "Object", - "optional": true, - "doc": "

(optional) The scope (this reference) in which the function is executed. Defaults to the browser window.

\n", - "name": "scope" - } - ], - "name": "findBy", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

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

\n", - "linenr": 238, - "return": { - "type": "Object", - "doc": "

The first item in the collection which returned true from the selection function.

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-findIndex", - "shortDoc": "Finds the index of the first matching object in this collection by a specific property/value. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The name of a property on your objects.

\n", - "name": "property" - }, - { - "type": "String/RegExp", - "optional": false, - "doc": "

A string that the property values\nshould start with or a RegExp to test against the property.

\n", - "name": "value" - }, - { - "type": "Number", - "optional": true, - "doc": "

(optional) The index to start searching at (defaults to 0).

\n", - "name": "start" - }, - { - "type": "Boolean", - "optional": true, - "doc": "

(optional) True to match any part of the string, not just the beginning.

\n", - "name": "anyMatch" - }, - { - "type": "Boolean", - "optional": true, - "doc": "

(optional) True for case sensitive comparison.

\n", - "name": "caseSensitive" - } - ], - "name": "findIndex", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

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

\n", - "linenr": 657, - "return": { - "type": "Number", - "doc": "

The matched index or -1

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-findIndexBy", - "shortDoc": "Find the index of the first matching object in this collection by a function. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "Function", - "optional": false, - "doc": "

The function to be called, it will receive the args o (the object), k (the key).

\n", - "name": "fn" - }, - { - "type": "Object", - "optional": true, - "doc": "

(optional) The scope (this reference) in which the function is executed. Defaults to this MixedCollection.

\n", - "name": "scope" - }, - { - "type": "Number", - "optional": true, - "doc": "

(optional) The index to start searching at (defaults to 0).

\n", - "name": "start" - } - ], - "name": "findIndexBy", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

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

\n", - "linenr": 677, - "return": { - "type": "Number", - "doc": "

The matched index or -1

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-fireEvent", - "shortDoc": "Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The name of the event to fire.

\n", - "name": "eventName" - }, - { - "type": "Object...", - "optional": false, - "doc": "

Variable number of parameters are passed to handlers.

\n", - "name": "args" - } - ], - "name": "fireEvent", - "owner": "Ext.util.Observable", - "doc": "

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

\n\n

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

\n", - "linenr": 233, - "return": { - "type": "Boolean", - "doc": "

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

\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-first", - "shortDoc": "Returns the first item in the collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - - ], - "name": "first", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

Returns the first item in the collection.

\n", - "linenr": 448, - "return": { - "type": "Object", - "doc": "

the first item in the collection..

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-get", - "shortDoc": "Returns the item associated with the passed key OR index. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "String/Number", - "optional": false, - "doc": "

The key or index of the item.

\n", - "name": "key" - } - ], - "name": "get", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

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

\n", - "linenr": 384, - "return": { - "type": "Object", - "doc": "

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" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-getAt", - "shortDoc": "Returns the item at the specified index. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "Number", - "optional": false, - "doc": "

The index of the item.

\n", - "name": "index" - } - ], - "name": "getAt", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

Returns the item at the specified index.

\n", - "linenr": 399, - "return": { - "type": "Object", - "doc": "

The item at the specified index.

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-getByKey", - "shortDoc": "Returns the item associated with the passed key. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "String/Number", - "optional": false, - "doc": "

The key of the item.

\n", - "name": "key" - } - ], - "name": "getByKey", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

Returns the item associated with the passed key.

\n", - "linenr": 408, - "return": { - "type": "Object", - "doc": "

The item associated with the passed key.

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-getCount", - "shortDoc": "Returns the number of items in the collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - - ], - "name": "getCount", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

Returns the number of items in the collection.

\n", - "linenr": 358, - "return": { - "type": "Number", - "doc": "

the number of items in the collection.

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-getKey", - "shortDoc": "MixedCollection has a generic way to fetch keys if you implement getKey. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

The item for which to find the key.

\n", - "name": "item" - } - ], - "name": "getKey", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

MixedCollection has a generic way to fetch keys if you implement getKey. The default implementation\nsimply returns item.id but you can provide your own implementation\nto return a different value as in 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();\nmc.getKey = function(el){\n   return el.dom.id;\n};\nmc.add(someEl);\nmc.add(otherEl);\n\n// or via the constructor\nvar mc = new Ext.util.MixedCollection(false, function(el){\n   return el.dom.id;\n});\nmc.add(someEl);\nmc.add(otherEl);\n
\n\n", - "linenr": 103, - "return": { - "type": "Object", - "doc": "

The key for the passed item.

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-getName", - "shortDoc": "Get the current class' name in string format. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - - ], - "name": "getName", - "owner": "Ext.Base", - "doc": "

Get the current class' name in string format.

\n\n
Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\n", - "linenr": 631, - "return": { - "type": "String", - "doc": "

className

\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-getRange", - "shortDoc": "Returns a range of items in this collection ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "Number", - "optional": true, - "doc": "

(optional) The starting index. Defaults to 0.

\n", - "name": "startIndex" - }, - { - "type": "Number", - "optional": true, - "doc": "

(optional) The ending index. Defaults to the last item.

\n", - "name": "endIndex" - } - ], - "name": "getRange", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

Returns a range of items in this collection

\n", - "linenr": 536, - "return": { - "type": "Array", - "doc": "

An array of items

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-hasListener", - "shortDoc": "Checks to see if this object has any listeners for a specified event ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The name of the event to check for

\n", - "name": "eventName" - } - ], - "name": "hasListener", - "owner": "Ext.util.Observable", - "doc": "

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

\n", - "linenr": 530, - "return": { - "type": "Boolean", - "doc": "

True if the event is being listened for, else false

\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-implement", - "shortDoc": "Add methods / properties to the prototype of this class. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "members" - } - ], - "name": "implement", - "owner": "Ext.Base", - "doc": "

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.implement({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\n", - "linenr": 415, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-indexOf", - "shortDoc": "Returns index within the collection of the passed Object. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

The item to find the index of.

\n", - "name": "o" - } - ], - "name": "indexOf", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

Returns index within the collection of the passed Object.

\n", - "linenr": 366, - "return": { - "type": "Number", - "doc": "

index of the item. Returns -1 if not found.

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-indexOfKey", - "shortDoc": "Returns index within the collection of the passed key. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The key to find the index of.

\n", - "name": "key" - } - ], - "name": "indexOfKey", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

Returns index within the collection of the passed key.

\n", - "linenr": 375, - "return": { - "type": "Number", - "doc": "

index of the key.

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": true, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-initConfig", - "shortDoc": "Initialize configuration for this class. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "config" - } - ], - "name": "initConfig", - "owner": "Ext.Base", - "doc": "

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        return this;\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\n", - "linenr": 63, - "return": { - "type": "Object", - "doc": "

mixins The mixin prototypes as key - value pairs

\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Sortable.html#Ext-util-Sortable-method-initSortable", - "shortDoc": "Performs initialization of this mixin. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sortable.js", - "private": false, - "params": [ - - ], - "name": "initSortable", - "owner": "Ext.util.Sortable", - "doc": "

Performs initialization of this mixin. Component classes using this mixin should call this method\nduring their own initialization.

\n", - "linenr": 36, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Sortable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-insert", - "shortDoc": "Inserts an item at the specified index in the collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "Number", - "optional": false, - "doc": "

The index to insert the item at.

\n", - "name": "index" - }, - { - "type": "String", - "optional": false, - "doc": "

The key to associate with the new item, or the item itself.

\n", - "name": "key" - }, - { - "type": "Object", - "optional": true, - "doc": "

(optional) If the second parameter was a key, the new item.

\n", - "name": "o" - } - ], - "name": "insert", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

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

\n", - "linenr": 268, - "return": { - "type": "Object", - "doc": "

The item inserted.

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-last", - "shortDoc": "Returns the last item in the collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - - ], - "name": "last", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

Returns the last item in the collection.

\n", - "linenr": 456, - "return": { - "type": "Object", - "doc": "

the last item in the collection..

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "StoreManager.html#Ext-data-StoreManager-method-lookup", - "shortDoc": "Gets a registered Store by id ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/StoreManager.js", - "private": false, - "params": [ - { - "type": "String/Object", - "optional": false, - "doc": "

The id of the Store, or a Store instance, or a store configuration

\n", - "name": "id" - } - ], - "name": "lookup", - "owner": "Ext.data.StoreManager", - "doc": "

Gets a registered Store by id

\n", - "linenr": 70, - "return": { - "type": "Ext.data.Store", - "doc": "\n" - }, - "html_filename": "StoreManager.html" - }, - { - "deprecated": null, - "alias": { - "tagname": "alias", - "cls": "Ext.util.Observable", - "doc": null, - "owner": "addManagedListener" - }, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-mon", - "shortDoc": "Shorthand for addManagedListener. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Observable/Element", - "optional": false, - "doc": "

The item to which to add a listener/listeners.

\n", - "name": "item" - }, - { - "type": "Object/String", - "optional": false, - "doc": "

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

\n", - "name": "ename" - }, - { - "type": "Function", - "optional": true, - "doc": "

(optional) If the ename parameter was an event name, this is the handler function.

\n", - "name": "fn" - }, - { - "type": "Object", - "optional": true, - "doc": "

(optional) If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

\n", - "name": "scope" - }, - { - "type": "Object", - "optional": true, - "doc": "

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

\n", - "name": "opt" - } - ], - "name": "mon", - "owner": "Ext.util.Observable", - "doc": "

Shorthand for addManagedListener.

\n\n

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

\n", - "linenr": 681, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": { - "tagname": "alias", - "cls": "Ext.util.Observable", - "doc": null, - "owner": "removeManagedListener" - }, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-mun", - "shortDoc": "Shorthand for removeManagedListener. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Observable|Element", - "optional": false, - "doc": "

The item from which to remove a listener/listeners.

\n", - "name": "item" - }, - { - "type": "Object|String", - "optional": false, - "doc": "

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

\n", - "name": "ename" - }, - { - "type": "Function", - "optional": false, - "doc": "

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

\n", - "name": "fn" - }, - { - "type": "Object", - "optional": false, - "doc": "

Optional. If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

\n", - "name": "scope" - } - ], - "name": "mun", - "owner": "Ext.util.Observable", - "doc": "

Shorthand for removeManagedListener.

\n\n

Removes listeners that were added by the mon method.

\n", - "linenr": 687, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-observe", - "shortDoc": "Sets observability on the passed class constructor. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Function", - "optional": false, - "doc": "

The class constructor to make observable.

\n", - "name": "c" - }, - { - "type": "Object", - "optional": false, - "doc": "

An object containing a series of listeners to add. See addListener.

\n", - "name": "listeners" - } - ], - "name": "observe", - "owner": "Ext.util.Observable", - "doc": "

Sets observability on the passed class constructor.

\n\n

This makes any event fired on any instance of the passed class also fire a single event through\nthe class allowing for central handling of events on many instances at once.

\n\n

Usage:

\n\n
Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n    console.log('Ajax request made to ' + options.url);\n});\n
\n", - "linenr": 69, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": { - "tagname": "alias", - "cls": "Ext.util.Observable", - "doc": null, - "owner": "addListener" - }, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-on", - "shortDoc": "Shorthand for addListener. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The name of the event to listen for. May also be an object who's property names are\nevent names.

\n", - "name": "eventName" - }, - { - "type": "Function", - "optional": false, - "doc": "

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

\n", - "name": "handler" - }, - { - "type": "Object", - "optional": true, - "doc": "

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

\n", - "name": "scope" - }, - { - "type": "Object", - "optional": true, - "doc": "

(optional) An object containing handler configuration.

\n\n

Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

\n\n

This object may contain any of the following properties:

\n\n\n\n\n

Combining Options

\n\n

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

\n\n

A delayed, one-time listener.

\n\n
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
\n\n

Attaching multiple handlers in 1 call

\n\n

The method also allows for a single argument to be passed which is a config object containing properties which\nspecify 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", - "name": "options" - } - ], - "name": "on", - "owner": "Ext.util.Observable", - "doc": "

Shorthand for addListener.

\n\n

Appends an event handler to this object.

\n", - "linenr": 669, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-override", - "shortDoc": "Override prototype members of this class. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "members" - } - ], - "name": "override", - "owner": "Ext.Base", - "doc": "

Override prototype members of this class. Overridden methods can be invoked via\nExt.Base.callOverridden

\n\n
Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n\n        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\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", - "linenr": 518, - "return": { - "type": "Ext.Base", - "doc": "

this

\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "StoreManager.html#Ext-data-StoreManager-method-register", - "shortDoc": "Registers one or more Stores with the StoreManager. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/StoreManager.js", - "private": false, - "params": [ - { - "type": "Ext.data.Store", - "optional": false, - "doc": "

A Store instance

\n", - "name": "store1" - }, - { - "type": "Ext.data.Store", - "optional": true, - "doc": "

(optional)

\n", - "name": "store2" - }, - { - "type": "Ext.data.Store", - "optional": true, - "doc": "

... (optional)

\n", - "name": "etc" - } - ], - "name": "register", - "owner": "Ext.data.StoreManager", - "doc": "

Registers one or more Stores with the StoreManager. You do not normally need to register stores\nmanually. Any store initialized with a Ext.data.Store.storeId will be auto-registered.

\n", - "linenr": 45, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "StoreManager.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-relayEvents", - "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

The Observable whose events this object is to relay.

\n", - "name": "origin" - }, - { - "type": "[String]", - "optional": false, - "doc": "

Array of event names to relay.

\n", - "name": "events" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "prefix" - } - ], - "name": "relayEvents", - "owner": "Ext.util.Observable", - "doc": "

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

\n", - "linenr": 573, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-releaseCapture", - "shortDoc": "Removes all added captures from the Observable. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Observable", - "optional": false, - "doc": "

The Observable to release

\n", - "name": "o" - } - ], - "name": "releaseCapture", - "owner": "Ext.util.Observable", - "doc": "

Removes all added captures from the Observable.

\n", - "linenr": 44, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-remove", - "shortDoc": "Remove an item from the collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

The item to remove.

\n", - "name": "o" - } - ], - "name": "remove", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

Remove an item from the collection.

\n", - "linenr": 302, - "return": { - "type": "Object", - "doc": "

The item removed or false if no item was removed.

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-removeAll", - "shortDoc": "Remove all items in the passed array from the collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "Array", - "optional": false, - "doc": "

An array of items to be removed.

\n", - "name": "items" - } - ], - "name": "removeAll", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

Remove all items in the passed array from the collection.

\n", - "linenr": 311, - "return": { - "type": "Ext.util.MixedCollection", - "doc": "

this object

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-removeAt", - "shortDoc": "Remove an item from a specified index in the collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "Number", - "optional": false, - "doc": "

The index within the collection of the item to remove.

\n", - "name": "index" - } - ], - "name": "removeAt", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

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

\n", - "linenr": 324, - "return": { - "type": "Object", - "doc": "

The item removed or false if no item was removed.

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-removeAtKey", - "shortDoc": "Removed an item associated with the passed key fom the collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The key of the item to remove.

\n", - "name": "key" - } - ], - "name": "removeAtKey", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

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

\n", - "linenr": 349, - "return": { - "type": "Object", - "doc": "

The item removed or false if no item was removed.

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-removeListener", - "shortDoc": "Removes an event handler. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The type of event the handler was associated with.

\n", - "name": "eventName" - }, - { - "type": "Function", - "optional": false, - "doc": "

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

\n", - "name": "handler" - }, - { - "type": "Object", - "optional": true, - "doc": "

(optional) The scope originally specified for the handler.

\n", - "name": "scope" - } - ], - "name": "removeListener", - "owner": "Ext.util.Observable", - "doc": "

Removes an event handler.

\n", - "linenr": 392, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-removeManagedListener", - "shortDoc": "Removes listeners that were added by the mon method. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Observable|Element", - "optional": false, - "doc": "

The item from which to remove a listener/listeners.

\n", - "name": "item" - }, - { - "type": "Object|String", - "optional": false, - "doc": "

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

\n", - "name": "ename" - }, - { - "type": "Function", - "optional": false, - "doc": "

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

\n", - "name": "fn" - }, - { - "type": "Object", - "optional": false, - "doc": "

Optional. If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

\n", - "name": "scope" - } - ], - "name": "removeManagedListener", - "owner": "Ext.util.Observable", - "doc": "

Removes listeners that were added by the mon method.

\n", - "linenr": 197, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "MixedCollection.html#Ext-util-MixedCollection-method-reorder", - "shortDoc": "Reorders each of the items based on a mapping from old index to new index. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/MixedCollection.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

Mapping from old item index to new item index

\n", - "name": "mapping" - } - ], - "name": "reorder", - "owner": "Ext.util.MixedCollection", - "doc": "

Reorders each of the items based on a mapping from old index to new index. Internally this\njust translates into a sort. The 'sort' event is fired whenever reordering has occured.

\n", - "linenr": 152, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "MixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-replace", - "shortDoc": "Replaces an item in the collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The key associated with the item to replace, or the replacement item.

\n\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\n", - "name": "key" - }, - { - "type": "Object", - "optional": true, - "doc": "

{Object} o (optional) If the first parameter passed was a key, the item to associate\nwith that key.

\n", - "name": "o" - } - ], - "name": "replace", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

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

\n", - "linenr": 135, - "return": { - "type": "Object", - "doc": "

The new item.

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-resumeEvents", - "shortDoc": "Resumes firing events (see suspendEvents). ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - - ], - "name": "resumeEvents", - "owner": "Ext.util.Observable", - "doc": "

Resumes firing events (see suspendEvents).

\n\n

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

\n", - "linenr": 554, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Sortable.html#Ext-util-Sortable-method-sort", - "shortDoc": "Sorts the data in the Store by one or more of its properties. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sortable.js", - "private": false, - "params": [ - { - "type": "String|Array", - "optional": false, - "doc": "

Either a string name of one of the fields in this Store's configured Model,\nor an Array of sorter configurations.

\n", - "name": "sorters" - }, - { - "type": "String", - "optional": false, - "doc": "

The overall direction to sort the data by. Defaults to \"ASC\".

\n", - "name": "direction" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "where" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "doSort" - } - ], - "name": "sort", - "owner": "Ext.util.Sortable", - "doc": "

Sorts the data in the Store by one or more of its properties. Example usage:

\n\n\n
//sort by a single field\nmyStore.sort('myField', 'DESC');\n\n//sorting by multiple fields\nmyStore.sort([\n    {\n        property : 'age',\n        direction: 'ASC'\n    },\n    {\n        property : 'name',\n        direction: 'DESC'\n    }\n]);\n
\n\n\n

Internally, Store converts the passed arguments into an array of Ext.util.Sorter instances, and delegates the actual\nsorting to its internal Ext.util.MixedCollection.

\n\n\n

When passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:

\n\n\n
store.sort('myField');\nstore.sort('myField');\n
\n\n\n

Is equivalent to this code, because Store handles the toggling automatically:

\n\n\n
store.sort('myField', 'ASC');\nstore.sort('myField', 'DESC');\n
\n\n", - "linenr": 58, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Sortable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "MixedCollection.html#Ext-util-MixedCollection-method-sortBy", - "shortDoc": "Sorts the collection by a single sorter function ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/MixedCollection.js", - "private": false, - "params": [ - { - "type": "Function", - "optional": false, - "doc": "

The function to sort by

\n", - "name": "sorterFn" - } - ], - "name": "sortBy", - "owner": "Ext.util.MixedCollection", - "doc": "

Sorts the collection by a single sorter function

\n", - "linenr": 113, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "MixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "MixedCollection.html#Ext-util-MixedCollection-method-sortByKey", - "shortDoc": "Sorts this collection by keys. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/MixedCollection.js", - "private": false, - "params": [ - { - "type": "String", - "optional": true, - "doc": "

(optional) 'ASC' or 'DESC'. Defaults to 'ASC'.

\n", - "name": "direction" - }, - { - "type": "Function", - "optional": true, - "doc": "

(optional) Comparison function that defines the sort order.\nDefaults to sorting by case insensitive string.

\n", - "name": "fn" - } - ], - "name": "sortByKey", - "owner": "Ext.util.MixedCollection", - "doc": "

Sorts this collection by keys.

\n", - "linenr": 192, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "MixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": true, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-statics", - "shortDoc": "Get the reference to the class from which this object was instantiated. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - - ], - "name": "statics", - "owner": "Ext.Base", - "doc": "

Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base.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        return this;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n
\n", - "linenr": 199, - "return": { - "type": "Class", - "doc": "\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-method-sum", - "shortDoc": "Collects all of the values of the given property and returns their sum ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The property to sum by

\n", - "name": "property" - }, - { - "type": "String", - "optional": false, - "doc": "

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", - "name": "root" - }, - { - "type": "Number", - "optional": true, - "doc": "

(optional) The record index to start at (defaults to 0)

\n", - "name": "start" - }, - { - "type": "Number", - "optional": true, - "doc": "

(optional) The record index to end at (defaults to -1)

\n", - "name": "end" - } - ], - "name": "sum", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

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

\n", - "linenr": 464, - "return": { - "type": "Number", - "doc": "

The total

\n" - }, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-suspendEvents", - "shortDoc": "Suspends the firing of all events. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Boolean", - "optional": false, - "doc": "

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

\n", - "name": "queueSuspended" - } - ], - "name": "suspendEvents", - "owner": "Ext.util.Observable", - "doc": "

Suspends the firing of all events. (see resumeEvents)

\n", - "linenr": 541, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": { - "tagname": "alias", - "cls": "Ext.util.Observable", - "doc": null, - "owner": "removeListener" - }, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-un", - "shortDoc": "Shorthand for removeListener. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The type of event the handler was associated with.

\n", - "name": "eventName" - }, - { - "type": "Function", - "optional": false, - "doc": "

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

\n", - "name": "handler" - }, - { - "type": "Object", - "optional": true, - "doc": "

(optional) The scope originally specified for the handler.

\n", - "name": "scope" - } - ], - "name": "un", - "owner": "Ext.util.Observable", - "doc": "

Shorthand for removeListener.

\n\n

Removes an event handler.

\n", - "linenr": 675, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "StoreManager.html#Ext-data-StoreManager-method-unregister", - "shortDoc": "Unregisters one or more Stores with the StoreManager ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/StoreManager.js", - "private": false, - "params": [ - { - "type": "String/Object", - "optional": false, - "doc": "

The id of the Store, or a Store instance

\n", - "name": "id1" - }, - { - "type": "String/Object", - "optional": true, - "doc": "

(optional)

\n", - "name": "id2" - }, - { - "type": "String/Object", - "optional": true, - "doc": "

... (optional)

\n", - "name": "etc" - } - ], - "name": "unregister", - "owner": "Ext.data.StoreManager", - "doc": "

Unregisters one or more Stores with the StoreManager

\n", - "linenr": 58, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "StoreManager.html" - } - ], - "property": [ - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "Sortable.html#Ext-util-Sortable-property-", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sortable.js", - "private": false, - "name": "", - "owner": "Ext.util.Sortable", - "doc": "

The property in each item that contains the data to sort.

\n", - "linenr": 31, - "html_filename": "Sortable.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "Sortable.html#Ext-util-Sortable-property-defaultSortDirection", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sortable.js", - "private": false, - "name": "defaultSortDirection", - "owner": "Ext.util.Sortable", - "doc": "

The default sort direction to use if one is not specified (defaults to \"ASC\")

\n", - "linenr": 20, - "html_filename": "Sortable.html" - }, - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "Sortable.html#Ext-util-Sortable-property-isSortable", - "shortDoc": "Flag denoting that this object is sortable. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sortable.js", - "private": false, - "name": "isSortable", - "owner": "Ext.util.Sortable", - "doc": "

Flag denoting that this object is sortable. Always true.

\n", - "linenr": 13, - "html_filename": "Sortable.html" - }, - { - "type": "Class", - "deprecated": null, - "alias": null, - "protected": true, - "tagname": "property", - "href": "Base3.html#Ext-Base-property-self", - "shortDoc": "Get the reference to the current class from which this object was instantiated. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "name": "self", - "owner": "Ext.Base", - "doc": "

Get the reference to the current class from which this object was instantiated. Unlike Ext.Base.statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base.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        return this;\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n
\n", - "linenr": 18, - "html_filename": "Base3.html" - }, - { - "type": "Ext.util.MixedCollection", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "Sortable.html#Ext-util-Sortable-property-sorters", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sortable.js", - "private": false, - "name": "sorters", - "owner": "Ext.util.Sortable", - "doc": "

The collection of Sorters currently applied to this Store

\n", - "linenr": 44, - "html_filename": "Sortable.html" - } - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-event-add", - "shortDoc": "Fires when an item is added to the collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "Number", - "optional": false, - "doc": "

The index at which the item was added.

\n", - "name": "index" - }, - { - "type": "Object", - "optional": false, - "doc": "

The item added.

\n", - "name": "o" - }, - { - "type": "String", - "optional": false, - "doc": "

The key associated with the added item.

\n", - "name": "key" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "

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

\n" - } - ], - "name": "add", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

Fires when an item is added to the collection.

\n", - "linenr": 26, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-event-clear", - "shortDoc": "Fires when the collection is cleared. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "

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

\n" - } - ], - "name": "clear", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

Fires when the collection is cleared.

\n", - "linenr": 20, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-event-remove", - "shortDoc": "Fires when an item is removed from the collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

The item being removed.

\n", - "name": "o" - }, - { - "type": "String", - "optional": true, - "doc": "

(optional) The key associated with the removed item.

\n", - "name": "key" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "

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

\n" - } - ], - "name": "remove", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

Fires when an item is removed from the collection.

\n", - "linenr": 44, - "html_filename": "AbstractMixedCollection.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractMixedCollection.html#Ext-util-AbstractMixedCollection-event-replace", - "shortDoc": "Fires when an item is replaced in the collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/AbstractMixedCollection.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

he key associated with the new added.

\n", - "name": "key" - }, - { - "type": "Object", - "optional": false, - "doc": "

The item being replaced.

\n", - "name": "old" - }, - { - "type": "Object", - "optional": false, - "doc": "

The new item.

\n", - "name": "new" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "

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

\n" - } - ], - "name": "replace", - "owner": "Ext.util.AbstractMixedCollection", - "doc": "

Fires when an item is replaced in the collection.

\n", - "linenr": 35, - "html_filename": "AbstractMixedCollection.html" - } - ] - }, - "singleton": true, - "alias": null, - "superclasses": [ - "Ext.Base", - "Ext.util.AbstractMixedCollection", - "Ext.util.MixedCollection" - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "StoreManager.html#Ext-data-StoreManager", - "subclasses": [ - - ], - "static": false, - "author": null, - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/StoreManager.js", - "private": false, - "alternateClassNames": [ - "Ext.StoreMgr", - "Ext.data.StoreMgr", - "Ext.StoreManager" - ], - "name": "Ext.data.StoreManager", - "doc": "

Contains a collection of all stores that are created that have an identifier.\nAn identifier can be assigned by setting the storeId \nproperty. When a store is in the StoreManager, it can be referred to via it's identifier:\n

Ext.create('Ext.data.Store', {\n    model: 'SomeModel',\n    storeId: 'myStore'\n});\n\nvar store = Ext.data.StoreManager.lookup('myStore');\n
\nAlso note that the lookup method is aliased to Ext.getStore for convenience.

\n\n\n

\nIf a store is registered with the StoreManager, you can also refer to the store by it's identifier when\nregistering it with any Component that consumes data from a store:\n

Ext.create('Ext.data.Store', {\n    model: 'SomeModel',\n    storeId: 'myStore'\n});\n\nExt.create('Ext.view.View', {\n    store: 'myStore',\n    // other configuration here\n});\n
\n

\n\n\n

TODO: Make this an AbstractMgr

\n", - "mixedInto": [ - - ], - "linenr": 1, - "xtypes": [ - - ], - "html_filename": "StoreManager.html", - "extends": "Ext.util.MixedCollection" -}); \ No newline at end of file +Ext.data.JsonP.Ext_data_StoreManager({"tagname":"class","html":"
Alternate names
Ext.StoreMgr
Ext.data.StoreMgr
Ext.StoreManager
Hierarchy
Ext.Base
Ext.util.AbstractMixedCollection
Ext.util.MixedCollection
Ext.data.StoreManager
Mixins
Ext.util.Sortable
Ext.util.Observable
Uses
Ext.data.ArrayStore
Files
StoreManager.js

Contains a collection of all stores that are created that have an identifier. An identifier can be assigned by\nsetting the storeId property. When a store is in the StoreManager, it can be\nreferred to via it's identifier:

\n\n
Ext.create('Ext.data.Store', {\n    model: 'SomeModel',\n    storeId: 'myStore'\n});\n\nvar store = Ext.data.StoreManager.lookup('myStore');\n
\n\n

Also note that the lookup method is aliased to Ext.getStore for convenience.

\n\n

If a store is registered with the StoreManager, you can also refer to the store by it's identifier when registering\nit with any Component that consumes data from a store:

\n\n
Ext.create('Ext.data.Store', {\n    model: 'SomeModel',\n    storeId: 'myStore'\n});\n\nExt.create('Ext.view.View', {\n    store: 'myStore',\n    // other configuration here\n});\n
\n
Defined By

Config options

Ext.util.AbstractMixedCollection
view source
: Boolean
Specify true if the addAll\nfunction should add function references to the collection. ...

Specify true if the addAll\nfunction should add function references to the collection. Defaults to\nfalse.

\n

Defaults to: false

Ext.util.Observable
view source
: Object
A config object containing one or more event handlers to be added to this object during initialization. ...

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

\n\n

DOM events from Ext JS Components

\n\n

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

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

Properties

 
Ext.util.Sortable
view source
defaultSortDirection : String

The default sort direction to use if one is not specified.

\n

The default sort direction to use if one is not specified.

\n
Ext.util.Sortable
view source
: Boolean
Flag denoting that this object is sortable. ...

Flag denoting that this object is sortable. Always true.

\n
Ext.Base
view source
: Ext.Classprotected
Get the reference to the current class from which this object was instantiated. ...

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

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

The property in each item that contains the data to sort.

\n

The property in each item that contains the data to sort.

\n
 
Ext.util.Sortable
view source
sorters : Ext.util.MixedCollection

The collection of Sorters currently applied to this Store

\n

The collection of Sorters currently applied to this Store

\n
Defined By

Methods

Ext.util.MixedCollection
view source
new( Boolean allowFunctions, Function keyFn ) : Object
Creates new MixedCollection. ...

Creates new MixedCollection.

\n

Parameters

  • allowFunctions : Boolean

    Specify true if the addAll\nfunction should add function references to the collection. Defaults to\nfalse.

    \n
  • keyFn : Function

    A function that can accept an item of the type(s) stored in this MixedCollection\nand return the key value for that item. This is used when available to look up the key on items that\nwere passed without an explicit key parameter to a MixedCollection method. Passing this parameter is\nequivalent to providing an implementation for the getKey method.

    \n

Returns

Ext.util.AbstractMixedCollection
view source
( String key, Object o ) : Object
Adds an item to the collection. ...

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

\n

Parameters

  • key : String

    The key to associate with the item, or the new item.

    \n\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\n
  • o : Object

    The item to add.

    \n

Returns

Ext.util.AbstractMixedCollection
view source
( Object/Array 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.

\n

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
Ext.util.Observable
view source
( Object/String o, [String... more] )
Adds the specified events to the list of events which this Observable may fire. ...

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

\n

Parameters

  • o : Object/String

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

    \n\n
    this.addEvents({\n    storeloaded: true,\n    storecleared: true\n});\n
    \n
  • more : String... (optional)

    Additional event names if multiple event names are being passed as separate\nparameters. Usage:

    \n\n
    this.addEvents('storeloaded', 'storecleared');\n
    \n
Ext.util.Observable
view source
( String eventName, Function fn, [Object scope], [Object options] )
Appends an event handler to this object. ...

Appends an event handler to this object.

\n

Parameters

  • eventName : String

    The name of the event to listen for. May also be an object who's property names are\nevent names.

    \n\n
  • fn : Function

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

    \n\n
  • scope : Object (optional)

    The scope (this reference) in which the handler function is executed. If\nomitted, 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 argument to every event handler.

    \n\n\n\n\n

    This object may contain any of the following properties:

    \n\n\n\n\n
      \n

    • scope : Object

      \n\n

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

      • \n

    • delay : Number

      \n\n

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

      • \n

    • single : Boolean

      \n\n

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

      • \n

    • buffer : Number

      \n\n

      Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.

      • \n

    • target : Observable

      \n\n

      Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.

      • \n

    • element : String

      \n\n

      This option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.

      \n\n

      This option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:

      \n\n
      new Ext.panel.Panel({\n    title: 'The title',\n    listeners: {\n        click: this.handlePanelClick,\n        element: 'body'\n    }\n});\n
      • \n
    \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\n\n\n

    Attaching multiple handlers in 1 call

    \n\n\n\n\n

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

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

    One can also specify options for each event handler separately:

    \n\n\n\n\n
    myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
    \n\n
Ext.util.Observable
view source
( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope], [Object opt] )
Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestr...

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

\n

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item to which to add a listener/listeners.

    \n\n
  • ename : Object/String

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

    \n\n
  • fn : Function (optional)

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

    \n\n
  • scope : Object (optional)

    If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

    \n\n
  • opt : Object (optional)

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

    \n\n
Ext.Base
view source
( Array/Arguments args ) : Objectprotected
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        return this;\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        var instance = this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n\n        return instance;\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

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object

    \n

Returns

  • Object

    Returns the result after calling the overridden method

    \n
Ext.Base
view source
( Array/Arguments args ) : Objectprotected
Call the parent's overridden method. ...

Call the parent's overridden method. For example:

\n\n
Ext.define('My.own.A', {\n    constructor: function(test) {\n        alert(test);\n    }\n});\n\nExt.define('My.own.B', {\n    extend: 'My.own.A',\n\n    constructor: function(test) {\n        alert(test);\n\n        this.callParent([test + 1]);\n    }\n});\n\nExt.define('My.own.C', {\n    extend: 'My.own.B',\n\n    constructor: function() {\n        alert(\"Going to call parent's overriden constructor...\");\n\n        this.callParent(arguments);\n    }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n                         // alerts '2', then alerts '3'\n
\n

Parameters

  • args : Array/Arguments

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

    \n

Returns

  • Object

    Returns the result from the superclass' method

    \n
Ext.util.AbstractMixedCollection
view source
( )
Removes all items from the collection. ...

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

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

Removes all listeners for this object including the managed listeners

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

Removes all managed listeners for this object.

\n
Ext.util.AbstractMixedCollection
view source
( ) : Ext.util.MixedCollection
Creates a shallow copy of this collection ...

Creates a shallow copy of this collection

\n

Returns

Ext.util.AbstractMixedCollection
view source
( String property, [String root], [Boolean allowBlank] ) : Array
Collects unique values of a particular property in this MixedCollection ...

Collects unique values of a particular property in this MixedCollection

\n

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

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

\n

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

\n

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
Ext.util.AbstractMixedCollection
view source
( Function fn, [Object scope] )
Executes the specified function once for every item in the collection, passing the following arguments:\n\n\nitem : Mixe...

Executes the specified function once for every item in the collection, passing the following arguments:

\n\n
    \n
  • item : Mixed

    The collection item

    • \n
  • index : Number

    The item's index

    • \n
  • length : Number

    The total number of items in the collection

    • \n
\n\n\n

The function should return a boolean value. Returning false from the function will stop the iteration.

\n

Parameters

  • fn : Function

    The function to execute for each item.

    \n
  • scope : Object (optional)

    The scope (this reference) in which the function is executed. Defaults to the current item in the iteration.

    \n
Ext.util.AbstractMixedCollection
view source
( Function fn, [Object 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.

\n

Parameters

  • fn : Function

    The function to execute for each item.

    \n
  • scope : Object (optional)

    The scope (this reference) in which the function is executed. Defaults to the browser window.

    \n
Ext.util.Observable
view source
( String/String[] events )
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.override(Ext.form.field.Base, {\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n        this.enableBubble('change');\n    }),\n\n    //  We know that we want Field's events to bubble directly to the FormPanel.\n    getBubbleTarget : function() {\n        if (!this.formPanel) {\n            this.formPanel = this.findParentByType('form');\n        }\n        return this.formPanel;\n    }\n});\n\nvar myForm = new Ext.formPanel({\n    title: 'User Details',\n    items: [{\n        ...\n    }],\n    listeners: {\n        change: function() {\n            // Title goes red if form has been modified.\n            myForm.header.setStyle('color', 'red');\n        }\n    }\n});\n
\n

Parameters

  • events : String/String[]

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

    \n
Ext.util.AbstractMixedCollection
view source
( Ext.util.Filter[]/String property, String/RegExp value, [Boolean anyMatch], [Boolean 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\nvar people = new Ext.util.MixedCollection();\npeople.addAll([\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//a new MixedCollection containing only the items where age == 24\nvar middleAged = people.filter('age', 24);\n
\n\n

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.AbstractMixedCollection
view source
( Function fn, [Object 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.

\n

Parameters

  • fn : Function

    The function to be called, it will receive the args o (the object), k (the key)

    \n
  • scope : Object (optional)

    The scope (this reference) in which the function is executed. Defaults to this MixedCollection.

    \n

Returns

Ext.util.AbstractMixedCollection
view source
( Function fn, [Object 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.

\n

Parameters

  • fn : Function

    The selection function to execute for each item.

    \n
  • scope : Object (optional)

    The scope (this reference) in which the function is executed. Defaults to the browser window.

    \n

Returns

  • Object

    The first item in the collection which returned true from the selection function, or null if none was found

    \n
Ext.util.AbstractMixedCollection
view source
( String property, String/RegExp value, [Number start], [Boolean anyMatch], [Boolean 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.

\n

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
( Function fn, [Object scope], [Number 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.

\n

Parameters

  • fn : Function

    The function to be called, it will receive the args o (the object), k (the key).

    \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
Ext.util.Observable
view source
( String eventName, Object... args ) : Boolean
Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...

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

\n\n

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

\n

Parameters

  • eventName : String

    The name of the event to fire.

    \n
  • args : Object...

    Variable number of parameters are passed to handlers.

    \n

Returns

  • Boolean

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

    \n
Ext.util.AbstractMixedCollection
view source
( ) : Object
Returns the first item in the collection. ...

Returns the first item in the collection.

\n

Returns

  • Object

    the first item in the collection..

    \n
Ext.util.AbstractMixedCollection
view source
( String/Number 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.

\n

Parameters

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
( Number index ) : Object
Returns the item at the specified index. ...

Returns the item at the specified index.

\n

Parameters

  • index : Number

    The index of the item.

    \n

Returns

  • Object

    The item at the specified index.

    \n
Ext.util.AbstractMixedCollection
view source
( String/Number key ) : Object
Returns the item associated with the passed key. ...

Returns the item associated with the passed key.

\n

Parameters

Returns

  • Object

    The item associated with the passed key.

    \n
Ext.util.AbstractMixedCollection
view source
( ) : Number
Returns the number of items in the collection. ...

Returns the number of items in the collection.

\n

Returns

  • Number

    the number of items in the collection.

    \n
Ext.util.AbstractMixedCollection
view source
( Object item ) : Object
MixedCollection has a generic way to fetch keys if you implement getKey. ...

MixedCollection has a generic way to fetch keys if you implement getKey. The default implementation\nsimply returns item.id but you can provide your own implementation\nto return a different value as in 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();\nmc.getKey = function(el){\n   return el.dom.id;\n};\nmc.add(someEl);\nmc.add(otherEl);\n\n// or via the constructor\nvar mc = new Ext.util.MixedCollection(false, function(el){\n   return el.dom.id;\n});\nmc.add(someEl);\nmc.add(otherEl);\n
\n\n

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
( [Number startIndex], [Number endIndex] ) : Array
Returns a range of items in this collection ...

Returns a range of items in this collection

\n

Parameters

  • startIndex : Number (optional)

    The starting index. Defaults to 0.

    \n
  • endIndex : Number (optional)

    The ending index. Defaults to the last item.

    \n

Returns

Ext.util.Observable
view source
( String eventName ) : Boolean
Checks to see if this object has any listeners for a specified event ...

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

\n

Parameters

  • eventName : String

    The name of the event to check for

    \n

Returns

  • Boolean

    True if the event is being listened for, else false

    \n
Ext.util.AbstractMixedCollection
view source
( Object o ) : Number
Returns index within the collection of the passed Object. ...

Returns index within the collection of the passed Object.

\n

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
( String key ) : Number
Returns index within the collection of the passed key. ...

Returns index within the collection of the passed key.

\n

Parameters

  • key : String

    The key to find the index of.

    \n

Returns

Ext.Base
view source
( Object config ) : Objectprotected
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        return this;\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\n

Parameters

Returns

  • Object

    mixins The mixin prototypes as key - value pairs

    \n
Ext.util.Sortable
view source
( )
Performs initialization of this mixin. ...

Performs initialization of this mixin. Component classes using this mixin should call this method during their\nown initialization.

\n
Ext.util.AbstractMixedCollection
view source
( Number index, String key, [Object 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.

\n

Parameters

  • index : Number

    The index to insert the item at.

    \n
  • key : String

    The key to associate with the new item, or the item itself.

    \n
  • o : Object (optional)

    If the second parameter was a key, the new item.

    \n

Returns

Ext.util.AbstractMixedCollection
view source
( ) : Object
Returns the last item in the collection. ...

Returns the last item in the collection.

\n

Returns

  • Object

    the last item in the collection..

    \n
Ext.data.StoreManager
view source
( String/Object store ) : Ext.data.Store
Gets a registered Store by id ...

Gets a registered Store by id

\n

Parameters

  • store : String/Object

    The id of the Store, or a Store instance, or a store configuration

    \n

Returns

Ext.util.Observable
view source
( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope], [Object opt] )
Shorthand for addManagedListener. ...

Shorthand for addManagedListener.

\n\n

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

\n

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item to which to add a listener/listeners.

    \n\n
  • ename : Object/String

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

    \n\n
  • fn : Function (optional)

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

    \n\n
  • scope : Object (optional)

    If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

    \n\n
  • opt : Object (optional)

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

    \n\n
Ext.util.Observable
view source
( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope] )
Shorthand for removeManagedListener. ...

Shorthand for removeManagedListener.

\n\n

Removes listeners that were added by the mon method.

\n

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item from which to remove a listener/listeners.

    \n\n
  • ename : Object/String

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

    \n\n
  • fn : Function (optional)

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

    \n\n
  • scope : Object (optional)

    If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

    \n\n
Ext.util.Observable
view source
( String eventName, Function fn, [Object scope], [Object options] )
Shorthand for addListener. ...

Shorthand for addListener.

\n\n

Appends an event handler to this object.

\n

Parameters

  • eventName : String

    The name of the event to listen for. May also be an object who's property names are\nevent names.

    \n\n
  • fn : Function

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

    \n\n
  • scope : Object (optional)

    The scope (this reference) in which the handler function is executed. If\nomitted, 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 argument to every event handler.

    \n\n\n\n\n

    This object may contain any of the following properties:

    \n\n\n\n\n
      \n

    • scope : Object

      \n\n

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

      • \n

    • delay : Number

      \n\n

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

      • \n

    • single : Boolean

      \n\n

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

      • \n

    • buffer : Number

      \n\n

      Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.

      • \n

    • target : Observable

      \n\n

      Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.

      • \n

    • element : String

      \n\n

      This option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.

      \n\n

      This option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:

      \n\n
      new Ext.panel.Panel({\n    title: 'The title',\n    listeners: {\n        click: this.handlePanelClick,\n        element: 'body'\n    }\n});\n
      • \n
    \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\n\n\n

    Attaching multiple handlers in 1 call

    \n\n\n\n\n

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

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

    One can also specify options for each event handler separately:

    \n\n\n\n\n
    myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
    \n\n
Ext.data.StoreManager
view source
( Ext.data.Store... stores )
Registers one or more Stores with the StoreManager. ...

Registers one or more Stores with the StoreManager. You do not normally need to register stores manually. Any\nstore initialized with a Ext.data.Store.storeId will be auto-registered.

\n

Parameters

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

Parameters

  • origin : Object

    The Observable whose events this object is to relay.

    \n
  • events : String[]

    Array of event names to relay.

    \n
  • prefix : String
    \n
Ext.util.AbstractMixedCollection
view source
( Object o ) : Object
Remove an item from the collection. ...

Remove an item from the collection.

\n

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
( Array items ) : Ext.util.MixedCollection
Remove all items in the passed array from the collection. ...

Remove all items in the passed array from the collection.

\n

Parameters

  • items : Array

    An array of items to be removed.

    \n

Returns

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

\n

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
( String key ) : Object
Removed an item associated with the passed key fom the collection. ...

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

\n

Parameters

  • key : String

    The key of the item to remove.

    \n

Returns

  • Object

    The item removed or false if no item was removed.

    \n
Ext.util.Observable
view source
( String eventName, Function fn, [Object scope] )
Removes an event handler. ...

Removes an event handler.

\n

Parameters

  • eventName : String

    The type of event the handler was associated with.

    \n\n
  • fn : Function

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

    \n\n
  • scope : Object (optional)

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

    \n\n
Ext.util.Observable
view source
( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope] )
Removes listeners that were added by the mon method. ...

Removes listeners that were added by the mon method.

\n

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item from which to remove a listener/listeners.

    \n\n
  • ename : Object/String

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

    \n\n
  • fn : Function (optional)

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

    \n\n
  • scope : Object (optional)

    If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

    \n\n
Ext.util.MixedCollection
view source
( Object mapping )
Reorders each of the items based on a mapping from old index to new index. ...

Reorders each of the items based on a mapping from old index to new index. Internally this\njust translates into a sort. The 'sort' event is fired whenever reordering has occured.

\n

Parameters

  • mapping : Object

    Mapping from old item index to new item index

    \n
Ext.util.AbstractMixedCollection
view source
( String key, Object o ) : Object
Replaces an item in the collection. ...

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

\n

Parameters

  • key : String

    The key associated with the item to replace, or the replacement item.

    \n\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\n
  • o : Object

    {Object} o (optional) If the first parameter passed was a key, the item to associate\nwith that key.

    \n

Returns

Ext.util.Observable
view source
( )
Resumes firing events (see suspendEvents). ...

Resumes firing events (see suspendEvents).

\n\n

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

\n
Ext.util.Sortable
view source
( String/Ext.util.Sorter[] sorters, String direction ) : Ext.util.Sorter[]
Sorts the data in the Store by one or more of its properties. ...

Sorts the data in the Store by one or more of its properties. Example usage:

\n\n
//sort by a single field\nmyStore.sort('myField', 'DESC');\n\n//sorting by multiple fields\nmyStore.sort([\n    {\n        property : 'age',\n        direction: 'ASC'\n    },\n    {\n        property : 'name',\n        direction: 'DESC'\n    }\n]);\n
\n\n

Internally, Store converts the passed arguments into an array of Ext.util.Sorter instances, and delegates\nthe actual sorting to its internal Ext.util.MixedCollection.

\n\n

When passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:

\n\n
store.sort('myField');\nstore.sort('myField');\n
\n\n

Is equivalent to this code, because Store handles the toggling automatically:

\n\n
store.sort('myField', 'ASC');\nstore.sort('myField', 'DESC');\n
\n

Parameters

  • sorters : String/Ext.util.Sorter[]

    Either a string name of one of the fields in this Store's configured\nModel, or an array of sorter configurations.

    \n
  • direction : String

    The overall direction to sort the data by. Defaults to \"ASC\".

    \n

Returns

Ext.util.MixedCollection
view source
( Function sorterFn )
Sorts the collection by a single sorter function ...

Sorts the collection by a single sorter function

\n

Parameters

  • sorterFn : Function

    The function to sort by

    \n
Ext.util.MixedCollection
view source
( [String direction], [Function fn] )
Sorts this collection by keys. ...

Sorts this collection by keys.

\n

Parameters

  • direction : String (optional)

    'ASC' or 'DESC'. Defaults to 'ASC'.

    \n
  • fn : Function (optional)

    Comparison function that defines the sort order.\nDefaults to sorting by case insensitive string.

    \n
Ext.Base
view source
( ) : Ext.Classprotected
Get the reference to the class from which this object was instantiated. ...

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

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

Returns

Ext.util.AbstractMixedCollection
view source
( String property, [String root], [Number start], [Number 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

\n

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

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

Suspends the firing of all events. (see resumeEvents)

\n

Parameters

  • queueSuspended : Boolean

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

    \n
Ext.util.Observable
view source
( String eventName, Function fn, [Object scope] )
Shorthand for removeListener. ...

Shorthand for removeListener.

\n\n

Removes an event handler.

\n

Parameters

  • eventName : String

    The type of event the handler was associated with.

    \n\n
  • fn : Function

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

    \n\n
  • scope : Object (optional)

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

    \n\n
Ext.data.StoreManager
view source
( String/Object... stores )
Unregisters one or more Stores with the StoreManager ...

Unregisters one or more Stores with the StoreManager

\n

Parameters

  • stores : String/Object...

    Any number of Store instances or ID-s

    \n
Defined By

Events

Ext.util.AbstractMixedCollection
view source
( Number index, Object o, String key, Object eOpts )
Fires when an item is added to the collection. ...

Fires when an item is added to the collection.

\n

Parameters

Ext.util.AbstractMixedCollection
view source
( Object eOpts )
Fires when the collection is cleared. ...

Fires when the collection is cleared.

\n

Parameters

Ext.util.AbstractMixedCollection
view source
( Object o, [String key], Object eOpts )
Fires when an item is removed from the collection. ...

Fires when an item is removed from the collection.

\n

Parameters

Ext.util.AbstractMixedCollection
view source
( String key, Object old, Object new, Object eOpts )
Fires when an item is replaced in the collection. ...

Fires when an item is replaced in the collection.

\n

Parameters

","allMixins":["Ext.util.Sortable","Ext.util.Observable"],"meta":{"docauthor":["Evan Trimboli "]},"requires":[],"deprecated":null,"extends":"Ext.util.MixedCollection","inheritable":false,"static":false,"superclasses":["Ext.Base","Ext.util.AbstractMixedCollection","Ext.util.MixedCollection","Ext.data.StoreManager"],"singleton":true,"code_type":"ext_define","alias":null,"statics":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[],"event":[]},"subclasses":[],"uses":["Ext.data.ArrayStore"],"protected":false,"mixins":[],"members":{"property":[{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.util.Sortable","template":null,"required":null,"protected":false,"name":"defaultSortDirection","id":"property-defaultSortDirection"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.util.Sortable","template":null,"required":null,"protected":false,"name":"isSortable","id":"property-isSortable"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.Base","template":null,"required":null,"protected":true,"name":"self","id":"property-self"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.util.Sortable","template":null,"required":null,"protected":false,"name":"sortRoot","id":"property-sortRoot"},{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.util.Sortable","template":null,"required":null,"protected":false,"name":"sorters","id":"property-sorters"}],"css_var":[],"css_mixin":[],"cfg":[{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":null,"required":false,"protected":false,"name":"allowFunctions","id":"cfg-allowFunctions"},{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":null,"required":false,"protected":false,"name":"listeners","id":"cfg-listeners"}],"method":[{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.MixedCollection","template":false,"required":null,"protected":false,"name":"constructor","id":"method-constructor"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"add","id":"method-add"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"addAll","id":"method-addAll"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"addEvents","id":"method-addEvents"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"addListener","id":"method-addListener"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"addManagedListener","id":"method-addManagedListener"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"callOverridden","id":"method-callOverridden"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"callParent","id":"method-callParent"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"clear","id":"method-clear"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"clearListeners","id":"method-clearListeners"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"clearManagedListeners","id":"method-clearManagedListeners"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"clone","id":"method-clone"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"collect","id":"method-collect"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"contains","id":"method-contains"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"containsKey","id":"method-containsKey"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"each","id":"method-each"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"eachKey","id":"method-eachKey"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"enableBubble","id":"method-enableBubble"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"filter","id":"method-filter"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"filterBy","id":"method-filterBy"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"findBy","id":"method-findBy"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"findIndex","id":"method-findIndex"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"findIndexBy","id":"method-findIndexBy"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"fireEvent","id":"method-fireEvent"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"first","id":"method-first"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"get","id":"method-get"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"getAt","id":"method-getAt"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"getByKey","id":"method-getByKey"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"getCount","id":"method-getCount"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"getKey","id":"method-getKey"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"getRange","id":"method-getRange"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"hasListener","id":"method-hasListener"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"indexOf","id":"method-indexOf"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"indexOfKey","id":"method-indexOfKey"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"initConfig","id":"method-initConfig"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Sortable","template":false,"required":null,"protected":false,"name":"initSortable","id":"method-initSortable"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"insert","id":"method-insert"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"last","id":"method-last"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.data.StoreManager","template":false,"required":null,"protected":false,"name":"lookup","id":"method-lookup"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"mon","id":"method-mon"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"mun","id":"method-mun"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"on","id":"method-on"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.data.StoreManager","template":false,"required":null,"protected":false,"name":"register","id":"method-register"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"relayEvents","id":"method-relayEvents"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"remove","id":"method-remove"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"removeAll","id":"method-removeAll"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"removeAt","id":"method-removeAt"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"removeAtKey","id":"method-removeAtKey"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"removeListener","id":"method-removeListener"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"removeManagedListener","id":"method-removeManagedListener"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.MixedCollection","template":false,"required":null,"protected":false,"name":"reorder","id":"method-reorder"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"replace","id":"method-replace"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"resumeEvents","id":"method-resumeEvents"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Sortable","template":false,"required":null,"protected":false,"name":"sort","id":"method-sort"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.MixedCollection","template":false,"required":null,"protected":false,"name":"sortBy","id":"method-sortBy"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.MixedCollection","template":false,"required":null,"protected":false,"name":"sortByKey","id":"method-sortByKey"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"statics","id":"method-statics"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":false,"required":null,"protected":false,"name":"sum","id":"method-sum"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"suspendEvents","id":"method-suspendEvents"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"un","id":"method-un"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.data.StoreManager","template":false,"required":null,"protected":false,"name":"unregister","id":"method-unregister"}],"event":[{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":null,"required":null,"protected":false,"name":"add","id":"event-add"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":null,"required":null,"protected":false,"name":"clear","id":"event-clear"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":null,"required":null,"protected":false,"name":"remove","id":"event-remove"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.util.AbstractMixedCollection","template":null,"required":null,"protected":false,"name":"replace","id":"event-replace"}]},"private":false,"component":false,"name":"Ext.data.StoreManager","alternateClassNames":["Ext.StoreMgr","Ext.data.StoreMgr","Ext.StoreManager"],"id":"class-Ext.data.StoreManager","mixedInto":[],"xtypes":{},"files":[{"href":"StoreManager.html#Ext-data-StoreManager","filename":"StoreManager.js"}]}); \ No newline at end of file