X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..6746dc89c47ed01b165cc1152533605f97eb8e8d:/docs/output/Ext.Object.js diff --git a/docs/output/Ext.Object.js b/docs/output/Ext.Object.js index e17d1caf..681ffeed 100644 --- a/docs/output/Ext.Object.js +++ b/docs/output/Ext.Object.js @@ -1,330 +1,365 @@ Ext.data.JsonP.Ext_Object({ - "tagname": "class", - "name": "Ext.Object", - "doc": "

A collection of useful static methods to deal with objects

\n", - "extends": null, - "mixins": [ - - ], - "alternateClassNames": [ + "allMixins": [ ], - "xtype": null, - "author": "Jacky Nguyen ", + "deprecated": null, "docauthor": "Jacky Nguyen ", - "singleton": true, - "private": false, - "cfg": [ + "members": { + "cfg": [ - ], - "method": [ - { - "tagname": "method", - "name": "each", - "member": "Ext.Object", - "doc": "

Iterate through an object and invoke the given callback function for each iteration. The iteration can be stop\nby returning false in the callback function. For example:

\n\n
var person = {\n    name: 'Jacky'\n    hairColor: 'black'\n    loves: ['food', 'sleeping', 'wife']\n};\n\nExt.Object.each(person, function(key, value, myself) {\n    console.log(key + \":\" + value);\n\n    if (key === 'hairColor') {\n        return false; // stop the iteration\n    }\n});\n
\n", - "params": [ - { - "type": "Object", - "name": "object", - "doc": "

The object to iterate

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

The callback function. Passed arguments for each iteration are:

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

(Optional) The execution scope (this) of the callback function

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Object.js", - "linenr": 275, - "html_filename": "Object.html", - "href": "Object.html#Ext-Object-method-each", - "shortDoc": "Iterate through an object and invoke the given callback function for each iteration. The iteration can be stop\nby ret..." - }, - { - "tagname": "method", - "name": "fromQueryString", - "member": "Ext.Object", - "doc": "

Converts a query string back into an object.

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

The query string to decode

\n", - "optional": false + ], + "method": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Object.html#Ext-Object-method-each", + "shortDoc": "Iterate through an object and invoke the given callback function for each iteration. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/lang/Object.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "

The object to iterate

\n", + "name": "object" + }, + { + "type": "Function", + "optional": false, + "doc": "

The callback function. Passed arguments for each iteration are:

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

(Optional) The execution scope (this) of the callback function

\n", + "name": "scope" + } + ], + "name": "each", + "owner": "Ext.Object", + "doc": "

Iterate through an object and invoke the given callback function for each iteration. The iteration can be stop\nby returning false in the callback function. For example:

\n\n
var person = {\n    name: 'Jacky'\n    hairColor: 'black'\n    loves: ['food', 'sleeping', 'wife']\n};\n\nExt.Object.each(person, function(key, value, myself) {\n    console.log(key + \":\" + value);\n\n    if (key === 'hairColor') {\n        return false; // stop the iteration\n    }\n});\n
\n", + "linenr": 275, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Boolean", - "name": "recursive", - "doc": "

(Optional) Whether or not to recursively decode the string. This format is supported by\nPHP / Ruby on Rails servers and similar. Defaults to false

\n", - "optional": false - } - ], - "return": { - "type": "Object", - "doc": "\n" + "html_filename": "Object.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Object.js", - "linenr": 156, - "html_filename": "Object.html", - "href": "Object.html#Ext-Object-method-fromQueryString", - "shortDoc": "Converts a query string back into an object.\n\n\nNon-recursive:\n\n Ext.Object.fromQueryString(foo=1&bar=2); // retu..." - }, - { - "tagname": "method", - "name": "getKey", - "member": "Ext.Object", - "doc": "

Returns the first matching key corresponding to the given value.\nIf no matching value is found, null is returned.

\n\n
var person = {\n    name: 'Jacky',\n    loves: 'food'\n};\n\nalert(Ext.Object.getKey(sencha, 'loves')); // alerts 'food'\n
\n", - "params": [ - { + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Object.html#Ext-Object-method-fromQueryString", + "shortDoc": "Converts a query string back into an object. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/lang/Object.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The query string to decode

\n", + "name": "queryString" + }, + { + "type": "Boolean", + "optional": false, + "doc": "

(Optional) Whether or not to recursively decode the string. This format is supported by\nPHP / Ruby on Rails servers and similar. Defaults to false

\n", + "name": "recursive" + } + ], + "name": "fromQueryString", + "owner": "Ext.Object", + "doc": "

Converts a query string back into an object.

\n\n\n\n", + "linenr": 156, + "return": { "type": "Object", - "name": "object", - "doc": "\n", - "optional": false + "doc": "\n" }, - { - "type": "Object", - "name": "value", - "doc": "

The value to find

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Object.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Object.js", - "linenr": 388, - "html_filename": "Object.html", - "href": "Object.html#Ext-Object-method-getKey", - "shortDoc": "Returns the first matching key corresponding to the given value.\nIf no matching value is found, null is returned.\n\nva..." - }, - { - "tagname": "method", - "name": "getKeys", - "member": "Ext.Object", - "doc": "

Gets all keys of the given object as an array.

\n\n
var values = Ext.Object.getKeys({\n    name: 'Jacky',\n    loves: 'food'\n}); // ['name', 'loves']\n
\n", - "params": [ - { - "type": "Object", - "name": "object", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "Array", - "doc": "

An array of keys from the object

\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Object.html#Ext-Object-method-getKey", + "shortDoc": "Returns the first matching key corresponding to the given value. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/lang/Object.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "object" + }, + { + "type": "Object", + "optional": false, + "doc": "

The value to find

\n", + "name": "value" + } + ], + "name": "getKey", + "owner": "Ext.Object", + "doc": "

Returns the first matching key corresponding to the given value.\nIf no matching value is found, null is returned.

\n\n
var person = {\n    name: 'Jacky',\n    loves: 'food'\n};\n\nalert(Ext.Object.getKey(sencha, 'loves')); // alerts 'food'\n
\n", + "linenr": 388, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Object.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Object.js", - "linenr": 438, - "html_filename": "Object.html", - "href": "Object.html#Ext-Object-method-getKeys", - "shortDoc": "Gets all keys of the given object as an array.\n\nvar values = Ext.Object.getKeys({\n name: 'Jacky',\n loves: 'food..." - }, - { - "tagname": "method", - "name": "getSize", - "member": "Ext.Object", - "doc": "

Gets the total number of this object's own properties

\n\n
var size = Ext.Object.getSize({\n    name: 'Jacky',\n    loves: 'food'\n}); // size equals 2\n
\n", - "params": [ - { - "type": "Object", - "name": "object", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "Number", - "doc": "

size

\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Object.html#Ext-Object-method-getKeys", + "shortDoc": "Gets all keys of the given object as an array. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/lang/Object.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "object" + } + ], + "name": "getKeys", + "owner": "Ext.Object", + "doc": "

Gets all keys of the given object as an array.

\n\n
var values = Ext.Object.getKeys({\n    name: 'Jacky',\n    loves: 'food'\n}); // ['name', 'loves']\n
\n", + "linenr": 438, + "return": { + "type": "Array", + "doc": "

An array of keys from the object

\n" + }, + "html_filename": "Object.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Object.js", - "linenr": 463, - "html_filename": "Object.html", - "href": "Object.html#Ext-Object-method-getSize", - "shortDoc": "Gets the total number of this object's own properties\n\nvar size = Ext.Object.getSize({\n name: 'Jacky',\n loves: ..." - }, - { - "tagname": "method", - "name": "getValues", - "member": "Ext.Object", - "doc": "

Gets all values of the given object as an array.

\n\n
var values = Ext.Object.getValues({\n    name: 'Jacky',\n    loves: 'food'\n}); // ['Jacky', 'food']\n
\n", - "params": [ - { - "type": "Object", - "name": "object", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "Array", - "doc": "

An array of values from the object

\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Object.html#Ext-Object-method-getSize", + "shortDoc": "Gets the total number of this object's own properties\n\nvar size = Ext.Object.getSize({\n name: 'Jacky',\n loves: ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/lang/Object.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "object" + } + ], + "name": "getSize", + "owner": "Ext.Object", + "doc": "

Gets the total number of this object's own properties

\n\n
var size = Ext.Object.getSize({\n    name: 'Jacky',\n    loves: 'food'\n}); // size equals 2\n
\n", + "linenr": 463, + "return": { + "type": "Number", + "doc": "

size

\n" + }, + "html_filename": "Object.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Object.js", - "linenr": 413, - "html_filename": "Object.html", - "href": "Object.html#Ext-Object-method-getValues", - "shortDoc": "Gets all values of the given object as an array.\n\nvar values = Ext.Object.getValues({\n name: 'Jacky',\n loves: '..." - }, - { - "tagname": "method", - "name": "merge", - "member": "Ext.Object", - "doc": "

Merges any number of objects recursively without referencing them or their children.

\n\n
var extjs = {\n    companyName: 'Ext JS',\n    products: ['Ext JS', 'Ext GWT', 'Ext Designer'],\n    isSuperCool: true\n    office: {\n        size: 2000,\n        location: 'Palo Alto',\n        isFun: true\n    }\n};\n\nvar newStuff = {\n    companyName: 'Sencha Inc.',\n    products: ['Ext JS', 'Ext GWT', 'Ext Designer', 'Sencha Touch', 'Sencha Animator'],\n    office: {\n        size: 40000,\n        location: 'Redwood City'\n    }\n};\n\nvar sencha = Ext.Object.merge(extjs, newStuff);\n\n// extjs and sencha then equals to\n{\n    companyName: 'Sencha Inc.',\n    products: ['Ext JS', 'Ext GWT', 'Ext Designer', 'Sencha Touch', 'Sencha Animator'],\n    isSuperCool: true\n    office: {\n        size: 30000,\n        location: 'Redwood City'\n        isFun: true\n    }\n}\n
\n", - "params": [ - { - "type": "Object", - "name": "object", - "doc": "

,...

\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Object.html#Ext-Object-method-getValues", + "shortDoc": "Gets all values of the given object as an array. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/lang/Object.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "object" + } + ], + "name": "getValues", + "owner": "Ext.Object", + "doc": "

Gets all values of the given object as an array.

\n\n
var values = Ext.Object.getValues({\n    name: 'Jacky',\n    loves: 'food'\n}); // ['Jacky', 'food']\n
\n", + "linenr": 413, + "return": { + "type": "Array", + "doc": "

An array of values from the object

\n" }, - { + "html_filename": "Object.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Object.html#Ext-Object-method-merge", + "shortDoc": "Merges any number of objects recursively without referencing them or their children. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/lang/Object.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "

,...

\n", + "name": "object" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "key" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "value" + } + ], + "name": "merge", + "owner": "Ext.Object", + "doc": "

Merges any number of objects recursively without referencing them or their children.

\n\n
var extjs = {\n    companyName: 'Ext JS',\n    products: ['Ext JS', 'Ext GWT', 'Ext Designer'],\n    isSuperCool: true\n    office: {\n        size: 2000,\n        location: 'Palo Alto',\n        isFun: true\n    }\n};\n\nvar newStuff = {\n    companyName: 'Sencha Inc.',\n    products: ['Ext JS', 'Ext GWT', 'Ext Designer', 'Sencha Touch', 'Sencha Animator'],\n    office: {\n        size: 40000,\n        location: 'Redwood City'\n    }\n};\n\nvar sencha = Ext.Object.merge(extjs, newStuff);\n\n// extjs and sencha then equals to\n{\n    companyName: 'Sencha Inc.',\n    products: ['Ext JS', 'Ext GWT', 'Ext Designer', 'Sencha Touch', 'Sencha Animator'],\n    isSuperCool: true\n    office: {\n        size: 30000,\n        location: 'Redwood City'\n        isFun: true\n    }\n}\n
\n", + "linenr": 313, + "return": { "type": "Object", - "name": "key", - "doc": "\n", - "optional": false + "doc": "

merged The object that is created as a result of merging all the objects passed in.

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

merged The object that is created as a result of merging all the objects passed in.

\n" + "html_filename": "Object.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Object.js", - "linenr": 313, - "html_filename": "Object.html", - "href": "Object.html#Ext-Object-method-merge", - "shortDoc": "Merges any number of objects recursively without referencing them or their children.\n\nvar extjs = {\n companyName: ..." - }, - { - "tagname": "method", - "name": "toQueryObjects", - "member": "Ext.Object", - "doc": "

Convert a name - value pair to an array of objects with support for nested structures; useful to construct\nquery strings. For example:

\n\n
var objects = Ext.Object.toQueryObjects('hobbies', ['reading', 'cooking', 'swimming']);\n\n// objects then equals:\n[\n    { name: 'hobbies', value: 'reading' },\n    { name: 'hobbies', value: 'cooking' },\n    { name: 'hobbies', value: 'swimming' },\n];\n\nvar objects = Ext.Object.toQueryObjects('dateOfBirth', {\n    day: 3,\n    month: 8,\n    year: 1987,\n    extra: {\n        hour: 4\n        minute: 30\n    }\n}, true); // Recursive\n\n// objects then equals:\n[\n    { name: 'dateOfBirth[day]', value: 3 },\n    { name: 'dateOfBirth[month]', value: 8 },\n    { name: 'dateOfBirth[year]', value: 1987 },\n    { name: 'dateOfBirth[extra][hour]', value: 4 },\n    { name: 'dateOfBirth[extra][minute]', value: 30 },\n];\n
\n", - "params": [ - { - "type": "String", - "name": "name", - "doc": "\n", - "optional": false - }, - { - "type": "Mixed", - "name": "value", - "doc": "\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Object.html#Ext-Object-method-toQueryObjects", + "shortDoc": "Convert a name - value pair to an array of objects with support for nested structures; useful to construct\nquery stri...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/lang/Object.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "\n", + "name": "name" + }, + { + "type": "Mixed", + "optional": false, + "doc": "\n", + "name": "value" + }, + { + "type": "Boolean", + "optional": false, + "doc": "\n", + "name": "recursive" + } + ], + "name": "toQueryObjects", + "owner": "Ext.Object", + "doc": "

Convert a name - value pair to an array of objects with support for nested structures; useful to construct\nquery strings. For example:

\n\n
var objects = Ext.Object.toQueryObjects('hobbies', ['reading', 'cooking', 'swimming']);\n\n// objects then equals:\n[\n    { name: 'hobbies', value: 'reading' },\n    { name: 'hobbies', value: 'cooking' },\n    { name: 'hobbies', value: 'swimming' },\n];\n\nvar objects = Ext.Object.toQueryObjects('dateOfBirth', {\n    day: 3,\n    month: 8,\n    year: 1987,\n    extra: {\n        hour: 4\n        minute: 30\n    }\n}, true); // Recursive\n\n// objects then equals:\n[\n    { name: 'dateOfBirth[day]', value: 3 },\n    { name: 'dateOfBirth[month]', value: 8 },\n    { name: 'dateOfBirth[year]', value: 1987 },\n    { name: 'dateOfBirth[extra][hour]', value: 4 },\n    { name: 'dateOfBirth[extra][minute]', value: 30 },\n];\n
\n", + "linenr": 15, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Boolean", - "name": "recursive", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Object.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Object.js", - "linenr": 15, - "html_filename": "Object.html", - "href": "Object.html#Ext-Object-method-toQueryObjects", - "shortDoc": "Convert a name - value pair to an array of objects with support for nested structures; useful to construct\nquery stri..." - }, - { - "tagname": "method", - "name": "toQueryString", - "member": "Ext.Object", - "doc": "

Takes an object and converts it to an encoded query string

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

The object to encode

\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Object.html#Ext-Object-method-toQueryString", + "shortDoc": "Takes an object and converts it to an encoded query string\n\n\nNon-recursive:\n\n Ext.Object.toQueryString({foo: 1, bar:...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/lang/Object.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "

The object to encode

\n", + "name": "object" + }, + { + "type": "Boolean", + "optional": true, + "doc": "

(optional) Whether or not to interpret the object in recursive format.\n(PHP / Ruby on Rails servers and similar). Defaults to false

\n", + "name": "recursive" + } + ], + "name": "toQueryString", + "owner": "Ext.Object", + "doc": "

Takes an object and converts it to an encoded query string

\n\n\n\n", + "linenr": 95, + "return": { + "type": "String", + "doc": "

queryString

\n" }, - { - "type": "Boolean", - "name": "recursive", - "doc": "

(optional) Whether or not to interpret the object in recursive format.\n(PHP / Ruby on Rails servers and similar). Defaults to false

\n", - "optional": true - } - ], - "return": { - "type": "String", - "doc": "

queryString

\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Object.js", - "linenr": 95, - "html_filename": "Object.html", - "href": "Object.html#Ext-Object-method-toQueryString", - "shortDoc": "Takes an object and converts it to an encoded query string\n\n\nNon-recursive:\n\n Ext.Object.toQueryString({foo: 1, bar:..." - } - ], - "property": [ + "html_filename": "Object.html" + } + ], + "property": [ - ], - "event": [ + ], + "cssVar": [ - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/lang/Object.js", - "linenr": 1, - "html_filename": "Object.html", - "href": "Object.html#Ext-Object", - "cssVar": [ + ], + "cssMixin": [ - ], - "cssMixin": [ + ], + "event": [ - ], - "component": false, + ] + }, + "singleton": true, + "alias": null, "superclasses": [ ], + "protected": false, + "tagname": "class", + "mixins": [ + + ], + "href": "Object.html#Ext-Object", "subclasses": [ ], + "static": false, + "author": "Jacky Nguyen ", + "component": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/lang/Object.js", + "private": false, + "alternateClassNames": [ + + ], + "name": "Ext.Object", + "doc": "

A collection of useful static methods to deal with objects

\n", "mixedInto": [ ], - "allMixins": [ + "linenr": 1, + "xtypes": [ - ] + ], + "html_filename": "Object.html", + "extends": null }); \ No newline at end of file