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()
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 theBuildable.getBuildElement(org.w3c.dom.Document)
method to write the attributes into an XML elementVisibilityCondition
getAttributeVisibility(String name)
By default, all attributes are visibleDimension
getSize()
String
getType()
boolean
isFixed()
protected void
loadImage(GamePieceImage defn)
void
setAttribute(String key, Object o)
Sets a buildFile (XML) 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
- See Also:
- Constant Field Values
-
SRC_VARIABLE
- See Also:
- Constant Field Values
-
SRC_FIXED
- See Also:
- Constant Field Values
-
IMAGE
- See Also:
- Constant Field Values
-
SOURCE
- See Also:
- Constant Field Values
-
imageSource
-
imageName
-
image
Deprecated, for removal: This API element is subject to removal in a future version. -
srcOp
-
imageBounds
-
-
Constructor Details
-
ImageItem
public ImageItem() -
ImageItem
-
ImageItem
-
-
Method Details
-
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 interfaceAutoConfigurable
- Overrides:
getAttributeDescriptions
in classItem
- 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
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 ofAutoConfigurer
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 inAbstractBuildable.getAttributeNames()
- Specified by:
getAttributeTypes
in interfaceAutoConfigurable
- Overrides:
getAttributeTypes
in classItem
-
getAttributeNames
Description copied from class:AbstractBuildable
Lists all the buildFile (XML) attribute names for this component. If this component is ALSO anAbstractConfigurable
, then this list of attributes determines the appropriate attribute order forAbstractConfigurable.getAttributeDescriptions()
andAbstractConfigurable.getAttributeTypes()
.- Specified by:
getAttributeNames
in interfaceAutoConfigurable
- Overrides:
getAttributeNames
in classItem
- Returns:
- a list of all buildFile (XML) attribute names for this component
-
setAttribute
Description copied from class:AbstractBuildable
Sets a buildFile (XML) attribute value for this component. Thekey
parameter will be one of those listed inAbstractBuildable.getAttributeNames()
. If thevalue
parameter is a String, it will be the value returned byAbstractBuildable.getAttributeValueString(java.lang.String)
for the samekey
. If the implementing class extendsAbstractConfigurable
, thenvalue
will be an instance of the corresponding Class listed inAbstractConfigurable.getAttributeTypes()
- Specified by:
setAttribute
in interfaceAutoConfigurable
- Specified by:
setAttribute
in interfaceTranslatable
- Overrides:
setAttribute
in classItem
- Parameters:
key
- the name of the attribute. Will be one of those listed inAbstractBuildable.getAttributeNames()
o
- If thevalue
parameter is a String, it will be the value returned byAbstractBuildable.getAttributeValueString(java.lang.String)
for the samekey
. If the implementing class extendsAbstractConfigurable
, thenvalue
can also be an instance of the corresponding Class listed inAbstractConfigurable.getAttributeTypes()
-
getAttributeValueString
Description copied from interface:AutoConfigurable
Called by theBuildable.getBuildElement(org.w3c.dom.Document)
method to write the attributes into an XML element- Specified by:
getAttributeValueString
in interfaceAutoConfigurable
- Specified by:
getAttributeValueString
in interfaceTranslatable
- Overrides:
getAttributeValueString
in classItem
- Parameters:
key
- the name of the attribute. Will be one of those listed inAbstractBuildable.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)
.
-
getAttributeVisibility
Description copied from class:AbstractConfigurable
By default, all attributes are visible- Specified by:
getAttributeVisibility
in interfaceAutoConfigurable
- Overrides:
getAttributeVisibility
in classItem
- 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
Description copied from class:Item
Implemented by subclass to draw itself. -
getType
-
getSize
-
isFixed
public boolean isFixed() -
loadImage
-
decode
-
encode
-