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

/*

 * 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 org.gvsig.tools.swing.impl.icontheme;

import java.awt.Image;

import java.io.File;

import java.io.IOException;

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.gvsig.tools.swing.icontheme.IconTheme;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

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

	class DefaultIcon implements Icon {

		private ImageIcon image;

		private URL resource;

		private String name;

		private String group;

		private String provider;

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

			this.image = image;

			this.resource = resource;

			this.group = group;

			this.name = name;

			this.provider = provider;

		}

		public ImageIcon getImageIcon() {

			if (this.image != null){

				return this.image;

			}

			try {

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

			} catch(Exception ex) {

				return null;

			}

			return this.image;

		}

		public Image getImage() {

			ImageIcon icon = this.getImageIcon();

			if( icon == null ) {

				return null;

			}

			return icon.getImage();

		}

		public String getName() {

			return name;

		}

		public String getGroup() {

			return group;

		}

		public Object getResource() {

			return resource;

		}

		public URL getURL() {

			if( resource instanceof URL ) {

				return (URL) this.resource;

			}

			return null;

		}

		public String getLabel() {

			if( resource != null ) {

				return resource.toString();

			}

			if( image != null ) {

				return image.toString();

			}

			return "";

		}

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

		}

		public String getProviderName() {

			return provider;

		}

	}

	public BaseIconTheme() {

		this(null);

	}	

	public BaseIconTheme(IconTheme defaultIconTheme) {

		this.setDefault(defaultIconTheme);

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

		this.name = "default";

		this.description = "Default icon theme";

		this.iconList = new HashMap<String, Icon>();

	}

	/**

	 * Load the icons of the theme

	 */

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

		}

	}

	private boolean isEmptyString(String s) {

		if( s==null ) {

			return true;

		}

		if( s.trim().length() == 0 ) {

			return true;

		}

		return false;

	}

	public void setDefault(IconTheme def){

    	if( def == this ) {

    		defaultTheme = null;

    	} else {

    		defaultTheme = def;

    	}

    }

    public IconTheme getDefault(){

    	return defaultTheme;

    }

	public boolean exists(String iconName) {

		if( isEmptyString(iconName) ) {

			return false;

		}

		deferredLoad();

		if (iconList.containsKey(iconName)) {

			return true;

		}

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

			return true;

		}

		return false;

	}

	public Iterator<String> iterator() {

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

		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<String>(names);

		Collections.sort(names2);

		return names2.iterator();

	}

	public Iterator<Icon> getThemeIcons() {

		Set<Icon> themeIcons = new HashSet<Icon>();

		deferredLoad();

		if( defaultTheme !=null ) {

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

			while( it.hasNext() ) {

				themeIcons.add(it.next());

			}

		}

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

		while( it.hasNext() ) {

			themeIcons.add(it.next());

		}

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

		Collections.sort(themeIcons2);

		return themeIcons2.iterator();

	}

	public Icon getThemeIcon(String name) {

		if( isEmptyString(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 ImageIcon get(String name) {

		ImageIcon icon = null;

		if( ! isEmptyString(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();

	}

	public String getName() {

		return name;

	}

	public void setName(String themeName) {

		name = themeName;

	}

	public String getID() {

		return this.id;

	}

	public void setID(String id) {

		this.id = id;

	}

	public String getDescription() {

		return description;

	}

	public void setDescription(String description) {

		this.description = description;

	}

	/**

	 * Returns the name of the icon theme

	 */

	public String toString() {

		String s = null;

		if( isEmptyString(this.getName()) ) {

			s = this.getID();

		}

		if( isEmptyString(this.getDescription()) ) {

			return s;

		}

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

	}

	public ImageIcon getDefaultIcon() {

		ImageIcon imageIcon = null;

		Icon icon = null;

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

	}

	public void setDefaultIcon(ImageIcon icon) {

		this.defaultIconName = null;

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

	}

	public void setDefaultIcon(URL resource) {

		this.defaultIconName = null;

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

	}

	public void setDefaultIcon(String name) {

		this.defaultIconName = name;

	}

	public void register(String provider, String group, String name,

			ImageIcon icon, URL resource) {

		if( isEmptyString(name) ) {

			throw new IllegalArgumentException("name is empty");

		}

		deferredLoad();

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

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

			iconList.put(name, themeIcon);

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

		}

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

		iconList.put(name, themeIcon);

	}

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

		deferredLoad();

		String identifier = null;

		if( !isEmptyString(provider) ) {

			identifier = provider ;

		}

		if( group!= null ) {

			identifier = identifier + "/" + group;

		}

		if( name == null ) {

			identifier = identifier + "/unknow";

		} else {

			identifier = identifier + "/" + name;

		}

		return identifier; 

	}

	public void registerDefault(String provider, String group,

			String name, ImageIcon icon, URL resource) {

		deferredLoad();

		if (defaultTheme!=null){

			if( !defaultTheme.exists(name)) {

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

			}

		} else {

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

		}

	}

	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

	 */

	public ImageIcon getNoIcon() {

		return this.getDefaultIcon();

	}

	/**

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

	 */

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

		}

	}

	/**

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

	 */

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

		}

	}

	/**

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

	 */

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

		}

	}

	/**

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

	 */

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

		}

	}

	/**

	 * @deprecated use get(String iconName) instead.

	 */

	public ImageIcon get(String iconName, ClassLoader loader) {

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

		return this.get(iconName);

	}

}

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

import java.io.File;

import java.io.FilenameFilter;

import java.net.MalformedURLException;

import java.util.HashMap;

import org.gvsig.installer.lib.api.InstallerLocator;

import org.gvsig.installer.lib.api.InstallerManager;

import org.gvsig.installer.lib.api.PackageInfo;

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

/**

 * This class extends AbstractIconTheme and implements the abstract methods of this

 * class. This methods are <code>loadIcon</code> and <code>load</code>. This methods

 * allows load one icon or all icons in the resource.

 */

public class FolderIconTheme extends BaseIconTheme{

	protected File resource = null; 

	protected PackageInfo packageInfo = null;

	/**

	 * Constructor.Constructs an Icon Theme with a default one.

	 * @param def. The default icon theme

	 */

	public FolderIconTheme(IconTheme def) {

		super(def);

	}

	public void load(Object resource) throws IllegalArgumentException {

		if( !(resource instanceof File) ) {

			throw new IllegalArgumentException();

		}

		File res = (File) resource;

		if( !res.isDirectory() ) {

			throw new IllegalArgumentException();

		}

		this.resource = res;

		this.iconList = null;

		this.loadPackageInfo();

		this.setName(this.packageInfo.getName());

		this.setDescription(this.packageInfo.getDescription());

	}

	private void loadPackageInfo() {

		File pkgfile = new File(this.resource,"package.info"); 

		InstallerManager manager = InstallerLocator.getInstallerManager();

		try {

			this.packageInfo = manager.createPackageInfo(pkgfile.toURI().toURL().openStream());

		} catch (Exception e) {

			throw new IllegalArgumentException(e);

		}

	}

	protected void deferredLoad() {

		if( this.iconList != null ) {

			return;

		}

		iconList = new HashMap<String, IconTheme.Icon>();

		load(resource, "");

		File[] files = resource.listFiles();

		for (int i=files.length-1; i>=0; i--) {

			if( files[i].isDirectory() ) {

				load(files[i],files[i].getName());

			}

		}

	}

	private void load(File folder, String group) {

		File[] imagefiles = folder.listFiles(new ImageFileFilter());

		String name;

		for (int i=imagefiles.length-1; i>=0; i--) {

			name = computeKey(imagefiles[i].getName());

			try {

				this.register(null, group, name, null, imagefiles[i].toURI().toURL());

			} catch (MalformedURLException e) {

				logger.info("Can't load icon", e);

			}

		}

	}

	/**

	 * This class allows filter the images in the directory. Allows to load the images

	 * with a apropiate extension.

	 */

	private class ImageFileFilter implements FilenameFilter {

		public boolean accept(File dir, String fileName) {

			String extension = "";

			int pointPos = fileName.lastIndexOf(".");

			if (pointPos>0 && pointPos < (fileName.length()-1) )

				extension = fileName.substring(pointPos+1).toLowerCase();

			if ( extension.equals("jpg") || extension.equals("jpeg")

					|| extension.equals("png")

					|| extension.equals("gif")

					)

				return true;

			else

				return false;

		}

	}

	/**

	 * Returns the key of the image without extension

	 * @param fileName

	 * @return string

	 */

	private String computeKey(String fileName) {

		int pointPos = fileName.lastIndexOf(".");

		if (pointPos!=-1)

			return fileName.substring(0, pointPos);

		else

			return fileName;

	}

}

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

import java.io.File;

import java.util.HashMap;

import java.util.Iterator;

import java.util.Map;

import org.gvsig.tools.observer.ComplexObserver;

import org.gvsig.tools.observer.Observable;

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

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

import org.gvsig.tools.util.FolderSet;

import org.gvsig.tools.util.impl.DefaultFolderSet;

public class DefaultIconThemeManager implements IconThemeManager , ComplexObserver{

	private static IconThemeManager iconThemeManager = null;

	private IconTheme defaultTheme = null;

	private IconTheme currentTheme = null;

	private Map<String, IconTheme> themes = null;

	private FolderSet repository = null;

	public static IconThemeManager getIconThemeManager(){

		if (iconThemeManager == null){

			iconThemeManager = new DefaultIconThemeManager();

		}

		return iconThemeManager;

	}

	public DefaultIconThemeManager() {

		this.defaultTheme = new BaseIconTheme();

		this.currentTheme = this.defaultTheme;

		this.themes = null;

		this.repository = new DefaultFolderSet();

		this.repository.addObserver(this);

	}

	public IconTheme getDefault() {

		return this.defaultTheme;

	}

	public void setCurrent(IconTheme iconTheme) {

		this.defaultTheme = iconTheme;

	}

	public IconTheme getCurrent() {

		return this.currentTheme;

	}

	public IconTheme get(String themeID) {

		return this.get(themeID);

	}

	public Iterator<IconTheme> iterator() {

		return this.getThemes().values().iterator();

	}

	public boolean contains(IconTheme theme) {

		return this.getThemes().containsValue(theme);

	}

	public boolean add(IconTheme theme) {

		this.getThemes().put(theme.getID(), theme);

		return true; 

	}

	public boolean remove(IconTheme theme) {

		return this.getThemes().remove(theme)==null ? false: true;

	}

	public void clear() {

		this.themes = null;

	}

	public FolderSet getRepository() {

		return this.repository;

	}

	public void update(Observable observable, Object notification) {

		if( observable != this.repository ) {

			return;

		}

		this.themes = null;

	}

	private Map<String, IconTheme> getThemes() {

		if( this.themes != null ) {

			return this.themes;

		}

		Map<String, IconTheme> themes = new HashMap<String, IconTheme>();

		File[] folders = this.repository.listFiles();

		for( int i=0; i<folders.length; i++ ) {

			if( folders[i].isDirectory() ) {

				FolderIconTheme theme = new FolderIconTheme(this.getDefault());

				try {

					theme.load(folders[i]);

					themes.put(theme.getID(), theme);

				} catch( IllegalArgumentException ex) {

					// Do nothing

				}

			}

		}

		this.themes = themes;

		return themes;

	}

}

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

import java.io.File;

import java.io.InputStream;

import java.net.MalformedURLException;

import java.net.URI;

import java.net.URISyntaxException;

import java.net.URL;

import java.util.Enumeration;

import java.util.HashMap;

import java.util.zip.ZipEntry;

import java.util.zip.ZipFile;

import org.gvsig.installer.lib.api.InstallerLocator;

import org.gvsig.installer.lib.api.InstallerManager;

import org.gvsig.installer.lib.api.PackageInfo;

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

/**

 * Extends BaseIconTheme to add support for themes stored in zip files.

 * 

 * TODO: This class is under construction.

 */

public class IconThemeZip extends BaseIconTheme{

	protected File resource = null; 

	protected PackageInfo packageInfo = null;

	public IconThemeZip(IconTheme def) {

		super(def);

	}

	public void load(Object resource) {

		if( !(resource instanceof File) ) {

			throw new IllegalArgumentException();

		}

		File res = (File) resource;

		if( !res.isDirectory() ) {

			throw new IllegalArgumentException();

		}

		this.resource = res;

		this.iconList = null;

		this.loadPackageInfo();

		this.setName(this.packageInfo .getName());

		this.setDescription(this.packageInfo.getDescription());

	}

	private void loadPackageInfo() {

		InstallerManager manager = InstallerLocator.getInstallerManager();

		ZipFile zipFile = null;

		try {

			zipFile = new ZipFile(resource);

			InputStream pkgstream = zipFile.getInputStream( zipFile.getEntry("packages.zip") );

			this.packageInfo = manager.createPackageInfo(pkgstream);

		} catch (Exception e) {

			throw new IllegalArgumentException(e);

		}

	}

	protected void deferredLoad() {

		if (this.iconList != null) {

			return;

		}

		iconList = new HashMap<String, IconTheme.Icon>();

		ZipFile zipFile = null;

		try {

			zipFile = new ZipFile(resource);

		} catch (Exception e) {

			throw new IllegalArgumentException();

		}

		Enumeration<?> entries = zipFile.entries();

		while (entries.hasMoreElements()) {

			ZipEntry entry = (ZipEntry) entries.nextElement();

			if (!entry.isDirectory()) {

				try {

					if (isImage(entry.getName())) {

						String name = getNameOfEntry(entry);

						String group = getGroupOfEntry(entry);

						URL resource = getURLOfEntry(this.resource, entry);

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

					}

				} catch (Exception e) {

					logger.info("Can't register icon. Entry = " +entry.toString(), e);

				}

			}

		}

	}

	private URL getURLOfEntry(File zip, ZipEntry entry) throws MalformedURLException, URISyntaxException {

		String s = "jar:" + zip.toString() + "!" + entry.getName();

		return new URI(s).toURL();

	}

	private String getGroupOfEntry(ZipEntry entry) {

		// FIXME:

		return "";

	}

	private String getNameOfEntry(ZipEntry entry) {

		// FIXME: 

		return entry.getName();

	}

	private boolean isImage(String fileName) {

		String extension = "";

		int pointPos = fileName.lastIndexOf(".");

		if (pointPos>0 && pointPos < (fileName.length()-1) )

			extension = fileName.substring(pointPos+1).toLowerCase();

		if ( extension.equals("jpg") || extension.equals("jpeg")

				|| extension.equals("png")

				|| extension.equals("gif"))

			return true;

		else

			return false;

	}

}

        <dependency>

			<groupId>org.apache.directory.studio</groupId>

			<artifactId>org.apache.commons.io</artifactId>

			<version>2.4</version>

			<scope>compile</scope>

		</dependency>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.installer.lib.api</artifactId>

			<scope>compile</scope>

			<version>1.0.1-SNAPSHOT</version>

		</dependency>