Class TextItem

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.gamepieceimage.Item

VASSAL.build.module.gamepieceimage.TextItem

All Implemented Interfaces:

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

Direct Known Subclasses:

TextBoxItem

public class TextItem
extends Item

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextItem.FontStyleConfig
static class	TextItem.NameFormatConfig
static class	TextItem.TextSource

Nested classes/interfaces inherited from class Item

Item.IconConfig, Item.LocationConfig

Modifier and Type	Class	Description
static class	Item.IconConfig
static class	Item.LocationConfig

Nested classes/interfaces inherited from interface AutoConfigurable

AutoConfigurable.Util

Modifier and Type	Interface	Description
static class	AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static final int	AL_BOTTOM
static final int	AL_CENTER
static final int	AL_LEFT
static final int	AL_RIGHT
static final int	AL_TOP
protected static final String	BOTTOM
protected static final String	CENTER
protected String	changeCmd
protected KeyStroke	changeKey
protected static final String	DEFAULT_FORMAT
protected static final String	FONT
protected String	fontStyleName
protected static final String	LABEL
protected static final String	LEFT
protected boolean	lockable
protected String	lockCmd
protected KeyStroke	lockKey
protected static final String	PIECE_NAME
protected static final String	RIGHT
protected static final String	SOURCE
static final String	SRC_FIXED
static final String	SRC_VARIABLE
protected String	text
protected static final String	TEXT
protected String	textSource
protected static final String	TOP
static final String	TYPE

Fields inherited from class Item

advanced, ADVANCED, antialias, ANTIALIAS, layout, LOCATION, NAME, rotation, ROTATION, X_OFFSET, xoffset, Y_OFFSET, yoffset

Modifier and Type	Field	Description
protected boolean	advanced
protected static final String	ADVANCED
protected boolean	antialias
protected static final String	ANTIALIAS
protected GamePieceLayout	layout
protected static final String	LOCATION
protected static final String	NAME
protected int	rotation
protected static final String	ROTATION
protected static final String	X_OFFSET
protected int	xoffset
protected static final String	Y_OFFSET
protected int	yoffset

Fields inherited from class AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Modifier and Type	Field	Description
protected PropertyChangeSupport	changeSupport
protected Configurer	config
protected String	localizedName
protected ComponentI18nData	myI18nData
protected String	name

Fields inherited from class AbstractBuildable

buildComponents, validator

Modifier and Type	Field	Description
protected List<Buildable>	buildComponents
protected ValidityChecker	validator

Fields inherited from interface Configurable

NAME_PROPERTY

Modifier and Type	Field	Description
static final String	NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
TextItem()
TextItem(GamePieceLayout l)
TextItem(GamePieceLayout l, String nam)

Method Summary

Modifier and Type	Method	Description
static Item	decode(GamePieceLayout l, String s)
static void	decode(TextItem item, String s)
void	draw(Graphics g, GamePieceImage defn)	Implemented by subclass to draw itself.
static void	drawLabel(Graphics g, String text, int x, int y, Font f, int hAlign, int vAlign, Color fgColor, Color bgColor, Color borderColor, boolean outline, Color outlineColor)
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(Document) method to write the attributes into an XML element
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
String	getDisplayName()
Dimension	getSize()
String	getType()
boolean	isFixed()
boolean	isOutline()
void	setAttribute(String key, Object o)	Sets a buildFile (XML) attribute value for this component.

Methods inherited from class Item

addTo, getAllowableConfigureComponents, getDisplayLocation, getHelpFile, getLayout, getLocation, getRotation, getXoffset, getYoffset, isAntialias, removeFrom

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Adds this component to its parent.
Class<?>[]	getAllowableConfigureComponents()
String	getDisplayLocation()
HelpFile	getHelpFile()
protected GamePieceLayout	getLayout()
String	getLocation()
int	getRotation()
int	getXoffset()
int	getYoffset()
boolean	isAntialias()
void	removeFrom(Buildable parent)	Remove this component from its parent

Methods inherited from class AbstractConfigurable

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

Modifier and Type	Method	Description
void	add(Buildable b)	Set the owning translatable of this component
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener.
Configurable[]	getConfigureComponents()
String	getConfigureName()	ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
List<String>	getExpressionList()	SearchTarget
List<String>	getFormattedStringList()	SearchTarget
ComponentI18nData	getI18nData()
protected String	getI18nPrefix()
String	getLocalizedConfigureName()
List<String>	getMenuTextList()	SearchTarget
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
List<String>	getPropertyList()	SearchTarget
String	getTypeName()	Returns the name of the configurable type for display purposes.
void	remove(Buildable b)	Remove a Buildable object from this object
void	removePropertyChangeListener(PropertyChangeListener l)
protected void	setAllAttributesUntranslatable()	Sets all attributes untranslatable.
protected void	setAttributeTranslatable(String attr, boolean b)	Over-ride the default attribute translatability.
void	setConfigureName(String s)	Sets the name and fires a PropertyChangeEvent

Methods inherited from class AbstractBuildable

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

Modifier and Type	Method	Description
void	addImageNamesRecursively(Collection<String> s)	Adds all images used by this component AND any subcomponents to the collection
void	build(Element e)	Build this component by getting all XML attributes of the XML element and calling AbstractBuildable.setAttribute(String, Object) with the String value of the attribute
String	buildString()
<T> List<T>	getAllDescendantComponentsOf(Class<T> target)	Recursively descend the build tree and return a List of all components that are instances of the given class
Buildable	getAncestor()
List<Buildable>	getBuildables()
Enumeration<Buildable>	getBuildComponents()	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getBuildables() instead.
Element	getBuildElement(Document doc)
<T> Enumeration<T>	getComponents(Class<T> target)	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getComponentsOf(Class) instead.
<T> List<T>	getComponentsOf(Class<T> target)
Buildable	getNonFolderAncestor()
List<String>	getPropertyNames()	Override this method to provide a list of properties to be exposed for use by expressions in the module.
void	setAncestor(Buildable ancestor)
void	validate(Buildable target, ValidationReport report)

Methods inherited from class AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

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.
SortedSet<String>	getAllImageNames()
SortedSet<String>	getLocalImageNames()

Methods inherited from class Object

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

Methods inherited from interface Auditable

getComponentName, getComponentTypeName

Modifier and Type	Method	Description
default String	getComponentName()	Return the name of the trait or Component an Auditable is
default String	getComponentTypeName()	Return a description of the Type of trait or Component an Auditable is

Methods inherited from interface Buildable

isMandatory, isMovable, isUnique

Modifier and Type	Method	Description
default boolean	isMandatory()	Is this component a reqired component within its parent?
default boolean	isMovable()	Is this component allowed to be moved around the Configure Tree?
default boolean	isUnique()	Does this component need to be unique within it's parent?

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

FONT

protected static final String FONT

See Also:

• Constant Field Values

SOURCE

protected static final String SOURCE

See Also:

• Constant Field Values

TEXT

protected static final String TEXT

See Also:

• Constant Field Values

LEFT

protected static final String LEFT

See Also:

• Constant Field Values

CENTER

protected static final String CENTER

See Also:

• Constant Field Values

RIGHT

protected static final String RIGHT

See Also:

• Constant Field Values

TOP

protected static final String TOP

See Also:

• Constant Field Values

BOTTOM

protected static final String BOTTOM

See Also:

• Constant Field Values

SRC_VARIABLE

public static final String SRC_VARIABLE

See Also:

• Constant Field Values

SRC_FIXED

public static final String SRC_FIXED

See Also:

• Constant Field Values

PIECE_NAME

protected static final String PIECE_NAME

See Also:

• Constant Field Values

LABEL

protected static final String LABEL

See Also:

• Constant Field Values

DEFAULT_FORMAT

protected static final String DEFAULT_FORMAT

See Also:

• Constant Field Values

AL_CENTER

public static final int AL_CENTER

See Also:

• Constant Field Values

AL_RIGHT

public static final int AL_RIGHT

See Also:

• Constant Field Values

AL_LEFT

public static final int AL_LEFT

See Also:

• Constant Field Values

AL_TOP

public static final int AL_TOP

See Also:

• Constant Field Values

AL_BOTTOM

public static final int AL_BOTTOM

See Also:

• Constant Field Values

fontStyleName

protected String fontStyleName

textSource

protected String textSource

text

protected String text

changeCmd

protected String changeCmd

changeKey

protected KeyStroke changeKey

lockable

protected boolean lockable

lockCmd

protected String lockCmd

lockKey

protected KeyStroke lockKey

Constructor Details

TextItem

public TextItem()

TextItem

public TextItem(GamePieceLayout l)

TextItem

public TextItem(GamePieceLayout l,
 String nam)

Method Details

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 Item

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 Item

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 Item

Returns:

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

setAttribute

public void setAttribute(String key,
 Object o)

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

Parameters:

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

o - If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(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(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 Item

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(String, 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 Item

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.

draw

public void draw(Graphics g,
 GamePieceImage defn)

Description copied from class: Item

Implemented by subclass to draw itself.

Specified by:

draw in class Item

getType

public String getType()

Specified by:

getType in class Item

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class Item

getSize

public Dimension getSize()

Specified by:

getSize in class Item

decode

public static Item decode(GamePieceLayout l,
 String s)

decode

public static void decode(TextItem item,
 String s)

encode

public String encode()

Overrides:

encode in class Item

isOutline

public boolean isOutline()

isFixed

public boolean isFixed()

drawLabel

public static void drawLabel(Graphics g,
 String text,
 int x,
 int y,
 Font f,
 int hAlign,
 int vAlign,
 Color fgColor,
 Color bgColor,
 Color borderColor,
 boolean outline,
 Color outlineColor)