X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..6746dc89c47ed01b165cc1152533605f97eb8e8d:/docs/output/Ext.ModelManager.js diff --git a/docs/output/Ext.ModelManager.js b/docs/output/Ext.ModelManager.js index 279c7d5a..3957b526 100644 --- a/docs/output/Ext.ModelManager.js +++ b/docs/output/Ext.ModelManager.js @@ -1,357 +1,401 @@ Ext.data.JsonP.Ext_ModelManager({ - "tagname": "class", - "name": "Ext.ModelManager", - "doc": "

The ModelManager keeps track of all Ext.data.Model types defined in your application.

\n\n

Creating Model Instances\nModel instances can be created by using the create function. It is also possible to do\nthis by using the Model type directly. The following snippets are equivalent:

\n\n
Ext.define('User', {\n    extend: 'Ext.data.Model',\n    fields: ['first', 'last']\n});\n\n// method 1, create through the manager\nExt.ModelManager.create({\n    first: 'Ed',\n    last: 'Spencer'\n}, 'User');\n\n// method 2, create on the type directly\nnew User({\n    first: 'Ed',\n    last: 'Spencer'\n});\n
\n\n

Accessing Model Types\nA reference to a Model type can be obtained by using the getModel function. Since models types\nare normal classes, you can access the type directly. The following snippets are equivalent:

\n\n
Ext.define('User', {\n    extend: 'Ext.data.Model',\n    fields: ['first', 'last']\n});\n\n// method 1, access model type through the manager\nvar UserType = Ext.ModelManager.getModel('User');\n\n// method 2, reference the type directly\nvar UserType = User;\n
\n", - "extends": "Ext.AbstractManager", - "mixins": [ + "allMixins": [ ], - "alternateClassNames": [ - "Ext.ModelMgr" - ], - "xtype": null, - "author": "Ed Spencer", + "deprecated": null, "docauthor": null, - "singleton": true, - "private": false, - "cfg": [ + "members": { + "cfg": [ - ], - "method": [ - { - "tagname": "method", - "name": "create", - "member": "Ext.ModelManager", - "doc": "

Creates a new instance of a Model using the given data.

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

Data to initialize the Model's fields with

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

The name of the model to create

\n", - "optional": false + ], + "method": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "ModelManager.html#Ext-ModelManager-method-create", + "shortDoc": "Creates a new instance of a Model using the given data. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ModelManager.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "

Data to initialize the Model's fields with

\n", + "name": "data" + }, + { + "type": "String", + "optional": false, + "doc": "

The name of the model to create

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

Optional unique id of the Model instance (see Ext.data.Model)

\n", + "name": "id" + } + ], + "name": "create", + "owner": "Ext.ModelManager", + "doc": "

Creates a new instance of a Model using the given data.

\n", + "linenr": 135, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Number", - "name": "id", - "doc": "

Optional unique id of the Model instance (see Ext.data.Model)

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "ModelManager.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ModelManager.js", - "linenr": 135, - "html_filename": "ModelManager.html", - "href": "ModelManager.html#Ext-ModelManager-method-create", - "shortDoc": "

Creates a new instance of a Model using the given data.

\n" - }, - { - "tagname": "method", - "name": "each", - "member": "Ext.AbstractManager", - "doc": "

Executes the specified function once for each item in the collection.\nReturning false from the function will cease iteration.

\n\n

The paramaters passed to the function are:

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

The function to execute.

\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractManager.html#Ext-AbstractManager-method-each", + "shortDoc": "Executes the specified function once for each item in the collection. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", + "private": false, + "params": [ + { + "type": "Object", + "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.AbstractManager", + "doc": "

Executes the specified function once for each item in the collection.\nReturning false from the function will cease iteration.

\n\n

The paramaters passed to the function are:

\n\n
\n\n", + "linenr": 116, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "scope", - "doc": "

The scope to execute in. Defaults to this.

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "AbstractManager.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js", - "linenr": 118, - "html_filename": "AbstractManager.html", - "href": "AbstractManager.html#Ext-AbstractManager-method-each", - "shortDoc": "Executes the specified function once for each item in the collection.\nReturning false from the function will cease it..." - }, - { - "tagname": "method", - "name": "get", - "member": "Ext.AbstractManager", - "doc": "

Returns an item by id.\nFor additional details see Ext.util.HashMap.get.

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

The id of the item

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

The item, undefined if not found.

\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractManager.html#Ext-AbstractManager-method-get", + "shortDoc": "Returns an item by id. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The id of the item

\n", + "name": "id" + } + ], + "name": "get", + "owner": "Ext.AbstractManager", + "doc": "

Returns an item by id.\nFor additional details see Ext.util.HashMap.get.

\n", + "linenr": 29, + "return": { + "type": "Mixed", + "doc": "

The item, undefined if not found.

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

Returns an item by id.\nFor additional details see Ext.util.HashMap.get.

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

Gets the number of items in the collection.

\n", - "params": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractManager.html#Ext-AbstractManager-method-getCount", + "shortDoc": "Gets the number of items in the collection. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", + "private": false, + "params": [ - ], - "return": { - "type": "Number", - "doc": "

The number of items in the collection.

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

Gets the number of items in the collection.

\n" - }, - { - "tagname": "method", - "name": "getModel", - "member": "Ext.ModelManager", - "doc": "

Returns the Ext.data.Model for a given model name

\n", - "params": [ - { - "type": "String/Object", - "name": "id", - "doc": "

The id of the model or the model instance.

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + ], + "name": "getCount", + "owner": "Ext.AbstractManager", + "doc": "

Gets the number of items in the collection.

\n", + "linenr": 133, + "return": { + "type": "Number", + "doc": "

The number of items in the collection.

\n" + }, + "html_filename": "AbstractManager.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ModelManager.js", - "linenr": 123, - "html_filename": "ModelManager.html", - "href": "ModelManager.html#Ext-ModelManager-method-getModel", - "shortDoc": "

Returns the Ext.data.Model for a given model name

\n" - }, - { - "tagname": "method", - "name": "isRegistered", - "member": "Ext.AbstractManager", - "doc": "

Checks if an item type is registered.

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

The mnemonic string by which the class may be looked up

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

Whether the type is registered.

\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "ModelManager.html#Ext-ModelManager-method-getModel", + "shortDoc": "Returns the Ext.data.Model for a given model name ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ModelManager.js", + "private": false, + "params": [ + { + "type": "String/Object", + "optional": false, + "doc": "

The id of the model or the model instance.

\n", + "name": "id" + } + ], + "name": "getModel", + "owner": "Ext.ModelManager", + "doc": "

Returns the Ext.data.Model for a given model name

\n", + "linenr": 123, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "ModelManager.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js", - "linenr": 67, - "html_filename": "AbstractManager.html", - "href": "AbstractManager.html#Ext-AbstractManager-method-isRegistered", - "shortDoc": "

Checks if an item type is registered.

\n" - }, - { - "tagname": "method", - "name": "onAvailable", - "member": "Ext.AbstractManager", - "doc": "

Registers a function that will be called when an item with the specified id is added to the manager. This will happen on instantiation.

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

The item id

\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractManager.html#Ext-AbstractManager-method-isRegistered", + "shortDoc": "Checks if an item type is registered. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The mnemonic string by which the class may be looked up

\n", + "name": "type" + } + ], + "name": "isRegistered", + "owner": "Ext.AbstractManager", + "doc": "

Checks if an item type is registered.

\n", + "linenr": 65, + "return": { + "type": "Boolean", + "doc": "

Whether the type is registered.

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

The callback function. Called with a single parameter, the item.

\n", - "optional": false + "html_filename": "AbstractManager.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractManager.html#Ext-AbstractManager-method-onAvailable", + "shortDoc": "Registers a function that will be called when an item with the specified id is added to the manager. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The item id

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

The callback function. Called with a single parameter, the item.

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

The scope (this reference) in which the callback is executed. Defaults to the item.

\n", + "name": "scope" + } + ], + "name": "onAvailable", + "owner": "Ext.AbstractManager", + "doc": "

Registers a function that will be called when an item with the specified id is added to the manager. This will happen on instantiation.

\n", + "linenr": 93, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "scope", - "doc": "

The scope (this reference) in which the callback is executed. Defaults to the item.

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "AbstractManager.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js", - "linenr": 95, - "html_filename": "AbstractManager.html", - "href": "AbstractManager.html#Ext-AbstractManager-method-onAvailable", - "shortDoc": "Registers a function that will be called when an item with the specified id is added to the manager. This will happen..." - }, - { - "tagname": "method", - "name": "register", - "member": "Ext.AbstractManager", - "doc": "

Registers an item to be managed

\n", - "params": [ - { - "type": "Mixed", - "name": "item", - "doc": "

The item to register

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractManager.html#Ext-AbstractManager-method-register", + "shortDoc": "Registers an item to be managed ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", + "private": false, + "params": [ + { + "type": "Mixed", + "optional": false, + "doc": "

The item to register

\n", + "name": "item" + } + ], + "name": "register", + "owner": "Ext.AbstractManager", + "doc": "

Registers an item to be managed

\n", + "linenr": 39, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "AbstractManager.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js", - "linenr": 41, - "html_filename": "AbstractManager.html", - "href": "AbstractManager.html#Ext-AbstractManager-method-register", - "shortDoc": "

Registers an item to be managed

\n" - }, - { - "tagname": "method", - "name": "registerType", - "member": "Ext.AbstractManager", - "doc": "

Registers a new item constructor, keyed by a type key.\n\n", - "params": [ - { - "type": "String", - "name": "type", - "doc": "

The mnemonic string by which the class may be looked up.

\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractManager.html#Ext-AbstractManager-method-registerType", + "shortDoc": "Registers a new item constructor, keyed by a type key. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The mnemonic string by which the class may be looked up.

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

The new instance class.

\n", + "name": "cls" + } + ], + "name": "registerType", + "owner": "Ext.AbstractManager", + "doc": "

Registers a new item constructor, keyed by a type key.\n\n", + "linenr": 55, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Constructor", - "name": "cls", - "doc": "

The new instance class.

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "AbstractManager.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js", - "linenr": 57, - "html_filename": "AbstractManager.html", - "href": "AbstractManager.html#Ext-AbstractManager-method-registerType", - "shortDoc": "

Registers a new item constructor, keyed by a type key.\n\n" - }, - { - "tagname": "method", - "name": "unregister", - "member": "Ext.AbstractManager", - "doc": "

Unregisters an item by removing it from this manager

\n", - "params": [ - { - "type": "Mixed", - "name": "item", - "doc": "

The item to unregister

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractManager.html#Ext-AbstractManager-method-unregister", + "shortDoc": "Unregisters an item by removing it from this manager ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", + "private": false, + "params": [ + { + "type": "Mixed", + "optional": false, + "doc": "

The item to unregister

\n", + "name": "item" + } + ], + "name": "unregister", + "owner": "Ext.AbstractManager", + "doc": "

Unregisters an item by removing it from this manager

\n", + "linenr": 47, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "AbstractManager.html" + } + ], + "property": [ + { + "type": "Ext.util.MixedCollection", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "AbstractManager.html#Ext-AbstractManager-property-all", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", + "private": false, + "name": "all", + "owner": "Ext.AbstractManager", + "doc": "

Contains all of the items currently managed

\n", + "linenr": 19, + "html_filename": "AbstractManager.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js", - "linenr": 49, - "html_filename": "AbstractManager.html", - "href": "AbstractManager.html#Ext-AbstractManager-method-unregister", - "shortDoc": "

Unregisters an item by removing it from this manager

\n" - } - ], - "property": [ - { - "tagname": "property", - "name": "all", - "member": "Ext.AbstractManager", - "type": "Ext.util.MixedCollection", - "doc": "

Contains all of the items currently managed

\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js", - "linenr": 21, - "html_filename": "AbstractManager.html", - "href": "AbstractManager.html#Ext-AbstractManager-property-all" - }, - { - "tagname": "property", - "name": "associationStack", - "member": "Ext.ModelManager", - "type": "Array", - "doc": "

Private stack of associations that must be created once their associated model has been defined

\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ModelManager.js", - "linenr": 56, - "html_filename": "ModelManager.html", - "href": "ModelManager.html#Ext-ModelManager-property-associationStack" - } - ], - "event": [ + { + "type": "Array", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "ModelManager.html#Ext-ModelManager-property-associationStack", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ModelManager.js", + "private": false, + "name": "associationStack", + "owner": "Ext.ModelManager", + "doc": "

Private stack of associations that must be created once their associated model has been defined

\n", + "linenr": 56, + "html_filename": "ModelManager.html" + } + ], + "cssVar": [ - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ModelManager.js", - "linenr": 1, - "html_filename": "ModelManager.html", - "href": "ModelManager.html#Ext-ModelManager", - "cssVar": [ + ], + "cssMixin": [ - ], - "cssMixin": [ + ], + "event": [ - ], - "component": false, + ] + }, + "singleton": true, + "alias": null, "superclasses": [ "Ext.AbstractManager" ], + "protected": false, + "tagname": "class", + "mixins": [ + + ], + "href": "ModelManager.html#Ext-ModelManager", "subclasses": [ ], + "static": false, + "author": "Ed Spencer", + "component": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ModelManager.js", + "private": false, + "alternateClassNames": [ + "Ext.ModelMgr" + ], + "name": "Ext.ModelManager", + "doc": "

The ModelManager keeps track of all Ext.data.Model types defined in your application.

\n\n

Creating Model Instances\nModel instances can be created by using the create function. It is also possible to do\nthis by using the Model type directly. The following snippets are equivalent:

\n\n
Ext.define('User', {\n    extend: 'Ext.data.Model',\n    fields: ['first', 'last']\n});\n\n// method 1, create through the manager\nExt.ModelManager.create({\n    first: 'Ed',\n    last: 'Spencer'\n}, 'User');\n\n// method 2, create on the type directly\nnew User({\n    first: 'Ed',\n    last: 'Spencer'\n});\n
\n\n

Accessing Model Types\nA reference to a Model type can be obtained by using the getModel function. Since models types\nare normal classes, you can access the type directly. The following snippets are equivalent:

\n\n
Ext.define('User', {\n    extend: 'Ext.data.Model',\n    fields: ['first', 'last']\n});\n\n// method 1, access model type through the manager\nvar UserType = Ext.ModelManager.getModel('User');\n\n// method 2, reference the type directly\nvar UserType = User;\n
\n", "mixedInto": [ ], - "allMixins": [ + "linenr": 1, + "xtypes": [ - ] + ], + "html_filename": "ModelManager.html", + "extends": "Ext.AbstractManager" }); \ No newline at end of file