Upgrade to ExtJS 3.3.0 - Released 10/06/2010
[extjs.git] / docs / source / AbstractManager.html
diff --git a/docs/source/AbstractManager.html b/docs/source/AbstractManager.html
new file mode 100644 (file)
index 0000000..8dcdc7c
--- /dev/null
@@ -0,0 +1,122 @@
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
+  <title>The source code</title>
+    <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+    <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+</head>
+<body  onload="prettyPrint();">
+    <pre class="prettyprint lang-js">/*!
+ * Ext JS Library 3.3.0
+ * Copyright(c) 2006-2010 Ext JS, Inc.
+ * licensing@extjs.com
+ * http://www.extjs.com/license
+ */
+<div id="cls-Ext.AbstractManager"></div>/**
+ * @class Ext.AbstractManager
+ * @extends Object
+ * Base Manager class - extended by ComponentMgr and PluginMgr
+ */
+Ext.AbstractManager = Ext.extend(Object, {
+    typeName: 'type',
+    
+    constructor: function(config) {
+        Ext.apply(this, config || {});
+        
+        <div id="prop-Ext.AbstractManager-all"></div>/**
+         * Contains all of the items currently managed
+         * @property all
+         * @type Ext.util.MixedCollection
+         */
+        this.all = new Ext.util.MixedCollection();
+        
+        this.types = {};
+    },
+    
+    <div id="method-Ext.AbstractManager-get"></div>/**
+     * Returns a component by {@link Ext.Component#id id}.
+     * For additional details see {@link Ext.util.MixedCollection#get}.
+     * @param {String} id The component {@link Ext.Component#id id}
+     * @return Ext.Component The Component, <code>undefined</code> if not found, or <code>null</code> if a
+     * Class was found.
+     */
+    get : function(id){
+        return this.all.get(id);
+    },
+    
+    <div id="method-Ext.AbstractManager-register"></div>/**
+     * Registers an item to be managed
+     * @param {Mixed} item The item to register
+     */
+    register: function(item) {
+        this.all.add(item);
+    },
+    
+    <div id="method-Ext.AbstractManager-unregister"></div>/**
+     * Unregisters a component by removing it from this manager
+     * @param {Mixed} item The item to unregister
+     */
+    unregister: function(item) {
+        this.all.remove(item);        
+    },
+    
+    <div id="method-Ext.AbstractManager-registerType"></div>/**
+     * <p>Registers a new Component constructor, keyed by a new
+     * {@link Ext.Component#xtype}.</p>
+     * <p>Use this method (or its alias {@link Ext#reg Ext.reg}) to register new
+     * subclasses of {@link Ext.Component} so that lazy instantiation may be used when specifying
+     * child Components.
+     * see {@link Ext.Container#items}</p>
+     * @param {String} xtype The mnemonic string by which the Component class may be looked up.
+     * @param {Constructor} cls The new Component class.
+     */
+    registerType : function(type, cls){
+        this.types[type] = cls;
+        cls[this.typeName] = type;
+    },
+    
+    <div id="method-Ext.AbstractManager-isRegistered"></div>/**
+     * Checks if a Component type is registered.
+     * @param {Ext.Component} xtype The mnemonic string by which the Component class may be looked up
+     * @return {Boolean} Whether the type is registered.
+     */
+    isRegistered : function(type){
+        return this.types[type] !== undefined;    
+    },
+    
+    <div id="method-Ext.AbstractManager-create"></div>/**
+     * Creates and returns an instance of whatever this manager manages, based on the supplied type and config object
+     * @param {Object} config The config object
+     * @param {String} defaultType If no type is discovered in the config object, we fall back to this type
+     * @return {Mixed} The instance of whatever this manager is managing
+     */
+    create: function(config, defaultType) {
+        var type        = config[this.typeName] || config.type || defaultType,
+            Constructor = this.types[type];
+        
+        if (Constructor == undefined) {
+            throw new Error(String.format("The '{0}' type has not been registered with this manager", type));
+        }
+        
+        return new Constructor(config);
+    },
+    
+    <div id="method-Ext.AbstractManager-onAvailable"></div>/**
+     * Registers a function that will be called when a Component with the specified id is added to the manager. This will happen on instantiation.
+     * @param {String} id The component {@link Ext.Component#id id}
+     * @param {Function} fn The callback function
+     * @param {Object} scope The scope (<code>this</code> reference) in which the callback is executed. Defaults to the Component.
+     */
+    onAvailable : function(id, fn, scope){
+        var all = this.all;
+        
+        all.on("add", function(index, o){
+            if (o.id == id) {
+                fn.call(scope || o, o);
+                all.un("add", fn, scope);
+            }
+        });
+    }
+});</pre>    
+</body>
+</html>
\ No newline at end of file