Application: gvSIG desktop

package org.gvsig.tools.swing.icontheme;

import java.util.Iterator;

import org.gvsig.tools.util.FolderSet;

public interface IconThemeManager {

	/**

	 * Gets the default theme

	 * @return the default theme.

	 */

	public IconTheme getDefault();

	/**

	 * Sets the iconTheme like current theme

	 * @param iconTheme

	 */

	public void setCurrent(IconTheme iconTheme);

	/**

	 * Gets the current theme

	 * @return current the current theme

	 */

	public IconTheme getCurrent();

	/**

	 * Returns the theme that has been registered with the name that receives like

	 * parameter

	 * @param themeName

	 * @return the theme that contains like name in its properties the parameter

	 */

	public IconTheme get(String themeID);

	public boolean contains(IconTheme theme);

	public Iterator<IconTheme> iterator();

	public boolean add(IconTheme theme);

	public boolean remove(IconTheme theme);

	public void clear();

	public FolderSet getRepository();

}

package org.gvsig.tools.swing.icontheme;

import java.awt.Image;

import java.io.File;

import java.net.URL;

import java.util.Iterator;

import javax.swing.ImageIcon;

import org.gvsig.andami.PluginServices;

public interface IconTheme {

	public static final String NO_ICON_NAME = "-no-icon-";

	interface Icon extends Comparable<Icon> {

		public String getName();

		public String getGroup() ;

		public ImageIcon getImageIcon();

		public Image getImage();

		public Object getResource() ;

		public URL getURL() ;

		public String getLabel();

		public String getProviderName();

	}

	/**

	 * Load all icons from the IconTheme

	 */

	public void load(Object resource) throws IllegalArgumentException;

	public void setDefault(IconTheme def);

	public IconTheme getDefault();

	/**

	 * 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 name);

	/**

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

	 * is present in the theme. If the icon not exists try to return

	 * a icon with name "no-icon" or returns <code>null</code> if 

	 * this not exists.

	 *

	 * @param name

	 * 			The name whose associated icon is to be retrieved

	 *

	 * @return

	 * 			The icon associated with the provided name

	 */

	public ImageIcon get(String iconName);

	/**

	 * Return the ThemeIcon associated with the name.

	 *  

	 * @param name of the icon

	 * @return the IconTheme requiered

	 */

	public Icon getThemeIcon(String name);

	/**

	 * Gets the theme name of the theme

	 * @return theme name

	 */

	public String getName();

	/**

	 * Sets the theme name of the theme

	 *

	 * @param themeName

	 */

	public void setName(String themeName);

	public String getID();

	public void setID(String id);

	/**

	 * Gets the theme description.

	 *

	 * @return The description of this theme.

	 */

	public String getDescription();

	/**

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

	/**

	 * Return an iterator over the names of the icons in the theme.

	 * 

	 * @return iterator of names of icons

	 */

	public Iterator<String> iterator();

	/**

	 * Return an iterator over the ThemIcon in the theme.

	 *  

	 * @return iterator of ThemeIcon

	 */

	public Iterator<Icon> getThemeIcons();

	/**

	 * Return the icon used as icon by default when the requested icon 

	 * not exists.

	 * 

	 * @return the default icon to use.

	 */

	public ImageIcon getDefaultIcon();

	/**

	 * Set the default icon to use when the requestd icon not exists.

	 * 

	 * @param icon

	 */

	public void setDefaultIcon(ImageIcon icon);

	public void setDefaultIcon(URL resource);

	public void setDefaultIcon(String name);

	/**

	 * Register a icon in the theme.

	 * The parameter icon can be null if the resource is specified.

	 * The parameter resource can be null if the icon is specified. 

	 * 

	 * Plugin and group can be null.

	 *  

	 * @param provider name of the icon

	 * @param group name for the icon.

	 * @param name of icon

	 * @param icon, can be nulll if the resource is specified. 

	 * @param resource, resource of the icon, usualy and url to the icon.

	 * 

	 * @throws IllegalArgumentException if name is null/empty or icon/resource are null

	 */

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

	/**

	 * Register a icon in the theme.

	 * The parameter icon can be null if the resource is specified.

	 * The parameter resource can be null if the icon is specified. 

	 * 

	 * Plugin and group can be null.

	 * 

	 * @param provider name of the icon

	 * @param group name for the icon.

	 * @param name of icon

	 * @param icon, can be nulll if the resource is specified. 

	 * @param resource, resource of the icon, usualy and url to the icon.

	 * 

	 * @throws IllegalArgumentException if name is null/empty or icon/resource are null

	 */

	public void register(String provider, String group, String name, ImageIcon icon, URL resource) throws IllegalArgumentException;

	public void export(File folder);

	/**

	 * @deprecated use {@link #getDefaultIcon()} 

	 * @return

	 */

	public ImageIcon getNoIcon();

	/**

	 * @deprecated use {@link #get(String)} instead

	 */

	public ImageIcon get(String iconName, ClassLoader loader);

	/**

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

	 */

	public void registerDefault(String iconName, ImageIcon image);

	/**

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

	 */

	public void registerDefault(String iconName, Object resource);

	/**

	 * @deprecated use {@link #register(PluginServices, String, String, ImageIcon, Object)}

	 */

	public void register(String iconName, ImageIcon image);

	/**

	 * @deprecated use {@link #register(PluginServices, String, String, ImageIcon, Object)}

	 */

	public void register(String iconName, Object resource);

}