Upgrade to ExtJS 3.3.1 - Released 11/30/2010
[extjs.git] / docs / output / Ext.AbstractManager.html
1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.AbstractManager-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.AbstractManager-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.AbstractManager-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="bookmark" href="../docs/?class=Ext.AbstractManager"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/AbstractManager.html#cls-Ext.AbstractManager">Ext.AbstractManager</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/AbstractManager.html#cls-Ext.AbstractManager">AbstractManager.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/AbstractManager.html#cls-Ext.AbstractManager">AbstractManager</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description">Base Manager class - extended by ComponentMgr and PluginMgr</div><div class="hr"></div><a id="Ext.AbstractManager-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.AbstractManager-all"></a><b><a href="source/AbstractManager.html#prop-Ext.AbstractManager-all">all</a></b> : Ext.util.MixedCollection<div class="mdesc">Contains all of the items currently managed</div></td><td class="msource">AbstractManager</td></tr></tbody></table><a id="Ext.AbstractManager-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.AbstractManager-create"></a><b><a href="source/AbstractManager.html#method-Ext.AbstractManager-create">create</a></b>(&nbsp;<code>Object&nbsp;config</code>,&nbsp;<code>String&nbsp;defaultType</code>&nbsp;)
2     :
3                                         Mixed<div class="mdesc"><div class="short">Creates and returns an instance of whatever this manager manages, based on the supplied type and config object</div><div class="long">Creates and returns an instance of whatever this manager manages, based on the supplied type and config object<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc">The config object</div></li><li><code>defaultType</code> : String<div class="sub-desc">If no type is discovered in the config object, we fall back to this type</div></li></ul><strong>Returns:</strong><ul><li><code>Mixed</code><div class="sub-desc">The instance of whatever this manager is managing</div></li></ul></div></div></div></td><td class="msource">AbstractManager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.AbstractManager-get"></a><b><a href="source/AbstractManager.html#method-Ext.AbstractManager-get">get</a></b>(&nbsp;<code>String&nbsp;id</code>&nbsp;)
4     :
5                                         Ext.Component<div class="mdesc"><div class="short">Returns a component by id.
6 For additional details see Ext.util.MixedCollection.get.</div><div class="long">Returns a component by <a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a>.
7 For additional details see <a href="output/Ext.util.MixedCollection.html#Ext.util.MixedCollection-get" ext:member="get" ext:cls="Ext.util.MixedCollection">Ext.util.MixedCollection.get</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>id</code> : String<div class="sub-desc">The component <a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">The Component, &lt;code&gt;undefined&lt;/code&gt; if not found, or &lt;code&gt;null&lt;/code&gt; if a
8 Class was found.</div></li></ul></div></div></div></td><td class="msource">AbstractManager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.AbstractManager-isRegistered"></a><b><a href="source/AbstractManager.html#method-Ext.AbstractManager-isRegistered">isRegistered</a></b>(&nbsp;<code>Ext.Component&nbsp;xtype</code>&nbsp;)
9     :
10                                         Boolean<div class="mdesc"><div class="short">Checks if a Component type is registered.</div><div class="long">Checks if a Component type is registered.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>xtype</code> : Ext.Component<div class="sub-desc">The mnemonic string by which the Component class may be looked up</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">Whether the type is registered.</div></li></ul></div></div></div></td><td class="msource">AbstractManager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.AbstractManager-onAvailable"></a><b><a href="source/AbstractManager.html#method-Ext.AbstractManager-onAvailable">onAvailable</a></b>(&nbsp;<code>String&nbsp;id</code>,&nbsp;<code>Function&nbsp;fn</code>,&nbsp;<code>Object&nbsp;scope</code>&nbsp;)
11     :
12                                         void<div class="mdesc"><div class="short">Registers a function that will be called when a Component with the specified id is added to the manager. This will ha...</div><div class="long">Registers a function that will be called when a Component with the specified id is added to the manager. This will happen on instantiation.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>id</code> : String<div class="sub-desc">The component <a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></div></li><li><code>fn</code> : Function<div class="sub-desc">The callback function</div></li><li><code>scope</code> : Object<div class="sub-desc">The scope (<code>this</code> reference) in which the callback is executed. Defaults to the Component.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">AbstractManager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.AbstractManager-register"></a><b><a href="source/AbstractManager.html#method-Ext.AbstractManager-register">register</a></b>(&nbsp;<code>Mixed&nbsp;item</code>&nbsp;)
13     :
14                                         void<div class="mdesc"><div class="short">Registers an item to be managed</div><div class="long">Registers an item to be managed<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>item</code> : Mixed<div class="sub-desc">The item to register</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">AbstractManager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.AbstractManager-registerType"></a><b><a href="source/AbstractManager.html#method-Ext.AbstractManager-registerType">registerType</a></b>(&nbsp;<code>String&nbsp;xtype</code>,&nbsp;<code>Constructor&nbsp;cls</code>&nbsp;)
15     :
16                                         void<div class="mdesc"><div class="short">Registers a new Component constructor, keyed by a new
17 Ext.Component.xtype.
18 Use this method (or its alias Ext.reg) to ...</div><div class="long"><p>Registers a new Component constructor, keyed by a new
19 <a href="output/Ext.Component.html#Ext.Component-xtype" ext:member="xtype" ext:cls="Ext.Component">Ext.Component.xtype</a>.</p>
20 <p>Use this method (or its alias <a href="output/Ext.html#Ext-reg" ext:member="reg" ext:cls="Ext">Ext.reg</a>) to register new
21 subclasses of <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a> so that lazy instantiation may be used when specifying
22 child Components.
23 see <a href="output/Ext.Container.html#Ext.Container-items" ext:member="items" ext:cls="Ext.Container">Ext.Container.items</a></p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>xtype</code> : String<div class="sub-desc">The mnemonic string by which the Component class may be looked up.</div></li><li><code>cls</code> : Constructor<div class="sub-desc">The new Component class.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">AbstractManager</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.AbstractManager-unregister"></a><b><a href="source/AbstractManager.html#method-Ext.AbstractManager-unregister">unregister</a></b>(&nbsp;<code>Mixed&nbsp;item</code>&nbsp;)
24     :
25                                         void<div class="mdesc"><div class="short">Unregisters a component by removing it from this manager</div><div class="long">Unregisters a component by removing it from this manager<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>item</code> : Mixed<div class="sub-desc">The item to unregister</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">AbstractManager</td></tr></tbody></table><a id="Ext.AbstractManager-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>