The string name of the model that is being associated with. Required
\n", - "linenr": 122, - "html_filename": "Association.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Association.html#Ext-data-Association-cfg-associationKey", - "shortDoc": "The name of the property in the data to read the association from. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Association.js", - "private": false, - "name": "associationKey", - "owner": "Ext.data.Association", - "doc": "The name of the property in the data to read the association from.\nDefaults to the name of the associated model.
\n", - "linenr": 136, - "html_filename": "Association.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Association.html#Ext-data-Association-cfg-ownerModel", - "shortDoc": "The string name of the model that owns the association. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Association.js", - "private": false, - "name": "ownerModel", - "owner": "Ext.data.Association", - "doc": "The string name of the model that owns the association. Required
\n", - "linenr": 118, - "html_filename": "Association.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Association.html#Ext-data-Association-cfg-primaryKey", - "shortDoc": "The name of the primary key on the associated model. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Association.js", - "private": false, - "name": "primaryKey", - "owner": "Ext.data.Association", - "doc": "The name of the primary key on the associated model. Defaults to 'id'.\nIn general this will be the Ext.data.Model.idProperty of the Model.
\n", - "linenr": 126, - "html_filename": "Association.html" - }, - { - "type": "Ext.data.reader.Reader", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Association.html#Ext-data-Association-cfg-reader", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Association.js", - "private": false, - "name": "reader", - "owner": "Ext.data.Association", - "doc": "A special reader to read associated data
\n", - "linenr": 132, - "html_filename": "Association.html" - } - ], - "method": [ - { - "deprecated": null, - "alias": null, - "href": "Association.html#Ext-data-Association-method-constructor", - "tagname": "method", - "protected": false, - "shortDoc": "Creates the Association object. ...", - "static": false, - "params": [ - { - "type": "Object", - "optional": true, - "doc": "(optional) Config object.
\n", - "name": "config" - } - ], - "private": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Association.js", - "doc": "Creates the Association object.
\n", - "owner": "Ext.data.Association", - "name": "Association", - "html_filename": "Association.html", - "return": { - "type": "Object", - "doc": "\n" - }, - "linenr": 170 - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Association.html#Ext-data-Association-method-getReader", - "shortDoc": "Get a specialized reader for reading associated data ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Association.js", - "private": false, - "params": [ - - ], - "name": "getReader", - "owner": "Ext.data.Association", - "doc": "Get a specialized reader for reading associated data
\n", - "linenr": 214, - "return": { - "type": "Ext.data.reader.Reader", - "doc": "The reader, null if not supplied
\n" - }, - "html_filename": "Association.html" - } - ], - "property": [ - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "Association.html#Ext-data-Association-property-associatedName", - "shortDoc": "The name of the model is on the other end of the association (e.g. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Association.js", - "private": false, - "name": "associatedName", - "owner": "Ext.data.Association", - "doc": "The name of the model is on the other end of the association (e.g. if a User model hasMany Orders, this is 'Order')
\n", - "linenr": 202, - "html_filename": "Association.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "Association.html#Ext-data-Association-property-ownerName", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Association.js", - "private": false, - "name": "ownerName", - "owner": "Ext.data.Association", - "doc": "The name of the model that 'owns' the association
\n", - "linenr": 196, - "html_filename": "Association.html" - } - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - - ] - }, - "singleton": false, - "alias": null, - "superclasses": [ - - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "Association.html#Ext-data-Association", - "subclasses": [ - "Ext.data.HasManyAssociation", - "Ext.data.BelongsToAssociation" - ], - "static": false, - "author": "Ed Spencer", - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/Association.js", - "private": false, - "alternateClassNames": [ - - ], - "name": "Ext.data.Association", - "doc": "Associations enable you to express relationships between different Models. Let's say we're\nwriting an ecommerce system where Users can make Orders - there's a relationship between these Models that we can\nexpress like this:
\n\n\n\n\nExt.define('User', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name', 'email'],\n\n hasMany: {model: 'Order', name: 'orders'}\n});\n\nExt.define('Order', {\n extend: 'Ext.data.Model',\n fields: ['id', 'user_id', 'status', 'price'],\n\n belongsTo: 'User'\n});\nWe've set up two models - User and Order - and told them about each other. You can set up as many associations on\neach Model as you need using the two default types - hasMany and\nbelongsTo. There's much more detail on the usage of each of those inside their\ndocumentation pages. If you're not familiar with Models already, there is plenty on those too.
\n\n\n\n\nFurther Reading
\n\n\n\n\n\n\n\nSelf association models
\n\nWe can also have models that create parent/child associations between the same type. Below is an example, where\ngroups can be nested inside other groups:
\n\n\n\n// Server Data\n{\n \"groups\": {\n \"id\": 10,\n \"parent_id\": 100,\n \"name\": \"Main Group\",\n \"parent_group\": {\n \"id\": 100,\n \"parent_id\": null,\n \"name\": \"Parent Group\"\n },\n \"child_groups\": [{\n \"id\": 2,\n \"parent_id\": 10,\n \"name\": \"Child Group 1\"\n },{\n \"id\": 3,\n \"parent_id\": 10,\n \"name\": \"Child Group 2\"\n },{\n \"id\": 4,\n \"parent_id\": 10,\n \"name\": \"Child Group 3\"\n }]\n }\n}\n\n// Client code\nExt.define('Group', {\n extend: 'Ext.data.Model',\n fields: ['id', 'parent_id', 'name'],\n proxy: {\n type: 'ajax',\n url: 'data.json',\n reader: {\n type: 'json',\n root: 'groups'\n }\n },\n associations: [{\n type: 'hasMany',\n model: 'Group',\n primaryKey: 'id',\n foreignKey: 'parent_id',\n autoLoad: true,\n associationKey: 'child_groups' // read child data from child_groups\n }, {\n type: 'belongsTo',\n model: 'Group',\n primaryKey: 'id',\n foreignKey: 'parent_id',\n autoLoad: true,\n associationKey: 'parent_group' // read parent data from parent_group\n }]\n});\n\n\nExt.onReady(function(){\n \n Group.load(10, {\n success: function(group){\n console.log(group.getGroup().get('name'));\n \n group.groups().each(function(rec){\n console.log(rec.get('name'));\n });\n }\n });\n \n});\nHierarchy
Ext.BaseExt.data.AssociationFiles
Associations enable you to express relationships between different Models. Let's say we're\nwriting an ecommerce system where Users can make Orders - there's a relationship between these Models that we can\nexpress like this:
\n\nExt.define('User', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name', 'email'],\n\n hasMany: {model: 'Order', name: 'orders'}\n});\n\nExt.define('Order', {\n extend: 'Ext.data.Model',\n fields: ['id', 'user_id', 'status', 'price'],\n\n belongsTo: 'User'\n});\nWe've set up two models - User and Order - and told them about each other. You can set up as many associations on\neach Model as you need using the two default types - hasMany and belongsTo. There's much more detail on the usage of each of those inside their\ndocumentation pages. If you're not familiar with Models already, there is plenty on those too.
\n\nFurther Reading
\n\n\n\n\nWe can also have models that create parent/child associations between the same type. Below is an example, where\ngroups can be nested inside other groups:
\n\n// Server Data\n{\n \"groups\": {\n \"id\": 10,\n \"parent_id\": 100,\n \"name\": \"Main Group\",\n \"parent_group\": {\n \"id\": 100,\n \"parent_id\": null,\n \"name\": \"Parent Group\"\n },\n \"child_groups\": [{\n \"id\": 2,\n \"parent_id\": 10,\n \"name\": \"Child Group 1\"\n },{\n \"id\": 3,\n \"parent_id\": 10,\n \"name\": \"Child Group 2\"\n },{\n \"id\": 4,\n \"parent_id\": 10,\n \"name\": \"Child Group 3\"\n }]\n }\n}\n\n// Client code\nExt.define('Group', {\n extend: 'Ext.data.Model',\n fields: ['id', 'parent_id', 'name'],\n proxy: {\n type: 'ajax',\n url: 'data.json',\n reader: {\n type: 'json',\n root: 'groups'\n }\n },\n associations: [{\n type: 'hasMany',\n model: 'Group',\n primaryKey: 'id',\n foreignKey: 'parent_id',\n autoLoad: true,\n associationKey: 'child_groups' // read child data from child_groups\n }, {\n type: 'belongsTo',\n model: 'Group',\n primaryKey: 'id',\n foreignKey: 'parent_id',\n associationKey: 'parent_group' // read parent data from parent_group\n }]\n});\n\nExt.onReady(function(){\n\n Group.load(10, {\n success: function(group){\n console.log(group.getGroup().get('name'));\n\n group.groups().each(function(rec){\n console.log(rec.get('name'));\n });\n }\n });\n\n});\nThe string name of the model that is being associated with.
\nThe string name of the model that is being associated with.
\nThe name of the property in the data to read the association from. Defaults to the name of the associated model.
\nThe string name of the model that owns the association.
\nThe string name of the model that owns the association.
\nThe name of the primary key on the associated model. In general this will be the\nExt.data.Model.idProperty of the Model.
\nDefaults to: "id"
The name of the model is on the other end of the association (e.g. if a User model hasMany Orders, this is\n'Order')
\nThe name of the model that 'owns' the association
\nThe name of the model that 'owns' the association
\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'\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\"\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'\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
\nGet a specialized reader for reading associated data
\nThe reader, null if not supplied
\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'\nmixins The mixin prototypes as key - value pairs
\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\nAdd / override static properties of this class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.addStatics({\n someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'\n method1: function() { ... }, // My.cool.Class.method1 = function() { ... };\n method2: function() { ... } // My.cool.Class.method2 = function() { ... };\n});\nthis
\nBorrow another class' members to the prototype of this class.
\n\nExt.define('Bank', {\n money: '$$$',\n printMoney: function() {\n alert('$$$$$$$');\n }\n});\n\nExt.define('Thief', {\n ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\nThe class to borrow members from
\nThe names of the members to borrow
\nthis
\nCreate a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\nAll parameters are passed to the constructor of the class.
\nthe created instance.
\nCreate aliases for existing prototype methods. Example:
\n\nExt.define('My.cool.Class', {\n method1: function() { ... },\n method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n method3: 'method1',\n method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\nThe new method name, or an object to set multiple aliases. See\nflexSetter
\nThe original method name
\nGet the current class' name in string format.
\n\nExt.define('My.cool.Class', {\n constructor: function() {\n alert(this.self.getName()); // alerts 'My.cool.Class'\n }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\nclassName
\nAdd methods / properties to the prototype of this class.
\n\nExt.define('My.awesome.Cat', {\n constructor: function() {\n ...\n }\n});\n\n My.awesome.Cat.implement({\n meow: function() {\n alert('Meowww...');\n }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\nOverride prototype members of this class. Overridden methods can be invoked via\ncallOverridden
\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\"\nthis
\n