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": "BelongsToAssociation.html#Ext-data-BelongsToAssociation-cfg-foreignKey", - "shortDoc": "The name of the foreign key on the owner model that links it to the associated\nmodel. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/BelongsToAssociation.js", - "private": false, - "name": "foreignKey", - "owner": "Ext.data.BelongsToAssociation", - "doc": "The name of the foreign key on the owner model that links it to the associated\nmodel. Defaults to the lowercased name of the associated model plus \"_id\", e.g. an association with a\nmodel called Product would set up a product_id foreign key.
\n\nExt.define('Order', {\n extend: 'Ext.data.Model',\n fields: ['id', 'date'],\n hasMany: 'Product'\n});\n\nExt.define('Product', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name', 'order_id'], // refers to the id of the order that this product belongs to\n belongsTo: 'Group'\n});\nvar product = new Product({\n id: 1,\n name: 'Product 1',\n order_id: 22\n}, 1);\nproduct.getOrder(); // Will make a call to the server asking for order_id 22\n\nThe name of the getter function that will be added to the local model's prototype.\nDefaults to 'get' + the name of the foreign model, e.g. getCategory
\n", - "linenr": 149, - "html_filename": "BelongsToAssociation.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" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "BelongsToAssociation.html#Ext-data-BelongsToAssociation-cfg-setterName", - "shortDoc": "The name of the setter function that will be added to the local model's prototype. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/BelongsToAssociation.js", - "private": false, - "name": "setterName", - "owner": "Ext.data.BelongsToAssociation", - "doc": "The name of the setter function that will be added to the local model's prototype.\nDefaults to 'set' + the name of the foreign model, e.g. setCategory
\n", - "linenr": 154, - "html_filename": "BelongsToAssociation.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "BelongsToAssociation.html#Ext-data-BelongsToAssociation-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/BelongsToAssociation.js", - "private": false, - "name": "type", - "owner": "Ext.data.BelongsToAssociation", - "doc": "The type configuration can be used when creating associations using a configuration object.\nUse 'belongsTo' to create a HasManyAssocation
\n\nassociations: [{\n type: 'belongsTo',\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": "BelongsToAssociation", - "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": "BelongsToAssociation.html#Ext-data-BelongsToAssociation", - "subclasses": [ - - ], - "static": false, - "author": "Ed Spencer", - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/BelongsToAssociation.js", - "private": false, - "alternateClassNames": [ - - ], - "name": "Ext.data.BelongsToAssociation", - "doc": "Represents a many to one association with another model. The owner model is expected to have\na foreign key which references the primary key of the associated model:
\n\n\n\n\nExt.define('Category', {\n extend: 'Ext.data.Model',\n fields: [\n {name: 'id', type: 'int'},\n {name: 'name', type: 'string'}\n ]\n});\n\nExt.define('Product', {\n extend: 'Ext.data.Model',\n fields: [\n {name: 'id', type: 'int'},\n {name: 'category_id', type: 'int'},\n {name: 'name', type: 'string'}\n ],\n // we can use the belongsTo shortcut on the model to create a belongsTo association\n belongsTo: {type: 'belongsTo', model: 'Category'}\n});\nIn the example above we have created models for Products and Categories, and linked them together\nby saying that each Product belongs to a Category. This automatically links each Product to a Category\nbased on the Product's category_id, and provides new functions on the Product model:
\n\n\n\n\nGenerated getter function
\n\n\n\n\nThe first function that is added to the owner model is a getter function:
\n\n\n\n\nvar product = new Product({\n id: 100,\n category_id: 20,\n name: 'Sneakers'\n});\n\nproduct.getCategory(function(category, operation) {\n //do something with the category object\n alert(category.get('id')); //alerts 20\n}, this);\nThe getCategory function was created on the Product model when we defined the association. This uses the\nCategory's configured proxy to load the Category asynchronously, calling the provided\ncallback when it has loaded.
\n\n\n\n\nThe new getCategory function will also accept an object containing success, failure and callback properties\n- callback will always be called, success will only be called if the associated model was loaded successfully\nand failure will only be called if the associatied model could not be loaded:
\n\n\n\n\nproduct.getCategory({\n callback: function(category, operation) {}, //a function that will always be called\n success : function(category, operation) {}, //a function that will only be called if the load succeeded\n failure : function(category, operation) {}, //a function that will only be called if the load did not succeed\n scope : this //optionally pass in a scope object to execute the callbacks in\n});\nIn each case above the callbacks are called with two arguments - the associated model instance and the\noperation object that was executed to load that instance. The Operation object is\nuseful when the instance could not be loaded.
\n\n\n\n\nGenerated setter function
\n\n\n\n\nThe second generated function sets the associated model instance - if only a single argument is passed to\nthe setter then the following two calls are identical:
\n\n\n\n\n//this call\nproduct.setCategory(10);\n\n//is equivalent to this call:\nproduct.set('category_id', 10);\nIf we pass in a second argument, the model will be automatically saved and the second argument passed to\nthe owner model's save method:
\n\n\nproduct.setCategory(10, function(product, operation) {\n //the product has been saved\n alert(product.get('category_id')); //now alerts 10\n});\n\n//alternative syntax:\nproduct.setCategory(10, {\n callback: function(product, operation), //a function that will always be called\n success : function(product, operation), //a function that will only be called if the load succeeded\n failure : function(product, operation), //a function that will only be called if the load did not succeed\n scope : this //optionally pass in a scope object to execute the callbacks in\n})\nCustomisation
\n\n\n\n\nAssociations reflect on the models they are linking to automatically set up properties such as the\nprimaryKey and foreignKey. These can alternatively be specified:
\n\n\n\n\nExt.define('Product', {\n fields: [...],\n\n associations: [\n {type: 'belongsTo', model: 'Category', primaryKey: 'unique_id', foreignKey: 'cat_id'}\n ]\n});\n Here we replaced the default primary key (defaults to 'id') and foreign key (calculated as 'category_id')\nwith our own settings. Usually this will not be needed.
\n\n", - "mixedInto": [ - - ], - "linenr": 1, - "xtypes": [ - - ], - "html_filename": "BelongsToAssociation.html", - "extends": "Ext.data.Association" -}); \ No newline at end of file +Ext.data.JsonP.Ext_data_BelongsToAssociation({"tagname":"class","html":"Hierarchy
Ext.BaseExt.data.AssociationExt.data.BelongsToAssociationFiles
Represents a many to one association with another model. The owner model is expected to have\na foreign key which references the primary key of the associated model:
\n\nExt.define('Category', {\n extend: 'Ext.data.Model',\n fields: [\n { name: 'id', type: 'int' },\n { name: 'name', type: 'string' }\n ]\n});\n\nExt.define('Product', {\n extend: 'Ext.data.Model',\n fields: [\n { name: 'id', type: 'int' },\n { name: 'category_id', type: 'int' },\n { name: 'name', type: 'string' }\n ],\n // we can use the belongsTo shortcut on the model to create a belongsTo association\n associations: [\n { type: 'belongsTo', model: 'Category' }\n ]\n});\nIn the example above we have created models for Products and Categories, and linked them together\nby saying that each Product belongs to a Category. This automatically links each Product to a Category\nbased on the Product's category_id, and provides new functions on the Product model:
\n\nThe first function that is added to the owner model is a getter function:
\n\nvar product = new Product({\n id: 100,\n category_id: 20,\n name: 'Sneakers'\n});\n\nproduct.getCategory(function(category, operation) {\n // do something with the category object\n alert(category.get('id')); // alerts 20\n}, this);\nThe getCategory function was created on the Product model when we defined the association. This uses the\nCategory's configured proxy to load the Category asynchronously, calling the provided\ncallback when it has loaded.
\n\nThe new getCategory function will also accept an object containing success, failure and callback properties\n- callback will always be called, success will only be called if the associated model was loaded successfully\nand failure will only be called if the associatied model could not be loaded:
\n\nproduct.getCategory({\n callback: function(category, operation) {}, // a function that will always be called\n success : function(category, operation) {}, // a function that will only be called if the load succeeded\n failure : function(category, operation) {}, // a function that will only be called if the load did not succeed\n scope : this // optionally pass in a scope object to execute the callbacks in\n});\nIn each case above the callbacks are called with two arguments - the associated model instance and the\noperation object that was executed to load that instance. The Operation object is\nuseful when the instance could not be loaded.
\n\nThe second generated function sets the associated model instance - if only a single argument is passed to\nthe setter then the following two calls are identical:
\n\n// this call...\nproduct.setCategory(10);\n\n// is equivalent to this call:\nproduct.set('category_id', 10);\nIf we pass in a second argument, the model will be automatically saved and the second argument passed to\nthe owner model's save method:
\n\nproduct.setCategory(10, function(product, operation) {\n // the product has been saved\n alert(product.get('category_id')); //now alerts 10\n});\n\n//alternative syntax:\nproduct.setCategory(10, {\n callback: function(product, operation), // a function that will always be called\n success : function(product, operation), // a function that will only be called if the load succeeded\n failure : function(product, operation), // a function that will only be called if the load did not succeed\n scope : this //optionally pass in a scope object to execute the callbacks in\n})\nAssociations reflect on the models they are linking to automatically set up properties such as the\nprimaryKey and foreignKey. These can alternatively be specified:
\n\nExt.define('Product', {\n fields: [...],\n\n associations: [\n { type: 'belongsTo', model: 'Category', primaryKey: 'unique_id', foreignKey: 'cat_id' }\n ]\n});\nHere we replaced the default primary key (defaults to 'id') and foreign key (calculated as 'category_id')\nwith our own settings. Usually this will not be needed.
\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 name of the foreign key on the owner model that links it to the associated\nmodel. Defaults to the lowercased name of the associated model plus \"_id\", e.g. an association with a\nmodel called Product would set up a product_id foreign key.
\n\nExt.define('Order', {\n extend: 'Ext.data.Model',\n fields: ['id', 'date'],\n hasMany: 'Product'\n});\n\nExt.define('Product', {\n extend: 'Ext.data.Model',\n fields: ['id', 'name', 'order_id'], // refers to the id of the order that this product belongs to\n belongsTo: 'Group'\n});\nvar product = new Product({\n id: 1,\n name: 'Product 1',\n order_id: 22\n}, 1);\nproduct.getOrder(); // Will make a call to the server asking for order_id 22\nThe name of the getter function that will be added to the local model's prototype.\nDefaults to 'get' + the name of the foreign model, e.g. getCategory
\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 setter function that will be added to the local model's prototype.\nDefaults to 'set' + the name of the foreign model, e.g. setCategory
\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