add extjs 6.0.1 sources

[extjs.git] / extjs / packages / core / src / AbstractManager.js

/**\r
 * Base Manager class\r
 * @private\r
 * @deprecated\r
 */\r
Ext.define('Ext.AbstractManager', {\r
\r
    /* Begin Definitions */\r
\r
    requires: ['Ext.util.HashMap'],\r
\r
    /* End Definitions */\r
\r
    typeName: 'type',\r
\r
    constructor: function(config) {\r
        Ext.apply(this, config || {});\r
\r
        /**\r
         * @property {Ext.util.HashMap} all\r
         * Contains all of the items currently managed\r
         */\r
        this.all = new Ext.util.HashMap();\r
\r
        this.types = {};\r
    },\r
\r
    /**\r
     * Returns an item by id.\r
     * For additional details see {@link Ext.util.HashMap#get}.\r
     * @param {String} id The id of the item\r
     * @return {Object} The item, undefined if not found.\r
     */\r
    get : function(id) {\r
        return this.all.get(id);\r
    },\r
\r
    /**\r
     * Registers an item to be managed\r
     * @param {Object} item The item to register\r
     */\r
    register: function(item) {\r
        //<debug>\r
        var key = this.all.getKey(item);\r
        if (key === undefined) {\r
            Ext.raise('Key is undefined. Please ensure the item has a key before registering the item.');\r
        }\r
        if (this.all.containsKey(key)) {\r
            Ext.raise('Registering duplicate id "' + key + '" with ' + this.$className);\r
        }\r
        //</debug>\r
\r
        this.all.add(item);\r
    },\r
\r
    /**\r
     * Unregisters an item by removing it from this manager\r
     * @param {Object} item The item to unregister\r
     */\r
    unregister: function(item) {\r
        this.all.remove(item);\r
    },\r
\r
    /**\r
     * Registers a new item constructor, keyed by a type key.\r
     * @param {String} type The mnemonic string by which the class may be looked up.\r
     * @param {Function} cls The new instance class.\r
     */\r
    registerType : function(type, cls) {\r
        this.types[type] = cls;\r
        cls[this.typeName] = type;\r
    },\r
\r
    /**\r
     * Checks if an item type is registered.\r
     * @param {String} type The mnemonic string by which the class may be looked up\r
     * @return {Boolean} Whether the type is registered.\r
     */\r
    isRegistered : function(type){\r
        return this.types[type] !== undefined;\r
    },\r
\r
    /**\r
     * Creates and returns an instance of whatever this manager manages, based on the supplied type and\r
     * config object.\r
     * @param {Object} config The config object\r
     * @param {String} defaultType If no type is discovered in the config object, we fall back to this type\r
     * @return {Object} The instance of whatever this manager is managing\r
     */\r
    create: function(config, defaultType) {\r
        var type        = config[this.typeName] || config.type || defaultType,\r
            Constructor = this.types[type];\r
\r
        //<debug>\r
        if (Constructor === undefined) {\r
            Ext.raise("The '" + type + "' type has not been registered with this manager");\r
        }\r
        //</debug>\r
\r
        return new Constructor(config);\r
    },\r
\r
    /**\r
     * Registers a function that will be called when an item with the specified id is added to the manager.\r
     * This will happen on instantiation.\r
     * @param {String} id The item id\r
     * @param {Function} fn The callback function. Called with a single parameter, the item.\r
     * @param {Object} scope The scope (this reference) in which the callback is executed.\r
     * Defaults to the item.\r
     */\r
    onAvailable : function(id, fn, scope){\r
        var all = this.all,\r
            item,\r
            callback;\r
        \r
        if (all.containsKey(id)) {\r
            item = all.get(id);\r
            fn.call(scope || item, item);\r
        } else {\r
            callback = function(map, key, item){\r
                if (key == id) {\r
                    fn.call(scope || item, item);\r
                    all.un('add', callback);\r
                }\r
            }; \r
            all.on('add', callback);\r
        }\r
    },\r
    \r
    /**\r
     * Executes the specified function once for each item in the collection.\r
     * @param {Function} fn The function to execute.\r
     * @param {String} fn.key The key of the item\r
     * @param {Number} fn.value The value of the item\r
     * @param {Number} fn.length The total number of items in the collection\r
     * @param {Boolean} fn.return False to cease iteration.\r
     * @param {Object} scope The scope to execute in. Defaults to `this`.\r
     */\r
    each: function(fn, scope){\r
        this.all.each(fn, scope || this);    \r
    },\r
    \r
    /**\r
     * Gets the number of items in the collection.\r
     * @return {Number} The number of items in the collection.\r
     */\r
    getCount: function(){\r
        return this.all.getCount();\r
    }\r
});\r