X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.Object.js diff --git a/docs/output/Ext.Object.js b/docs/output/Ext.Object.js index e17d1caf..0d7698f0 100644 --- a/docs/output/Ext.Object.js +++ b/docs/output/Ext.Object.js @@ -1,330 +1 @@ -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": [ - - ], - "xtype": null, - "author": "Jacky NguyenIterate 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:
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\nkey
value
object
The object itself(Optional) The execution scope (this
) of the callback function
Converts a query string back into an object.
\n\nNon-recursive:
\n\nExt.Object.fromQueryString(foo=1&bar=2); // returns {foo: 1, bar: 2}\n Ext.Object.fromQueryString(foo=&bar=2); // returns {foo: null, bar: 2}\n Ext.Object.fromQueryString(some%20price=%24300); // returns {'some price': '$300'}\n Ext.Object.fromQueryString(colors=red&colors=green&colors=blue); // returns {colors: ['red', 'green', 'blue']}
Recursive:
\n\nExt.Object.fromQueryString(\"username=Jacky&dateOfBirth[day]=1&dateOfBirth[month]=2&dateOfBirth[year]=1911&hobbies[0]=coding&hobbies[1]=eating&hobbies[2]=sleeping&hobbies[3][0]=nested&hobbies[3][1]=stuff\", true);
\n\n// returns\n {
\n\n username: 'Jacky',\n dateOfBirth: {\n day: '1',\n month: '2',\n year: '1911'\n },\n hobbies: ['coding', 'eating', 'sleeping', ['nested', 'stuff']]\n
\n\n}
The query string to decode
\n", - "optional": false - }, - { - "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" - }, - "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\nvar person = {\n name: 'Jacky',\n loves: 'food'\n};\n\nalert(Ext.Object.getKey(sencha, 'loves')); // alerts 'food'\n
\n",
- "params": [
- {
- "type": "Object",
- "name": "object",
- "doc": "\n",
- "optional": false
- },
- {
- "type": "Object",
- "name": "value",
- "doc": "The value to find
\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": 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\nvar 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" - }, - "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\nvar 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" - }, - "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\nvar 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" - }, - "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\nvar 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 - }, - { - "type": "Object", - "name": "key", - "doc": "\n", - "optional": false - }, - { - "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" - }, - "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:
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
- },
- {
- "type": "Boolean",
- "name": "recursive",
- "doc": "\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": 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\nNon-recursive:
\n\nExt.Object.toQueryString({foo: 1, bar: 2}); // returns \"foo=1&bar=2\"\n Ext.Object.toQueryString({foo: null, bar: 2}); // returns \"foo=&bar=2\"\n Ext.Object.toQueryString({'some price': '$300'}); // returns \"some%20price=%24300\"\n Ext.Object.toQueryString({date: new Date(2011, 0, 1)}); // returns \"date=%222011-01-01T00%3A00%3A00%22\"\n Ext.Object.toQueryString({colors: ['red', 'green', 'blue']}); // returns \"colors=red&colors=green&colors=blue\"
Recursive:
\n\nExt.Object.toQueryString({
\n\n username: 'Jacky',\n dateOfBirth: {\n day: 1,\n month: 2,\n year: 1911\n },\n hobbies: ['coding', 'eating', 'sleeping', ['nested', 'stuff']]\n
\n\n }, true); // returns the following string (broken down and url-decoded for ease of reading purpose):\n\n // username=Jacky\n // &dateOfBirth[day]=1&dateOfBirth[month]=2&dateOfBirth[year]=1911\n // &hobbies[0]=coding&hobbies[1]=eating&hobbies[2]=sleeping&hobbies[3][0]=nested&hobbies[3][1]=stuff\n
The object to encode
\n", - "optional": false - }, - { - "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": [ - - ], - "event": [ - - ], - "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": [ - - ], - "component": false, - "superclasses": [ - - ], - "subclasses": [ - - ], - "mixedInto": [ - - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_Object({"tagname":"class","html":"Files
A collection of useful static methods to deal with objects.
\nIterates through an object and invokes the given callback function for each iteration.\nThe iteration can be stopped by returning false
in the callback function. For example:
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
\nConverts a query string back into an object.
\n\nNon-recursive:
\n\nExt.Object.fromQueryString(foo=1&bar=2); // returns {foo: 1, bar: 2}\nExt.Object.fromQueryString(foo=&bar=2); // returns {foo: null, bar: 2}\nExt.Object.fromQueryString(some%20price=%24300); // returns {'some price': '$300'}\nExt.Object.fromQueryString(colors=red&colors=green&colors=blue); // returns {colors: ['red', 'green', 'blue']}\n
\n\nRecursive:
\n\n Ext.Object.fromQueryString(\"username=Jacky&dateOfBirth[day]=1&dateOfBirth[month]=2&dateOfBirth[year]=1911&hobbies[0]=coding&hobbies[1]=eating&hobbies[2]=sleeping&hobbies[3][0]=nested&hobbies[3][1]=stuff\", true);\n// returns\n{\n username: 'Jacky',\n dateOfBirth: {\n day: '1',\n month: '2',\n year: '1911'\n },\n hobbies: ['coding', 'eating', 'sleeping', ['nested', 'stuff']]\n}\n
\nThe query string to decode
\nWhether or not to recursively decode the string. This format is supported by\nPHP / Ruby on Rails servers and similar.
\nDefaults to: false
Merges any number of objects recursively without referencing them or their children.
\n\nvar 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
\nAny number of objects to merge.
\nmerged The object that is created as a result of merging all the objects passed in.
\nConverts a name
- value
pair to an array of objects with support for nested structures. Useful to construct\nquery strings. For example:
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
\nTrue to traverse object recursively
\nDefaults to: false
Takes an object and converts it to an encoded query string.
\n\nNon-recursive:
\n\nExt.Object.toQueryString({foo: 1, bar: 2}); // returns \"foo=1&bar=2\"\nExt.Object.toQueryString({foo: null, bar: 2}); // returns \"foo=&bar=2\"\nExt.Object.toQueryString({'some price': '$300'}); // returns \"some%20price=%24300\"\nExt.Object.toQueryString({date: new Date(2011, 0, 1)}); // returns \"date=%222011-01-01T00%3A00%3A00%22\"\nExt.Object.toQueryString({colors: ['red', 'green', 'blue']}); // returns \"colors=red&colors=green&colors=blue\"\n
\n\nRecursive:
\n\nExt.Object.toQueryString({\n username: 'Jacky',\n dateOfBirth: {\n day: 1,\n month: 2,\n year: 1911\n },\n hobbies: ['coding', 'eating', 'sleeping', ['nested', 'stuff']]\n}, true); // returns the following string (broken down and url-decoded for ease of reading purpose):\n// username=Jacky\n// &dateOfBirth[day]=1&dateOfBirth[month]=2&dateOfBirth[year]=1911\n// &hobbies[0]=coding&hobbies[1]=eating&hobbies[2]=sleeping&hobbies[3][0]=nested&hobbies[3][1]=stuff\n
\nThe object to encode
\nWhether or not to interpret the object in recursive format.\n(PHP / Ruby on Rails servers and similar).
\nDefaults to: false
queryString
\n