@qooxdoo/framework/source/class/qx/ui/command/Group.js

The JS Framework for Coders

/* ************************************************************************

   Copyright:
     2012 1&1 Internet AG, Germany, http://www.1und1.de

   Authors:
     * Mustafa Sak (msak)

************************************************************************ */

/**
 * Registrar for commands to be able to group them.
 */
qx.Class.define("qx.ui.command.Group", {
  extend: qx.core.Object,

  construct() {
    super();
    this._cmds = {};
  },

  properties: {
    /**
     * Activates or deactivates all commands in group.
     */
    active: {
      init: true,
      check: "Boolean",
      apply: "_applyActive"
    }
  },

  members: {
    _cmds: null,

    // property apply
    _applyActive(value) {
      for (var cmdkey in this._cmds) {
        this._cmds[cmdkey].setActive(value);
      }
    },

    /*
    ---------------------------------------------------------------------------
      PUBLIC API
    ---------------------------------------------------------------------------
    */

    /**
     * Adds a command with a key to the group.
     *
     * @param key {String} Key to be able to addresses the command
     * @param command {qx.ui.command.Command} Command
     *
     * @return {Boolean} <code>false</code> if key already added before
     */
    add(key, command) {
      if (qx.core.Environment.get("qx.debug")) {
        this.assertArgumentsCount(
          arguments,
          2,
          2,
          "Given parameter count mismatch! Please provide a key as string " +
            "and a command intsance."
        );

        this.assertString(key, "Key parameter must be a string.");
        this.assertInstance(
          command,
          qx.ui.command.Command,
          "Given command is not an instance of qx.ui.command.Command"
        );
      }

      if (this.has(key)) {
        if (qx.core.Environment.get("qx.debug")) {
          this.debug("Command with key: '" + key + "' already exists!");
        }
        return false;
      }

      command.setActive(this.getActive());
      this._cmds[key] = command;

      return true;
    },

    /**
     * Returns a command by key.
     *
     * @param key {String} Key which addresses the command
     *
     * @return {qx.ui.command.Command|null} Corresponding command instance or null
     */
    get(key) {
      if (qx.core.Environment.get("qx.debug")) {
        this.assertString(key, "Key parameter must be a string.");
      }

      var cmd = this._cmds[key];
      if (!cmd) {
        if (qx.core.Environment.get("qx.debug")) {
          this.debug(
            "The key: '" +
              key +
              "' was not added before. Please use " +
              "'add()' method to add the command."
          );
        }

        return null;
      }

      return cmd;
    },

    /**
     * Returns true if a command is registered by key.
     *
     * @param key {String} Key which addresses the command
     *
     * @return {Boolean} Returns <code>true</code> if a command is registered by a key
     */
    has(key) {
      if (qx.core.Environment.get("qx.debug")) {
        this.assertString(key, "Key parameter must be a string.");
      }

      return !!this._cmds[key];
    },

    /**
     * Removes a command by key from group. Returns the command.
     *
     * @param key {String} Key which addresses the command
     *
     * @return {qx.ui.command.Command|null} Corresponding command instance or null
     */
    remove(key) {
      if (qx.core.Environment.get("qx.debug")) {
        this.assertString(key, "Key parameter must be a string.");
      }

      var cmd = this._cmds[key];
      if (!cmd) {
        if (qx.core.Environment.get("qx.debug")) {
          this.debug(
            "The key: '" +
              key +
              "' was not added before. Please use " +
              "'add()' method to add the command."
          );
        }

        return null;
      }

      delete this._cmds[key];

      return cmd;
    }
  },

  destruct() {
    this._cmds = null;
  }
});