Provides a registry of all Components (instances of Ext.Component or any subclass\nthereof) on a page so that they can be easily accessed by component\nid (see get, or the convenience method Ext.getCmp).
\n\n\nThis object also provides a registry of available Component classes\nindexed by a mnemonic code known as the Component's xtype.\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 Component from the specified config object using the\nconfig object's xtype to determine the class to instantiate.
\n", - "params": [ - { - "type": "Object", - "name": "config", - "doc": "A configuration object for the Component you wish to create.
\n", - "optional": false + ], + "method": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "ComponentManager.html#Ext-ComponentManager-method-create", + "shortDoc": "Creates a new Component from the specified config object using the\nconfig object's xtype to determine the class to in...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ComponentManager.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "A configuration object for the Component you wish to create.
\n", + "name": "config" + }, + { + "type": "Constructor", + "optional": false, + "doc": "The constructor to provide the default Component type if\nthe config object does not contain a xtype. (Optional if the config contains a xtype).
Creates a new Component from the specified config object using the\nconfig object's xtype to determine the class to instantiate.
\n", + "linenr": 25, + "return": { + "type": "Ext.Component", + "doc": "The newly instantiated Component.
\n" }, - { - "type": "Constructor", - "name": "defaultType", - "doc": "The constructor to provide the default Component type if\nthe config object does not contain a xtype. (Optional if the config contains a xtype).
The newly instantiated Component.
\n" + "html_filename": "ComponentManager.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ComponentManager.js", - "linenr": 25, - "html_filename": "ComponentManager.html", - "href": "ComponentManager.html#Ext-ComponentManager-method-create", - "shortDoc": "Creates a new Component from the specified config object using the\nconfig object's xtype to determine the class to in..." - }, - { - "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 + { + "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 scope to execute in. Defaults to this.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "AbstractManager.html" }, - "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": "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.
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.
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": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractManager.html#Ext-AbstractManager-method-getCount", + "shortDoc": "Gets the number of items in the collection. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractManager.js", + "private": false, + "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 + ], + "name": "getCount", + "owner": "Ext.AbstractManager", + "doc": "Gets the number of items in the collection.
\n", + "linenr": 133, + "return": { + "type": "Number", + "doc": "The number of items in the collection.
\n" }, - { - "type": "Function", - "name": "fn", - "doc": "The callback function. Called with a single parameter, the item.
\n", - "optional": false + "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" }, - { - "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" + { + "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" }, - "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 + { + "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" }, - { - "type": "Constructor", - "name": "cls", - "doc": "The new instance class.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "AbstractManager.html" }, - "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" + { + "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" }, - "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": [ + { + "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": [ - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ComponentManager.js", - "linenr": 1, - "html_filename": "ComponentManager.html", - "href": "ComponentManager.html#Ext-ComponentManager", - "cssVar": [ + ], + "cssMixin": [ - ], - "cssMixin": [ + ], + "event": [ - ], - "component": false, + ] + }, + "singleton": true, + "alias": null, "superclasses": [ "Ext.AbstractManager" ], + "protected": false, + "tagname": "class", + "mixins": [ + + ], + "href": "ComponentManager.html#Ext-ComponentManager", "subclasses": [ ], + "static": false, + "author": null, + "component": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ComponentManager.js", + "private": false, + "alternateClassNames": [ + "Ext.ComponentMgr" + ], + "name": "Ext.ComponentManager", + "doc": "Provides a registry of all Components (instances of Ext.Component or any subclass\nthereof) on a page so that they can be easily accessed by component\nid (see get, or the convenience method Ext.getCmp).
\n\n\nThis object also provides a registry of available Component classes\nindexed by a mnemonic code known as the Component's xtype.\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.