ComponentMgr.js
上传用户:dawnssy
上传日期:2022-08-06
资源大小:9345k
文件大小:8k
源码类别:

JavaScript

开发平台:

JavaScript

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