eclipse-scout-core/src/image/IconDesc.js

/*
 * Copyright (c) 2014-2017 BSI Business Systems Integration AG.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     BSI Business Systems Integration AG - initial API and implementation
 */
import {icons} from '../index';

export default class IconDesc {

  constructor() {
    this.iconType;
    this.font;
    this.iconCharacter;
    this.iconUrl;
  }

  static IconType = {
    FONT_ICON: 0,
    BITMAP: 1
  };

  static DEFAULT_FONT = 'scoutIcons';

  /**
   * Returns a CSS class based on the used font-name.
   */
  cssClass() {
    if (this.isFontIcon() && this.font !== IconDesc.DEFAULT_FONT) {
      return 'font-' + this.font;
    }
    return '';
  }

  /**
   * Returns a CSS class string to be used with JQuery.add/removeClass().
   */
  appendCssClass(cssClass) {
    var additionalCssClass = this.cssClass();
    if (additionalCssClass.length > 0) {
      return cssClass + ' ' + additionalCssClass;
    }
    return cssClass;
  }

  isFontIcon() {
    return this.iconType === IconDesc.IconType.FONT_ICON;
  }

  isBitmap() {
    return this.iconType === IconDesc.IconType.BITMAP;
  }

  /**
   * Ensures that the given icon is of type {@link scout.iconDesc}. It a string is provided it is assumed that the string is the iconId which may be parsed to create the {@link IconDesc}.
   * @param {(string|IconDesc)} icon
   */
  static ensure(icon) {
    if (!icon) {
      return icon;
    }
    if (icon instanceof IconDesc) {
      return icon;
    }
    return icons.parseIconId(icon);
  }
}