Package VASSAL.build.module.gamepieceimage

Class SymbolItemInstance

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.gamepieceimage.ItemInstance

VASSAL.build.module.gamepieceimage.SymbolItemInstance

All Implemented Interfaces:

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

public class SymbolItemInstance
extends ItemInstance

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SymbolItemInstance.BgColorSwatchConfig
static class	SymbolItemInstance.FgColorSwatchConfig
static class	SymbolItemInstance.SizeColorSwatchConfig
static class	SymbolItemInstance.SizeConfig
static class	SymbolItemInstance.Symbol1Config
static class	SymbolItemInstance.Symbol2Config

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
protected String	size
static final String	SIZE
static final String	SIZE_COLOR
protected String	symbol1
static final String	SYMBOL1
protected String	symbol2
static final String	SYMBOL2

Fields inherited from class VASSAL.build.module.gamepieceimage.ItemInstance

BG_COLOR, bgColor, defn, FG_COLOR, fgColor, item, location, myConfig, type

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
SymbolItemInstance()
SymbolItemInstance(String nam, String typ, String loc, String sz, String s1, String s2)
SymbolItemInstance(String code, GamePieceImage defn)

Method Summary

Modifier and Type	Method	Description
void	decode(String code)
String	encode()
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
String	getSize()
protected ColorSwatch	getSizeColor()
String	getSymbol1()
String	getSymbol2()
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
void	setSize(String size)
protected void	setSizeColor(ColorSwatch sizeColor)
void	setSymbol1(String symbol1)
void	setSymbol2(String symbol2)

Methods inherited from class VASSAL.build.module.gamepieceimage.ItemInstance

addTo, formatName, getAllowableConfigureComponents, getBgColor, getDisplayLocation, getFgColor, getHelpFile, getItem, getLocation, getName, getSuffix, getType, newDefaultInstance, removeFrom, setBgColor, setConfig, setFgColor, setItem, setLocation, setName, setType

Methods inherited from class VASSAL.build.AbstractConfigurable

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

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

SIZE

public static final String SIZE

See Also:

• Constant Field Values

SIZE_COLOR

public static final String SIZE_COLOR

See Also:

• Constant Field Values

SYMBOL1

public static final String SYMBOL1

See Also:

• Constant Field Values

SYMBOL2

public static final String SYMBOL2

See Also:

• Constant Field Values

size

protected String size

symbol1

protected String symbol1

symbol2

protected String symbol2

Constructor Details

SymbolItemInstance

public SymbolItemInstance()

SymbolItemInstance

public SymbolItemInstance(String nam,
 String typ,
 String loc,
 String sz,
 String s1,
 String s2)

SymbolItemInstance

public SymbolItemInstance(String code,
 GamePieceImage defn)

Method Details

encode

public String encode()

Specified by:

encode in class ItemInstance

decode

public void decode(String code)

setSize

public void setSize(String size)

getSize

public String getSize()

setSizeColor

protected void setSizeColor(ColorSwatch sizeColor)

getSizeColor

protected ColorSwatch getSizeColor()

setSymbol1

public void setSymbol1(String symbol1)

getSymbol1

public String getSymbol1()

setSymbol2

public void setSymbol2(String symbol2)

getSymbol2

public String getSymbol2()

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

Overrides:

getAttributeDescriptions in class ItemInstance

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

Overrides:

getAttributeTypes in class ItemInstance

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

Overrides:

getAttributeNames in class ItemInstance

Returns:

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

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

Overrides:

setAttribute in class ItemInstance

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

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

Overrides:

getAttributeValueString in class ItemInstance

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.