X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/output/Ext.PluginManager.js diff --git a/docs/output/Ext.PluginManager.js b/docs/output/Ext.PluginManager.js new file mode 100644 index 00000000..cad73035 --- /dev/null +++ b/docs/output/Ext.PluginManager.js @@ -0,0 +1,344 @@ +Ext.data.JsonP.Ext_PluginManager({ + "tagname": "class", + "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.
Creates a new Plugin from the specified config object using the\nconfig object's ptype to determine the class to instantiate.
\n", + "params": [ + { + "type": "Object", + "name": "config", + "doc": "A configuration object for the Plugin you wish to create.
\n", + "optional": false + }, + { + "type": "Constructor", + "name": "defaultType", + "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
).
The newly instantiated Plugin.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/PluginManager.js", + "linenr": 19, + "html_filename": "PluginManager.html", + "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..." + }, + { + "tagname": "method", + "name": "each", + "member": "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 function to execute.
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "The scope to execute in. Defaults to this.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js", + "linenr": 118, + "html_filename": "AbstractManager.html", + "href": "AbstractManager.html#Ext-AbstractManager-method-each", + "shortDoc": "Executes the specified function once for each item in the collection.\nReturning false from the function will cease it..." + }, + { + "tagname": "method", + "name": "findByType", + "member": "Ext.PluginManager", + "doc": "Returns all plugins registered with the given type. Here, 'type' refers to the type of plugin, not its ptype.
\n", + "params": [ + { + "type": "String", + "name": "type", + "doc": "The type to search for
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "defaultsOnly", + "doc": "True to only return plugins of this type where the plugin's isDefault property is truthy
\n", + "optional": false + } + ], + "return": { + "type": "Array", + "doc": "All matching plugins
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/PluginManager.js", + "linenr": 61, + "html_filename": "PluginManager.html", + "href": "PluginManager.html#Ext-PluginManager-method-findByType", + "shortDoc": "Returns all plugins registered with the given type. Here, 'type' refers to the type of plugin, not its ptype.
\n" + }, + { + "tagname": "method", + "name": "get", + "member": "Ext.AbstractManager", + "doc": "Returns an item by id.\nFor additional details see Ext.util.HashMap.get.
\n", + "params": [ + { + "type": "String", + "name": "id", + "doc": "The id of the item
\n", + "optional": false + } + ], + "return": { + "type": "Mixed", + "doc": "The item, undefined
if not found.
Returns an item by id.\nFor additional details see Ext.util.HashMap.get.
\n" + }, + { + "tagname": "method", + "name": "getCount", + "member": "Ext.AbstractManager", + "doc": "Gets the number of items in the collection.
\n", + "params": [ + + ], + "return": { + "type": "Number", + "doc": "The number of items in the collection.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js", + "linenr": 135, + "html_filename": "AbstractManager.html", + "href": "AbstractManager.html#Ext-AbstractManager-method-getCount", + "shortDoc": "Gets the number of items in the collection.
\n" + }, + { + "tagname": "method", + "name": "isRegistered", + "member": "Ext.AbstractManager", + "doc": "Checks if an item type is registered.
\n", + "params": [ + { + "type": "String", + "name": "type", + "doc": "The mnemonic string by which the class may be looked up
\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "Whether the type is registered.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js", + "linenr": 67, + "html_filename": "AbstractManager.html", + "href": "AbstractManager.html#Ext-AbstractManager-method-isRegistered", + "shortDoc": "Checks if an item type is registered.
\n" + }, + { + "tagname": "method", + "name": "onAvailable", + "member": "Ext.AbstractManager", + "doc": "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", + "params": [ + { + "type": "String", + "name": "id", + "doc": "The item id
\n", + "optional": false + }, + { + "type": "Function", + "name": "fn", + "doc": "The callback function. Called with a single parameter, the item.
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "The scope (this
reference) in which the callback is executed. Defaults to the item.
Registers an item to be managed
\n", + "params": [ + { + "type": "Mixed", + "name": "item", + "doc": "The item to register
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js", + "linenr": 41, + "html_filename": "AbstractManager.html", + "href": "AbstractManager.html#Ext-AbstractManager-method-register", + "shortDoc": "Registers an item to be managed
\n" + }, + { + "tagname": "method", + "name": "registerType", + "member": "Ext.AbstractManager", + "doc": "Registers a new item constructor, keyed by a type key.\n\n", + "params": [ + { + "type": "String", + "name": "type", + "doc": "
The mnemonic string by which the class may be looked up.
\n", + "optional": false + }, + { + "type": "Constructor", + "name": "cls", + "doc": "The new instance class.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js", + "linenr": 57, + "html_filename": "AbstractManager.html", + "href": "AbstractManager.html#Ext-AbstractManager-method-registerType", + "shortDoc": "Registers a new item constructor, keyed by a type key.\n\n" + }, + { + "tagname": "method", + "name": "unregister", + "member": "Ext.AbstractManager", + "doc": "
Unregisters an item by removing it from this manager
\n", + "params": [ + { + "type": "Mixed", + "name": "item", + "doc": "The item to unregister
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js", + "linenr": 49, + "html_filename": "AbstractManager.html", + "href": "AbstractManager.html#Ext-AbstractManager-method-unregister", + "shortDoc": "Unregisters an item by removing it from this manager
\n" + } + ], + "property": [ + { + "tagname": "property", + "name": "all", + "member": "Ext.AbstractManager", + "type": "Ext.util.MixedCollection", + "doc": "Contains all of the items currently managed
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js", + "linenr": 21, + "html_filename": "AbstractManager.html", + "href": "AbstractManager.html#Ext-AbstractManager-property-all" + } + ], + "event": [ + + ], + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/PluginManager.js", + "linenr": 1, + "html_filename": "PluginManager.html", + "href": "PluginManager.html#Ext-PluginManager", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": false, + "superclasses": [ + "Ext.AbstractManager" + ], + "subclasses": [ + + ], + "mixedInto": [ + + ], + "allMixins": [ + + ] +}); \ No newline at end of file