add extjs 6.0.1 sources

[extjs.git] / extjs / packages / core / src / data / StoreManager.js

/**\r
 * Contains a collection of all stores that are created that have an identifier. An identifier can be assigned by\r
 * setting the {@link Ext.data.AbstractStore#storeId storeId} property. When a store is in the StoreManager, it can be\r
 * referred to via it's identifier:\r
 *\r
 *     Ext.create('Ext.data.Store', {\r
 *         model: 'SomeModel',\r
 *         storeId: 'myStore'\r
 *     });\r
 *\r
 *     var store = Ext.data.StoreManager.lookup('myStore');\r
 *\r
 * Also note that the {@link #lookup} method is aliased to {@link Ext#getStore} for convenience.\r
 *\r
 * If a store is registered with the StoreManager, you can also refer to the store by it's identifier when registering\r
 * it with any Component that consumes data from a store:\r
 *\r
 *     Ext.create('Ext.data.Store', {\r
 *         model: 'SomeModel',\r
 *         storeId: 'myStore'\r
 *     });\r
 *\r
 *     Ext.create('Ext.view.View', {\r
 *         store: 'myStore',\r
 *         // other configuration here\r
 *     });\r
 *\r
 */\r
Ext.define('Ext.data.StoreManager', {\r
    extend: 'Ext.util.MixedCollection',\r
    alternateClassName: [\r
        'Ext.StoreMgr',\r
        'Ext.data.StoreMgr',\r
        'Ext.StoreManager'\r
    ],\r
\r
    singleton: true,\r
\r
    requires: [\r
        'Ext.data.ArrayStore'\r
    ],\r
    \r
    /**\r
     * @cfg {Object} listeners\r
     * @private\r
     */\r
\r
    /**\r
     * Registers one or more Stores with the StoreManager. You do not normally need to register stores manually. Any\r
     * store initialized with a {@link Ext.data.Store#storeId} will be auto-registered.\r
     * @param {Ext.data.Store...} stores Any number of Store instances\r
     */\r
    register : function() {\r
        for (var i = 0, s; (s = arguments[i]); i++) {\r
            this.add(s);\r
        }\r
    },\r
\r
    /**\r
     * Unregisters one or more Stores with the StoreManager\r
     * @param {String/Object...} stores Any number of Store instances or ID-s\r
     */\r
    unregister : function() {\r
        for (var i = 0, s; (s = arguments[i]); i++) {\r
            this.remove(this.lookup(s));\r
        }\r
    },\r
\r
    /**\r
     * Gets a registered Store by id\r
     * @param {String/Object} store The id of the Store, or a Store instance, or a store configuration\r
     * @param {String} [defaultType] The store type to create when used with store configuration and there\r
     * is no type specified on the config.\r
     * @return {Ext.data.Store}\r
     */\r
    lookup : function(store, defaultType) {\r
        // handle the case when we are given an array or an array of arrays.\r
        if (Ext.isArray(store)) {\r
            var fields = ['field1'], \r
                expand = !Ext.isArray(store[0]),\r
                data = store,\r
                i,\r
                len;\r
                \r
            if(expand){\r
                data = [];\r
                for (i = 0, len = store.length; i < len; ++i) {\r
                    data.push([store[i]]);\r
                }\r
            } else {\r
                for(i = 2, len = store[0].length; i <= len; ++i){\r
                    fields.push('field' + i);\r
                }\r
            }\r
            return new Ext.data.ArrayStore({\r
                data  : data,\r
                fields: fields,\r
                autoDestroy: true,\r
                autoCreated: true,\r
                expanded: expand\r
            });\r
        }\r
        \r
        if (Ext.isString(store)) {\r
            // store id\r
            return this.get(store);\r
        } else {\r
            // store instance or store config\r
            return Ext.Factory.store(store, defaultType);\r
        }\r
    },\r
\r
    // getKey implementation for MixedCollection\r
    getKey : function(o) {\r
         return o.storeId;\r
    }\r
}, function() {    \r
    /**\r
     * Creates a new store for the given id and config, then registers it with the {@link Ext.data.StoreManager Store Manager}. \r
     * Sample usage:\r
     *\r
     *     Ext.regStore('AllUsers', {\r
     *         model: 'User'\r
     *     });\r
     *\r
     *     // the store can now easily be used throughout the application\r
     *     new Ext.List({\r
     *         store: 'AllUsers',\r
     *         ... other config\r
     *     });\r
     *\r
     * @param {String} id The id to set on the new store\r
     * @param {Object} config The store config\r
     * @member Ext\r
     * @method regStore\r
     */\r
    Ext.regStore = function(name, config) {\r
        var store;\r
\r
        if (Ext.isObject(name)) {\r
            config = name;\r
        } else {\r
            if (Ext.data.StoreManager.containsKey(name)) {\r
                return Ext.data.StoreManager.lookup(name);\r
            }\r
            config.storeId = name;\r
        }\r
\r
        if (config instanceof Ext.data.Store) {\r
            store = config;\r
        } else {\r
            store = new Ext.data.Store(config);\r
        }\r
\r
        Ext.data.StoreManager.register(store);\r
        return store;\r
    };\r
\r
    /**\r
     * Shortcut to {@link Ext.data.StoreManager#lookup}.\r
     * @member Ext\r
     * @method getStore\r
     * @inheritdoc Ext.data.StoreManager#lookup\r
     */\r
    Ext.getStore = function(name) {\r
        return Ext.data.StoreManager.lookup(name);\r
    };\r
\r
    // A dummy empty store with a fieldless Model defined in it.\r
    // Just for binding to Views which are instantiated with no Store defined.\r
    // They will be able to run and render fine, and be bound to a generated Store later.\r
    var emptyStore = Ext.regStore('ext-empty-store', { proxy: 'memory', useModelWarning: false });\r
\r
    emptyStore.isEmptyStore = true;\r
\r
    //<debug>\r
    emptyStore.add = emptyStore.remove = emptyStore.insert = emptyStore.loadData = function () {\r
        Ext.raise('Cannot modify ext-empty-store');\r
    };\r
    //</debug>\r
});\r