ResourceIcons.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2015 The Gridarta Developers.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

package net.sf.gridarta.utils;

import java.awt.Image;
import java.awt.Toolkit;
import java.awt.image.FilteredImageSource;
import java.awt.image.ImageFilter;
import java.awt.image.ImageProducer;
import java.io.File;
import java.net.URL;
import java.util.HashMap;
import java.util.Map;
import java.util.MissingResourceException;
import javax.swing.ImageIcon;
import org.apache.log4j.Category;
import org.apache.log4j.Logger;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class ResourceIcons {

    private static final String ICON_DIR = "icons/";

    public static final String SYSTEM_DIR = "system/";

    @NotNull
    public static final String SQUARE_SELECTED_SQUARE = SYSTEM_DIR + "selected_square.png";

    @NotNull
    public static final String SQUARE_SELECTED_SQUARE_NORTH = SYSTEM_DIR + "selected_square_n.png";

    @NotNull
    public static final String SQUARE_SELECTED_SQUARE_EAST = SYSTEM_DIR + "selected_square_e.png";

    @NotNull
    public static final String SQUARE_SELECTED_SQUARE_SOUTH = SYSTEM_DIR + "selected_square_s.png";

    @NotNull
    public static final String SQUARE_SELECTED_SQUARE_WEST = SYSTEM_DIR + "selected_square_w.png";

    @NotNull
    public static final String SQUARE_PRE_SELECTED_SQUARE = SYSTEM_DIR + "pre_selected_square.png";

    @NotNull
    public static final String SQUARE_CURSOR = SYSTEM_DIR + "cursor.png";

    @NotNull
    public static final String SQUARE_EMPTY = SYSTEM_DIR + "empty.png";

    @NotNull
    public static final String SQUARE_UNKNOWN = SYSTEM_DIR + "unknown.png";

    public static final String SQUARE_WARNING = SYSTEM_DIR + "warning.png";

    private static final String SQUARE_LIGHT = SYSTEM_DIR + "light.png";

    @NotNull
    public static final String SQUARE_NO_FACE = SYSTEM_DIR + "no_face.png";

    @NotNull
    public static final String SQUARE_NO_ARCH = SYSTEM_DIR + "no_arch.png";

    @NotNull
    public static final String TREASURE_LIST = SYSTEM_DIR + "treasure_list.png";

    @NotNull
    public static final String TREASUREONE_LIST = SYSTEM_DIR + "treasureone_list.png";

    @NotNull
    public static final String TREASURE_YES = SYSTEM_DIR + "treasure_yes.png";

    @NotNull
    public static final String TREASURE_NO = SYSTEM_DIR + "treasure_no.png";

    @NotNull
    public static final String DEFAULT_ICON = SYSTEM_DIR + "default_icon.png";

    @NotNull
    public static final String DEFAULT_PREVIEW = SYSTEM_DIR + "default_preview.png";

    @NotNull
    public static final String CLOSE_TAB_SMALL_ICON = ICON_DIR + "close_tab_small_icon.gif";

    @NotNull
    public static final String AUTO_RUN_SMALL_ICON = ICON_DIR + "auto_run_small_icon.gif";

    @NotNull
    public static final String FILTER_SMALL_ICON = ICON_DIR + "filter_small_icon.gif";

    @NotNull
    public static final String RUN_PLUGIN_SMALL_ICON = ICON_DIR + "run_plugin_small_icon.gif";

    @NotNull
    public static final String APP_ICON = ICON_DIR + "app_icon.gif";

    private static final Category LOG = Logger.getLogger(ResourceIcons.class);

    @NotNull
    private final Map<String, ImageIcon> imageCache = new HashMap<>();

    @Nullable
    private ImageIcon warningSquareIcon;

    @Nullable
    private ImageIcon lightSquareIcon;

    @NotNull
    public ImageIcon getResourceIcon(@NotNull final String iconName) throws MissingResourceException {
        // check cache
        final ImageIcon imageIcon = imageCache.get(iconName);
        if (imageIcon != null) {
            if (LOG.isDebugEnabled()) {
                LOG.debug("getResourceIcon(" + iconName + "): return cached");
            }
            return imageIcon;
        }

        @NotNull final ImageIcon icon;

        final URL iconURL = ResourceIcons.class.getClassLoader().getResource(iconName);
        if (iconURL != null) {
            if (LOG.isDebugEnabled()) {
                LOG.debug("getResourceIcon(" + iconName + "): loading from resource: " + iconURL);
            }
            icon = new ImageIcon(iconURL);
        } else {
            final File iconFile = new File(iconName);
            if (!iconFile.exists()) {
                LOG.warn("Cannot find icon '" + iconName + "'");
                throw new MissingResourceException("missing resource: icon " + iconName, ResourceIcons.class.getName(), iconName);
            }

            if (LOG.isDebugEnabled()) {
                LOG.debug("getResourceIcon(" + iconName + "): loading from file: " + iconFile);
            }
            icon = new ImageIcon(iconFile.getAbsolutePath());
        }

        imageCache.put(iconName, icon);
        return icon;
    }

    public void addToCache(@NotNull final String name, @NotNull final ImageIcon imageIcon) {
        imageCache.put(name, imageIcon);
    }

    @NotNull
    @SuppressWarnings("NullableProblems")
    public ImageIcon getWarningSquareIcon() {
        if (warningSquareIcon == null) {
            final ImageFilter alphaFilter = AlphaImageFilterInstance.ALPHA_FILTER;
            final ImageIcon sysIcon = getResourceIcon(SQUARE_WARNING);
            final Image image = sysIcon.getImage();
            final ImageProducer source = image.getSource();
            final ImageProducer producer = new FilteredImageSource(source, alphaFilter);
            final Image image2 = Toolkit.getDefaultToolkit().createImage(producer);
            warningSquareIcon = new ImageIcon(image2);
        }
        return warningSquareIcon;
    }

    @NotNull
    @SuppressWarnings("NullableProblems")
    public ImageIcon getLightSquareIcon() {
        if (lightSquareIcon == null) {
            final ImageFilter alphaFilter = AlphaImageFilterInstance.ALPHA_FILTER;
            final ImageIcon sysIcon = getResourceIcon(SQUARE_LIGHT);
            final Image image = sysIcon.getImage();
            final ImageProducer source = image.getSource();
            final ImageProducer producer = new FilteredImageSource(source, alphaFilter);
            final Image image2 = Toolkit.getDefaultToolkit().createImage(producer);
            lightSquareIcon = new ImageIcon(image2);
        }
        return lightSquareIcon;
    }

}