BundleMakerImages.java

/*******************************************************************************
 * Copyright (c) 2011 Bundlemaker project team.
 * 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:
 *     Bundlemaker project team - initial API and implementation
 ******************************************************************************/
package org.bundlemaker.core.ui;

import org.bundlemaker.core.ui.internal.Activator;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.resource.ImageRegistry;
import org.eclipse.swt.graphics.Image;

/**
 * This enumeration provides a number of images for the plugin.
 * 
 * <p>
 * Taken from http://blogs.itemis.de/wendehal/2010/07/08/pretty-elegant-way-to-provide -images-in-eclipse-ui-plug-ins/
 */
public enum BundleMakerImages {

  /**
   * the BundleMaker logo
   */
  BUNDLEMAKER_ICON("icons/bundlemaker-icon.png"),
  /**
   * the small BundleMaker logo
   */
  BUNDLEMAKER_ICON_SMALL("icons/bundlemaker-icon-small.png"),
  /**
   * represents an archive with binary resources
   */
  BUNDLEMAKER_PROJECT("icons/decorator/bm_project_decorator.png"),
  /**
   * The 'parse bundlemaker project' icon
   */
  BUNDLEMAKER_PARSE_PROJECT("icons/etools/bm-parse.png"),
  /**
   * Represents a Resource Content
   */
  RESOURCE_CONTENT("icons/resource_content.gif"),
  /**
   * a folder containing binaries
   */
  BINARY_FOLDER("icons/binary_folder.gif"),
  /**
   * a folder containing source files
   */
  SOURCE_FOLDER("icons/source_folder.gif"),
  /**
   * represents an archive with binary resources
   */
  BINARY_ARCHIVE("icons/binary_archive.gif"),
  /**
   * represents an archive with sources
   */
  SOURCE_ARCHIVE("icons/source_archive.gif"),
  /**
   * 
   */
  REFRESH("icons/refresh.gif"),
  /**
   * An empty box visualizing the not-checked state of a checkbox
   */
  UNCHECKED("icons/unchecked.gif"),
  /**
   * A checked box visualizing the checked state of a checkbox
   */
  CHECKED("icons/checked.gif"), //

  /**
   * Representing an object of an unknown type
   */
  UNKNOWN_OBJECT("icons/unknown_obj.gif"), //

  /**
   * Decorator used for error icons
   */
  ERROR_DECORATOR("icons/decorator/error_decorator.gif"), //

  /**
   * Icon for JDTProjectContentProvider
   */
  JDT_PROJECT_CONTENT_PROVIDER("icons/jdt_project_provider.gif"), //

  /**
   * Icon for FileBasedProjectContentProvider
   */
  FILEBASED_PROJECT_CONTENT_PROVIDER("icons/filebased_project_provider.gif");
  ;

  /**
   * The bundle-relative path to the icon
   */
  private final String path;

  private BundleMakerImages(final String path) {
    this.path = path;
  }

  /**
   * Returns an image. Clients do not need to dispose the image, it will be disposed automatically.
   * 
   * @return an {@link Image}
   */
  public Image getImage() {
    final ImageRegistry imageRegistry = Activator.getDefault().getImageRegistry();
    Image image = imageRegistry.get(this.path);
    if (image == null) {
      addImageDescriptor();
      image = imageRegistry.get(this.path);
    }

    return image;
  }

  /**
   * Returns an image descriptor.
   * 
   * @return an {@link ImageDescriptor}
   */
  public ImageDescriptor getImageDescriptor() {
    final ImageRegistry imageRegistry = Activator.getDefault().getImageRegistry();
    ImageDescriptor imageDescriptor = imageRegistry.getDescriptor(this.path);
    if (imageDescriptor == null) {
      addImageDescriptor();
      imageDescriptor = imageRegistry.getDescriptor(this.path);
    }

    return imageDescriptor;
  }

  private void addImageDescriptor() {
    final Activator plugin = Activator.getDefault();
    final ImageDescriptor id = ImageDescriptor.createFromURL(plugin.getBundle().getEntry(this.path));
    plugin.getImageRegistry().put(this.path, id);
  }

}