VASSAL.build.module.gamepieceimage.GamePieceImage

All Implemented Interfaces:: Cloneable, AutoConfigurable, Buildable, Configurable, Visualizable, PropertyNameSource, ValidityChecker, Translatable, UniqueIdManager.Identifyable

public class GamePieceImage
extends AbstractConfigurable
implements Visualizable, Cloneable, UniqueIdManager.Identifyable

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`GamePieceImage.BgColorSwatchConfig`
`static class`	`GamePieceImage.BorderColorSwatchConfig`
`static class`	`GamePieceImage.DefnConfig`

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

AutoConfigurable.Util

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`BG_COLOR`
`protected ColorSwatch`	`bgColor`
`static String`	`BORDER_COLOR`
`protected ColorSwatch`	`borderColor`
`protected InstanceConfigurer`	`defnConfig`
`protected String`	`id`
`protected static UniqueIdManager`	`idMgr`
`protected List<ItemInstance>`	`instances`
`protected GamePieceLayout`	`layout`
`protected static String`	`NAME`
`protected String`	`nameInUse`
`static String`	`PART_SIZE`
`static String`	`PART_SYMBOL1`
`static String`	`PART_SYMBOL2`
`protected static String`	`PROPS`
`protected SourceOp`	`srcOp`
`protected Image`	`visImage`

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

GamePieceImage()

GamePieceImage(String s)

GamePieceImage(GamePieceImage defn)

GamePieceImage(GamePieceLayout l)

Method Summary

Modifier and Type	Method	Description
`void`	`addTo(Buildable parent)`	Adds this component to its parent.
`Object`	`clone()`
`Class<?>[]`	`getAllowableConfigureComponents()`	Return a list of valid sub-component Classes.
`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
`ColorSwatch`	`getBgColor()`
`ColorSwatch`	`getBorderColor()`
`static String`	`getConfigureTypeName()`
`byte[]`	`getEncodedImage(BufferedImage bufferedImage)`
`HelpFile`	`getHelpFile()`
`String`	`getId()`
`ImageItemInstance`	`getImageInstance(String name)`
`ItemInstance`	`getInstance(String name)`
`List<ItemInstance>`	`getInstances()`
`GamePieceLayout`	`getLayout()`
`ShapeItemInstance`	`getShapeInstance(String name)`
`SymbolItemInstance`	`getSymbolInstance(String name)`
`TextBoxItemInstance`	`getTextBoxInstance(String name)`
`TextItemInstance`	`getTextInstance(String name)`
`int`	`getVisualizerHeight()`
`Image`	`getVisualizerImage()`
`int`	`getVisualizerWidth()`
`protected void`	`rebuildInstances()`
`void`	`rebuildVisualizerImage()`
`void`	`refreshConfig()`
`void`	`removeFrom(Buildable parent)`	Remove this component from its parent
`void`	`setAttribute(String key, Object value)`	Sets an attribute value for this component.
`void`	`setId(String id)`

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, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponentsOf, getPropertyNames, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.build.Buildable

build, getBuildElement

Methods inherited from interface VASSAL.tools.UniqueIdManager.Identifyable

getConfigureName

Field Details
- NAME
  
  protected static final String NAME
  
  See Also:
  
  Constant Field Values
- PROPS
  
  protected static final String PROPS
  
  See Also:
  
  Constant Field Values
- PART_SIZE
  
  public static final String PART_SIZE
  
  See Also:
  
  Constant Field Values
- PART_SYMBOL1
  
  public static final String PART_SYMBOL1
  
  See Also:
  
  Constant Field Values
- PART_SYMBOL2
  
  public static final String PART_SYMBOL2
  
  See Also:
  
  Constant Field Values
- BG_COLOR
  
  public static final String BG_COLOR
  
  See Also:
  
  Constant Field Values
- BORDER_COLOR
  
  public static final String BORDER_COLOR
  
  See Also:
  
  Constant Field Values
- instances
  
  protected List<ItemInstance> instances
- defnConfig
  
  protected InstanceConfigurer defnConfig
- layout
  
  protected GamePieceLayout layout
- bgColor
  
  protected ColorSwatch bgColor
- borderColor
  
  protected ColorSwatch borderColor
- id
  
  protected String id
- idMgr
  
  protected static UniqueIdManager idMgr
- nameInUse
  
  protected String nameInUse
- visImage
  
  protected Image visImage
- srcOp
  
  protected SourceOp srcOp
Constructor Details
- GamePieceImage
  
  public GamePieceImage()
- GamePieceImage
  
  public GamePieceImage(String s)
- GamePieceImage
  
  public GamePieceImage(GamePieceLayout l)
- GamePieceImage
  
  public GamePieceImage(GamePieceImage defn)
Method Details
- clone
  
  public Object clone()
  
  Overrides:
  
  clone in class Object
- getInstances
  
  public List<ItemInstance> getInstances()
- 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
  
  Specified by:
  
  getAttributeDescriptions in class AbstractConfigurable
- 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
  
  Specified by:
  
  getAttributeTypes in class AbstractConfigurable
- getAttributeNames
  
  public String[] getAttributeNames()
  
  Specified by:
  
  getAttributeNames in interface AutoConfigurable
  
  Specified by:
  
  getAttributeNames in class AbstractBuildable
  
  Returns:
  
  a list of all attribute names for this component
- getBgColor
  
  public ColorSwatch getBgColor()
- getBorderColor
  
  public ColorSwatch getBorderColor()
- 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
  
  Specified by:
  
  setAttribute in class AbstractBuildable
  
  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
  
  Specified by:
  
  getAttributeValueString in class AbstractBuildable
  
  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 AbstractConfigurable
  
  Returns:
  
  null if the attribute controls should always be visible;
- removeFrom
  
  public void removeFrom(Buildable parent)
  
  Description copied from interface: Configurable
  
  Remove this component from its parent
  
  Specified by:
  
  removeFrom in interface Configurable
- getHelpFile
  
  public HelpFile getHelpFile()
  
  Specified by:
  
  getHelpFile in interface Configurable
  
  Returns:
  
  a HelpFilte describing how to use and configure this component
- getAllowableConfigureComponents
  
  public Class<?>[] getAllowableConfigureComponents()
  
  Description copied from interface: Configurable
  
  Return a list of valid sub-component Classes. If a Class appears in this list, then instances of that class may be added to this component from the Configuration Window.
  
  Specified by:
  
  getAllowableConfigureComponents in interface Configurable
- addTo
  
  public void addTo(Buildable parent)
  
  Description copied from interface: Buildable
  
  Adds this component to its parent. In order to make Buildable objects extensible, the child is reponsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.
  
  Specified by:
  
  addTo in interface Buildable
- getId
  
  public String getId()
  
  Specified by:
  
  getId in interface UniqueIdManager.Identifyable
- setId
  
  public void setId(String id)
  
  Specified by:
  
  setId in interface UniqueIdManager.Identifyable
- getConfigureTypeName
  
  public static String getConfigureTypeName()
- refreshConfig
  
  public void refreshConfig()
- getLayout
  
  public GamePieceLayout getLayout()
- getVisualizerHeight
  
  public int getVisualizerHeight()
  
  Specified by:
  
  getVisualizerHeight in interface Visualizable
- getVisualizerWidth
  
  public int getVisualizerWidth()
  
  Specified by:
  
  getVisualizerWidth in interface Visualizable
- getVisualizerImage
  
  public Image getVisualizerImage()
  
  Specified by:
  
  getVisualizerImage in interface Visualizable
- rebuildVisualizerImage
  
  public void rebuildVisualizerImage()
  
  Specified by:
  
  rebuildVisualizerImage in interface Visualizable
- getEncodedImage
  
  public byte[] getEncodedImage(BufferedImage bufferedImage)
- getInstance
  
  public ItemInstance getInstance(String name)
- getTextInstance
  
  public TextItemInstance getTextInstance(String name)
- getTextBoxInstance
  
  public TextBoxItemInstance getTextBoxInstance(String name)
- getSymbolInstance
  
  public SymbolItemInstance getSymbolInstance(String name)
- getShapeInstance
  
  public ShapeItemInstance getShapeInstance(String name)
- getImageInstance
  
  public ImageItemInstance getImageInstance(String name)
- rebuildInstances
  
  protected void rebuildInstances()

Constructor	Description
`GamePieceImage()`
`GamePieceImage(String s)`
`GamePieceImage(GamePieceImage defn)`
`GamePieceImage(GamePieceLayout l)`

Class GamePieceImage