X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..HEAD:/docs/output/Ext.AbstractPlugin.js diff --git a/docs/output/Ext.AbstractPlugin.js b/docs/output/Ext.AbstractPlugin.js index 5b44cbbc..8446bba3 100644 --- a/docs/output/Ext.AbstractPlugin.js +++ b/docs/output/Ext.AbstractPlugin.js @@ -1,157 +1 @@ -Ext.data.JsonP.Ext_AbstractPlugin({ - "allMixins": [ - - ], - "deprecated": null, - "docauthor": null, - "members": { - "cfg": [ - - ], - "method": [ - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-destroy", - "shortDoc": "The destroy method is invoked by the owning Component at the time the Component is being destroyed. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractPlugin.js", - "private": false, - "params": [ - - ], - "name": "destroy", - "owner": "Ext.AbstractPlugin", - "doc": "
The destroy method is invoked by the owning Component at the time the Component is being destroyed.
\n\n\nThe supplied implementation is empty. Subclasses should perform plugin cleanup in their own implementation of this method.
\n\n", - "linenr": 42, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractPlugin.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-disable", - "shortDoc": "The base implementation just sets the plugin's disabled flag to true\n\n\nPlugin subclasses which need more complex proc...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractPlugin.js", - "private": false, - "params": [ - - ], - "name": "disable", - "owner": "Ext.AbstractPlugin", - "doc": "The base implementation just sets the plugin's disabled
flag to true
Plugin subclasses which need more complex processing may implement an overriding implementation.
\n\n", - "linenr": 57, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractPlugin.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-enable", - "shortDoc": "The base implementation just sets the plugin's disabled flag to false\n\n\nPlugin subclasses which need more complex pro...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractPlugin.js", - "private": false, - "params": [ - - ], - "name": "enable", - "owner": "Ext.AbstractPlugin", - "doc": "The base implementation just sets the plugin's disabled
flag to false
Plugin subclasses which need more complex processing may implement an overriding implementation.
\n\n", - "linenr": 49, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractPlugin.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractPlugin.html#Ext-AbstractPlugin-method-init", - "shortDoc": "The init method is invoked after initComponent has been run for the client Component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractPlugin.js", - "private": false, - "params": [ - { - "type": "Component", - "optional": false, - "doc": "The client Component which owns this plugin.
\n", - "name": "client" - } - ], - "name": "init", - "owner": "Ext.AbstractPlugin", - "doc": "The init method is invoked after initComponent has been run for the client Component.
\n\n\nThe supplied implementation is empty. Subclasses should perform plugin initialization, and set up bidirectional\nlinks between the plugin and its client Component in their own implementation of this method.
\n\n", - "linenr": 33, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractPlugin.html" - } - ], - "property": [ - - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - - ] - }, - "singleton": false, - "alias": null, - "superclasses": [ - - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "AbstractPlugin.html#Ext-AbstractPlugin", - "subclasses": [ - "Ext.grid.plugin.DragDrop", - "Ext.tree.ViewDDPlugin" - ], - "static": false, - "author": null, - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractPlugin.js", - "private": false, - "alternateClassNames": [ - - ], - "name": "Ext.AbstractPlugin", - "doc": "The AbstractPlugin class is the base class from which user-implemented plugins should inherit.
\n\n\nThis class defines the essential API of plugins as used by Components by defining the following methods:
\n\n\ninit
: The plugin initialization method which the owning Component calls at Component initialization\ntime.The Component passes itself as the sole parameter.
Subclasses should set up bidirectional\nlinks between the plugin and its client Component here.
destroy
: The plugin cleanup method which the owning Component calls at Component destruction time.enable
: The base implementation just sets the plugin's disabled
flag to false
disable
: The base implementation just sets the plugin's disabled
flag to true
Hierarchy
Ext.BaseExt.AbstractPluginFiles
The AbstractPlugin class is the base class from which user-implemented plugins should inherit.
\n\nThis class defines the essential API of plugins as used by Components by defining the following methods:
\n\ninit
: The plugin initialization method which the owning Component calls at Component initialization time.
The Component passes itself as the sole parameter.
\n\nSubclasses should set up bidirectional links between the plugin and its client Component here.
destroy
: The plugin cleanup method which the owning Component calls at Component destruction time.
Use this method to break links between the plugin and the Component and to free any allocated resources.
enable
: The base implementation just sets the plugin's disabled
flag to false
disable
: The base implementation just sets the plugin's disabled
flag to true
Get 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
\nThe destroy method is invoked by the owning Component at the time the Component is being destroyed.
\n\nThe supplied implementation is empty. Subclasses should perform plugin cleanup in their own implementation of\nthis method.
\nThe base implementation just sets the plugin's disabled
flag to true
Plugin subclasses which need more complex processing may implement an overriding implementation.
\nThe base implementation just sets the plugin's disabled
flag to false
Plugin subclasses which need more complex processing may implement an overriding implementation.
\nThe init method is invoked after initComponent method has been run for the client Component.
\n\nThe supplied implementation is empty. Subclasses should perform plugin initialization, and set up bidirectional\nlinks between the plugin and its client Component in their own implementation of this method.
\nThe client Component which owns this plugin.
\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
\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
\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});\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 '$$$$$$$'\n
\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});\n
\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()\n
\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'\n
\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();\n
\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\"\n
\nthis
\n