@qooxdoo/framework/source/class/qx/locale/LocalizedString.js

The JS Framework for Coders

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

   qooxdoo - the new era of web development

   http://qooxdoo.org

   Copyright:
     2004-2008 1&1 Internet AG, Germany, http://www.1und1.de

   License:
     MIT: https://opensource.org/licenses/MIT
     See the LICENSE file in the project's top-level directory for details.

   Authors:
     * Fabian Jakobs (fjakobs)

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

/**
 * This class contains the translation of a message and all information
 * to translate it again into a different language.
 */
qx.Class.define("qx.locale.LocalizedString", {
  extend: qx.type.BaseString,

  /**
   * @param translation {String} The translated message
   * @param messageId {String} The messageId to translate
   * @param args {Array} list of arguments passed used as values for format strings
   * @param localized {Boolean} True if the string uses localize instead of translate
   */
  construct(translation, messageId, args, localized) {
    super(translation);

    this.__messageId = messageId;
    this.__localized = !!localized;
    this.__args = args;
  },

  members: {
    __localized: null,
    __messageId: null,
    __args: null,

    /**
     * Get a translation of the string using the current locale.
     *
     * @return {qx.locale.LocalizedString|String} This string translated using the current
     *    locale.
     */
    translate() {
      if (this.__localized) {
        return qx.locale.Manager.getInstance().localize(
          this.__messageId,
          this.__args
        );
      }

      return qx.locale.Manager.getInstance().translate(
        this.__messageId,
        this.__args
      );
    },

    /**
     * Returns the messageId.
     *
     * @return {String} The messageId of this localized String
     */
    getMessageId() {
      return this.__messageId;
    }
  }
});