| gvSIG desktop 1

/*

 * 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.net.URL;

import java.util.HashMap;

import javax.swing.ImageIcon;

import org.apache.log4j.Logger;

import com.iver.andami.PluginServices;

/**

 * <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 abstract class AbstractIconTheme {

        private HashMap iconList = new HashMap();

        private String name=null;

        private String description=null;

        private String version="1.0";

        private Object resource=null;

        private AbstractIconTheme defaultTheme = null;

        /**

         * Abstract method that allows load an a icon. This method will be reimplemented by

         * inherit classes.

         * @param iconName

         * @param resource

         * @return

         */

        protected abstract ImageIcon loadIcon(String iconName,Object resource) ;

        /**

         * Load all icons from the IconTheme

         */

        public abstract void load() ;

        /**

         * Returns the logger

         * @return

         */

    protected Logger log() {

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

    }

    public void setDefault(AbstractIconTheme def){

            defaultTheme = def;

    }

    public AbstractIconTheme getDefault(){

            return defaultTheme;

    }

        /**

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

                if (iconList.containsKey(iconName))return true;

                if (defaultTheme.exists(iconName))return true;

                return false;

        }

        /**

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

                        return toImageIcon(object,iconName);

                }

                if (defaultTheme!=null && defaultTheme != this){

                        object =  defaultTheme.get(iconName);

                        if (object!=null){

                                return toImageIcon(object,iconName);

                        }

                }

                object = iconList.get("no-icon");

                if (object == null && (defaultTheme!=null && defaultTheme != this)){

                        object =  defaultTheme.get(iconName);

                }

                return toImageIcon(object,iconName);

        }

        protected ImageIcon toImageIcon(Object object,String iconName){

                if (object == null){

                        return null;

                }

                if( object instanceof URL ) {

                        return new ImageIcon((URL)object);

                }

                ImageIcon icon = loadIcon(iconName,object);

                return icon;

        }

        /**

         * <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 registerDefault(String iconName, ImageIcon image) {

                if (defaultTheme!=null)        defaultTheme.register(iconName, image);

                else register(iconName, image);

        }

        /**

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

         * resource. 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 resource The resource that is going to be asssocioated with the providad

         *         icon name

         */

        public void registerDefault(String iconName, Object resource) {

                if (defaultTheme!=null)defaultTheme.register(iconName, resource);

                else register(iconName, resource);

        }

        /**

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

         * resource. 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 resource The resource that is going to be asssocioated with the providad

         *         icon name

         */

        public void register(String iconName, Object resource) {

                iconList.put(iconName, resource);

        }

        /**

         * Gets the theme name.

         * @return theme name

         */

        public String getName() {

                return name;

        }

        /**

         * Sets the theme name.

         *

         * @param themeName

         */

        public void setName(String themeName) {

                name = themeName;

        }

        /**

         * Gets the theme description.

         *

         * @return The description of this theme.

         */

        public String getDescription() {

                return description;

        }

        /**

         * Sets the theme description. It should be a short description

         * (around 20-30 words), including the highlights of the theme,

         * the author and maybe its email address or a link the the theme's

         * homepage.

         *

         * @param description

         */

        public void setDescription(String description) {

                this.description = description;

        }

        /**

         * Returns the theme version. It defaults to "1.0".

         *

         * @return The version of this theme.

         */

        public String getVersion() {

                return version;

        }

        /**

         * Set the theme version.

         *

         * @param version

         */

        public void setVersion(String version) {

                this.version = version;

        }

        /**

         * Gets the Object which contains physically contains this theme on disk.

         * It may be a ZipFile or JarFile, or a directory.

         *

         * @return

         */

        public Object getResource() {

                return resource;

        }

        /**

         * Sets the file which contains physically contains this theme on disk.

         * It may be a ZipFile or JarFile, or a directory.

         *

         * @return

         */

        public void setResource(Object resource) {

                this.resource = resource;

        }

        /**

         * Returns the name of the icon theme

         */

        public String toString() {

                return getName();

        }

        /**

         * 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 = defaultTheme.get(iconName);

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

                        return (URL) object;

                return null;

        }

}