Package VASSAL.build.module.gamepieceimage

Class TextBoxItem

java.lang.Object

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.gamepieceimage.Item

VASSAL.build.module.gamepieceimage.TextItem

VASSAL.build.module.gamepieceimage.TextBoxItem

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable

public class TextBoxItem
extends TextItem

Nested Class Summary

Nested classes/interfaces inherited from class VASSAL.build.module.gamepieceimage.TextItem

TextItem.FontStyleConfig, TextItem.NameFormatConfig, TextItem.TextSource

Nested classes/interfaces inherited from class VASSAL.build.module.gamepieceimage.Item

Item.IconConfig, Item.LocationConfig

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
protected int	height
protected static String	HEIGHT
protected boolean	isHTML
static String	TYPE
protected static String	USE_HTML
protected int	width
protected static String	WIDTH

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

AL_BOTTOM, AL_CENTER, AL_LEFT, AL_RIGHT, AL_TOP, BOTTOM, CENTER, changeCmd, changeKey, DEFAULT_FORMAT, FONT, fontStyleName, LABEL, LEFT, lockable, lockCmd, lockKey, PIECE_NAME, RIGHT, SOURCE, SRC_FIXED, SRC_VARIABLE, text, TEXT, textSource, TOP

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

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

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
TextBoxItem()
TextBoxItem(GamePieceLayout l)
TextBoxItem(GamePieceLayout l, String n)

Method Summary

Modifier and Type	Method	Description
static Item	decode(GamePieceLayout l, String s)
void	draw(Graphics g, GamePieceImage defn)	Implemented by subclass to draw itself.
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 buildFile (XML) attributes of this component.
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
String	getDisplayName()
int	getHeight()
Dimension	getSize()
String	getType()
int	getWidth()
void	setAttribute(String key, Object o)	Sets a buildFile (XML) attribute value for this component.

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

decode, drawLabel, isFixed, isOutline

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

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

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, getI18nData, getI18nPrefix, getLocalizedConfigureName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getPropertyNames, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.build.Buildable

build, getBuildElement

Field Details

TYPE

public static final String TYPE

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

USE_HTML

protected static final String USE_HTML

See Also:

Constant Field Values

height

protected int height

width

protected int width

isHTML

protected boolean isHTML

Constructor Details

TextBoxItem

public TextBoxItem()

TextBoxItem

public TextBoxItem(GamePieceLayout l)

TextBoxItem

public TextBoxItem(GamePieceLayout l,
String n)

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 TextItem

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 class: AbstractConfigurable

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

Specified by:

getAttributeTypes in interface AutoConfigurable

Overrides:

getAttributeTypes in class TextItem

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 TextItem

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.

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 TextItem

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

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

Parameters:

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

Returns:

a String representation of the attribute with the given name. When initializing a module, this String value will be passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object).

getWidth

public int getWidth()

getHeight

public int getHeight()

draw

public void draw(Graphics g,
GamePieceImage defn)

Description copied from class: Item

Implemented by subclass to draw itself.

Overrides:

draw in class TextItem

getType

public String getType()

Overrides:

getType in class TextItem

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class TextItem

getSize

public Dimension getSize()

Overrides:

getSize in class TextItem

decode

public static Item decode(GamePieceLayout l,
String s)

encode

public String encode()

Overrides:

encode in class TextItem