org.gvsig.tools.swing.impl.icontheme

Class BaseIconTheme

java.lang.Object

org.gvsig.tools.swing.impl.icontheme.BaseIconTheme

All Implemented Interfaces:

IconTheme

Direct Known Subclasses:

FolderIconTheme, IconThemeZip

public class BaseIconTheme
extends java.lang.Object
implements IconTheme

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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gvsig.tools.swing.icontheme.IconTheme

IconTheme.Icon

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	defaultIconName
protected IconTheme	defaultTheme
protected java.lang.String	description
protected java.util.Map<java.lang.String,java.lang.String>	groupsDescriptions
protected java.util.Map<java.lang.String,IconTheme.Icon>	iconList
protected java.lang.String	id
protected static Logger	logger
protected java.lang.String	name
protected java.util.Map<java.lang.String,java.lang.String>	subgroupsDescriptions

Fields inherited from interface org.gvsig.tools.swing.icontheme.IconTheme

NO_ICON_NAME

Constructor Summary

Constructors

Constructor and Description
BaseIconTheme()
BaseIconTheme(IconTheme defaultIconTheme)

Method Summary

Modifier and Type	Method and Description
void	addGroupImage(java.lang.String group, java.net.URL resource)
void	addSubgroupImage(java.lang.String group, java.lang.String subgroup, java.net.URL resource)
protected void	deferredLoad() Override this to load icons on demand instead of load on the creation of the theme.
boolean	exists(java.lang.String iconName) Returns true if the icon theme contains a mapping for the specified iconName.
void	export(java.io.File folder)
javax.swing.ImageIcon	get(java.lang.String name) Gets the ImageIcon associated with the provided name, if the name is present in the theme.
javax.swing.ImageIcon	get(java.lang.String iconName, java.lang.ClassLoader loader) Deprecated. use get(String iconName) instead.
IconTheme	getDefault()
javax.swing.ImageIcon	getDefaultIcon() Return the icon used as icon by default when the requested icon not exists.
java.lang.String	getDescription() Gets the theme description.
java.lang.String	getGroupDescription(java.lang.String group)
java.util.List<SimpleImage>	getGroupImages(java.lang.String group)
java.lang.String	getID()
java.lang.String	getName() Gets the theme name of the theme
javax.swing.ImageIcon	getNoIcon() Deprecated. use getDefaultIcon
java.lang.String	getSubgroupDescription(java.lang.String group, java.lang.String subgroup)
java.util.List<SimpleImage>	getSubgroupImages(java.lang.String group, java.lang.String subgroup)
IconTheme.Icon	getThemeIcon(java.lang.String name) Return the ThemeIcon associated with the name.
java.util.Iterator<IconTheme.Icon>	getThemeIcons() Return an iterator over the ThemIcon in the theme.
boolean	isMyIcon(java.lang.String name)
java.util.Iterator<java.lang.String>	iterator() Return an iterator over the names of the icons in the theme.
void	load(java.lang.Object resource) Load the icons of the theme
boolean	matchID(java.lang.String id)
void	register(java.lang.String name, javax.swing.ImageIcon image) Deprecated. use #registerDefault(PluginServices, String, String, ImageIcon, Object)
void	register(java.lang.String name, java.lang.Object resource) Deprecated. use #registerDefault(PluginServices, String, String, ImageIcon, Object)
void	register(java.lang.String provider, java.lang.String group, java.lang.String name, javax.swing.ImageIcon icon, java.net.URL resource) Register a icon in the theme.
IconTheme.Icon	register(java.lang.String provider, java.lang.String group, java.lang.String subgroup, java.lang.String name, javax.swing.ImageIcon icon, java.net.URL resource)
void	registerDefault(java.lang.String name, javax.swing.ImageIcon image) Deprecated. use #registerDefault(PluginServices, String, String, ImageIcon, Object)
void	registerDefault(java.lang.String name, java.lang.Object resource) Deprecated. use #registerDefault(PluginServices, String, String, ImageIcon, Object)
void	registerDefault(java.lang.String provider, java.lang.String group, java.lang.String name, javax.swing.ImageIcon icon, java.net.URL resource) Register a icon in the theme.
IconTheme.Icon	registerDefault(java.lang.String provider, java.lang.String group, java.lang.String subgroup, java.lang.String name, javax.swing.ImageIcon icon, java.net.URL resource)
void	setDefault(IconTheme def)
void	setDefaultIcon(javax.swing.ImageIcon icon) Set the default icon to use when the requestd icon not exists.
void	setDefaultIcon(java.lang.String name)
void	setDefaultIcon(java.net.URL resource)
void	setDescription(java.lang.String description) Sets the theme description.
void	setGroupDescription(java.lang.String group, java.lang.String description)
void	setID(java.lang.String id)
void	setName(java.lang.String themeName) Sets the theme name of the theme
void	setSubgroupDescription(java.lang.String group, java.lang.String subgroup, java.lang.String description)
java.lang.String	toString() Returns the name of the icon theme

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

logger

protected static Logger logger

id

protected java.lang.String id

name

protected java.lang.String name

description

protected java.lang.String description

iconList

protected java.util.Map<java.lang.String,IconTheme.Icon> iconList

defaultTheme

protected IconTheme defaultTheme

defaultIconName

protected java.lang.String defaultIconName

groupsDescriptions

protected java.util.Map<java.lang.String,java.lang.String> groupsDescriptions

subgroupsDescriptions

protected java.util.Map<java.lang.String,java.lang.String> subgroupsDescriptions

Constructor Detail

BaseIconTheme

public BaseIconTheme()

BaseIconTheme

public BaseIconTheme(IconTheme defaultIconTheme)

Method Detail

load

public void load(java.lang.Object resource)

Load the icons of the theme

Specified by:

load in interface IconTheme

Parameters:

resource -

deferredLoad

protected void deferredLoad()

Override this to load icons on demand instead of load on the creation of the theme.

setDefault

public void setDefault(IconTheme def)

Specified by:

setDefault in interface IconTheme

getDefault

public IconTheme getDefault()

Specified by:

getDefault in interface IconTheme

exists

public boolean exists(java.lang.String iconName)

Description copied from interface: IconTheme

Returns true if the icon theme contains a mapping for the specified iconName.

Specified by:

exists in interface IconTheme

Returns:

true if this IconTheme contains iconName, false otherwise.

iterator

public java.util.Iterator<java.lang.String> iterator()

Description copied from interface: IconTheme

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

Specified by:

iterator in interface IconTheme

Returns:

iterator of names of icons

getThemeIcons

public java.util.Iterator<IconTheme.Icon> getThemeIcons()

Description copied from interface: IconTheme

Return an iterator over the ThemIcon in the theme.

Specified by:

getThemeIcons in interface IconTheme

Returns:

iterator of ThemeIcon

getThemeIcon

public IconTheme.Icon getThemeIcon(java.lang.String name)

Description copied from interface: IconTheme

Return the ThemeIcon associated with the name.

Specified by:

getThemeIcon in interface IconTheme

Parameters:

name - of the icon

Returns:

the IconTheme requiered

isMyIcon

public boolean isMyIcon(java.lang.String name)

Specified by:

isMyIcon in interface IconTheme

get

public javax.swing.ImageIcon get(java.lang.String name)

Description copied from interface: IconTheme

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 null if this not exists.

Specified by:

get in interface IconTheme

Returns:

The icon associated with the provided name

getName

public java.lang.String getName()

Description copied from interface: IconTheme

Gets the theme name of the theme

Specified by:

getName in interface IconTheme

Returns:

theme name

setName

public void setName(java.lang.String themeName)

Description copied from interface: IconTheme

Sets the theme name of the theme

Specified by:

setName in interface IconTheme

getID

public java.lang.String getID()

Specified by:

getID in interface IconTheme

setID

public void setID(java.lang.String id)

Specified by:

setID in interface IconTheme

getDescription

public java.lang.String getDescription()

Description copied from interface: IconTheme

Gets the theme description.

Specified by:

getDescription in interface IconTheme

Returns:

The description of this theme.

setDescription

public void setDescription(java.lang.String description)

Description copied from interface: IconTheme

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.

Specified by:

setDescription in interface IconTheme

toString

public java.lang.String toString()

Returns the name of the icon theme

Overrides:

toString in class java.lang.Object

getDefaultIcon

public javax.swing.ImageIcon getDefaultIcon()

Description copied from interface: IconTheme

Return the icon used as icon by default when the requested icon not exists.

Specified by:

getDefaultIcon in interface IconTheme

Returns:

the default icon to use.

setDefaultIcon

public void setDefaultIcon(javax.swing.ImageIcon icon)

Description copied from interface: IconTheme

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

Specified by:

setDefaultIcon in interface IconTheme

setDefaultIcon

public void setDefaultIcon(java.net.URL resource)

Specified by:

setDefaultIcon in interface IconTheme

setDefaultIcon

public void setDefaultIcon(java.lang.String name)

Specified by:

setDefaultIcon in interface IconTheme

register

public void register(java.lang.String provider,
                     java.lang.String group,
                     java.lang.String name,
                     javax.swing.ImageIcon icon,
                     java.net.URL resource)

Description copied from interface: IconTheme

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.

Specified by:

register in interface IconTheme

Parameters:

provider - name of the icon

group - name for the icon.

name - of icon

register

public IconTheme.Icon register(java.lang.String provider,
                               java.lang.String group,
                               java.lang.String subgroup,
                               java.lang.String name,
                               javax.swing.ImageIcon icon,
                               java.net.URL resource)

Specified by:

register in interface IconTheme

registerDefault

public void registerDefault(java.lang.String provider,
                            java.lang.String group,
                            java.lang.String name,
                            javax.swing.ImageIcon icon,
                            java.net.URL resource)
                     throws java.lang.IllegalArgumentException

Description copied from interface: IconTheme

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.

Specified by:

registerDefault in interface IconTheme

Parameters:

provider - name of the icon

group - name for the icon.

name - of icon

Throws:

java.lang.IllegalArgumentException - if name is null/empty or icon/resource are null

registerDefault

public IconTheme.Icon registerDefault(java.lang.String provider,
                                      java.lang.String group,
                                      java.lang.String subgroup,
                                      java.lang.String name,
                                      javax.swing.ImageIcon icon,
                                      java.net.URL resource)

Specified by:

registerDefault in interface IconTheme

export

public void export(java.io.File folder)

Specified by:

export in interface IconTheme

getNoIcon

public javax.swing.ImageIcon getNoIcon()

Deprecated. use getDefaultIcon

Specified by:

getNoIcon in interface IconTheme

Returns:

registerDefault

public void registerDefault(java.lang.String name,
                            javax.swing.ImageIcon image)

Deprecated. use #registerDefault(PluginServices, String, String, ImageIcon, Object)

Specified by:

registerDefault in interface IconTheme

Parameters:

name -

image -

registerDefault

public void registerDefault(java.lang.String name,
                            java.lang.Object resource)

Deprecated. use #registerDefault(PluginServices, String, String, ImageIcon, Object)

Specified by:

registerDefault in interface IconTheme

Parameters:

name -

resource -

register

public void register(java.lang.String name,
                     javax.swing.ImageIcon image)

Deprecated. use #registerDefault(PluginServices, String, String, ImageIcon, Object)

Specified by:

register in interface IconTheme

Parameters:

name -

image -

register

public void register(java.lang.String name,
                     java.lang.Object resource)

Deprecated. use #registerDefault(PluginServices, String, String, ImageIcon, Object)

Specified by:

register in interface IconTheme

Parameters:

name -

resource -

get

public javax.swing.ImageIcon get(java.lang.String iconName,
                                 java.lang.ClassLoader loader)

Deprecated. use get(String iconName) instead.

Specified by:

get in interface IconTheme

Parameters:

iconName -

loader -

Returns:

getGroupDescription

public java.lang.String getGroupDescription(java.lang.String group)

Specified by:

getGroupDescription in interface IconTheme

setGroupDescription

public void setGroupDescription(java.lang.String group,
                                java.lang.String description)

Specified by:

setGroupDescription in interface IconTheme

getSubgroupDescription

public java.lang.String getSubgroupDescription(java.lang.String group,
                                               java.lang.String subgroup)

Specified by:

getSubgroupDescription in interface IconTheme

setSubgroupDescription

public void setSubgroupDescription(java.lang.String group,
                                   java.lang.String subgroup,
                                   java.lang.String description)

Specified by:

setSubgroupDescription in interface IconTheme

addGroupImage

public void addGroupImage(java.lang.String group,
                          java.net.URL resource)

Specified by:

addGroupImage in interface IconTheme

getGroupImages

public java.util.List<SimpleImage> getGroupImages(java.lang.String group)

Specified by:

getGroupImages in interface IconTheme

addSubgroupImage

public void addSubgroupImage(java.lang.String group,
                             java.lang.String subgroup,
                             java.net.URL resource)

Specified by:

addSubgroupImage in interface IconTheme

getSubgroupImages

public java.util.List<SimpleImage> getSubgroupImages(java.lang.String group,
                                                     java.lang.String subgroup)

Specified by:

getSubgroupImages in interface IconTheme

matchID

public boolean matchID(java.lang.String id)

Specified by:

matchID in interface IconTheme