VASSAL.build.module.gamepieceimage.SymbolItemInstance

All Implemented Interfaces:: AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable

public class SymbolItemInstance
extends ItemInstance

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`SymbolItemInstance.BgColorSwatchConfig`
`static class`	`SymbolItemInstance.FgColorSwatchConfig`
`static class`	`SymbolItemInstance.SizeColorSwatchConfig`
`static class`	`SymbolItemInstance.SizeConfig`
`static class`	`SymbolItemInstance.Symbol1Config`
`static class`	`SymbolItemInstance.Symbol2Config`

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

AutoConfigurable.Util

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`size`
`static String`	`SIZE`
`static String`	`SIZE_COLOR`
`protected String`	`symbol1`
`static String`	`SYMBOL1`
`protected String`	`symbol2`
`static String`	`SYMBOL2`

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

BG_COLOR, bgColor, defn, FG_COLOR, fgColor, item, location, myConfig, type

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
`SymbolItemInstance()`
`SymbolItemInstance(String nam, String typ, String loc, String sz, String s1, String s2)`
`SymbolItemInstance(String code, GamePieceImage defn)`

Method Summary

Modifier and Type	Method	Description
`void`	`decode(String code)`
`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.
`String`	`getSize()`
`protected ColorSwatch`	`getSizeColor()`
`String`	`getSymbol1()`
`String`	`getSymbol2()`
`void`	`setAttribute(String key, Object value)`	Sets an attribute value for this component.
`void`	`setSize(String size)`
`protected void`	`setSizeColor(ColorSwatch sizeColor)`
`void`	`setSymbol1(String symbol1)`
`void`	`setSymbol2(String symbol2)`

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

addTo, formatName, getAllowableConfigureComponents, getBgColor, getFgColor, getHelpFile, getItem, getLocation, getName, getSuffix, getType, newDefaultInstance, removeFrom, setBgColor, setConfig, setFgColor, setItem, setLocation, setName, setType

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getAttributeVisibility, 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
- SIZE
  
  public static final String SIZE
  
  See Also:
  
  Constant Field Values
- SIZE_COLOR
  
  public static final String SIZE_COLOR
  
  See Also:
  
  Constant Field Values
- SYMBOL1
  
  public static final String SYMBOL1
  
  See Also:
  
  Constant Field Values
- SYMBOL2
  
  public static final String SYMBOL2
  
  See Also:
  
  Constant Field Values
- size
  
  protected String size
- symbol1
  
  protected String symbol1
- symbol2
  
  protected String symbol2
Constructor Details
- SymbolItemInstance
  
  public SymbolItemInstance()
- SymbolItemInstance
  
  public SymbolItemInstance(String nam, String typ, String loc, String sz, String s1, String s2)
- SymbolItemInstance
  
  public SymbolItemInstance(String code, GamePieceImage defn)
Method Details
- encode
  
  public String encode()
  
  Specified by:
  
  encode in class ItemInstance
- decode
  
  public void decode(String code)
- setSize
  
  public void setSize(String size)
- getSize
  
  public String getSize()
- setSizeColor
  
  protected void setSizeColor(ColorSwatch sizeColor)
- getSizeColor
  
  protected ColorSwatch getSizeColor()
- setSymbol1
  
  public void setSymbol1(String symbol1)
- getSymbol1
  
  public String getSymbol1()
- setSymbol2
  
  public void setSymbol2(String symbol2)
- getSymbol2
  
  public String getSymbol2()
- 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 ItemInstance
- 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 ItemInstance
- getAttributeNames
  
  public String[] getAttributeNames()
  
  Specified by:
  
  getAttributeNames in interface AutoConfigurable
  
  Overrides:
  
  getAttributeNames in class ItemInstance
  
  Returns:
  
  a list of all attribute names for this component
- setAttribute
  
  public void setAttribute(String key, Object value)
  
  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 ItemInstance
  
  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 ItemInstance
  
  Parameters:
  
  key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

Class SymbolItemInstance