X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/output/Ext.ComponentManager.js diff --git a/docs/output/Ext.ComponentManager.js b/docs/output/Ext.ComponentManager.js new file mode 100644 index 00000000..45dd85a3 --- /dev/null +++ b/docs/output/Ext.ComponentManager.js @@ -0,0 +1,313 @@ +Ext.data.JsonP.Ext_ComponentManager({ + "tagname": "class", + "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\n

This 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.

\n\n\n

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.

\n\n\n

For a list of all available xtypes, see Ext.Component.

\n\n", + "extends": "Ext.AbstractManager", + "mixins": [ + + ], + "alternateClassNames": [ + "Ext.ComponentMgr" + ], + "xtype": null, + "author": null, + "docauthor": null, + "singleton": true, + "private": false, + "cfg": [ + + ], + "method": [ + { + "tagname": "method", + "name": "create", + "member": "Ext.ComponentManager", + "doc": "

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 + }, + { + "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).

\n", + "optional": false + } + ], + "return": { + "type": "Ext.Component", + "doc": "

The newly instantiated Component.

\n" + }, + "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\n

The paramaters passed to the function are:

\n\n
\n\n", + "params": [ + { + "type": "Object", + "name": "fn", + "doc": "

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": "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.

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js", + "linenr": 31, + "html_filename": "AbstractManager.html", + "href": "AbstractManager.html#Ext-AbstractManager-method-get", + "shortDoc": "

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.

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractManager.js", + "linenr": 95, + "html_filename": "AbstractManager.html", + "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. This will happen..." + }, + { + "tagname": "method", + "name": "register", + "member": "Ext.AbstractManager", + "doc": "

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/ComponentManager.js", + "linenr": 1, + "html_filename": "ComponentManager.html", + "href": "ComponentManager.html#Ext-ComponentManager", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": false, + "superclasses": [ + "Ext.AbstractManager" + ], + "subclasses": [ + + ], + "mixedInto": [ + + ], + "allMixins": [ + + ] +}); \ No newline at end of file