Package VASSAL.tools.icon

Class IconFamily

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.tools.icon.IconFamily

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget

public class IconFamily
extends AbstractConfigurable

An IconFamily is a named set of Icons in the four standard Tango sizes. Each IconFamily consists of at least a Scalable Icon, plus zero or more specifically sized icons. If a specific sized Icon is missing, the IconFamily will supply a scaled icon based on the Scalable icon. Icons are created as lazily as possible. IconFamilys are created in two ways: - For Vassal inbuilt Icons by IconFactory when it scans the Vengine for inbuilt Icons - For Modules, IconFamilys can be added to IconFamilyContainer by the module designer. Each IconFamily consists of at least a Scalable Icon, plus zero or more specifically sized icons. If an

Nested Class Summary

Nested classes/interfaces inherited from interface VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ICON0
static final String	ICON1
static final String	ICON2
static final String	ICON3
protected OpIcon[]	icons
static final int	LARGE
static final int	MEDIUM
static final String	SCALABLE_ICON
protected OpIcon	scalableIcon
protected String	scalablePath
protected String[]	sizePaths
static final int	SMALL
static final int	XSMALL

Fields inherited from class VASSAL.build.AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
IconFamily()
IconFamily(String familyName)
IconFamily(String familyName, String scalableName, String[] sizeName)	Create a new IconFamily with the given name.

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener.
void	addTo(Buildable parent)	Adds this component to its parent.
protected OpIcon	buildIcon(int size)
protected void	buildScalableIcon()
Class<?>[]	getAllowableConfigureComponents()
String[]	getAttributeDescriptions()	Return an array of Strings describing the attributes of this object.
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
Class<?>[]	getAttributeTypes()	Return the Class for the attributes of this object.
String	getAttributeValueString(String key)	Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
static String	getConfigureTypeName()
HelpFile	getHelpFile()
Icon	getIcon(int size)	Return a particular sized icon.
static int	getIconHeight(int size)
static int	getIconSize(String name)	Return an Icon Size based on the local language name
static String[]	getIconSizeNames()	Return list of Icon Size names in local language
BufferedImage	getImage(int size)
String	getName()
Icon	getRawIcon(int size)	Return a particular sized Icon, but do not build one from the scalable Icon if it is not found.
Icon	getScalableIcon()	Return the scalable icon directly (used by IconFamily.IconImageConfigurer)
boolean	isLegacy()
void	removeFrom(Buildable parent)	Remove this component from its parent
protected OpIcon	scaleIcon(OpIcon base, int toSizePixels)	Scale an Icon to desired size
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
void	setConfigureName(String s)	Sets the name and fires a PropertyChangeEvent
void	setScalableIconPath(String s)
void	setSizeIconPath(int size, String path)

Methods inherited from class VASSAL.build.AbstractConfigurable

add, getAttributeVisibility, getConfigureComponents, getConfigureName, getExpressionList, getFormattedStringList, getI18nData, getI18nPrefix, getLocalizedConfigureName, getMenuTextList, getNamedKeyStrokeList, getPropertyList, getTypeName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, build, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, getPropertyNames, setAncestor, validate

Methods inherited from class VASSAL.search.AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.script.expression.Auditable

getComponentName, getComponentTypeName

Methods inherited from interface VASSAL.build.Buildable

build, getBuildElement, isMandatory, isMovable, isUnique

Field Details

SCALABLE_ICON

public static final String SCALABLE_ICON

See Also:

• Constant Field Values

ICON0

public static final String ICON0

See Also:

• Constant Field Values

ICON1

public static final String ICON1

See Also:

• Constant Field Values

ICON2

public static final String ICON2

See Also:

• Constant Field Values

ICON3

public static final String ICON3

See Also:

• Constant Field Values

XSMALL

public static final int XSMALL

See Also:

• Constant Field Values

SMALL

public static final int SMALL

See Also:

• Constant Field Values

MEDIUM

public static final int MEDIUM

See Also:

• Constant Field Values

LARGE

public static final int LARGE

See Also:

• Constant Field Values

icons

protected OpIcon[] icons

scalableIcon

protected OpIcon scalableIcon

scalablePath

protected String scalablePath

sizePaths

protected String[] sizePaths

Constructor Details

IconFamily

public IconFamily(String familyName,
 String scalableName,
 String[] sizeName)

Create a new IconFamily with the given name. The name supplied will normally be the name of an IconFamily, with no suffix. These constructors are used by IconFactory to create IconFamilys for the Vassal inbuilt Icons FIXME: Write this bit...Will be needed once Toolbar Icon support is added Backward Compatibility: If the name supplied does have a file type suffix, then it is a specific Icon name from a pre-IconFamily module. By throwing away the suffix, IconFamily will use the supplied icon as a base icon to create the full IconFamily.

Parameters:

familyName - IconFamily name or Icon name

scalableName - Name of the scalable icon

sizeName - Names of the sized Icons

IconFamily

public IconFamily(String familyName)

IconFamily

public IconFamily()

Method Details

getIconSizeNames

public static String[] getIconSizeNames()

Return list of Icon Size names in local language

Returns:

getIconSize

public static int getIconSize(String name)

Return an Icon Size based on the local language name

getIconHeight

public static int getIconHeight(int size)

setScalableIconPath

public void setScalableIconPath(String s)

setSizeIconPath

public void setSizeIconPath(int size,
 String path)

isLegacy

public boolean isLegacy()

getIcon

public Icon getIcon(int size)

Return a particular sized icon. If it can't be found, then build it by scaling the base Icon.

Parameters:

size - Icon size

Returns:

Icon

getRawIcon

public Icon getRawIcon(int size)

Return a particular sized Icon, but do not build one from the scalable Icon if it is not found.

Parameters:

size -

Returns:

getScalableIcon

public Icon getScalableIcon()

Return the scalable icon directly (used by IconFamily.IconImageConfigurer)

Returns:

getImage

public BufferedImage getImage(int size)

buildIcon

protected OpIcon buildIcon(int size)

buildScalableIcon

protected void buildScalableIcon()

scaleIcon

protected OpIcon scaleIcon(OpIcon base,
 int toSizePixels)

Scale an Icon to desired size

Parameters:

base - Base Icon

toSizePixels - Required Size in Pixels

Returns:

Scaled Icon

getName

public String getName()

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Description copied from interface: Configurable

Add a PropertyChangeListener. A PropertyChangeEvent should be fired with property name Configurable.NAME_PROPERTY when the value returned from Configurable.getConfigureName() has changed

Specified by:

addPropertyChangeListener in interface Configurable

Overrides:

addPropertyChangeListener in class AbstractConfigurable

setConfigureName

public void setConfigureName(String s)

Description copied from class: AbstractConfigurable

Sets the name and fires a PropertyChangeEvent

Overrides:

setConfigureName in class AbstractConfigurable

getConfigureTypeName

public static String getConfigureTypeName()

getAttributeDescriptions

public String[] getAttributeDescriptions()

Description copied from interface: AutoConfigurable

Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object.

Specified by:

getAttributeDescriptions in interface AutoConfigurable

Specified by:

getAttributeDescriptions in class AbstractConfigurable

Returns:

an array of Strings describing the buildFile (XML) attributes of this component. These strings are used as prompts in the Properties window for this object, when the component is configured in the Editor. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from interface: AutoConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, File, Color, and KeyStroke

Specified by:

getAttributeTypes in interface AutoConfigurable

Specified by:

getAttributeTypes in class AbstractConfigurable

Returns:

the Class for the buildFile (XML) attributes of this component. Valid classes include: String, Integer, Double, Boolean, Image, Color, and KeyStroke, along with any class for which a Configurer exists in VASSAL.configure. The class determines, among other things, which type of AutoConfigurer will be used to configure the attribute when the object is configured in the Editor. The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()

getAttributeNames

public String[] getAttributeNames()

Description copied from class: AbstractBuildable

Lists all the buildFile (XML) attribute names for this component. If this component is ALSO an AbstractConfigurable, then this list of attributes determines the appropriate attribute order for AbstractConfigurable.getAttributeDescriptions() and AbstractConfigurable.getAttributeTypes().

Specified by:

getAttributeNames in interface AutoConfigurable

Specified by:

getAttributeNames in class AbstractBuildable

Returns:

a list of all buildFile (XML) attribute names for this component

getAttributeValueString

public String getAttributeValueString(String key)

Description copied from interface: AutoConfigurable

Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element

Specified by:

getAttributeValueString in interface AutoConfigurable

Specified by:

getAttributeValueString in interface Translatable

Specified by:

getAttributeValueString in class AbstractBuildable

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

Returns:

a String representation of the XML buildFile attribute with the given name. When initializing a module, this String value will loaded from the XML and passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object). It is also frequently used for checking the current value of an attribute.

setAttribute

public void setAttribute(String key,
 Object value)

Description copied from class: AbstractBuildable

Sets a buildFile (XML) attribute value for this component. The key parameter will be one of those listed in AbstractBuildable.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value will be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

Specified by:

setAttribute in interface AutoConfigurable

Specified by:

setAttribute in interface Translatable

Specified by:

setAttribute in class AbstractBuildable

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

value - If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value can also be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Returns:

a list of valid sub-component Classes. If a Class appears in this list, then instances of that class may be added to this component from the Editor's ConfigureTree window by right-clicking on the component and selecting the appropriate "Add" option.

getHelpFile

public HelpFile getHelpFile()

Returns:

a HelpFile describing how to use and configure * this component

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

addTo

public void addTo(Buildable parent)

Description copied from interface: Buildable

Adds this component to its parent. In order to make Buildable objects extensible, the child is responsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.

Parameters:

parent - parent Buildable to add this component to as a subcomponent.

getConfigurer

public Configurer getConfigurer()

Description copied from class: AbstractConfigurable

The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer

Specified by:

getConfigurer in interface Configurable

Overrides:

getConfigurer in class AbstractConfigurable

Returns:

Configurer for this component