docs/source/ComponentMgr.html

   1 <html>\r
   2 <head>\r
   3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \r
   4   <title>The source code</title>\r
   5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
   6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
   7 </head>\r
   8 <body  onload="prettyPrint();">\r
   9     <pre class="prettyprint lang-js"><div id="cls-Ext.ComponentMgr"></div>/**
  10  * @class Ext.ComponentMgr
  11  * <p>Provides a registry of all Components (instances of {@link Ext.Component} or any subclass
  12  * thereof) on a page so that they can be easily accessed by {@link Ext.Component component}
  13  * {@link Ext.Component#id id} (see {@link #get}, or the convenience method {@link Ext#getCmp Ext.getCmp}).</p>
  14  * <p>This object also provides a registry of available Component <i>classes</i>
  15  * indexed by a mnemonic code known as the Component's {@link Ext.Component#xtype xtype}.
  16  * The <code>{@link Ext.Component#xtype xtype}</code> provides a way to avoid instantiating child Components
  17  * when creating a full, nested config object for a complete Ext page.</p>
  18  * <p>A child Component may be specified simply as a <i>config object</i>
  19  * as long as the correct <code>{@link Ext.Component#xtype xtype}</code> is specified so that if and when the Component
  20  * needs rendering, the correct type can be looked up for lazy instantiation.</p>
  21  * <p>For a list of all available <code>{@link Ext.Component#xtype xtypes}</code>, see {@link Ext.Component}.</p>
  22  * @singleton
  23  */
  24 Ext.ComponentMgr = function(){
  25     var all = new Ext.util.MixedCollection();
  26     var types = {};
  27     var ptypes = {};
  28
  29     return {
  30         <div id="method-Ext.ComponentMgr-register"></div>/**
  31          * Registers a component.
  32          * @param {Ext.Component} c The component
  33          */
  34         register : function(c){
  35             all.add(c);
  36         },
  37
  38         <div id="method-Ext.ComponentMgr-unregister"></div>/**
  39          * Unregisters a component.
  40          * @param {Ext.Component} c The component
  41          */
  42         unregister : function(c){
  43             all.remove(c);
  44         },
  45
  46         <div id="method-Ext.ComponentMgr-get"></div>/**
  47          * Returns a component by {@link Ext.Component#id id}.
  48          * For additional details see {@link Ext.util.MixedCollection#get}.
  49          * @param {String} id The component {@link Ext.Component#id id}
  50          * @return Ext.Component The Component, <code>undefined</code> if not found, or <code>null</code> if a
  51          * Class was found.
  52          */
  53         get : function(id){
  54             return all.get(id);
  55         },
  56
  57         <div id="method-Ext.ComponentMgr-onAvailable"></div>/**
  58          * Registers a function that will be called when a Component with the specified id is added to ComponentMgr. This will happen on instantiation.
  59          * @param {String} id The component {@link Ext.Component#id id}
  60          * @param {Function} fn The callback function
  61          * @param {Object} scope The scope (<code>this</code> reference) in which the callback is executed. Defaults to the Component.
  62          */
  63         onAvailable : function(id, fn, scope){
  64             all.on("add", function(index, o){
  65                 if(o.id == id){
  66                     fn.call(scope || o, o);
  67                     all.un("add", fn, scope);
  68                 }
  69             });
  70         },
  71
  72         <div id="prop-Ext.ComponentMgr-all"></div>/**
  73          * The MixedCollection used internally for the component cache. An example usage may be subscribing to
  74          * events on the MixedCollection to monitor addition or removal.  Read-only.
  75          * @type {MixedCollection}
  76          */
  77         all : all,
  78
  79         <div id="prop-Ext.ComponentMgr-types"></div>/**
  80          * The xtypes that have been registered with the component manager.
  81          * @type {Object}
  82          */
  83         types : types,
  84
  85         <div id="prop-Ext.ComponentMgr-ptypes"></div>/**
  86          * The ptypes that have been registered with the component manager.
  87          * @type {Object}
  88          */
  89         ptypes: ptypes,
  90
  91         <div id="method-Ext.ComponentMgr-isRegistered"></div>/**
  92          * Checks if a Component type is registered.
  93          * @param {Ext.Component} xtype The mnemonic string by which the Component class may be looked up
  94          * @return {Boolean} Whether the type is registered.
  95          */
  96         isRegistered : function(xtype){
  97             return types[xtype] !== undefined;
  98         },
  99
 100         <div id="method-Ext.ComponentMgr-isPluginRegistered"></div>/**
 101          * Checks if a Plugin type is registered.
 102          * @param {Ext.Component} ptype The mnemonic string by which the Plugin class may be looked up
 103          * @return {Boolean} Whether the type is registered.
 104          */
 105         isPluginRegistered : function(ptype){
 106             return ptypes[ptype] !== undefined;
 107         },
 108
 109         <div id="method-Ext.ComponentMgr-registerType"></div>/**
 110          * <p>Registers a new Component constructor, keyed by a new
 111          * {@link Ext.Component#xtype}.</p>
 112          * <p>Use this method (or its alias {@link Ext#reg Ext.reg}) to register new
 113          * subclasses of {@link Ext.Component} so that lazy instantiation may be used when specifying
 114          * child Components.
 115          * see {@link Ext.Container#items}</p>
 116          * @param {String} xtype The mnemonic string by which the Component class may be looked up.
 117          * @param {Constructor} cls The new Component class.
 118          */
 119         registerType : function(xtype, cls){
 120             types[xtype] = cls;
 121             cls.xtype = xtype;
 122         },
 123
 124         <div id="method-Ext.ComponentMgr-create"></div>/**
 125          * Creates a new Component from the specified config object using the
 126          * config object's {@link Ext.component#xtype xtype} to determine the class to instantiate.
 127          * @param {Object} config A configuration object for the Component you wish to create.
 128          * @param {Constructor} defaultType The constructor to provide the default Component type if
 129          * the config object does not contain a <code>xtype</code>. (Optional if the config contains a <code>xtype</code>).
 130          * @return {Ext.Component} The newly instantiated Component.
 131          */
 132         create : function(config, defaultType){
 133             return config.render ? config : new types[config.xtype || defaultType](config);
 134         },
 135
 136         <div id="method-Ext.ComponentMgr-registerPlugin"></div>/**
 137          * <p>Registers a new Plugin constructor, keyed by a new
 138          * {@link Ext.Component#ptype}.</p>
 139          * <p>Use this method (or its alias {@link Ext#preg Ext.preg}) to register new
 140          * plugins for {@link Ext.Component}s so that lazy instantiation may be used when specifying
 141          * Plugins.</p>
 142          * @param {String} ptype The mnemonic string by which the Plugin class may be looked up.
 143          * @param {Constructor} cls The new Plugin class.
 144          */
 145         registerPlugin : function(ptype, cls){
 146             ptypes[ptype] = cls;
 147             cls.ptype = ptype;
 148         },
 149
 150         <div id="method-Ext.ComponentMgr-createPlugin"></div>/**
 151          * Creates a new Plugin from the specified config object using the
 152          * config object's {@link Ext.component#ptype ptype} to determine the class to instantiate.
 153          * @param {Object} config A configuration object for the Plugin you wish to create.
 154          * @param {Constructor} defaultType The constructor to provide the default Plugin type if
 155          * the config object does not contain a <code>ptype</code>. (Optional if the config contains a <code>ptype</code>).
 156          * @return {Ext.Component} The newly instantiated Plugin.
 157          */
 158         createPlugin : function(config, defaultType){
 159             var PluginCls = ptypes[config.ptype || defaultType];
 160             if (PluginCls.init) {
 161                 return PluginCls;
 162             } else {
 163                 return new PluginCls(config);
 164             }
 165         }
 166     };
 167 }();
 168
 169 <div id="method-Ext-reg"></div>/**
 170  * Shorthand for {@link Ext.ComponentMgr#registerType}
 171  * @param {String} xtype The {@link Ext.component#xtype mnemonic string} by which the Component class
 172  * may be looked up.
 173  * @param {Constructor} cls The new Component class.
 174  * @member Ext
 175  * @method reg
 176  */
 177 Ext.reg = Ext.ComponentMgr.registerType; // this will be called a lot internally, shorthand to keep the bytes down
 178 <div id="method-Ext-preg"></div>/**
 179  * Shorthand for {@link Ext.ComponentMgr#registerPlugin}
 180  * @param {String} ptype The {@link Ext.component#ptype mnemonic string} by which the Plugin class
 181  * may be looked up.
 182  * @param {Constructor} cls The new Plugin class.
 183  * @member Ext
 184  * @method preg
 185  */
 186 Ext.preg = Ext.ComponentMgr.registerPlugin;
 187 <div id="method-Ext-create"></div>/**
 188  * Shorthand for {@link Ext.ComponentMgr#create}
 189  * Creates a new Component from the specified config object using the
 190  * config object's {@link Ext.component#xtype xtype} to determine the class to instantiate.
 191  * @param {Object} config A configuration object for the Component you wish to create.
 192  * @param {Constructor} defaultType The constructor to provide the default Component type if
 193  * the config object does not contain a <code>xtype</code>. (Optional if the config contains a <code>xtype</code>).
 194  * @return {Ext.Component} The newly instantiated Component.
 195  * @member Ext
 196  * @method create
 197  */
 198 Ext.create = Ext.ComponentMgr.create;</pre>    \r
 199 </body>\r
 200 </html>