X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..6746dc89c47ed01b165cc1152533605f97eb8e8d:/docs/output/Ext.util.HashMap.js diff --git a/docs/output/Ext.util.HashMap.js b/docs/output/Ext.util.HashMap.js index 0080c55b..1116be1f 100644 --- a/docs/output/Ext.util.HashMap.js +++ b/docs/output/Ext.util.HashMap.js @@ -1,532 +1,941 @@ Ext.data.JsonP.Ext_util_HashMap({ - "tagname": "class", - "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", - "extends": null, - "mixins": [ - - ], - "alternateClassNames": [ + "allMixins": [ ], - "xtype": null, - "author": null, + "deprecated": null, "docauthor": null, - "singleton": false, - "private": false, - "cfg": [ - { - "tagname": "cfg", - "name": "keyFn", - "member": "Ext.util.HashMap", - "type": "Function", - "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", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 28, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap-cfg-keyFn", - "shortDoc": "A function that is used to retrieve a default key for a passed object.\nA default is provided that returns the id prop..." - } - ], - "method": [ - { - "tagname": "method", - "name": "HashMap", - "member": "Ext.util.HashMap", - "doc": "\n", - "params": [ - { + "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", - "name": "config", - "doc": "

The configuration options

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 1, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap-method-constructor", - "shortDoc": "\n" - }, - { - "tagname": "method", - "name": "add", - "member": "Ext.util.HashMap", - "doc": "

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

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

The item to add.

\n", - "optional": false - } - ], - "return": { - "type": "Object", - "doc": "

The item added.

\n" + "linenr": 36 }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 115, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap-method-add", - "shortDoc": "

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

\n" - }, - { - "tagname": "method", - "name": "clear", - "member": "Ext.util.HashMap", - "doc": "

Removes all items from the hash.

\n", - "params": [ - { + { + "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", - "name": "initial", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "Ext.util.HashMap", - "doc": "

this

\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 209, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap-method-clear", - "shortDoc": "

Removes all items from the hash.

\n" - }, - { - "tagname": "method", - "name": "clone", - "member": "Ext.util.HashMap", - "doc": "

Performs a shallow copy on this hash.

\n", - "params": [ - - ], - "return": { - "type": "Ext.util.HashMap", - "doc": "

The new hash object.

\n" + "doc": "

The item added.

\n" + }, + "html_filename": "HashMap.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 306, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap-method-clone", - "shortDoc": "

Performs a shallow copy on this hash.

\n" - }, - { - "tagname": "method", - "name": "contains", - "member": "Ext.util.HashMap", - "doc": "

Checks whether a value exists in the hash.

\n", - "params": [ - { - "type": "Object", - "name": "value", - "doc": "

The value to check for.

\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "

True if the value exists in the dictionary.

\n" + { + "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" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 232, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap-method-contains", - "shortDoc": "

Checks whether a value exists in the hash.

\n" - }, - { - "tagname": "method", - "name": "containsKey", - "member": "Ext.util.HashMap", - "doc": "

Checks whether a key exists in the hash.

\n", - "params": [ - { - "type": "String", - "name": "key", - "doc": "

The key to check for.

\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "

True if they key exists in the hash.

\n" + { + "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" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 223, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap-method-containsKey", - "shortDoc": "

Checks whether a key exists in the hash.

\n" - }, - { - "tagname": "method", - "name": "each", - "member": "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", - "params": [ - { - "type": "Function", - "name": "fn", - "doc": "

The function to execute.

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

The scope to execute in. Defaults to this.

\n", - "optional": false - } - ], - "return": { - "type": "Ext.util.HashMap", - "doc": "

this

\n" + "html_filename": "Base3.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 275, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap-method-each", - "shortDoc": "Executes the specified function once for each item in the hash.\nReturning false from the function will cease iteratio..." - }, - { - "tagname": "method", - "name": "get", - "member": "Ext.util.HashMap", - "doc": "

Retrieves an item with a particular key.

\n", - "params": [ - { - "type": "String", - "name": "key", - "doc": "

The key to lookup.

\n", - "optional": false - } - ], - "return": { - "type": "Object", - "doc": "

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

\n" + { + "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" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 200, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap-method-get", - "shortDoc": "

Retrieves an item with a particular key.

\n" - }, - { - "tagname": "method", - "name": "getCount", - "member": "Ext.util.HashMap", - "doc": "

Gets the number of items in the hash.

\n", - "params": [ + { + "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": [ - ], - "return": { - "type": "Number", - "doc": "

The number of items in the hash.

\n" + ], + "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" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 79, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap-method-getCount", - "shortDoc": "

Gets the number of items in the hash.

\n" - }, - { - "tagname": "method", - "name": "getKeys", - "member": "Ext.util.HashMap", - "doc": "

Return all of the keys in the hash.

\n", - "params": [ - - ], - "return": { - "type": "Array", - "doc": "

An array of keys.

\n" + { + "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" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 241, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap-method-getKeys", - "shortDoc": "

Return all of the keys in the hash.

\n" - }, - { - "tagname": "method", - "name": "getValues", - "member": "Ext.util.HashMap", - "doc": "

Return all of the values in the hash.

\n", - "params": [ - - ], - "return": { - "type": "Array", - "doc": "

An array of values.

\n" + { + "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" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 249, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap-method-getValues", - "shortDoc": "

Return all of the values in the hash.

\n" - }, - { - "tagname": "method", - "name": "remove", - "member": "Ext.util.HashMap", - "doc": "

Remove an item from the hash.

\n", - "params": [ - { + { + "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", - "name": "o", - "doc": "

The value of the item to remove.

\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "

True if the item was successfully removed.

\n" + "doc": "

the created instance.

\n" + }, + "html_filename": "Base3.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 168, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap-method-remove", - "shortDoc": "

Remove an item from the hash.

\n" - }, - { - "tagname": "method", - "name": "removeAtKey", - "member": "Ext.util.HashMap", - "doc": "

Remove an item from the hash.

\n", - "params": [ - { - "type": "String", - "name": "key", - "doc": "

The key to remove.

\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "

True if the item was successfully removed.

\n" + { + "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" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 181, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap-method-removeAtKey", - "shortDoc": "

Remove an item from the hash.

\n" - }, - { - "tagname": "method", - "name": "replace", - "member": "Ext.util.HashMap", - "doc": "

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

\n", - "params": [ - { - "type": "String", - "name": "key", - "doc": "

The key of the item.

\n", - "optional": false + { + "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", - "name": "value", - "doc": "

The new value for the item.

\n", - "optional": false - } - ], - "return": { - "type": "Object", - "doc": "

The new value of the item.

\n" + "doc": "

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

\n" + }, + "html_filename": "HashMap.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 147, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap-method-replace", - "shortDoc": "

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

\n" - } - ], - "property": [ + { + "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": [ - ], - "event": [ - { - "tagname": "event", - "name": "add", - "member": "Ext.util.HashMap", - "doc": "

Fires when a new item is added to the hash

\n", - "params": [ - { - "type": "Ext.util.HashMap", - "name": "this", - "doc": "

.

\n", - "optional": false + ], + "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", - "name": "key", - "doc": "

The key of the added item.

\n", - "optional": false + "doc": "

The key to use.

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

The value of the added item.

\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 42, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap-event-add", - "shortDoc": "

Fires when a new item is added to the hash

\n" - }, - { - "tagname": "event", - "name": "clear", - "member": "Ext.util.HashMap", - "doc": "

Fires when the hash is cleared.

\n", - "params": [ - { - "type": "Ext.util.HashMap", - "name": "this", - "doc": "

.

\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 50, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap-event-clear", - "shortDoc": "

Fires when the hash is cleared.

\n" - }, - { - "tagname": "event", - "name": "remove", - "member": "Ext.util.HashMap", - "doc": "

Fires when an item is removed from the hash.

\n", - "params": [ - { - "type": "Ext.util.HashMap", - "name": "this", - "doc": "

.

\n", - "optional": false + "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", - "name": "key", - "doc": "

The key of the removed item.

\n", - "optional": false + "doc": "

className

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

The value of the removed item.

\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 56, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap-event-remove", - "shortDoc": "

Fires when an item is removed from the hash.

\n" - }, - { - "tagname": "event", - "name": "replace", - "member": "Ext.util.HashMap", - "doc": "

Fires when an item is replaced in the hash.

\n", - "params": [ - { - "type": "Ext.util.HashMap", - "name": "this", - "doc": "

.

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

The key of the replaced item.

\n", - "optional": false + "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", - "name": "value", - "doc": "

The new value for the item.

\n", - "optional": false + "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", - "name": "old", - "doc": "

The old value for the item.

\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 64, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap-event-replace", - "shortDoc": "

Fires when an item is replaced in the hash.

\n" - } - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/HashMap.js", - "linenr": 1, - "html_filename": "HashMap.html", - "href": "HashMap.html#Ext-util-HashMap", - "cssVar": [ + "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": [ - ], - "cssMixin": [ + ], + "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": [ - ], - "component": false, + ], + "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": [ ], - "allMixins": [ + "linenr": 1, + "xtypes": [ - ] + ], + "html_filename": "HashMap.html", + "extends": "Ext.Base" }); \ No newline at end of file