org.eclipse.xtend.check.ui.editor.EditorImages.java Source code

Introduction

Here is the source code for org.eclipse.xtend.check.ui.editor.EditorImages.java

Source

/*******************************************************************************
 * Copyright (c) 2005, 20067 committers of openArchitectureWare and others.
 * 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:
 *     committers of openArchitectureWare - initial API and implementation
 *******************************************************************************/
package org.eclipse.xtend.check.ui.editor;

import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
import java.net.MalformedURLException;
import java.net.URL;

import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.resource.ImageRegistry;
import org.eclipse.swt.graphics.Image;
import org.eclipse.xtend.check.ui.CheckEditorPlugin;
import org.eclipse.xtend.shared.ui.Activator;
import org.eclipse.xtend.shared.ui.internal.XtendLog;

public class EditorImages {

    public static final String STATEMENT = "statement.gif";

    /**
     * The image registry containing <code>Image</code>s and
     * <code>ImageDescriptor</code>s.
     */
    private static ImageRegistry imageRegistry;

    /* Declare Common paths */
    private static URL ICON_BASE_URL = null;

    static {
        final String pathSuffix = "icons/"; //$NON-NLS-1$
        EditorImages.ICON_BASE_URL = CheckEditorPlugin.getDefault().getBundle().getEntry(pathSuffix);
        initializeImageRegistry();
    }

    /**
     * Declare all images
     */
    private static void declareImages() {
        Field[] fs = EditorImages.class.getFields();
        for (Field f : fs) {
            if (f.getType().equals(String.class) && Modifier.isFinal(f.getModifiers())
                    && Modifier.isStatic(f.getModifiers()) && Modifier.isPublic(f.getModifiers())) {
                try {
                    declareRegistryImage((String) f.get(null), (String) f.get(null));
                } catch (IllegalArgumentException e) {
                } catch (IllegalAccessException e) {
                }
            }
        }
    }

    /**
     * Declare an Image in the registry table.
     * 
     * @param key
     *            The key to use when registering the image
     * @param path
     *            The path where the image can be found. This path is relative
     *            to where this plugin class is found (i.e. typically the
     *            packages directory)
     */
    private final static void declareRegistryImage(final String key, final String path) {
        ImageDescriptor desc = ImageDescriptor.getMissingImageDescriptor();
        try {
            desc = ImageDescriptor.createFromURL(makeIconFileURL(path));
        } catch (final MalformedURLException me) {
            XtendLog.logError(me);
        }
        EditorImages.imageRegistry.put(key, desc);
    }

    /**
     * Returns the ImageRegistry.
     */
    public static ImageRegistry getImageRegistry() {
        if (EditorImages.imageRegistry == null) {
            initializeImageRegistry();
        }
        return EditorImages.imageRegistry;
    }

    /**
     * Initialize the image registry by declaring all of the required graphics.
     * This involves creating JFace image descriptors describing how to
     * create/find the image should it be needed. The image is not actually
     * allocated until requested.
     * 
     * Prefix conventions Wizard Banners WIZBAN_ Preference Banners PREF_BAN_
     * Property Page Banners PROPBAN_ Color toolbar CTOOL_ Enable toolbar ETOOL_
     * Disable toolbar DTOOL_ Local enabled toolbar ELCL_ Local Disable toolbar
     * DLCL_ Object large OBJL_ Object small OBJS_ View VIEW_ Product images
     * PROD_ Misc images MISC_
     * 
     * Where are the images? The images (typically gifs) are found in the same
     * location as this plugin class. This may mean the same package directory
     * as the package holding this class. The images are declared using
     * this.getClass() to ensure they are looked up via this plugin class.
     * 
     * @see org.eclipse.jface.resource.ImageRegistry
     */
    public static ImageRegistry initializeImageRegistry() {
        EditorImages.imageRegistry = new ImageRegistry(Activator.getStandardDisplay());
        declareImages();
        return EditorImages.imageRegistry;
    }

    /**
     * Returns the <code>Image</code> identified by the given key, or
     * <code>null</code> if it does not exist.
     */
    public static Image getImage(final String key) {
        return getImageRegistry().get(key);
    }

    /**
     * Returns the <code>ImageDescriptor</code> identified by the given key,
     * or <code>null</code> if it does not exist.
     */
    public static ImageDescriptor getImageDescriptor(final String key) {
        return getImageRegistry().getDescriptor(key);
    }

    private static URL makeIconFileURL(final String iconPath) throws MalformedURLException {
        if (EditorImages.ICON_BASE_URL == null) {
            throw new MalformedURLException();
        }

        return new URL(EditorImages.ICON_BASE_URL, iconPath);
    }
}