X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/output/Ext.Object.js

diff --git a/docs/output/Ext.Object.js b/docs/output/Ext.Object.js
new file mode 100644
index 00000000..e17d1caf
--- /dev/null
+++ b/docs/output/Ext.Object.js
@@ -0,0 +1,330 @@
+Ext.data.JsonP.Ext_Object({
+  "tagname": "class",
+  "name": "Ext.Object",
+  "doc": "<p>A collection of useful static methods to deal with objects</p>\n",
+  "extends": null,
+  "mixins": [
+
+  ],
+  "alternateClassNames": [
+
+  ],
+  "xtype": null,
+  "author": "Jacky Nguyen <jacky@sencha.com>",
+  "docauthor": "Jacky Nguyen <jacky@sencha.com>",
+  "singleton": true,
+  "private": false,
+  "cfg": [
+
+  ],
+  "method": [
+    {
+      "tagname": "method",
+      "name": "each",
+      "member": "Ext.Object",
+      "doc": "<p>Iterate through an object and invoke the given callback function for each iteration. The iteration can be stop\nby returning <code>false</code> in the callback function. For example:</p>\n\n<pre><code>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</code></pre>\n",
+      "params": [
+        {
+          "type": "Object",
+          "name": "object",
+          "doc": "<p>The object to iterate</p>\n",
+          "optional": false
+        },
+        {
+          "type": "Function",
+          "name": "fn",
+          "doc": "<p>The callback function. Passed arguments for each iteration are:</p>\n\n<ul>\n<li>{String} <code>key</code></li>\n<li>{Mixed} <code>value</code></li>\n<li>{Object} <code>object</code> The object itself</li>\n</ul>\n\n",
+          "optional": false
+        },
+        {
+          "type": "Object",
+          "name": "scope",
+          "doc": "<p>(Optional) The execution scope (<code>this</code>) of the callback function</p>\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": "<p>Converts a query string back into an object.</p>\n\n<ul>\n<li><p>Non-recursive:</p>\n\n<p>  Ext.Object.fromQueryString(foo=1&amp;bar=2); // returns {foo: 1, bar: 2}\n  Ext.Object.fromQueryString(foo=&amp;bar=2); // returns {foo: null, bar: 2}\n  Ext.Object.fromQueryString(some%20price=%24300); // returns {'some price': '$300'}\n  Ext.Object.fromQueryString(colors=red&amp;colors=green&amp;colors=blue); // returns {colors: ['red', 'green', 'blue']}</p></li>\n<li><p>Recursive:</p>\n\n<p>  Ext.Object.fromQueryString(\"username=Jacky&amp;dateOfBirth[day]=1&amp;dateOfBirth[month]=2&amp;dateOfBirth[year]=1911&amp;hobbies[0]=coding&amp;hobbies[1]=eating&amp;hobbies[2]=sleeping&amp;hobbies[3][0]=nested&amp;hobbies[3][1]=stuff\", true);</p>\n\n<p>  // returns\n  {</p>\n\n<pre><code>  username: 'Jacky',\n  dateOfBirth: {\n      day: '1',\n      month: '2',\n      year: '1911'\n  },\n  hobbies: ['coding', 'eating', 'sleeping', ['nested', 'stuff']]\n</code></pre>\n\n<p>  }</p></li>\n</ul>\n\n",
+      "params": [
+        {
+          "type": "String",
+          "name": "queryString",
+          "doc": "<p>The query string to decode</p>\n",
+          "optional": false
+        },
+        {
+          "type": "Boolean",
+          "name": "recursive",
+          "doc": "<p>(Optional) Whether or not to recursively decode the string. This format is supported by\nPHP / Ruby on Rails servers and similar. Defaults to false</p>\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&amp;bar=2); // retu..."
+    },
+    {
+      "tagname": "method",
+      "name": "getKey",
+      "member": "Ext.Object",
+      "doc": "<p>Returns the first matching key corresponding to the given value.\nIf no matching value is found, null is returned.</p>\n\n<pre><code>var person = {\n    name: 'Jacky',\n    loves: 'food'\n};\n\nalert(Ext.Object.getKey(sencha, 'loves')); // alerts 'food'\n</code></pre>\n",
+      "params": [
+        {
+          "type": "Object",
+          "name": "object",
+          "doc": "\n",
+          "optional": false
+        },
+        {
+          "type": "Object",
+          "name": "value",
+          "doc": "<p>The value to find</p>\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": "<p>Gets all keys of the given object as an array.</p>\n\n<pre><code>var values = Ext.Object.getKeys({\n    name: 'Jacky',\n    loves: 'food'\n}); // ['name', 'loves']\n</code></pre>\n",
+      "params": [
+        {
+          "type": "Object",
+          "name": "object",
+          "doc": "\n",
+          "optional": false
+        }
+      ],
+      "return": {
+        "type": "Array",
+        "doc": "<p>An array of keys from the object</p>\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": "<p>Gets the total number of this object's own properties</p>\n\n<pre><code>var size = Ext.Object.getSize({\n    name: 'Jacky',\n    loves: 'food'\n}); // size equals 2\n</code></pre>\n",
+      "params": [
+        {
+          "type": "Object",
+          "name": "object",
+          "doc": "\n",
+          "optional": false
+        }
+      ],
+      "return": {
+        "type": "Number",
+        "doc": "<p>size</p>\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": "<p>Gets all values of the given object as an array.</p>\n\n<pre><code>var values = Ext.Object.getValues({\n    name: 'Jacky',\n    loves: 'food'\n}); // ['Jacky', 'food']\n</code></pre>\n",
+      "params": [
+        {
+          "type": "Object",
+          "name": "object",
+          "doc": "\n",
+          "optional": false
+        }
+      ],
+      "return": {
+        "type": "Array",
+        "doc": "<p>An array of values from the object</p>\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": "<p>Merges any number of objects recursively without referencing them or their children.</p>\n\n<pre><code>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</code></pre>\n",
+      "params": [
+        {
+          "type": "Object",
+          "name": "object",
+          "doc": "<p>,...</p>\n",
+          "optional": false
+        },
+        {
+          "type": "Object",
+          "name": "key",
+          "doc": "\n",
+          "optional": false
+        },
+        {
+          "type": "Object",
+          "name": "value",
+          "doc": "\n",
+          "optional": false
+        }
+      ],
+      "return": {
+        "type": "Object",
+        "doc": "<p>merged The object that is created as a result of merging all the objects passed in.</p>\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": "<p>Convert a <code>name</code> - <code>value</code> pair to an array of objects with support for nested structures; useful to construct\nquery strings. For example:</p>\n\n<pre><code>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</code></pre>\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": "<p>Takes an object and converts it to an encoded query string</p>\n\n<ul>\n<li><p>Non-recursive:</p>\n\n<p>  Ext.Object.toQueryString({foo: 1, bar: 2}); // returns \"foo=1&amp;bar=2\"\n  Ext.Object.toQueryString({foo: null, bar: 2}); // returns \"foo=&amp;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&amp;colors=green&amp;colors=blue\"</p></li>\n<li><p>Recursive:</p>\n\n<p>  Ext.Object.toQueryString({</p>\n\n<pre><code>  username: 'Jacky',\n  dateOfBirth: {\n      day: 1,\n      month: 2,\n      year: 1911\n  },\n  hobbies: ['coding', 'eating', 'sleeping', ['nested', 'stuff']]\n</code></pre>\n\n  }, true); // returns the following string (broken down and url-decoded for ease of reading purpose):\n\n<pre><code>        // username=Jacky\n        //    &amp;dateOfBirth[day]=1&amp;dateOfBirth[month]=2&amp;dateOfBirth[year]=1911\n        //    &amp;hobbies[0]=coding&amp;hobbies[1]=eating&amp;hobbies[2]=sleeping&amp;hobbies[3][0]=nested&amp;hobbies[3][1]=stuff\n</code></pre></li>\n</ul>\n\n",
+      "params": [
+        {
+          "type": "Object",
+          "name": "object",
+          "doc": "<p>The object to encode</p>\n",
+          "optional": false
+        },
+        {
+          "type": "Boolean",
+          "name": "recursive",
+          "doc": "<p>(optional) Whether or not to interpret the object in recursive format.\n(PHP / Ruby on Rails servers and similar). Defaults to false</p>\n",
+          "optional": true
+        }
+      ],
+      "return": {
+        "type": "String",
+        "doc": "<p>queryString</p>\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