fr.opensagres.eclipse.jsbuild.grunt.internal.ui.ImageResource.java Source code

Introduction

Here is the source code for fr.opensagres.eclipse.jsbuild.grunt.internal.ui.ImageResource.java

Source

/**
 *  Copyright (c) 2013-2014 Angelo ZERR.
 *  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:
 *  Angelo Zerr <angelo.zerr@gmail.com> - initial API and implementation
 */
package fr.opensagres.eclipse.jsbuild.grunt.internal.ui;

import java.net.URL;
import java.util.HashMap;
import java.util.Map;

import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.resource.ImageRegistry;
import org.eclipse.swt.graphics.Image;

/**
 * Utility class to handle image resources.
 */
public class ImageResource {
    // the image registry
    private static ImageRegistry imageRegistry;

    // map of image descriptors since these
    // will be lost by the image registry
    private static Map<String, ImageDescriptor> imageDescriptors;

    // base urls for images
    private static URL ICON_BASE_URL;

    private static final String URL_DLCL = "full/dlcl16/";
    private static final String URL_ELCL = "full/elcl16/";
    private static final String URL_OBJ = "full/obj16/";

    // General Object Images
    public static final String IMG_GRUNTFILE = "gruntfile";
    public static final String IMG_TASK = "task";
    public static final String IMG_TASK_DEFAULT = "task_default";
    public static final String IMG_TARGET = "target";

    static {
        try {
            String pathSuffix = "icons/";
            ICON_BASE_URL = GruntUIPlugin.getDefault().getBundle().getEntry(pathSuffix);
        } catch (Exception e) {
            Logger.logException("Images error", e);
        }
    }

    /**
     * Cannot construct an ImageResource. Use static methods only.
     */
    private ImageResource() {
        // do nothing
    }

    /**
     * Dispose of element images that were created.
     */
    protected static void dispose() {
        // do nothing
    }

    /**
     * Return the image with the given key.
     * 
     * @param key
     *            java.lang.String
     * @return org.eclipse.swt.graphics.Image
     */
    public static Image getImage(String key) {
        return getImage(key, null);
    }

    /**
     * Return the image with the given key.
     * 
     * @param key
     *            java.lang.String
     * @return org.eclipse.swt.graphics.Image
     */
    public static Image getImage(String key, String keyIfImageNull) {
        if (imageRegistry == null)
            initializeImageRegistry();
        Image image = imageRegistry.get(key);
        if (image == null) {
            if (keyIfImageNull != null) {
                return getImage(keyIfImageNull, null);
            }
            imageRegistry.put(key, ImageDescriptor.getMissingImageDescriptor());
            image = imageRegistry.get(key);
        }
        return image;
    }

    /**
     * Return the image descriptor with the given key.
     * 
     * @param key
     *            java.lang.String
     * @return org.eclipse.jface.resource.ImageDescriptor
     */
    public static ImageDescriptor getImageDescriptor(String key) {
        if (imageRegistry == null)
            initializeImageRegistry();
        ImageDescriptor id = imageDescriptors.get(key);
        if (id != null)
            return id;

        return ImageDescriptor.getMissingImageDescriptor();
    }

    /**
     * Initialize the image resources.
     */
    protected static void initializeImageRegistry() {
        imageRegistry = GruntUIPlugin.getDefault().getImageRegistry();
        imageDescriptors = new HashMap<String, ImageDescriptor>();

        // load general object images
        registerImage(IMG_GRUNTFILE, URL_OBJ + IMG_GRUNTFILE + ".png");
        registerImage(IMG_TASK, URL_OBJ + IMG_TASK + ".png");
        registerImage(IMG_TASK_DEFAULT, URL_OBJ + IMG_TASK_DEFAULT + ".png");
        registerImage(IMG_TARGET, URL_OBJ + IMG_TARGET + ".png");

    }

    /**
     * Register an image with the registry.
     * 
     * @param key
     *            java.lang.String
     * @param partialURL
     *            java.lang.String
     */
    public static void registerImage(String key, String partialURL) {
        try {
            ImageDescriptor id = ImageDescriptor.createFromURL(new URL(ICON_BASE_URL, partialURL));
            registerImageDescriptor(key, id);
        } catch (Exception e) {
            Logger.logException("Error registering image " + key + " from " + partialURL, e);
        }
    }

    public static void registerImageDescriptor(String key, ImageDescriptor id) {
        if (imageRegistry == null)
            initializeImageRegistry();
        imageRegistry.put(key, id);
        imageDescriptors.put(key, id);
    }

}