X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.ModelManager.js diff --git a/docs/output/Ext.ModelManager.js b/docs/output/Ext.ModelManager.js index 3957b526..6277a5a1 100644 --- a/docs/output/Ext.ModelManager.js +++ b/docs/output/Ext.ModelManager.js @@ -1,401 +1 @@ -Ext.data.JsonP.Ext_ModelManager({ - "allMixins": [ - - ], - "deprecated": null, - "docauthor": null, - "members": { - "cfg": [ - - ], - "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" - }, - "html_filename": "ModelManager.html" - }, - { - "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\nThe paramaters passed to the function are:
\n\nThe key of the item
The value of the item
The total number of items in the collection
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.
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" - }, - { - "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" - }, - { - "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" - }, - "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.
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" - }, - "html_filename": "AbstractManager.html" - }, - { - "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" - }, - { - "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" - }, - "html_filename": "AbstractManager.html" - }, - { - "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" - }, - { - "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": [ - - ], - "cssMixin": [ - - ], - "event": [ - - ] - }, - "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\nCreating 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\nExt.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\nAccessing 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\nExt.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": [
-
- ],
- "linenr": 1,
- "xtypes": [
-
- ],
- "html_filename": "ModelManager.html",
- "extends": "Ext.AbstractManager"
-});
\ No newline at end of file
+Ext.data.JsonP.Ext_ModelManager({"tagname":"class","html":"Alternate names
Ext.ModelMgrHierarchy
Ext.BaseExt.AbstractManagerExt.ModelManagerRequires
Files
The ModelManager keeps track of all Ext.data.Model types defined in your application.
\n\nCreating Model Instances
\n\nModel instances can be created by using the Ext.create method. Ext.create replaces\nthe deprecated Ext.ModelManager.create method. It is also possible to create a model instance\nthis by using the Model type directly. The following 3 snippets are equivalent:
\n\nExt.define('User', {\n extend: 'Ext.data.Model',\n fields: ['first', 'last']\n});\n\n// method 1, create using Ext.create (recommended)\nExt.create('User', {\n first: 'Ed',\n last: 'Spencer'\n});\n\n// method 2, create through the manager (deprecated)\nExt.ModelManager.create({\n first: 'Ed',\n last: 'Spencer'\n}, 'User');\n\n// method 3, create on the type directly\nnew User({\n first: 'Ed',\n last: 'Spencer'\n});\n
\n\nAccessing Model Types
\n\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\nExt.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
\nPrivate stack of associations that must be created once their associated model has been defined
\nPrivate stack of associations that must be created once their associated model has been defined
\nGet the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self
is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison
Ext.define('My.Cat', {\n statics: {\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n alert(this.self.speciesName); / dependent on 'this'\n\n return this;\n },\n\n clone: function() {\n return new this.self();\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\n
\nCall the original method that was previously overridden with override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nThe arguments, either an array or the arguments
object
Returns the result after calling the overridden method
\nCall the parent's overridden method. For example:
\n\nExt.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\n
\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Returns the result from the superclass' method
\nCreates a new instance of a Model using the given data.
\n\nThis method is deprecated. Use Ext.create instead. For example:
\n\nExt.create('User', {\n first: 'Ed',\n last: 'Spencer'\n});\n
\nData to initialize the Model's fields with
\nThe name of the model to create
\nunique id of the Model instance (see Ext.data.Model)
\nExecutes the specified function once for each item in the collection.
\nReturns an item by id.\nFor additional details see Ext.util.HashMap.get.
\nThe id of the item
\nThe item, undefined if not found.
\nInitialize configuration for this class. a typical example:
\n\nExt.define('My.awesome.Class', {\n // The default config\n config: {\n name: 'Awesome',\n isAwesome: true\n },\n\n constructor: function(config) {\n this.initConfig(config);\n\n return this;\n }\n});\n\nvar awesome = new My.awesome.Class({\n name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\nmixins The mixin prototypes as key - value pairs
\nRegisters a function that will be called when an item with the specified id is added to the manager.\nThis will happen on instantiation.
\nGet the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics()
is scope-independent and it always returns the class from which it was called, regardless of what\nthis
points to during run-time
Ext.define('My.Cat', {\n statics: {\n totalCreated: 0,\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n var statics = this.statics();\n\n alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to\n // equivalent to: My.Cat.speciesName\n\n alert(this.self.speciesName); // dependent on 'this'\n\n statics.totalCreated++;\n\n return this;\n },\n\n clone: function() {\n var cloned = new this.self; // dependent on 'this'\n\n cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName\n\n return cloned;\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n },\n\n constructor: function() {\n this.callParent();\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nalert(clone.groupName); // alerts 'Cat'\n\nalert(My.Cat.totalCreated); // alerts 3\n
\nUnregisters an item by removing it from this manager
\nThe item to unregister
\n