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": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "HasManyAssociation.html#Ext-data-HasManyAssociation-cfg-autoLoad", - "shortDoc": "True to automatically load the related store from a remote source when instantiated. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/HasManyAssociation.js", - "private": false, - "name": "autoLoad", - "owner": "Ext.data.HasManyAssociation", - "doc": "True to automatically load the related store from a remote source when instantiated.\nDefaults to false.
\n", - "linenr": 167, - "html_filename": "HasManyAssociation.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "HasManyAssociation.html#Ext-data-HasManyAssociation-cfg-filterProperty", - "shortDoc": "Optionally overrides the default filter that is set up on the associated Store. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/HasManyAssociation.js", - "private": false, - "name": "filterProperty", - "owner": "Ext.data.HasManyAssociation", - "doc": "Optionally overrides the default filter that is set up on the associated Store. If\nthis is not set, a filter is automatically created which filters the association based on the configured\nforeignKey. See intro docs for more details. Defaults to undefined
\n", - "linenr": 161, - "html_filename": "HasManyAssociation.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "HasManyAssociation.html#Ext-data-HasManyAssociation-cfg-foreignKey", - "shortDoc": "The name of the foreign key on the associated model that links it to the owner\nmodel. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/HasManyAssociation.js", - "private": false, - "name": "foreignKey", - "owner": "Ext.data.HasManyAssociation", - "doc": "The name of the foreign key on the associated model that links it to the owner\nmodel. Defaults to the lowercased name of the owner model plus \"_id\", e.g. an association with a where a\nmodel called Group hasMany Users would create 'group_id' as the foreign key. When the remote store is loaded,\nthe store is automatically filtered so that only records with a matching foreign key are included in the\nresulting child store. This can be overridden by specifying the filterProperty.
\n\nExt.define('Group', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name'],\n hasMany: 'User'\n});\n\nExt.define('User', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name', 'group_id'], // refers to the id of the group that this user belongs to\n belongsTo: 'Group'\n});\nThe name of the function to create on the owner model to retrieve the child store.\nIf not specified, the pluralized name of the child model is used.
\n\n// This will create a users() method on any Group model instance\nExt.define('Group', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name'],\n hasMany: 'User'\n});\nvar group = new Group();\nconsole.log(group.users());\n\n// The method to retrieve the users will now be getUserList\nExt.define('Group', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name'],\n hasMany: {model: 'User', name: 'getUserList'}\n});\nvar group = new Group();\nconsole.log(group.getUserList());\nThe 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" - }, - { - "type": "Object", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "HasManyAssociation.html#Ext-data-HasManyAssociation-cfg-storeConfig", - "shortDoc": "Optional configuration object that will be passed to the generated Store. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/HasManyAssociation.js", - "private": false, - "name": "storeConfig", - "owner": "Ext.data.HasManyAssociation", - "doc": "Optional configuration object that will be passed to the generated Store. Defaults to\nundefined.
\n", - "linenr": 156, - "html_filename": "HasManyAssociation.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "HasManyAssociation.html#Ext-data-HasManyAssociation-cfg-type", - "shortDoc": "The type configuration can be used when creating associations using a configuration object. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/HasManyAssociation.js", - "private": false, - "name": "type", - "owner": "Ext.data.HasManyAssociation", - "doc": "The type configuration can be used when creating associations using a configuration object.\nUse 'hasMany' to create a HasManyAssocation
\n\nassociations: [{\n type: 'hasMany',\n model: 'User'\n}]\n(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": "HasManyAssociation", - "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": [ - "Ext.data.Association" - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "HasManyAssociation.html#Ext-data-HasManyAssociation", - "subclasses": [ - - ], - "static": false, - "author": "Ed Spencer", - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/HasManyAssociation.js", - "private": false, - "alternateClassNames": [ - - ], - "name": "Ext.data.HasManyAssociation", - "doc": "Represents a one-to-many relationship between two models. Usually created indirectly via a model definition:
\n\n\n\n\nExt.define('Product', {\n extend: 'Ext.data.Model',\n fields: [\n {name: 'id', type: 'int'},\n {name: 'user_id', type: 'int'},\n {name: 'name', type: 'string'}\n ]\n});\n\nExt.define('User', {\n extend: 'Ext.data.Model',\n fields: [\n {name: 'id', type: 'int'},\n {name: 'name', type: 'string'}\n ],\n // we can use the hasMany shortcut on the model to create a hasMany association\n hasMany: {model: 'Product', name: 'products'}\n});\nAbove we created Product and User models, and linked them by saying that a User hasMany Products. This gives\nus a new function on every User instance, in this case the function is called 'products' because that is the name\nwe specified in the association configuration above.
\n\n\n\n\nThis new function returns a specialized Store which is automatically filtered to load\nonly Products for the given model instance:
\n\n\n\n\n//first, we load up a User with id of 1\nvar user = Ext.ModelManager.create({id: 1, name: 'Ed'}, 'User');\n\n//the user.products function was created automatically by the association and returns a Store\n//the created store is automatically scoped to the set of Products for the User with id of 1\nvar products = user.products();\n\n//we still have all of the usual Store functions, for example it's easy to add a Product for this User\nproducts.add({\n name: 'Another Product'\n});\n\n//saves the changes to the store - this automatically sets the new Product's user_id to 1 before saving\nproducts.sync();\nThe new Store is only instantiated the first time you call products() to conserve memory and processing time,\nthough calling products() a second time returns the same store instance.
\n\n\n\n\nCustom filtering
\n\n\n\n\nThe Store is automatically furnished with a filter - by default this filter tells the store to only return\nrecords where the associated model's foreign key matches the owner model's primary key. For example, if a User\nwith ID = 100 hasMany Products, the filter loads only Products with user_id == 100.
\n\n\n\n\nSometimes we want to filter by another field - for example in the case of a Twitter search application we may\nhave models for Search and Tweet:
\n\n\n\n\nExt.define('Search', {\n extend: 'Ext.data.Model',\n fields: [\n 'id', 'query'\n ],\n\n hasMany: {\n model: 'Tweet',\n name : 'tweets',\n filterProperty: 'query'\n }\n});\n\nExt.define('Tweet', {\n extend: 'Ext.data.Model',\n fields: [\n 'id', 'text', 'from_user'\n ]\n});\n\n//returns a Store filtered by the filterProperty\nvar store = new Search({query: 'Sencha Touch'}).tweets();\nThe tweets association above is filtered by the query property by setting the filterProperty, and is\nequivalent to this:
\n\n\n\n\nvar store = new Ext.data.Store({\n model: 'Tweet',\n filters: [\n {\n property: 'query',\n value : 'Sencha Touch'\n }\n ]\n});\nHierarchy
Ext.BaseExt.data.AssociationExt.data.HasManyAssociationRequires
Files
Represents a one-to-many relationship between two models. Usually created indirectly via a model definition:
\n\n\n\n\nExt.define('Product', {\n extend: 'Ext.data.Model',\n fields: [\n {name: 'id', type: 'int'},\n {name: 'user_id', type: 'int'},\n {name: 'name', type: 'string'}\n ]\n});\n\nExt.define('User', {\n extend: 'Ext.data.Model',\n fields: [\n {name: 'id', type: 'int'},\n {name: 'name', type: 'string'}\n ],\n // we can use the hasMany shortcut on the model to create a hasMany association\n hasMany: {model: 'Product', name: 'products'}\n});\nAbove we created Product and User models, and linked them by saying that a User hasMany Products. This gives\nus a new function on every User instance, in this case the function is called 'products' because that is the name\nwe specified in the association configuration above.
\n\n\n\n\nThis new function returns a specialized Store which is automatically filtered to load\nonly Products for the given model instance:
\n\n\n\n\n//first, we load up a User with id of 1\nvar user = Ext.create('User', {id: 1, name: 'Ed'});\n\n//the user.products function was created automatically by the association and returns a Store\n//the created store is automatically scoped to the set of Products for the User with id of 1\nvar products = user.products();\n\n//we still have all of the usual Store functions, for example it's easy to add a Product for this User\nproducts.add({\n name: 'Another Product'\n});\n\n//saves the changes to the store - this automatically sets the new Product's user_id to 1 before saving\nproducts.sync();\nThe new Store is only instantiated the first time you call products() to conserve memory and processing time,\nthough calling products() a second time returns the same store instance.
\n\n\n\n\nCustom filtering
\n\n\n\n\nThe Store is automatically furnished with a filter - by default this filter tells the store to only return\nrecords where the associated model's foreign key matches the owner model's primary key. For example, if a User\nwith ID = 100 hasMany Products, the filter loads only Products with user_id == 100.
\n\n\n\n\nSometimes we want to filter by another field - for example in the case of a Twitter search application we may\nhave models for Search and Tweet:
\n\n\n\n\nExt.define('Search', {\n extend: 'Ext.data.Model',\n fields: [\n 'id', 'query'\n ],\n\n hasMany: {\n model: 'Tweet',\n name : 'tweets',\n filterProperty: 'query'\n }\n});\n\nExt.define('Tweet', {\n extend: 'Ext.data.Model',\n fields: [\n 'id', 'text', 'from_user'\n ]\n});\n\n//returns a Store filtered by the filterProperty\nvar store = new Search({query: 'Sencha Touch'}).tweets();\nThe tweets association above is filtered by the query property by setting the filterProperty, and is\nequivalent to this:
\n\n\n\n\nvar store = Ext.create('Ext.data.Store', {\n model: 'Tweet',\n filters: [\n {\n property: 'query',\n value : 'Sencha Touch'\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.
\nTrue to automatically load the related store from a remote source when instantiated.\nDefaults to false.
\nOptionally overrides the default filter that is set up on the associated Store. If\nthis is not set, a filter is automatically created which filters the association based on the configured\nforeignKey. See intro docs for more details. Defaults to undefined
\nThe name of the foreign key on the associated model that links it to the owner\nmodel. Defaults to the lowercased name of the owner model plus \"_id\", e.g. an association with a where a\nmodel called Group hasMany Users would create 'group_id' as the foreign key. When the remote store is loaded,\nthe store is automatically filtered so that only records with a matching foreign key are included in the\nresulting child store. This can be overridden by specifying the filterProperty.
\n\nExt.define('Group', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name'],\n hasMany: 'User'\n});\n\nExt.define('User', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name', 'group_id'], // refers to the id of the group that this user belongs to\n belongsTo: 'Group'\n});\nThe name of the function to create on the owner model to retrieve the child store.\nIf not specified, the pluralized name of the child model is used.
\n\n// This will create a users() method on any Group model instance\nExt.define('Group', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name'],\n hasMany: 'User'\n});\nvar group = new Group();\nconsole.log(group.users());\n\n// The method to retrieve the users will now be getUserList\nExt.define('Group', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name'],\n hasMany: {model: 'User', name: 'getUserList'}\n});\nvar group = new Group();\nconsole.log(group.getUserList());\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"
Optional configuration object that will be passed to the generated Store. Defaults to\nundefined.
\nThe 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