X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..HEAD:/docs/output/Ext.Object.js diff --git a/docs/output/Ext.Object.js b/docs/output/Ext.Object.js index 681ffeed..0d7698f0 100644 --- a/docs/output/Ext.Object.js +++ b/docs/output/Ext.Object.js @@ -1,365 +1 @@ -Ext.data.JsonP.Ext_Object({ - "allMixins": [ - - ], - "deprecated": null, - "docauthor": "Jacky Nguyen ", - "members": { - "cfg": [ - - ], - "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" - }, - "html_filename": "Object.html" - }, - { - "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", - "doc": "\n" - }, - "html_filename": "Object.html" - }, - { - "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" - }, - { - "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" - }, - { - "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" - }, - { - "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", - "doc": "

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

\n" - }, - "html_filename": "Object.html" - }, - { - "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" - }, - "html_filename": "Object.html" - }, - { - "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" - }, - "html_filename": "Object.html" - } - ], - "property": [ - - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - - ] - }, - "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": [ - - ], - "linenr": 1, - "xtypes": [ - - ], - "html_filename": "Object.html", - "extends": null -}); \ No newline at end of file +Ext.data.JsonP.Ext_Object({"tagname":"class","html":"
Files
Object.js

A collection of useful static methods to deal with objects.

\n
Defined By

Methods

Ext.Object
view source
( Object object, Function fn, [Object scope] )
Iterates through an object and invokes the given callback function for each iteration. ...

Iterates 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:

\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

Parameters

  • object : Object

    The object to iterate

    \n
  • fn : Function

    The callback function.

    \n

    Parameters

  • scope : Object (optional)

    The execution scope (this) of the callback function

    \n
Ext.Object
view source
( String queryString, [Boolean recursive] ) : Object
Converts a query string back into an object. ...

Converts a query string back into an object.

\n\n

Non-recursive:

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

Recursive:

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

Parameters

  • queryString : String

    The query string to decode

    \n
  • recursive : Boolean (optional)

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

    \n

    Defaults to: false

Returns

Ext.Object
view source
( Object object, Object value )
Returns the first matching key corresponding to the given value. ...

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(person, 'food')); // alerts 'loves'\n
\n

Parameters

Ext.Object
view source
( Object object ) : String[]
Gets all keys of the given object as an array. ...

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

Parameters

Returns

  • String[]

    An array of keys from the object

    \n
Ext.Object
view source
( Object object ) : Number
Gets the total number of this object's own properties\n\nvar size = Ext.Object.getSize({\n name: 'Jacky',\n loves: ...

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

Parameters

Returns

Ext.Object
view source
( Object object ) : Array
Gets all values of the given object as an array. ...

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

Parameters

Returns

  • Array

    An array of values from the object

    \n
Ext.Object
view source
( Object... object ) : Object
Merges any number of objects recursively without referencing them or their children. ...

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

Parameters

  • object : Object...

    Any number of objects to merge.

    \n

Returns

  • Object

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

    \n
Ext.Object
view source
( String name, Object/Array value, [Boolean recursive] ) : Array
Converts a name - value pair to an array of objects with support for nested structures. ...

Converts 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

Parameters

  • name : String
    \n
  • value : Object/Array
    \n
  • recursive : Boolean (optional)

    True to traverse object recursively

    \n

    Defaults to: false

Returns

Ext.Object
view source
( Object object, [Boolean recursive] ) : String
Takes an object and converts it to an encoded query string. ...

Takes an object and converts it to an encoded query string.

\n\n

Non-recursive:

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

Recursive:

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

Parameters

  • object : Object

    The object to encode

    \n
  • recursive : Boolean (optional)

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

    \n

    Defaults to: false

Returns

","allMixins":[],"meta":{"author":["Jacky Nguyen "],"docauthor":["Jacky Nguyen "]},"requires":[],"deprecated":null,"extends":null,"inheritable":false,"static":false,"superclasses":[],"singleton":true,"code_type":"nop","alias":null,"statics":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[],"event":[]},"subclasses":[],"uses":[],"protected":false,"mixins":[],"members":{"property":[],"css_var":[],"css_mixin":[],"cfg":[],"method":[{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Object","template":false,"required":null,"protected":false,"name":"each","id":"method-each"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Object","template":false,"required":null,"protected":false,"name":"fromQueryString","id":"method-fromQueryString"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Object","template":false,"required":null,"protected":false,"name":"getKey","id":"method-getKey"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Object","template":false,"required":null,"protected":false,"name":"getKeys","id":"method-getKeys"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Object","template":false,"required":null,"protected":false,"name":"getSize","id":"method-getSize"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Object","template":false,"required":null,"protected":false,"name":"getValues","id":"method-getValues"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Object","template":false,"required":null,"protected":false,"name":"merge","id":"method-merge"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Object","template":false,"required":null,"protected":false,"name":"toQueryObjects","id":"method-toQueryObjects"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Object","template":false,"required":null,"protected":false,"name":"toQueryString","id":"method-toQueryString"}],"event":[]},"private":false,"component":false,"name":"Ext.Object","alternateClassNames":[],"id":"class-Ext.Object","mixedInto":[],"xtypes":{},"files":[{"href":"Object2.html#Ext-Object","filename":"Object.js"}]}); \ No newline at end of file