| gvSIG desktop 1

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2007 IVER T.I. and Generalitat Valenciana.

 *

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

package com.iver.andami.iconthemes;

import java.io.File;

import java.io.IOException;

import java.io.InputStream;

import java.net.MalformedURLException;

import java.net.URL;

import java.util.HashMap;

import java.util.zip.ZipEntry;

import java.util.zip.ZipFile;

import javax.swing.ImageIcon;

import org.apache.log4j.Logger;

/**

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

 * 

 * <p>Developers are encouraged to always use the 

 * <code>get(iconName, fallbackImage)</code> methods to get icons,

 * as they ensure that the icons are not overwritten in the theme, but it

 * also ensures than an image is got in case the icon was still not

 * registered. Note that in this case, the iconName gets registered

 * (it is associated with the provided fallbackImage).

 * </p>

 * 

 * <p>Developers are encouraged to NOT override icons which are

 * present in the theme, as this defeats the purpose of IconThemes.</p>

 * 

 * @author Cesar Martinez Izquierdo <cesar.martinez@iver.es>

 */

public class IconTheme {

        private HashMap iconList = new HashMap();

        private Logger logger;

        private IconThemeInfo info;

        /**

         * Creates a new empty IconTheme. The next step is to register icons in order

         * the theme to be useful.

         * 

         * @param themeInfo An IconThemeInfo containing the name, the description, the

         * version and the source resource of the theme.

         */

        public IconTheme(IconThemeInfo themeInfo) {

                this.info = themeInfo;

        }

        /**

         * Returns <code>true</code> if the icon theme contains a mapping for the

         * specified iconName.

         * 

         * @param iconName The key to check if it has been registered in this

         * IconTheme

         * 

         * @return <code>true</code> if this IconTheme contains

         * <code>iconName</code>, <code>false</code> otherwise.

         */

        public boolean exists(String iconName) {

                return iconList.containsKey(iconName);

        }

        /**

         * Gets the ImageIcon associated with the provided key, if the key

         * is present in the theme, or returns <code>null</code> otherwise. 

         * 

         * @param iconName

         *                         The key whose associated icon is to be retrieved

         * 

         * @return

         *                         The icon associated with the provided key, or 

         * <code>null</code> otherwise. 

         */

        public ImageIcon get(String iconName) {

                Object object = iconList.get(iconName);

                if (object!=null) {

                        if (object instanceof ImageIcon)

                                return (ImageIcon) object;

                        else if (object instanceof URL) {

                                // ok, we got an imagePath, let's see if it's valid

                                ImageIcon icon =  new ImageIcon((URL)object);

                                if (icon.getImage()!=null) {

                                        // the icon was successfully created from the imagePath

                                        return icon;

                                }

                                else {

                                        getLogger().error("Registered icon does not map to a valid image -- key: "+iconName+" -- URL: "+object.toString());

                                        return null;

                                }

                        }

                        else if (object instanceof ZipEntry && info.getResource() instanceof ZipFile) {

                                ZipEntry entry = (ZipEntry) object;

                                ZipFile file = (ZipFile) info.getResource();

                                try {

                                        InputStream is = file.getInputStream(entry);

                                        int size=(int)entry.getSize();

                                        if (size==-1) return null; 

                                        byte[] b=new byte[size];

                                        int offset=0;

                                        int chunk=0;

                                        while ((size - offset) > 0) {

                                                chunk=is.read(b, offset, size - offset);

                                                if (chunk==-1) {

                                                        break;

                                                }

                                                offset+=chunk;

                                        }

                                } catch (IOException e) {

                                }

                        }

                }

                return null;

        }

        /**

         * Gets the ImageIcon associated with the provided key, if the key

         * is present in the theme, or register and returns the provided icon

         * otherwise. 

         * 

         * @param iconName

         *                         The key whose associated icon is to be retrieved

         * @param fallbackImage

         * 

         * @return

         *                         The icon associated with the provided key, or 

         * <code>null</code> otherwise. 

         */

        public ImageIcon get(String iconName, ImageIcon fallbackImage) {

                ImageIcon icon = get(iconName);

                if (icon!=null) {

                        return icon;

                }

                else {

                        register(iconName, fallbackImage);

                        return fallbackImage;

                }

        }

        /**

         * Gets the ImageIcon associated with the provided key, if the key

         * is present in the theme, or register and returns the provided icon

         * otherwise. 

         * 

         * @param iconName

         *                         The key whose associated icon is to be retrieved

         * @param fallbackImage

         * 

         * @return

         *                         The icon associated with the provided key, or 

         * <code>null</code> otherwise. 

         */

        public ImageIcon get(String iconName, URL fallbackImage) {

                ImageIcon icon = get(iconName);

                if (icon!=null) {

                        return icon;

                }

                else {

                        icon = new ImageIcon(fallbackImage);

                        if (icon.getImage()!=null) {

                                register(iconName, fallbackImage);

                                return icon;

                        }

                        else {

                                // we don't want to return an empty ImageIcon

                                getLogger().error("Provided icon does not map to a valid image -- key: "+iconName+" -- URL: "+fallbackImage.toString());

                        }

                        return null;

                }

        }

        /**

         * Gets the ImageIcon associated with the provided key, if the key

         * is present in the theme, or register and returns the provided icon

         * otherwise. 

         * 

         * @param iconName

         *                         The key whose associated icon is to be retrieved

         * @param fallbackImage

         * 

         * @return

         *                         The icon associated with the provided key, or 

         * <code>null</code> otherwise. 

         */

        public ImageIcon get(String iconName, String fallbackImage) {

                ImageIcon icon = get(iconName);

                if (icon!=null) {

                        return icon;

                }

                else {

                        icon = new ImageIcon(fallbackImage);

                        if (icon.getImage()!=null) {

                                try {

                                        File fallbackFile = new File(fallbackImage);

                                        register(iconName, fallbackFile.toURL());

                                        return icon;

                                } catch (MalformedURLException e) {

                                        e.printStackTrace();

                                        return null;

                                }

                        }

                        else {

                                // we don't want to return an empty ImageIcon

                                getLogger().error("Provided icon does not map to a valid image -- key: "+iconName+" -- URL: "+fallbackImage.toString());

                        }

                        return null;

                }

        }

        /**

         * <p>Register in this theme the provided iconName and the associated

         * image. Developers

         * must not override icons already registered, as this defeats the

         * purpose of the IconTheme. Therefore, use the <code>exists</code>

         * method before using <code>register</code>, to ensure the icon

         * is not previously registered.</p> 

         * 

         * @param iconName The name of the icon to register. It is the name

         * that will be used later to retrieve the icon.

         *  

         * @param image The image that is going to be associated with the

         * provided icon name.

         */

        public void register(String iconName, ImageIcon image) {

                iconList.put(iconName, image);

        }

        /**

         * <p>Register in this theme the provided iconName and the associated

         * image. Developers

         * must not override icons already registered, as this defeats the

         * purpose of the IconTheme. Therefore, use the <code>exists</code>

         * method before using <code>register</code>, to ensure the icon

         * is not previously registered.</p> 

         * 

         * <p>Note that this method may fail if the provided path does not

         * point to a valid image, so check the return value.</p>

         * 

         * @param iconName The name of the icon to register. It is the name

         * that will be used later to retrieve the icon.

         *  

         * @param image The path to the image that is going to be

         * associated with the provided icon name.

         * 

         * @return <code>true</code> if the provided path points to a

         * valid file, <code>false</code> otherwise.

         */

        public boolean register(String iconName, String imagePath) {

                try {

                        File imageFile = new File(imagePath);

                        if (imageFile.exists()) {

                                iconList.put(iconName, imageFile.toURL());

                                return true;

                        }

                }

                catch (NullPointerException ex1) {}

                catch (MalformedURLException ex2) {}

                return false;

        }

        /**

         * <p>Register in this theme the provided iconName and the associated

         * image. Developers

         * must not override icons already registered, as this defeats the

         * purpose of the IconTheme. Therefore, use the <code>exists</code>

         * method before using <code>register</code>, to ensure the icon

         * is not previously registered.</p> 

         * 

         * @param iconName The name of the icon to register. It is the name

         * that will be used later to retrieve the icon.

         *  

         * @param image The URL pointing to the image that is going to be

         * associated with the provided icon name.

         */

        public void register(String iconName, URL urlImage) {

                iconList.put(iconName, urlImage);

        }

        public void register(String iconName, ZipEntry zippedImage) {

                iconList.put(iconName, zippedImage);

        }

        /**

         * Return the URL which is currently associated with the

         * provided icon name, if this icon was registered as an

         * URL, or <code>null</code> if it is not present in the theme

         * or it was registered as an IconImage.

         * 

         * @param iconName

         * @return The URL which is currently associated with the

         * provided icon name, if this icon was registered as an

         * URL, or <code>null</code> if it is not present in the theme

         * or it was registered as an IconImage.

         */

        public URL getURL(String iconName) {

                Object object = iconList.get(iconName);

                if (object !=null && object instanceof URL)

                        return (URL) object;

                return null;

        }

        public IconThemeInfo getInfo() {

                return info;

        }

        private Logger getLogger() {

                if (logger!=null)

                        return logger;

                else

                        return Logger.getLogger(this.getClass());

        }

        protected void setLogger(Logger logger) {

                this.logger = logger;

        }

}