Application: gvSIG desktop » Library: org.gvsig.tools

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * 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.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.tools.swing.impl.icontheme;

import java.awt.Image;

import java.io.File;

import java.io.IOException;

import java.io.InputStream;

import java.net.URL;

import java.util.ArrayList;

import java.util.Collections;

import java.util.HashMap;

import java.util.HashSet;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import java.util.Set;

import javax.swing.ImageIcon;

import org.apache.commons.io.FileUtils;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.tools.swing.api.SimpleImage;

import org.gvsig.tools.swing.api.ToolsSwingLocator;

import org.gvsig.tools.swing.api.ToolsSwingManager;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.gvsig.tools.swing.icontheme.IconTheme;

import org.gvsig.tools.swing.impl.DefaultSimpleImage;

/**

 * <p>

 * This class represents an icon theme, which is basically a mapping of symbolic

 * icon names, and real icons (or icon paths). This is useful to change an

 * application's icons in an easy way. An icon theme is usually read from disk

 * on start up, but can also be created or modified on a later time.</p>

 *

 */

public class BaseIconTheme implements IconTheme {

    protected static Logger logger = LoggerFactory.getLogger(BaseIconTheme.class);

    protected String id = null;

    protected String name = null;

    protected String description = null;

    protected Map<String, Icon> iconList = null;

    protected IconTheme defaultTheme = null;

    protected String defaultIconName = null;

    protected Map<String,String> groupsDescriptions;

    protected Map<String,String> subgroupsDescriptions;

    private Map<String,List<URL>> groupsImages;

    private Map<String,List<URL>> subgroupsImages;

    class DefaultIcon implements Icon {

        private ImageIcon image;

        private ImageIcon scaledImage;

        private final URL resource;

        private final String name;

        private final String group;

        private final String provider;

        private String description;

        private String subgroup;

        DefaultIcon(String provider, String group, String name, ImageIcon image, URL resource) {

            this.image = image;

            this.scaledImage = this.image;

            if (this.image != null ) {

                double scaleFactor = ToolsSwingLocator.getIconThemeManager().getScaleFactor();

                if (scaleFactor != 1) {

                    SimpleImage simpleImage = new DefaultSimpleImage(this.image);

                    simpleImage = simpleImage.resize(scaleFactor);

                    this.scaledImage = new ImageIcon(simpleImage.getBufferedImage());

                }

            }

            this.resource = resource;

            this.group = group;

            this.name = name;

            this.provider = provider;

        }

        public boolean existsIcon() {

            if (image != null) {

                return true;

            }

            InputStream ist = null;

            boolean resp;

            try {

                ist = resource.openStream();

                resp = true;

            } catch (Exception ex) {

                resp = false;

            }

            try {

                if (ist != null) {

                    ist.close();

                }

            } catch (Exception ex) {

            }

            return resp;

        }

        @Override

        public ImageIcon getImageIcon() {

            if (this.image == null) {

                try {

                    this.image = new ImageIcon((URL) this.resource);

                    double scaleFactor = ToolsSwingLocator.getIconThemeManager().getScaleFactor();

                    if (scaleFactor != 1) {

                        SimpleImage simpleImage = new DefaultSimpleImage(this.image);

                        simpleImage = simpleImage.resize(scaleFactor);

                        this.scaledImage = new ImageIcon(simpleImage.getBufferedImage());

                    } else {

                        this.scaledImage = this.image;

                    }

                } catch (Exception ex) {

                    return null;

                }

            }

            return this.scaledImage;

        }

        @Override

        public Image getImage() {

            ImageIcon icon = this.getImageIcon();

            if (icon == null) {

                return null;

            }

            return icon.getImage();

        }

        @Override

        public String getName() {

            return name;

        }

        @Override

        public String getGroup() {

            return group;

        }

        @Override

        public Object getResource() {

            return resource;

        }

        @Override

        public URL getURL() {

            if (resource instanceof URL) {

                return (URL) this.resource;

            }

            return null;

        }

        @Override

        public String getLabel() {

            if (resource != null) {

                return resource.toString();

            }

            if (image != null) {

                return image.toString();

            }

            return "";

        }

        @Override

        public int compareTo(Icon other) {

            String this_id = this.getProviderName() + "/" + this.getGroup() + "/" + this.getName();

            String other_id = other.getProviderName() + "/" + other.getGroup() + "/" + other.getName();

            return this_id.compareTo(other_id);

        }

        @Override

        public String getProviderName() {

            return provider;

        }

        @Override

        public String getDescription() {

            return this.description;

        }

        @Override

        public String getSubgroup() {

            return this.subgroup;

        }

        @Override

        public String getGroupDescription() {

            if( defaultTheme == null ) {

                return groupsDescriptions.get(this.group);

            }

            return defaultTheme.getGroupDescription(this.group);            

        }

        @Override

        public String getSubgroupDescription() {

            if( defaultTheme == null ) {

                return subgroupsDescriptions.get(this.group + "|" + this.subgroup);

//                return getSubgroupDescription(this.group, this.subgroup);

            }

            return defaultTheme.getSubgroupDescription(this.group, this.subgroup);            

        }

        @Override

        public void setDescription(String description) {

            this.description = description;

        }

        @Override

        public void setSubgroup(String subgroup) {

            this.subgroup = subgroup;

        }

    }

    public BaseIconTheme() {

        this(null);

    }

    public BaseIconTheme(IconTheme defaultIconTheme) {

        this.groupsDescriptions = new HashMap<>();

        this.subgroupsDescriptions = new HashMap<>();

        this.groupsImages = new HashMap<>();

        this.subgroupsImages = new HashMap<>();

        this.setDefault(defaultIconTheme);

        this.id = "default"; // El id no traducirlo

        this.name = "default";

        this.description = "Default icon theme";

        this.iconList = new HashMap<>();

    }

    /**

     * Load the icons of the theme

     *

     * @param resource

     */

    @Override

    public void load(Object resource) {

        // Do nothing.

    }

    /**

     * Override this to load icons on demand instead of load on the creation of

     * the theme.

     */

    protected void deferredLoad() {

        // Do nothing

    }

    private void logstack(String msg) {

        try {

            throw new IllegalArgumentException();

        } catch (IllegalArgumentException e) {

            logger.debug(msg, e);

        }

    }

    @Override

    public void setDefault(IconTheme def) {

        if (def == this) {

            defaultTheme = null;

        } else {

            defaultTheme = def;

        }

    }

    @Override

    public IconTheme getDefault() {

        return defaultTheme;

    }

    @Override

    public boolean exists(String iconName) {

        if (StringUtils.isEmpty(iconName)) {

            return false;

        }

        deferredLoad();

        if (iconList.containsKey(iconName)) {

            return true;

        }

        return defaultTheme != null && defaultTheme.exists(iconName);

    }

    @Override

    public Iterator<String> iterator() {

        Set<String> names = new HashSet<>();

        deferredLoad();

        if (defaultTheme != null) {

            Iterator<String> it = defaultTheme.iterator();

            while (it.hasNext()) {

                names.add(it.next());

            }

        }

        Iterator<String> it = iconList.keySet().iterator();

        while (it.hasNext()) {

            names.add(it.next());

        }

        List<String> names2 = new ArrayList<>(names);

        Collections.sort(names2);

        return names2.iterator();

    }

    @Override

    public Iterator<Icon> getThemeIcons() {

        Map<String, Icon> themeIcons = new HashMap<>();

        deferredLoad();

        if (defaultTheme != null) {

            Iterator<Icon> it = defaultTheme.getThemeIcons();

            while (it.hasNext()) {

                Icon icon = it.next();

                themeIcons.put(icon.getName(), icon);

            }

        }

        Iterator<Icon> it = iconList.values().iterator();

        while (it.hasNext()) {

            Icon icon = it.next();

            themeIcons.put(icon.getName(), icon);

        }

        List<Icon> themeIcons2 = new ArrayList<>(themeIcons.values());

        Collections.sort(themeIcons2);

        return themeIcons2.iterator();

    }

    @Override

    public Icon getThemeIcon(String name) {

        if (StringUtils.isEmpty(name)) {

            return null;

        }

        deferredLoad();

        Icon themeIcon = (Icon) iconList.get(name);

        if (themeIcon != null) {

            return themeIcon;

        }

        if (defaultTheme != null && defaultTheme.exists(name)) {

            return defaultTheme.getThemeIcon(name);

        }

        return null;

    }

    public boolean isMyIcon(String name) {

        if (StringUtils.isEmpty(name)) {

            return false;

        }

        deferredLoad();

        Icon themeIcon = (Icon) iconList.get(name);

        return (themeIcon != null);

    }

    @Override

    public ImageIcon get(String name) {

        ImageIcon icon;

        if (!StringUtils.isEmpty(name)) {

            deferredLoad();

            Icon themeIcon = (Icon) iconList.get(name);

            if (themeIcon != null) {

                icon = themeIcon.getImageIcon();

                if (icon != null) {

                    return icon;

                }

            }

            if (defaultTheme != null && defaultTheme.exists(name)) {

                return defaultTheme.get(name);

            }

        }

        logger.info("get('" + name + "') icon not found");

        logstack("get('" + name + "') icon not found");

        return getNoIcon();

    }

    @Override

    public String getName() {

        return name;

    }

    @Override

    public void setName(String themeName) {

        name = themeName;

    }

    @Override

    public String getID() {

        return this.id;

    }

    @Override

    public void setID(String id) {

        this.id = id;

    }

    @Override

    public String getDescription() {

        return description;

    }

    @Override

    public void setDescription(String description) {

        this.description = description;

    }

    /**

     * Returns the name of the icon theme

     */

    @Override

    public String toString() {

        String s = this.getName();

        if (StringUtils.isEmpty(s)) {

            s = this.getID();

        }

        return s;

//                if( StringUtils.isEmpty(this.getDescription()) ) {

//                        return s;

//                }

//                return s + " - " + this.getDescription();

    }

    @Override

    public ImageIcon getDefaultIcon() {

        ImageIcon imageIcon;

        Icon icon;

        icon = this.getThemeIcon(defaultIconName);

        if (icon != null) {

            imageIcon = icon.getImageIcon();

            if (imageIcon != null) {

                return imageIcon;

            }

        }

        icon = this.getThemeIcon(NO_ICON_NAME);

        if (icon != null) {

            imageIcon = icon.getImageIcon();

            if (imageIcon != null) {

                return imageIcon;

            }

        }

        return new ImageIcon();

    }

    @Override

    public void setDefaultIcon(ImageIcon icon) {

        this.defaultIconName = null;

        this.register(null, null, NO_ICON_NAME, icon, null);

    }

    @Override

    public void setDefaultIcon(URL resource) {

        this.defaultIconName = null;

        this.register(null, null, NO_ICON_NAME, null, resource);

    }

    @Override

    public void setDefaultIcon(String name) {

        this.defaultIconName = name;

    }

    @Override

    public void register(String provider, String group,  

            String name,

            ImageIcon icon, URL resource) {

        this.register(provider, group, null, name, icon, resource);

    }

    @Override

    public IconTheme.Icon register(String provider, String group, String subgroup, 

            String name,

            ImageIcon icon, URL resource) {

        if (StringUtils.isEmpty(name)) {

            throw new IllegalArgumentException("name is empty");

        }

        deferredLoad();

        if (icon == null && resource == null) {

            Icon themeIcon = new DefaultIcon(provider, group, name, null, null);

            themeIcon.setSubgroup(subgroup);

            iconList.put(name, themeIcon);

            throw new IllegalArgumentException("icon and resource for '" + getIconIdentifier(provider, group, name) + "' are null");

        }

        DefaultIcon themeIcon = new DefaultIcon(provider, group, name, icon, resource);

        themeIcon.setSubgroup(subgroup);

        iconList.put(name, themeIcon);

        if (!themeIcon.existsIcon()) {

            throw new IllegalArgumentException("Resource not found for icon '" + getIconIdentifier(provider, group, name) + "'");

        }

        return themeIcon;

    }

    private String getIconIdentifier(String provider, String group, String name) {

        deferredLoad();

        String identifier = null;

        if (!StringUtils.isEmpty(provider)) {

            identifier = provider;

        }

        if (group != null) {

            identifier = identifier + "/" + group;

        }

        if (name == null) {

            identifier = identifier + "/unknow";

        } else {

            identifier = identifier + "/" + name;

        }

        return identifier;

    }

    @Override

    public void registerDefault(String provider, String group, String name, ImageIcon icon, URL resource) throws IllegalArgumentException {

        this.registerDefault(provider, group, null, name, icon, resource);

    }

    @Override

    public IconTheme.Icon registerDefault(String provider, String group, String subgroup,

            String name, ImageIcon icon, URL resource) {

        deferredLoad();

        if (defaultTheme != null) {

            Icon themeIcon = defaultTheme.getThemeIcon(name);

            if (themeIcon==null ) {

                return defaultTheme.register(provider, group, subgroup, name, icon, resource);

            }

            return themeIcon;

        }

        return this.register(provider, group, subgroup, name, icon, resource);

    }

    @Override

    public void export(File folder) {

        if (!folder.exists()) {

            folder.mkdir();

        }

        folder = new File(folder, this.getID());

        if (!folder.exists()) {

            folder.mkdir();

        }

        URL url_no_icon = this.getThemeIcon(NO_ICON_NAME).getURL();

        Iterator<Icon> themeIcons = this.getThemeIcons();

        while (themeIcons.hasNext()) {

            Icon themeIcon = themeIcons.next();

            URL url_src = themeIcon.getURL();

            if (url_src == null) {

                url_src = url_no_icon;

            }

            File target;

            if (themeIcon.getGroup() != null) {

                target = new File(folder, themeIcon.getGroup());

                target.mkdir();

            } else {

                target = new File(folder.getAbsolutePath());

            }

            target = new File(target, themeIcon.getName() + ".png");

            try {

                FileUtils.copyURLToFile(url_src, target);

            } catch (IOException e) {

                // TODO 

            }

        }

    }

    // ===================================================================

    /**

     * @deprecated use getDefaultIcon

     */

    @Override

    public ImageIcon getNoIcon() {

        return this.getDefaultIcon();

    }

    /**

     * @param name

     * @param image

     * @deprecated use

     * {@link #registerDefault(PluginServices, String, String, ImageIcon, Object)}

     */

    @Override

    public void registerDefault(String name, ImageIcon image) {

        logstack("registerDefault('" + name + "'), deprecated method.");

        try {

            registerDefault(null, null, name, image, null);

        } catch (IllegalArgumentException e) {

            logger.info(e.getLocalizedMessage(), e);

        }

    }

    /**

     * @param name

     * @param resource

     * @deprecated use

     * {@link #registerDefault(PluginServices, String, String, ImageIcon, Object)}

     */

    @Override

    public void registerDefault(String name, Object resource) {

        logstack("registerDefault('" + name + "'), deprecated method.");

        try {

            registerDefault(null, null, name, null, (URL) resource);

        } catch (IllegalArgumentException e) {

            logger.info(e.getLocalizedMessage(), e);

        }

    }

    /**

     * @param name

     * @param image

     * @deprecated use

     * {@link #registerDefault(PluginServices, String, String, ImageIcon, Object)}

     */

    @Override

    public void register(String name, ImageIcon image) {

        logstack("register('" + name + "'), deprecated method.");

        try {

            register(null, null, name, image, null);

        } catch (IllegalArgumentException e) {

            logger.info(e.getLocalizedMessage(), e);

        }

    }

    /**

     * @param name

     * @param resource

     * @deprecated use

     * {@link #registerDefault(PluginServices, String, String, ImageIcon, Object)}

     */

    @Override

    public void register(String name, Object resource) {

        logstack("register('" + name + "'), deprecated method.");

        try {

            register(null, null, name, null, (URL) resource);

        } catch (IllegalArgumentException e) {

            logger.info(e.getLocalizedMessage(), e);

        }

    }

    /**

     * @param iconName

     * @param loader

     * @return

     * @deprecated use get(String iconName) instead.

     */

    @Override

    public ImageIcon get(String iconName, ClassLoader loader) {

        logstack("get('" + iconName + "', loader), deprecated method.");

        return this.get(iconName);

    }

    @Override

    public String getGroupDescription(String group) {

        return this.groupsDescriptions.get(group);

    }

    @Override

    public void setGroupDescription(String group, String description) {

        this.groupsDescriptions.put(group, description);

    }

    @Override

    public String getSubgroupDescription(String group, String subgroup) {

        return this.subgroupsDescriptions.get(group + "|" + subgroup);

    }

    @Override

    public void setSubgroupDescription(String group, String subgroup, String description) {

        this.subgroupsDescriptions.put(group + "|" + subgroup, description);

    }

    public void addGroupImage(String group, URL resource) {

        List<URL> images = this.groupsImages.get(group);

        if( images == null ) {

            images = new ArrayList<>();

            this.groupsImages.put(group, images);

        }

        images.add(resource);

    }

    public List<SimpleImage> getGroupImages(String group) {

        List<URL> images = this.groupsImages.get(group);

        if( images == null ) {

            return Collections.EMPTY_LIST;

        }

        ToolsSwingManager manager = ToolsSwingLocator.getToolsSwingManager();

        List<SimpleImage> simpleImages = new ArrayList<>();

        for (URL image : images) {

            SimpleImage simpleImage = manager.createSimpleImage(image);

            simpleImages.add(simpleImage);

        }

        return simpleImages;

    } 

    public void addSubgroupImage(String group, String subgroup, URL resource) {

        String key = group + "|" + subgroup;

        List<URL> images = this.subgroupsImages.get(key);

        if( images == null ) {

            images = new ArrayList<>();

            this.subgroupsImages.put(key, images);

        }

        images.add(resource);

    }

    public List<SimpleImage> getSubgroupImages(String group, String subgroup) {

        String key = group + "|" + subgroup;

        List<URL> images = this.subgroupsImages.get(key);

        if( images == null ) {

            return Collections.EMPTY_LIST;

        }

        ToolsSwingManager manager = ToolsSwingLocator.getToolsSwingManager();

        List<SimpleImage> simpleImages = new ArrayList<>();

        for (URL image : images) {

            SimpleImage simpleImage = manager.createSimpleImage(image);

            simpleImages.add(simpleImage);

        }

        return simpleImages;

    } 

    @Override

    public boolean matchID(String id) {

        return StringUtils.equalsIgnoreCase(id, this.id);

    }

}