X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.PluginManager.js diff --git a/docs/output/Ext.PluginManager.js b/docs/output/Ext.PluginManager.js index 15feea50..dc06185d 100644 --- a/docs/output/Ext.PluginManager.js +++ b/docs/output/Ext.PluginManager.js @@ -1,385 +1 @@ -Ext.data.JsonP.Ext_PluginManager({ - "allMixins": [ - - ], - "deprecated": null, - "docauthor": null, - "members": { - "cfg": [ - - ], - "method": [ - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "PluginManager.html#Ext-PluginManager-method-create", - "shortDoc": "Creates a new Plugin from the specified config object using the\nconfig object's ptype to determine the class to insta...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/PluginManager.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "
A configuration object for the Plugin you wish to create.
\n", - "name": "config" - }, - { - "type": "Constructor", - "optional": false, - "doc": "The constructor to provide the default Plugin type if\nthe config object does not contain a ptype
. (Optional if the config contains a ptype
).
Creates a new Plugin from the specified config object using the\nconfig object's ptype to determine the class to instantiate.
\n", - "linenr": 19, - "return": { - "type": "Ext.Component", - "doc": "The newly instantiated Plugin.
\n" - }, - "html_filename": "PluginManager.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 type to search for
\n", - "name": "type" - }, - { - "type": "Boolean", - "optional": false, - "doc": "True to only return plugins of this type where the plugin's isDefault property is truthy
\n", - "name": "defaultsOnly" - } - ], - "name": "findByType", - "owner": "Ext.PluginManager", - "doc": "Returns all plugins registered with the given type. Here, 'type' refers to the type of plugin, not its ptype.
\n", - "linenr": 61, - "return": { - "type": "Array", - "doc": "All matching plugins
\n" - }, - "html_filename": "PluginManager.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractManager.html#Ext-AbstractManager-method-get", - "shortDoc": "Returns an item by id. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "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": "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" - } - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - - ] - }, - "singleton": true, - "alias": null, - "superclasses": [ - "Ext.AbstractManager" - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "PluginManager.html#Ext-PluginManager", - "subclasses": [ - - ], - "static": false, - "author": null, - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/PluginManager.js", - "private": false, - "alternateClassNames": [ - "Ext.PluginMgr" - ], - "name": "Ext.PluginManager", - "doc": "Provides a registry of available Plugin classes indexed by a mnemonic code known as the Plugin's ptype.\nThe xtype
provides a way to avoid instantiating child Components\nwhen creating a full, nested config object for a complete Ext page.
A child Component may be specified simply as a config object\nas long as the correct xtype
is specified so that if and when the Component\nneeds rendering, the correct type can be looked up for lazy instantiation.
For a list of all available xtypes
, see Ext.Component.
Alternate names
Ext.PluginMgrHierarchy
Ext.BaseExt.AbstractManagerExt.PluginManagerFiles
Provides a registry of available Plugin classes indexed by a mnemonic code known as the Plugin's ptype.
\n\nA plugin may be specified simply as a config object as long as the correct ptype
is specified:
{\n ptype: 'gridviewdragdrop',\n dragText: 'Drag and drop to reorganize'\n}\n
\n\nOr just use the ptype on its own:
\n\n'gridviewdragdrop'\n
\n\nAlternatively you can instantiate the plugin with Ext.create:
\n\nExt.create('Ext.view.plugin.AutoComplete', {\n ptype: 'gridviewdragdrop',\n dragText: 'Drag and drop to reorganize'\n})\n
\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 Plugin from the specified config object using the config object's ptype to determine the class to\ninstantiate.
\nA configuration object for the Plugin you wish to create.
\nThe constructor to provide the default Plugin type if the config object does not\ncontain a ptype
. (Optional if the config contains a ptype
).
The newly instantiated Plugin.
\nExecutes the specified function once for each item in the collection.
\nReturns all plugins registered with the given type. Here, 'type' refers to the type of plugin, not its ptype.
\nThe type to search for
\nTrue to only return plugins of this type where the plugin's isDefault property is\ntruthy
\nAll matching plugins
\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