Package VASSAL.build.module.gamepieceimage

Class GamePieceImage

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.gamepieceimage.GamePieceImage

All Implemented Interfaces:

Cloneable, AutoConfigurable, Buildable, Configurable, Visualizable, PropertyNameSource, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget, UniqueIdManager.Identifyable

public class GamePieceImage
extends AbstractConfigurable
implements Visualizable, Cloneable, UniqueIdManager.Identifyable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GamePieceImage.BgColorSwatchConfig
static class	GamePieceImage.BorderColorSwatchConfig
static class	GamePieceImage.DefnConfig
static class	GamePieceImage.ImageNameConfig

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
static final String	BORDER_COLOR
protected ColorSwatch	borderColor
protected InstanceConfigurer	defnConfig
protected String	id
protected static final UniqueIdManager	idMgr
protected List<ItemInstance>	instances
protected GamePieceLayout	layout
protected static final String	NAME
protected String	nameInUse
static final String	PART_SIZE
static final String	PART_SYMBOL1
static final String	PART_SYMBOL2
protected static final String	PROPS
protected SourceOp	srcOp
protected String	version	version number.
static final String	VERSION
static final String	VERSION_0
static final String	VERSION_1
protected Image	visImage

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
GamePieceImage()
GamePieceImage(String s)
GamePieceImage(GamePieceImage defn)
GamePieceImage(GamePieceLayout l)

Method Summary

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	Classes extending AbstractImageFinder should override this method in order to add the names of any image files they use to the collection.
void	addTo(Buildable parent)	Adds this component to its parent.
void	build(Element e)	Build this component by getting all XML attributes of the XML element and calling AbstractBuildable.setAttribute(java.lang.String, java.lang.Object) with the String value of the attribute
Object	clone()
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
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
ColorSwatch	getBgColor()
ColorSwatch	getBorderColor()
static String	getConfigureTypeName()
byte[]	getEncodedImage(BufferedImage bufferedImage)
HelpFile	getHelpFile()
String	getId()
ImageItemInstance	getImageInstance(String name)
ItemInstance	getInstance(String name)
List<ItemInstance>	getInstances()
GamePieceLayout	getLayout()
ShapeItemInstance	getShapeInstance(String name)
SymbolItemInstance	getSymbolInstance(String name)
TextBoxItemInstance	getTextBoxInstance(String name)
TextItemInstance	getTextInstance(String name)
String	getVersion()
int	getVisualizerHeight()
Image	getVisualizerImage()
int	getVisualizerWidth()
boolean	isVersion1()
protected void	rebuildInstances()
void	rebuildVisualizerImage()
void	refreshConfig()
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	setId(String id)

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, 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, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, getPropertyNames, setAncestor, validate

Methods inherited from class VASSAL.search.AbstractImageFinder

getAllImageNames, getLocalImageNames

Methods inherited from class java.lang.Object

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

getBuildElement, isMandatory, isMovable, isUnique

Methods inherited from interface VASSAL.tools.UniqueIdManager.Identifyable

getConfigureName

Field Details

NAME

protected static final String NAME

See Also:

• Constant Field Values

PROPS

protected static final String PROPS

See Also:

• Constant Field Values

PART_SIZE

public static final String PART_SIZE

See Also:

• Constant Field Values

PART_SYMBOL1

public static final String PART_SYMBOL1

See Also:

• Constant Field Values

PART_SYMBOL2

public static final String PART_SYMBOL2

See Also:

• Constant Field Values

BG_COLOR

public static final String BG_COLOR

See Also:

• Constant Field Values

BORDER_COLOR

public static final String BORDER_COLOR

See Also:

• Constant Field Values

VERSION

public static final String VERSION

See Also:

• Constant Field Values

VERSION_0

public static final String VERSION_0

See Also:

• Constant Field Values

VERSION_1

public static final String VERSION_1

See Also:

• Constant Field Values

instances

protected List<ItemInstance> instances

defnConfig

protected InstanceConfigurer defnConfig

layout

protected GamePieceLayout layout

bgColor

protected ColorSwatch bgColor

borderColor

protected ColorSwatch borderColor

id

protected String id

idMgr

protected static final UniqueIdManager idMgr

nameInUse

protected String nameInUse

visImage

protected Image visImage

srcOp

protected SourceOp srcOp

version

protected String version

version number. Existing GPI's loaded from a module will be defaulted to version 0

Constructor Details

GamePieceImage

public GamePieceImage()

GamePieceImage

public GamePieceImage(String s)

GamePieceImage

public GamePieceImage(GamePieceLayout l)

GamePieceImage

public GamePieceImage(GamePieceImage defn)

Method Details

build

public void build(Element e)

Description copied from class: AbstractBuildable

Build this component by getting all XML attributes of the XML element and calling AbstractBuildable.setAttribute(java.lang.String, java.lang.Object) with the String value of the attribute

Specified by:

build in interface Buildable

Overrides:

build in class AbstractBuildable

Parameters:

e - the XML element containing the object data

clone

public Object clone()

Overrides:

clone in class Object

getInstances

public List<ItemInstance> getInstances()

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

getBgColor

public ColorSwatch getBgColor()

getBorderColor

public ColorSwatch getBorderColor()

getVersion

public String getVersion()

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.

getAttributeVisibility

public VisibilityCondition getAttributeVisibility(String name)

Description copied from class: AbstractConfigurable

By default, all attributes are visible

Specified by:

getAttributeVisibility in interface AutoConfigurable

Overrides:

getAttributeVisibility in class AbstractConfigurable

Parameters:

name - Name (key) of one of this component's attributes

Returns:

a VisibilityCondition for this attribute, or null if attribute should always be visible.

addLocalImageNames

public void addLocalImageNames(Collection<String> s)

Description copied from class: AbstractImageFinder

Classes extending AbstractImageFinder should override this method in order to add the names of any image files they use to the collection.

Specified by:

addLocalImageNames in interface ImageSearchTarget

Overrides:

addLocalImageNames in class AbstractImageFinder

Parameters:

s - Collection to add image names to

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * this component

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Specified by:

getAllowableConfigureComponents in interface Configurable

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.

Specified by:

addTo in interface Buildable

Parameters:

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

getId

public String getId()

Specified by:

getId in interface UniqueIdManager.Identifyable

setId

public void setId(String id)

Specified by:

setId in interface UniqueIdManager.Identifyable

getConfigureTypeName

public static String getConfigureTypeName()

refreshConfig

public void refreshConfig()

getLayout

public GamePieceLayout getLayout()

getVisualizerHeight

public int getVisualizerHeight()

Specified by:

getVisualizerHeight in interface Visualizable

getVisualizerWidth

public int getVisualizerWidth()

Specified by:

getVisualizerWidth in interface Visualizable

getVisualizerImage

public Image getVisualizerImage()

Specified by:

getVisualizerImage in interface Visualizable

rebuildVisualizerImage

public void rebuildVisualizerImage()

Specified by:

rebuildVisualizerImage in interface Visualizable

getEncodedImage

public byte[] getEncodedImage(BufferedImage bufferedImage)

getInstance

public ItemInstance getInstance(String name)

getTextInstance

public TextItemInstance getTextInstance(String name)

getTextBoxInstance

public TextBoxItemInstance getTextBoxInstance(String name)

getSymbolInstance

public SymbolItemInstance getSymbolInstance(String name)

getShapeInstance

public ShapeItemInstance getShapeInstance(String name)

getImageInstance

public ImageItemInstance getImageInstance(String name)

rebuildInstances

protected void rebuildInstances()

isVersion1

public boolean isVersion1()