X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..HEAD:/docs/output/Ext.util.HashMap.js diff --git a/docs/output/Ext.util.HashMap.js b/docs/output/Ext.util.HashMap.js index 1116be1f..811b550c 100644 --- a/docs/output/Ext.util.HashMap.js +++ b/docs/output/Ext.util.HashMap.js @@ -1,941 +1 @@ -Ext.data.JsonP.Ext_util_HashMap({ - "allMixins": [ - - ], - "deprecated": null, - "docauthor": null, - "members": { - "cfg": [ - { - "type": "Function", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "HashMap.html#Ext-util-HashMap-cfg-keyFn", - "shortDoc": "A function that is used to retrieve a default key for a passed object. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/HashMap.js", - "private": false, - "name": "keyFn", - "owner": "Ext.util.HashMap", - "doc": "

A function that is used to retrieve a default key for a passed object.\nA default is provided that returns the id property on the object. This function is only used\nif the add method is called with a single argument.

\n", - "linenr": 26, - "html_filename": "HashMap.html" - } - ], - "method": [ - { - "deprecated": null, - "alias": null, - "href": "HashMap.html#Ext-util-HashMap-method-constructor", - "tagname": "method", - "protected": false, - "shortDoc": "Creates new HashMap. ...", - "static": false, - "params": [ - { - "type": "Object", - "optional": true, - "doc": "

(optional) Config object.

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

Creates new HashMap.

\n", - "owner": "Ext.util.HashMap", - "name": "HashMap", - "html_filename": "HashMap.html", - "return": { - "type": "Object", - "doc": "\n" - }, - "linenr": 36 - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "HashMap.html#Ext-util-HashMap-method-add", - "shortDoc": "Adds an item to the collection. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/HashMap.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 HashMap,\nor if the key of the stored items is in a property called id,\nthe HashMap 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.HashMap", - "doc": "

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

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

The item added.

\n" - }, - "html_filename": "HashMap.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": "HashMap.html#Ext-util-HashMap-method-clear", - "shortDoc": "Removes all items from the hash. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/HashMap.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "initial" - } - ], - "name": "clear", - "owner": "Ext.util.HashMap", - "doc": "

Removes all items from the hash.

\n", - "linenr": 217, - "return": { - "type": "Ext.util.HashMap", - "doc": "

this

\n" - }, - "html_filename": "HashMap.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "HashMap.html#Ext-util-HashMap-method-clone", - "shortDoc": "Performs a shallow copy on this hash. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/HashMap.js", - "private": false, - "params": [ - - ], - "name": "clone", - "owner": "Ext.util.HashMap", - "doc": "

Performs a shallow copy on this hash.

\n", - "linenr": 314, - "return": { - "type": "Ext.util.HashMap", - "doc": "

The new hash object.

\n" - }, - "html_filename": "HashMap.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "HashMap.html#Ext-util-HashMap-method-contains", - "shortDoc": "Checks whether a value exists in the hash. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/HashMap.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

The value to check for.

\n", - "name": "value" - } - ], - "name": "contains", - "owner": "Ext.util.HashMap", - "doc": "

Checks whether a value exists in the hash.

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

True if the value exists in the dictionary.

\n" - }, - "html_filename": "HashMap.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "HashMap.html#Ext-util-HashMap-method-containsKey", - "shortDoc": "Checks whether a key exists in the hash. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/HashMap.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The key to check for.

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

Checks whether a key exists in the hash.

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

True if they key exists in the hash.

\n" - }, - "html_filename": "HashMap.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": "HashMap.html#Ext-util-HashMap-method-each", - "shortDoc": "Executes the specified function once for each item in the hash. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/HashMap.js", - "private": false, - "params": [ - { - "type": "Function", - "optional": false, - "doc": "

The function to execute.

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

The scope to execute in. Defaults to this.

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

Executes the specified function once for each item in the hash.\nReturning false from the function will cease iteration.

\n\n

The paramaters passed to the function are:

\n\n
\n\n", - "linenr": 283, - "return": { - "type": "Ext.util.HashMap", - "doc": "

this

\n" - }, - "html_filename": "HashMap.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "HashMap.html#Ext-util-HashMap-method-get", - "shortDoc": "Retrieves an item with a particular key. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/HashMap.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The key to lookup.

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

Retrieves an item with a particular key.

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

The value at that key. If it doesn't exist, undefined is returned.

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

Gets the number of items in the hash.

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

The number of items in the hash.

\n" - }, - "html_filename": "HashMap.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "HashMap.html#Ext-util-HashMap-method-getKey", - "shortDoc": "Extracts the key from an object. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/HashMap.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

The object to get the key from

\n", - "name": "o" - } - ], - "name": "getKey", - "owner": "Ext.util.HashMap", - "doc": "

Extracts the key from an object. This is a default implementation, it may be overridden

\n", - "linenr": 114, - "return": { - "type": "String", - "doc": "

The key to use.

\n" - }, - "html_filename": "HashMap.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "HashMap.html#Ext-util-HashMap-method-getKeys", - "shortDoc": "Return all of the keys in the hash. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/HashMap.js", - "private": false, - "params": [ - - ], - "name": "getKeys", - "owner": "Ext.util.HashMap", - "doc": "

Return all of the keys in the hash.

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

An array of keys.

\n" - }, - "html_filename": "HashMap.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": "HashMap.html#Ext-util-HashMap-method-getValues", - "shortDoc": "Return all of the values in the hash. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/HashMap.js", - "private": false, - "params": [ - - ], - "name": "getValues", - "owner": "Ext.util.HashMap", - "doc": "

Return all of the values in the hash.

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

An array of values.

\n" - }, - "html_filename": "HashMap.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": 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": "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": "HashMap.html#Ext-util-HashMap-method-remove", - "shortDoc": "Remove an item from the hash. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/HashMap.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "

The value of the item to remove.

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

Remove an item from the hash.

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

True if the item was successfully removed.

\n" - }, - "html_filename": "HashMap.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "HashMap.html#Ext-util-HashMap-method-removeAtKey", - "shortDoc": "Remove an item from the hash. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/HashMap.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "

The key to remove.

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

Remove an item from the hash.

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

True if the item was successfully removed.

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

The key of the item.

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

The new value for the item.

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

Replaces an item in the hash. If the key doesn't exist, the\nadd method will be used.

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

The new value of the item.

\n" - }, - "html_filename": "HashMap.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" - } - ], - "property": [ - { - "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" - } - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "HashMap.html#Ext-util-HashMap-event-add", - "shortDoc": "Fires when a new item is added to the hash ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/HashMap.js", - "private": false, - "params": [ - { - "type": "Ext.util.HashMap", - "optional": false, - "doc": "

.

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

The key of the added item.

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

The value of the added item.

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

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

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

Fires when a new item is added to the hash

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

.

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

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

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

Fires when the hash is cleared.

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

.

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

The key of the removed item.

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

The value of the removed item.

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

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

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

Fires when an item is removed from the hash.

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

.

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

The key of the replaced item.

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

The new value for the item.

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

The old value for the item.

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

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

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

Fires when an item is replaced in the hash.

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

\nRepresents a collection of a set of key and value pairs. Each key in the HashMap\nmust be unique, the same key cannot exist twice. Access to items is provided via\nthe key only. Sample usage:\n

var map = new Ext.util.HashMap();\nmap.add('key1', 1);\nmap.add('key2', 2);\nmap.add('key3', 3);\n\nmap.each(function(key, value, length){\n    console.log(key, value, length);\n});\n
\n

\n\n\n\n\n

The HashMap is an unordered class,\nthere is no guarantee when iterating over the items that they will be in any particular\norder. If this is required, then use a Ext.util.MixedCollection.\n

\n\n", - "mixedInto": [ - - ], - "linenr": 1, - "xtypes": [ - - ], - "html_filename": "HashMap.html", - "extends": "Ext.Base" -}); \ No newline at end of file +Ext.data.JsonP.Ext_util_HashMap({"tagname":"class","html":"

Hierarchy

Ext.Base
Ext.util.HashMap

Mixins

Files

\nRepresents a collection of a set of key and value pairs. Each key in the HashMap\nmust be unique, the same key cannot exist twice. Access to items is provided via\nthe key only. Sample usage:\n

var map = new Ext.util.HashMap();\nmap.add('key1', 1);\nmap.add('key2', 2);\nmap.add('key3', 3);\n\nmap.each(function(key, value, length){\n    console.log(key, value, length);\n});\n
\n

\n\n\n\n\n

The HashMap is an unordered class,\nthere is no guarantee when iterating over the items that they will be in any particular\norder. If this is required, then use a Ext.util.MixedCollection.\n

\n\n
Defined By

Config options

A function that is used to retrieve a default key for a passed object. ...

A function that is used to retrieve a default key for a passed object.\nA default is provided that returns the id property on the object. This function is only used\nif the add method is called with a single argument.

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

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

Methods

Defined By

Instance Methods

Creates new HashMap. ...

Creates new HashMap.

\n

Parameters

  • config : Object (optional)

    Config object.

    \n

Returns

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 HashMap,\nor if the key of the stored items is in a property called id,\nthe HashMap 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

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
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
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
( 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
( 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
Removes all items from the hash. ...

Removes all items from the hash.

\n

Parameters

Returns

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

Removes all listeners for this object including the managed listeners

\n
Removes all managed listeners for this object. ...

Removes all managed listeners for this object.

\n
Performs a shallow copy on this hash. ...

Performs a shallow copy on this hash.

\n

Returns

Checks whether a value exists in the hash. ...

Checks whether a value exists in the hash.

\n

Parameters

  • value : Object

    The value to check for.

    \n

Returns

  • Boolean

    True if the value exists in the dictionary.

    \n
Checks whether a key exists in the hash. ...

Checks whether a key exists in the hash.

\n

Parameters

  • key : String

    The key to check for.

    \n

Returns

  • Boolean

    True if they key exists in the hash.

    \n
Executes the specified function once for each item in the hash. ...

Executes the specified function once for each item in the hash.\nReturning false from the function will cease iteration.

\n\n

The paramaters passed to the function are:

\n\n
    \n
  • key : String

    The key of the item

  • \n
  • value : Number

    The value of the item

  • \n
  • length : Number

    The total number of items in the hash

  • \n
\n\n

Parameters

  • fn : Function

    The function to execute.

    \n
  • scope : Object

    The scope to execute in. Defaults to this.

    \n

Returns

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
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
Retrieves an item with a particular key. ...

Retrieves an item with a particular key.

\n

Parameters

  • key : String

    The key to lookup.

    \n

Returns

  • Object

    The value at that key. If it doesn't exist, undefined is returned.

    \n
Gets the number of items in the hash. ...

Gets the number of items in the hash.

\n

Returns

  • Number

    The number of items in the hash.

    \n
Extracts the key from an object. ...

Extracts the key from an object. This is a default implementation, it may be overridden

\n

Parameters

  • o : Object

    The object to get the key from

    \n

Returns

Return all of the keys in the hash. ...

Return all of the keys in the hash.

\n

Returns

Return all of the values in the hash. ...

Return all of the values in the hash.

\n

Returns

  • Array

    An array of values.

    \n
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
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
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
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
( 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
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
Remove an item from the hash. ...

Remove an item from the hash.

\n

Parameters

  • o : Object

    The value of the item to remove.

    \n

Returns

  • Boolean

    True if the item was successfully removed.

    \n
Remove an item from the hash. ...

Remove an item from the hash.

\n

Parameters

  • key : String

    The key to remove.

    \n

Returns

  • Boolean

    True if the item was successfully removed.

    \n
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
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
Replaces an item in the hash. ...

Replaces an item in the hash. If the key doesn't exist, the\nadd method will be used.

\n

Parameters

  • key : String

    The key of the item.

    \n
  • value : Object

    The new value for the item.

    \n

Returns

  • Object

    The new value of the item.

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

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
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
Defined By

Static Methods

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

Add / override static properties of this class.

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

Parameters

Returns

( Ext.Base fromClass, String/String[] members ) : Ext.Basestatic
Borrow another class' members to the prototype of this class. ...

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

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

Parameters

  • fromClass : Ext.Base

    The class to borrow members from

    \n
  • members : String/String[]

    The names of the members to borrow

    \n

Returns

Create a new instance of this Class. ...

Create a new instance of this Class.

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

All parameters are passed to the constructor of the class.

\n

Returns

Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

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

Parameters

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

Get the current class' name in string format.

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

Returns

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

Add methods / properties to the prototype of this class.

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

Parameters

Override prototype members of this class. ...

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

\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

Returns

Defined By

Events

Fires when a new item is added to the hash ...

Fires when a new item is added to the hash

\n

Parameters

Fires when the hash is cleared. ...

Fires when the hash is cleared.

\n

Parameters

Fires when an item is removed from the hash. ...

Fires when an item is removed from the hash.

\n

Parameters

Fires when an item is replaced in the hash. ...

Fires when an item is replaced in the hash.

\n

Parameters

","allMixins":["Ext.util.Observable"],"meta":{},"requires":[],"deprecated":null,"extends":"Ext.Base","inheritable":false,"static":false,"superclasses":["Ext.Base","Ext.util.HashMap"],"singleton":false,"code_type":"ext_define","alias":null,"statics":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"addStatics","id":"static-method-addStatics"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"borrow","id":"static-method-borrow"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"create","id":"static-method-create"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"createAlias","id":"static-method-createAlias"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"getName","id":"static-method-getName"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"implement","id":"static-method-implement"},{"tagname":"method","deprecated":null,"static":true,"owner":"Ext.Base","template":false,"required":null,"protected":false,"name":"override","id":"static-method-override"}],"event":[]},"subclasses":[],"uses":[],"protected":false,"mixins":["Ext.util.Observable"],"members":{"property":[{"tagname":"property","deprecated":null,"static":false,"owner":"Ext.Base","template":null,"required":null,"protected":true,"name":"self","id":"property-self"}],"css_var":[],"css_mixin":[],"cfg":[{"tagname":"cfg","deprecated":null,"static":false,"owner":"Ext.util.HashMap","template":null,"required":false,"protected":false,"name":"keyFn","id":"cfg-keyFn"},{"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.HashMap","template":false,"required":null,"protected":false,"name":"constructor","id":"method-constructor"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.HashMap","template":false,"required":null,"protected":false,"name":"add","id":"method-add"},{"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.HashMap","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.HashMap","template":false,"required":null,"protected":false,"name":"clone","id":"method-clone"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.HashMap","template":false,"required":null,"protected":false,"name":"contains","id":"method-contains"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.HashMap","template":false,"required":null,"protected":false,"name":"containsKey","id":"method-containsKey"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.HashMap","template":false,"required":null,"protected":false,"name":"each","id":"method-each"},{"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.Observable","template":false,"required":null,"protected":false,"name":"fireEvent","id":"method-fireEvent"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.HashMap","template":false,"required":null,"protected":false,"name":"get","id":"method-get"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.HashMap","template":false,"required":null,"protected":false,"name":"getCount","id":"method-getCount"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.HashMap","template":false,"required":null,"protected":false,"name":"getKey","id":"method-getKey"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.HashMap","template":false,"required":null,"protected":false,"name":"getKeys","id":"method-getKeys"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.HashMap","template":false,"required":null,"protected":false,"name":"getValues","id":"method-getValues"},{"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.Base","template":false,"required":null,"protected":true,"name":"initConfig","id":"method-initConfig"},{"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.util.Observable","template":false,"required":null,"protected":false,"name":"relayEvents","id":"method-relayEvents"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.HashMap","template":false,"required":null,"protected":false,"name":"remove","id":"method-remove"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.HashMap","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.HashMap","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.Base","template":false,"required":null,"protected":true,"name":"statics","id":"method-statics"},{"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"}],"event":[{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.util.HashMap","template":null,"required":null,"protected":false,"name":"add","id":"event-add"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.util.HashMap","template":null,"required":null,"protected":false,"name":"clear","id":"event-clear"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.util.HashMap","template":null,"required":null,"protected":false,"name":"remove","id":"event-remove"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.util.HashMap","template":null,"required":null,"protected":false,"name":"replace","id":"event-replace"}]},"private":false,"component":false,"name":"Ext.util.HashMap","alternateClassNames":[],"id":"class-Ext.util.HashMap","mixedInto":[],"xtypes":{},"files":[{"href":"HashMap.html#Ext-util-HashMap","filename":"HashMap.js"}]}); \ No newline at end of file