Package VASSAL.build.module.gamepieceimage

Class ImageItem

java.lang.Object

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.gamepieceimage.Item

VASSAL.build.module.gamepieceimage.ImageItem

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable

public class ImageItem
extends Item

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ImageItem.BaseOp
static class	ImageItem.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 Image	image	Deprecated, for removal: This API element is subject to removal in a future version.
protected static String	IMAGE
protected Rectangle	imageBounds
protected String	imageName
protected String	imageSource
static String	SOURCE
static String	SRC_FIXED
static String	SRC_VARIABLE
protected ImageOp	srcOp
static String	TYPE

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
ImageItem()
ImageItem(GamePieceLayout l)
ImageItem(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()
Class<?>[]	getAttributeTypes()	Return the Class for the attributes of this object.
String	getAttributeValueString(String key)	Return a String representation of the attribute with the given name.
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
Dimension	getSize()
String	getType()
boolean	isFixed()
protected void	loadImage(GamePieceImage defn)
void	setAttribute(String key, Object o)	Sets an attribute value for this component.

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

addTo, getAllowableConfigureComponents, getDisplayName, 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

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

IMAGE

protected static final String IMAGE

See Also:

Constant Field Values

SOURCE

public static final String SOURCE

See Also:

Constant Field Values

imageSource

protected String imageSource

imageName

protected String imageName

image

@Deprecated(since="2020-08-06", forRemoval=true) protected Image image

Deprecated, for removal: This API element is subject to removal in a future version.

srcOp

protected ImageOp srcOp

imageBounds

protected Rectangle imageBounds

Constructor Details

ImageItem

public ImageItem()

ImageItem

public ImageItem(GamePieceLayout l)

ImageItem

public ImageItem(GamePieceLayout l, String n)

Method Details

getAttributeDescriptions

public String[] getAttributeDescriptions()

Description copied from class: AbstractConfigurable

Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()

Specified by:

getAttributeDescriptions in interface AutoConfigurable

Overrides:

getAttributeDescriptions in class Item

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from class: AbstractConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, Color, and KeyStroke 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 Item

getAttributeNames

public String[] getAttributeNames()

Specified by:

getAttributeNames in interface AutoConfigurable

Overrides:

getAttributeNames in class Item

Returns:

a list of all attribute names for this component

setAttribute

public void setAttribute(String key, Object o)

Description copied from class: AbstractBuildable

Sets an 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 Item

Parameters:

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

getAttributeValueString

public String getAttributeValueString(String key)

Description copied from class: AbstractBuildable

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

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

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

Returns:

null if the attribute controls 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

getSize

public Dimension getSize()

Specified by:

getSize in class Item

isFixed

public boolean isFixed()

loadImage

protected void loadImage(GamePieceImage defn)

decode

public static Item decode(GamePieceLayout l, String s)

encode

public String encode()

Overrides:

encode in class Item