--- /dev/null
+Ext.data.JsonP.Ext_ModelManager({
+ "tagname": "class",
+ "name": "Ext.ModelManager",
+ "doc": "<p>The ModelManager keeps track of all <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> types defined in your application.</p>\n\n<p><strong>Creating Model Instances</strong>\nModel instances can be created by using the <a href=\"#/api/Ext.ModelManager-method-create\" rel=\"Ext.ModelManager-method-create\" class=\"docClass\">create</a> function. It is also possible to do\nthis by using the Model type directly. The following snippets are equivalent:</p>\n\n<pre><code>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</code></pre>\n\n<p><strong>Accessing Model Types</strong>\nA reference to a Model type can be obtained by using the <a href=\"#/api/Ext.ModelManager-method-getModel\" rel=\"Ext.ModelManager-method-getModel\" class=\"docClass\">getModel</a> function. Since models types\nare normal classes, you can access the type directly. The following snippets are equivalent:</p>\n\n<pre><code>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</code></pre>\n",
+ "extends": "Ext.AbstractManager",
+ "mixins": [
+
+ ],
+ "alternateClassNames": [
+ "Ext.ModelMgr"
+ ],
+ "xtype": null,
+ "author": "Ed Spencer",
+ "docauthor": null,
+ "singleton": true,
+ "private": false,
+ "cfg": [
+
+ ],
+ "method": [
+ {
+ "tagname": "method",
+ "name": "create",
+ "member": "Ext.ModelManager",
+ "doc": "<p>Creates a new instance of a Model using the given data.</p>\n",
+ "params": [
+ {
+ "type": "Object",
+ "name": "data",
+ "doc": "<p>Data to initialize the Model's fields with</p>\n",
+ "optional": false
+ },
+ {
+ "type": "String",
+ "name": "name",
+ "doc": "<p>The name of the model to create</p>\n",
+ "optional": false
+ },
+ {
+ "type": "Number",
+ "name": "id",
+ "doc": "<p>Optional unique id of the Model instance (see <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a>)</p>\n",
+ "optional": false
+ }
+ ],
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "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": "<p>Creates a new instance of a Model using the given data.</p>\n"
+ },
+ {
+ "tagname": "method",
+ "name": "each",
+ "member": "Ext.AbstractManager",
+ "doc": "<p>Executes the specified function once for each item in the collection.\nReturning false from the function will cease iteration.</p>\n\n<p>The paramaters passed to the function are:</p>\n\n<div class=\"mdetail-params\"><ul>\n<li><b>key</b> : String<p class=\"sub-desc\">The key of the item</p></li>\n<li><b>value</b> : Number<p class=\"sub-desc\">The value of the item</p></li>\n<li><b>length</b> : Number<p class=\"sub-desc\">The total number of items in the collection</p></li>\n</ul></div>\n\n",
+ "params": [
+ {
+ "type": "Object",
+ "name": "fn",
+ "doc": "<p>The function to execute.</p>\n",
+ "optional": false
+ },
+ {
+ "type": "Object",
+ "name": "scope",
+ "doc": "<p>The scope to execute in. Defaults to <tt>this</tt>.</p>\n",
+ "optional": false
+ }
+ ],
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "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": "<p>Returns an item by id.\nFor additional details see <a href=\"#/api/Ext.util.HashMap-method-get\" rel=\"Ext.util.HashMap-method-get\" class=\"docClass\">Ext.util.HashMap.get</a>.</p>\n",
+ "params": [
+ {
+ "type": "String",
+ "name": "id",
+ "doc": "<p>The id of the item</p>\n",
+ "optional": false
+ }
+ ],
+ "return": {
+ "type": "Mixed",
+ "doc": "<p>The item, <code>undefined</code> if not found.</p>\n"
+ },
+ "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": "<p>Returns an item by id.\nFor additional details see <a href=\"#/api/Ext.util.HashMap-method-get\" rel=\"Ext.util.HashMap-method-get\" class=\"docClass\">Ext.util.HashMap.get</a>.</p>\n"
+ },
+ {
+ "tagname": "method",
+ "name": "getCount",
+ "member": "Ext.AbstractManager",
+ "doc": "<p>Gets the number of items in the collection.</p>\n",
+ "params": [
+
+ ],
+ "return": {
+ "type": "Number",
+ "doc": "<p>The number of items in the collection.</p>\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": "<p>Gets the number of items in the collection.</p>\n"
+ },
+ {
+ "tagname": "method",
+ "name": "getModel",
+ "member": "Ext.ModelManager",
+ "doc": "<p>Returns the <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> for a given model name</p>\n",
+ "params": [
+ {
+ "type": "String/Object",
+ "name": "id",
+ "doc": "<p>The id of the model or the model instance.</p>\n",
+ "optional": false
+ }
+ ],
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "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": "<p>Returns the <a href=\"#/api/Ext.data.Model\" rel=\"Ext.data.Model\" class=\"docClass\">Ext.data.Model</a> for a given model name</p>\n"
+ },
+ {
+ "tagname": "method",
+ "name": "isRegistered",
+ "member": "Ext.AbstractManager",
+ "doc": "<p>Checks if an item type is registered.</p>\n",
+ "params": [
+ {
+ "type": "String",
+ "name": "type",
+ "doc": "<p>The mnemonic string by which the class may be looked up</p>\n",
+ "optional": false
+ }
+ ],
+ "return": {
+ "type": "Boolean",
+ "doc": "<p>Whether the type is registered.</p>\n"
+ },
+ "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": "<p>Checks if an item type is registered.</p>\n"
+ },
+ {
+ "tagname": "method",
+ "name": "onAvailable",
+ "member": "Ext.AbstractManager",
+ "doc": "<p>Registers a function that will be called when an item with the specified id is added to the manager. This will happen on instantiation.</p>\n",
+ "params": [
+ {
+ "type": "String",
+ "name": "id",
+ "doc": "<p>The item id</p>\n",
+ "optional": false
+ },
+ {
+ "type": "Function",
+ "name": "fn",
+ "doc": "<p>The callback function. Called with a single parameter, the item.</p>\n",
+ "optional": false
+ },
+ {
+ "type": "Object",
+ "name": "scope",
+ "doc": "<p>The scope (<code>this</code> reference) in which the callback is executed. Defaults to the item.</p>\n",
+ "optional": false
+ }
+ ],
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "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": "<p>Registers an item to be managed</p>\n",
+ "params": [
+ {
+ "type": "Mixed",
+ "name": "item",
+ "doc": "<p>The item to register</p>\n",
+ "optional": false
+ }
+ ],
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "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": "<p>Registers an item to be managed</p>\n"
+ },
+ {
+ "tagname": "method",
+ "name": "registerType",
+ "member": "Ext.AbstractManager",
+ "doc": "<p>Registers a new item constructor, keyed by a type key.\n\n",
+ "params": [
+ {
+ "type": "String",
+ "name": "type",
+ "doc": "<p>The mnemonic string by which the class may be looked up.</p>\n",
+ "optional": false
+ },
+ {
+ "type": "Constructor",
+ "name": "cls",
+ "doc": "<p>The new instance class.</p>\n",
+ "optional": false
+ }
+ ],
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "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": "<p>Registers a new item constructor, keyed by a type key.\n\n"
+ },
+ {
+ "tagname": "method",
+ "name": "unregister",
+ "member": "Ext.AbstractManager",
+ "doc": "<p>Unregisters an item by removing it from this manager</p>\n",
+ "params": [
+ {
+ "type": "Mixed",
+ "name": "item",
+ "doc": "<p>The item to unregister</p>\n",
+ "optional": false
+ }
+ ],
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "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": "<p>Unregisters an item by removing it from this manager</p>\n"
+ }
+ ],
+ "property": [
+ {
+ "tagname": "property",
+ "name": "all",
+ "member": "Ext.AbstractManager",
+ "type": "Ext.util.MixedCollection",
+ "doc": "<p>Contains all of the items currently managed</p>\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": "<p>Private stack of associations that must be created once their associated model has been defined</p>\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": [
+
+ ],
+ "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ModelManager.js",
+ "linenr": 1,
+ "html_filename": "ModelManager.html",
+ "href": "ModelManager.html#Ext-ModelManager",
+ "cssVar": [
+
+ ],
+ "cssMixin": [
+
+ ],
+ "component": false,
+ "superclasses": [
+ "Ext.AbstractManager"
+ ],
+ "subclasses": [
+
+ ],
+ "mixedInto": [
+
+ ],
+ "allMixins": [
+
+ ]
+});
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff