devextreme/dist/transpiled/framework/html/command_manager.js

HTML5 JavaScript Component Suite for Responsive Web Development

"use strict";

require("../../integration/jquery");

var $ = require("jquery"),
    Class = require("../../core/class"),
    noop = require("../../core/utils/common").noop,
    iteratorUtils = require("../../core/utils/iterator"),
    errors = require("../errors"),
    CommandMapping = require("../command_mapping"),
    commandToDXWidgetAdapters = require("./widget_command_adapters"),
    when = require("../../core/utils/deferred").when;

require("../command");
require("./command_container");

var CommandManager = Class.inherit({
    ctor: function ctor(options) {
        options = options || {};
        this.defaultWidgetAdapter = options.defaultWidgetAdapter || this._getDefaultWidgetAdapter();
        this.commandMapping = options.commandMapping || new CommandMapping();
    },
    _getDefaultWidgetAdapter: function _getDefaultWidgetAdapter() {
        return {
            addCommand: noop,
            clearContainer: noop
        };
    },
    _getContainerAdapter: function _getContainerAdapter($container) {
        var componentNames = $container.data("dxComponents"),
            adapters = commandToDXWidgetAdapters;

        if (componentNames) {
            for (var index in componentNames) {
                var widgetName = componentNames[index];
                if (widgetName in adapters) {
                    // TODO return the adapter instance here
                    return adapters[widgetName];
                }
            }
        }
        return this.defaultWidgetAdapter;
    },
    findCommands: function findCommands($items) {
        var items = $items.find(".dx-command").add($items.filter(".dx-command"));
        var result = iteratorUtils.map(items, function (element) {
            return $(element).dxCommand("instance");
        });
        return result;
    },
    findCommandContainers: function findCommandContainers($markup) {
        var result = iteratorUtils.map($markup.find(".dx-command-container"), function (element) {
            return $(element).dxCommandContainer("instance");
        });
        return result;
    },
    _checkCommandId: function _checkCommandId(id, command) {
        if (id === null) {
            throw errors.Error("E3010", command.$element().get(0).outerHTML);
        }
    },
    renderCommandsToContainers: function renderCommandsToContainers(commands, containers) {
        var that = this,
            commandHash = {},
            commandIds = [],
            deferreds = [];

        iteratorUtils.each(commands, function (i, command) {
            var id = command.option("id");
            that._checkCommandId(id, command); // don't remove this function. It's used in VS design-time part.
            commandIds.push(id);
            commandHash[id] = command;
        });

        that.commandMapping.checkCommandsExist(commandIds);

        iteratorUtils.each(containers, function (k, container) {
            var commandInfos = [];
            iteratorUtils.each(commandHash, function (id, command) {
                var commandId = id; // command.option("id")/* || command.option("location") */;// TODO remove location check
                var commandOptions = that.commandMapping.getCommandMappingForContainer(commandId, container.option("id"));
                if (commandOptions) {
                    commandInfos.push({ command: command, options: commandOptions });
                }
            });
            if (commandInfos.length) {
                var deferred = that._attachCommandsToContainer(container.element(), commandInfos);
                if (deferred) {
                    deferreds.push(deferred);
                }
            }
        });

        return when.apply($, deferreds);
    },
    clearContainer: function clearContainer(container) {
        var $container = container.element(),
            adapter = this._getContainerAdapter($container);

        adapter.clearContainer($container);
    },
    _arrangeCommandsToContainers: function _arrangeCommandsToContainers(commands, containers) {
        errors.log("W0002", "CommandManager", "_arrangeCommandsToContainers", "14.1", "Use the 'renderCommandsToContainers' method instead.");
        this.renderCommandsToContainers(commands, containers);
    },
    _attachCommandsToContainer: function _attachCommandsToContainer($container, commandInfos) {
        var adapter = this._getContainerAdapter($container),
            result;

        if (adapter.beginUpdate) {
            adapter.beginUpdate($container);
        }
        iteratorUtils.each(commandInfos, function (index, commandInfo) {
            adapter.addCommand($container, commandInfo.command, commandInfo.options);
        });
        if (adapter.endUpdate) {
            result = adapter.endUpdate($container);
        }
        return result;
    }
});

module.exports = CommandManager;