add extjs 6.0.1 sources

[extjs.git] / extjs / packages / core / src / app / route / Queue.js

/**\r
 * A Queue is a queue of {@link Ext.app.route.Route} instances managed by the\r
 * {@link Ext.app.route.Router} singleton if queueActions is set to `true`.\r
 * \r
 * A developer shouldn't need to use this class as {@link Ext.app.route.Router} should\r
 * manage this class. When a {@link Ext.app.route.Route} is executed,it will automatically\r
 * keep running the queue until the queue is empty.\r
 * @private\r
 */\r
Ext.define('Ext.app.route.Queue', {\r
    /**\r
     * The {@link Ext.util.MixedCollection} that will hold the queued\r
     * {@link Ext.app.route.Route} and recognized arguments.\r
     *\r
     * @private\r
     */\r
    queue: null,\r
\r
    /**\r
     * The token from the {@link Ext.app.route.Router} that is being enacted on.\r
     */\r
    token: null,\r
\r
    constructor : function(config) {\r
        Ext.apply(this, config);\r
\r
        //Create the queue MixedCollection\r
        this.queue = new Ext.util.MixedCollection();\r
    },\r
\r
    /**\r
     * Add a {@link Ext.app.route.Route} to the queue.\r
     *\r
     * @param {Ext.app.route.Route} route The route to add to the queue.\r
     * @param {Object} args The arguments recognized by the {Ext.app.route.Route}.\r
     */\r
    queueAction : function (route, args) {\r
        this.queue.add({\r
            route : route,\r
            args  : args\r
        });\r
    },\r
\r
    /**\r
     * Clear all queued actions.\r
     */\r
    clearQueue : function() {\r
        this.queue.removeAll();\r
    },\r
\r
    /**\r
     * Run the queue one by one.\r
     */\r
    runQueue : function() {\r
        var queue  = this.queue,\r
            action = queue.removeAt(0),\r
            route;\r
\r
        if (action) {\r
            route = action && action.route;\r
\r
            route.execute(this.token, action.args, this.onActionExecute, this);\r
        }\r
    },\r
\r
    /**\r
     * Handle the execution of a queued action and optionally clear all queued actions.\r
     *\r
     * @param {Boolean} clearQueue If `true` was returned, will clear all queued actions.\r
     */\r
    onActionExecute : function(clearQueue) {\r
        if (clearQueue) {\r
            //clear all queued actions\r
            this.clearQueue();\r
        } else {\r
            //continue with queue execution\r
            this.runQueue();\r
        }\r
    }\r
});\r