Package VASSAL.build.module.gamepieceimage

Class ItemInstance

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.gamepieceimage.ItemInstance

All Implemented Interfaces:

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

Direct Known Subclasses:

ImageItemInstance, ShapeItemInstance, SymbolItemInstance, TextBoxItemInstance, TextItemInstance

public abstract class ItemInstance
extends AbstractConfigurable

Individual override parameters for an instance of an Item. The XXXItemInstance classes (TextItemInstance,ImageItemInstance, etc.) draw themselves optionally using values for color, text value, etc., from the corresponding XXXItem classes (TextItem,ImageItem, etc.) can make use of when drawing themselves

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	BG_COLOR
protected ColorSwatch	bgColor
protected GamePieceImage	defn
static final String	FG_COLOR
protected ColorSwatch	fgColor
protected Item	item
protected String	location
protected InstanceConfigurer	myConfig
protected String	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
ItemInstance()
ItemInstance(String nam, String typ, String loc)
ItemInstance(GamePieceImage defn)

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Adds this component to its parent.
abstract String	encode()
String	formatName(String name)
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
ColorSwatch	getBgColor()
String	getDisplayLocation()
ColorSwatch	getFgColor()
HelpFile	getHelpFile()
Item	getItem()
String	getLocation()
String	getName()
String	getSuffix()
String	getType()
static ItemInstance	newDefaultInstance(String name, String type, String location)
void	removeFrom(Buildable parent)	Remove this component from its parent
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
void	setBgColor(ColorSwatch bgColor)
void	setConfig(InstanceConfigurer i)
void	setFgColor(ColorSwatch fgColor)
protected void	setItem()
void	setLocation(String location)
void	setName(String name)
void	setType(String type)

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

FG_COLOR

public static final String FG_COLOR

See Also:

• Constant Field Values

BG_COLOR

public static final String BG_COLOR

See Also:

• Constant Field Values

type

protected String type

location

protected String location

bgColor

protected ColorSwatch bgColor

fgColor

protected ColorSwatch fgColor

defn

protected GamePieceImage defn

item

protected Item item

myConfig

protected InstanceConfigurer myConfig

Constructor Details

ItemInstance

public ItemInstance(String nam,
 String typ,
 String loc)

ItemInstance

public ItemInstance()

ItemInstance

public ItemInstance(GamePieceImage defn)

Method Details

setItem

protected void setItem()

getItem

public Item getItem()

setConfig

public void setConfig(InstanceConfigurer i)

encode

public abstract String encode()

newDefaultInstance

public static ItemInstance newDefaultInstance(String name,
 String type,
 String location)

setName

public void setName(String name)

getName

public String getName()

setType

public void setType(String type)

getType

public String getType()

setLocation

public void setLocation(String location)

getLocation

public String getLocation()

getDisplayLocation

public String getDisplayLocation()

setBgColor

public void setBgColor(ColorSwatch bgColor)

getBgColor

public ColorSwatch getBgColor()

setFgColor

public void setFgColor(ColorSwatch fgColor)

getFgColor

public ColorSwatch getFgColor()

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

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

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.

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

getHelpFile

public HelpFile getHelpFile()

Returns:

a HelpFile describing how to use and configure * this component

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.

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.

getSuffix

public String getSuffix()

formatName

public String formatName(String name)