Class GamePieceLayout

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.gamepieceimage.GamePieceLayout

All Implemented Interfaces:

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

public class GamePieceLayout
extends AbstractConfigurable
implements Visualizable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GamePieceLayout.BorderConfig
static class	GamePieceLayout.LayoutConfig

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
protected String	border
protected static final String	BORDER
protected static final String	BORDER_3D
protected static final String	BORDER_FANCY
protected static final String	BORDER_NONE
protected static final String	BORDER_PLAIN
protected static final String	CENTER
protected static final Map<String,String>	compass
protected static final String	E
protected int	height
protected static final String	HEIGHT
protected GamePieceImage	imageDefn
protected List<Item>	items
protected static final String	ITEMS
static final String[]	LOCATION_I18N_KEYS
static final String[]	LOCATIONS
protected static final String	N
protected static final String	NAME
protected static final String	NE
protected static final String	NW
protected static final int	POS_B
protected static final int	POS_C
protected static final int	POS_L
protected static final int	POS_R
protected static final int	POS_T
protected static final String	S
protected static final String	SE
protected static final String	SW
protected Image	visImage
protected static final String	W
protected int	width
protected static final String	WIDTH
static final int[]	X_POS
static final int[]	Y_POS

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

Method Summary

Modifier and Type	Method	Description
void	addItem(Item i)
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.
Image	buildImage(GamePieceImage defn)
protected void	decodeItemList(String string)
protected String	encodeItemList()
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
String	getBorder()
static String	getCompassPoint(String location)
static String	getConfigureTypeName()
static String	getDisplayLocation(String location)
GamePieceImage	getGenericDefn(String defnName)
HelpFile	getHelpFile()
protected Item	getItem(int n)
protected Item	getItem(String name)
protected int	getItemCount()
List<Item>	getItems()
int	getLayoutHeight()
int	getLayoutWidth()
Point	getPosition(Item item)
int	getVisualizerHeight()
Image	getVisualizerImage()
int	getVisualizerWidth()
protected void	invalidate()
boolean	isColoredBorder()
void	moveItem(int from, int to)
void	rebuildVisualizerImage()
void	refresh()
void	removeFrom(Buildable parent)	Remove this component from its parent
protected void	removeItem(int n)
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
void	setHeight(int height)
void	setImageDefn(GamePieceImage d)
void	setWidth(int width)

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

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

NAME

protected static final String NAME

See Also:

• Constant Field Values

WIDTH

protected static final String WIDTH

See Also:

• Constant Field Values

HEIGHT

protected static final String HEIGHT

See Also:

• Constant Field Values

BORDER

protected static final String BORDER

See Also:

• Constant Field Values

ITEMS

protected static final String ITEMS

See Also:

• Constant Field Values

N

protected static final String N

See Also:

• Constant Field Values

S

protected static final String S

See Also:

• Constant Field Values

E

protected static final String E

See Also:

• Constant Field Values

W

protected static final String W

See Also:

• Constant Field Values

NE

protected static final String NE

See Also:

• Constant Field Values

NW

protected static final String NW

See Also:

• Constant Field Values

SE

protected static final String SE

See Also:

• Constant Field Values

SW

protected static final String SW

See Also:

• Constant Field Values

CENTER

protected static final String CENTER

See Also:

• Constant Field Values

POS_L

protected static final int POS_L

See Also:

• Constant Field Values

POS_R

protected static final int POS_R

See Also:

• Constant Field Values

POS_T

protected static final int POS_T

See Also:

• Constant Field Values

POS_B

protected static final int POS_B

See Also:

• Constant Field Values

POS_C

protected static final int POS_C

See Also:

• Constant Field Values

BORDER_PLAIN

protected static final String BORDER_PLAIN

See Also:

• Constant Field Values

BORDER_FANCY

protected static final String BORDER_FANCY

See Also:

• Constant Field Values

BORDER_3D

protected static final String BORDER_3D

See Also:

• Constant Field Values

BORDER_NONE

protected static final String BORDER_NONE

See Also:

• Constant Field Values

LOCATIONS

public static final String[] LOCATIONS

LOCATION_I18N_KEYS

public static final String[] LOCATION_I18N_KEYS

X_POS

public static final int[] X_POS

Y_POS

public static final int[] Y_POS

compass

protected static final Map<String,String> compass

width

protected int width

height

protected int height

border

protected String border

imageDefn

protected GamePieceImage imageDefn

visImage

protected Image visImage

items

protected List<Item> items

Constructor Details

GamePieceLayout

public GamePieceLayout()

Method Details

getDisplayLocation

public static String getDisplayLocation(String location)

getCompassPoint

public static String getCompassPoint(String location)

getPosition

public Point getPosition(Item item)

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

isColoredBorder

public boolean isColoredBorder()

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

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.

getConfigureTypeName

public static String getConfigureTypeName()

setWidth

public void setWidth(int width)

getLayoutWidth

public int getLayoutWidth()

setHeight

public void setHeight(int height)

getLayoutHeight

public int getLayoutHeight()

getBorder

public String getBorder()

getItems

public List<Item> getItems()

getItemCount

protected int getItemCount()

getItem

protected Item getItem(int n)

getItem

protected Item getItem(String name)

removeItem

protected void removeItem(int n)

addItem

public void addItem(Item i)

moveItem

public void moveItem(int from,
 int to)

getVisualizerImage

public Image getVisualizerImage()

Specified by:

getVisualizerImage in interface Visualizable

buildImage

public Image buildImage(GamePieceImage defn)

refresh

public void refresh()

invalidate

protected void invalidate()

decodeItemList

protected void decodeItemList(String string)

encodeItemList

protected String encodeItemList()

getVisualizerHeight

public int getVisualizerHeight()

Specified by:

getVisualizerHeight in interface Visualizable

getVisualizerWidth

public int getVisualizerWidth()

Specified by:

getVisualizerWidth in interface Visualizable

rebuildVisualizerImage

public void rebuildVisualizerImage()

Specified by:

rebuildVisualizerImage in interface Visualizable

setImageDefn

public void setImageDefn(GamePieceImage d)

getGenericDefn

public GamePieceImage getGenericDefn(String defnName)

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