org.gvsig.tools.swing.icontheme

Interface IconTheme

All Known Implementing Classes:

BaseIconTheme, FolderIconTheme, IconThemeZip

public interface IconTheme

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IconTheme.Icon

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NO_ICON_NAME

Method Summary

Methods

Modifier and Type	Method and Description
boolean	exists(java.lang.String name) 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 iconName) 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) 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	getID()
java.lang.String	getName() Gets the theme name of the theme
javax.swing.ImageIcon	getNoIcon() Deprecated. use getDefaultIcon()
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.
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 all icons from the IconTheme
void	register(java.lang.String iconName, javax.swing.ImageIcon image) Deprecated. use #register(PluginServices, String, String, ImageIcon, Object)
void	register(java.lang.String iconName, java.lang.Object resource) Deprecated. use #register(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.
void	registerDefault(java.lang.String iconName, javax.swing.ImageIcon image) Deprecated. use #registerDefault(PluginServices, String, String, ImageIcon, Object)
void	registerDefault(java.lang.String iconName, 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.
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	setID(java.lang.String id)
void	setName(java.lang.String themeName) Sets the theme name of the theme

Field Detail

NO_ICON_NAME

static final java.lang.String NO_ICON_NAME

See Also:

Constant Field Values

Method Detail

load

void load(java.lang.Object resource)
          throws java.lang.IllegalArgumentException

Load all icons from the IconTheme

Throws:

java.lang.IllegalArgumentException

setDefault

void setDefault(IconTheme def)

getDefault

IconTheme getDefault()

exists

boolean exists(java.lang.String name)

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

Parameters:

iconName - The key to check if it has been registered in this IconTheme

Returns:

true if this IconTheme contains iconName, false otherwise.

get

javax.swing.ImageIcon get(java.lang.String iconName)

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.

Parameters:

name - The name whose associated icon is to be retrieved

Returns:

The icon associated with the provided name

getThemeIcon

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

Return the ThemeIcon associated with the name.

Parameters:

name - of the icon

Returns:

the IconTheme requiered

getName

java.lang.String getName()

Gets the theme name of the theme

Returns:

theme name

setName

void setName(java.lang.String themeName)

Sets the theme name of the theme

Parameters:

themeName -

getID

java.lang.String getID()

setID

void setID(java.lang.String id)

getDescription

java.lang.String getDescription()

Gets the theme description.

Returns:

The description of this theme.

setDescription

void setDescription(java.lang.String 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.

Parameters:

description -

iterator

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

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

Returns:

iterator of names of icons

getThemeIcons

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

Return an iterator over the ThemIcon in the theme.

Returns:

iterator of ThemeIcon

getDefaultIcon

javax.swing.ImageIcon getDefaultIcon()

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

Returns:

the default icon to use.

setDefaultIcon

void setDefaultIcon(javax.swing.ImageIcon icon)

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

Parameters:

icon -

setDefaultIcon

void setDefaultIcon(java.net.URL resource)

setDefaultIcon

void setDefaultIcon(java.lang.String name)

registerDefault

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

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.

Parameters:

provider - name of the icon

group - name for the icon.

name - of icon

icon, - can be nulll if the resource is specified.

resource, - resource of the icon, usualy and url to the icon.

Throws:

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

register

void register(java.lang.String provider,
            java.lang.String group,
            java.lang.String name,
            javax.swing.ImageIcon icon,
            java.net.URL resource)
              throws java.lang.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.

Parameters:

provider - name of the icon

group - name for the icon.

name - of icon

icon, - can be nulll if the resource is specified.

resource, - resource of the icon, usualy and url to the icon.

Throws:

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

export

void export(java.io.File folder)

getNoIcon

javax.swing.ImageIcon getNoIcon()

Deprecated. use getDefaultIcon()

Returns:

get

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

Deprecated. use get(String) instead

registerDefault

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

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

registerDefault

void registerDefault(java.lang.String iconName,
                   java.lang.Object resource)

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

register

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

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

register

void register(java.lang.String iconName,
            java.lang.Object resource)

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