VASSAL.counters.Embellishment0

All Implemented Interfaces:: PropertyNameSource, PropertySource, EditablePiece, GamePiece, PropertyExporter, StateMergeable, TranslatablePiece, PersistentPropertyContainer

public class Embellishment0
extends Decorator
implements TranslatablePiece

Embellishment has been extensively re-written for Vassal 3.2 changing both the behavior and the visual look of the configurer. A version number has been added to distinguish between the two versions. Note, there is also a much older Embellishment trait with a type of emb When editing a module, the old versions will be automatically converted to the new version. One feature (multiple keystrokes for a command) cannot be converted. This class contains the complete code of the original version 0 emb2 Embellishment to support editing of unconverted version 0 Embellishments and run-time support for modules containing unconverted traits. This is essentially the latest 3.1 version of Embellishment

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`activateCommand`
`protected String`	`activateKey`
`protected int`	`activateModifiers`
`protected String`	`activationStatus`
`static String`	`ACTIVE`
`protected KeyCommand[]`	`commands`
`protected String[]`	`commonName`
`protected KeyCommand`	`down`
`protected String`	`downCommand`
`protected String`	`downKey`
`protected int`	`downModifiers`
`protected boolean`	`drawUnderneathWhenSelected`
`protected int`	`firstLevelValue`
`protected boolean`	`followProperty`
`static String`	`ID`
`static String`	`IMAGE`
`protected String[]`	`imageName`
`protected ScaledImagePainter[]`	`imagePainter`
`protected Rectangle`	`lastBounds`
`protected Area`	`lastShape`
`static String`	`LEVEL`
`protected boolean`	`loopLevels`
`protected String`	`name`
`static String`	`NAME`
`protected int`	`nValues`
`static String`	`OLD_ID`
`protected String`	`propertyName`
`protected String`	`resetCommand`
`protected KeyStroke`	`resetKey`
`protected FormattedString`	`resetLevel`
`protected KeyStroke`	`rndKey`
`protected Rectangle[]`	`size`
`protected KeyCommand`	`up`
`protected String`	`upCommand`
`protected String`	`upKey`
`protected int`	`upModifiers`
`protected int`	`value`
`protected int`	`xOff`
`protected int`	`yOff`

Fields inherited from class VASSAL.counters.Decorator

piece

Fields inherited from interface VASSAL.counters.PropertyExporter

LOCALIZED_NAME

Fields inherited from interface VASSAL.i18n.TranslatablePiece

PREFIX

Constructor Summary

Constructors

Constructor Description

Embellishment0()

Embellishment0(String type, GamePiece d)

Method Summary

Modifier and Type	Method	Description
`Rectangle`	`boundingBox()`	The area which this GamePiece occupies when drawn at the point (0,0)
`protected void`	`checkPropertyLevel()`
`void`	`draw(Graphics g, int x, int y, Component obs, double zoom)`	Draw this GamePiece
`protected String`	`getCommonName(boolean localized, int i)`	Get the name of this level (alone)
`protected Image`	`getCurrentImage()`	Deprecated, for removal: This API element is subject to removal in a future version. Use `ImageOp.getImage()` instead.
`Rectangle`	`getCurrentImageBounds()`
`String`	`getDescription()`	A plain-English description of this type of piece
`PieceEditor`	`getEditor()`	Get the configurer for this trait
`HelpFile`	`getHelpFile()`
`PieceI18nData`	`getI18nData()`	Return I18n data for this piece
`static Embellishment`	`getLayerWithMatchingActivateCommand(GamePiece piece, KeyStroke stroke, boolean active)`	If the argument GamePiece contains a Layer whose "activate" command matches the given keystroke, and whose active status matches the boolean argument, return that Layer
`protected String`	`getLocalizedCommonName(int i)`	Get the localized name of this level (alone)
`String`	`getLocalizedName()`	Return the translated name for this piece.
`Object`	`getLocalizedProperty(Object key)`
`String`	`getName()`	The plain English name for this piece
`String`	`getName(boolean localized)`
`Object`	`getProperty(Object key)`
`Shape`	`getShape()`	Return the Shape of the counter by adding the shape of this layer to the shape of all inner traits.
`int`	`getValue()`
`boolean`	`isActive()`
`KeyCommand[]`	`myGetKeyCommands()`
`String`	`myGetState()`
`String`	`myGetType()`
`Command`	`myKeyEvent(KeyStroke stroke)`	The response of this trait alone to the given KeyStroke
`void`	`mySetState(String s)`	Set just the state of this trait
`void`	`mySetType(String s)`	Set the type information for this piece.
`String`	`oldGetType()`	Deprecated, for removal: This API element is subject to removal in a future version. No Replacement
`void`	`setActive(boolean val)`
`void`	`setValue(int val)`	Set the current level - First level = 0 Does not change the active status
`protected String`	`strip(String s)`

Methods inherited from class VASSAL.counters.Decorator

getCommandDescription, getDecorator, getI18nData, getI18nData, getId, getInner, getInnermost, getKeyCommands, getMap, getOuter, getOutermost, getParent, getPersistentProperty, getPosition, getProperties, getPropertyNames, getState, getTranslation, getType, isSelected, keyEvent, mergeState, putOldProperties, repack, reportDataError, reportDataError, reportDataError, setId, setInner, setMap, setOldProperties, setOldProperties, setParent, setPersistentProperty, setPosition, setProperty, setSelected, setState, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.counters.GamePiece

getId, getMap, getParent, getPosition, getState, getType, keyEvent, setId, setMap, setParent, setPosition, setProperty, setState

Methods inherited from interface VASSAL.counters.PropertyExporter

getProperties

Field Details
- OLD_ID
  
  public static final String OLD_ID
  
  See Also:
  
  Constant Field Values
- ID
  
  public static final String ID
  
  See Also:
  
  Constant Field Values
- IMAGE
  
  public static final String IMAGE
  
  See Also:
  
  Constant Field Values
- NAME
  
  public static final String NAME
  
  See Also:
  
  Constant Field Values
- LEVEL
  
  public static final String LEVEL
  
  See Also:
  
  Constant Field Values
- ACTIVE
  
  public static final String ACTIVE
  
  See Also:
  
  Constant Field Values
- activateKey
  
  protected String activateKey
- upKey
  
  protected String upKey
- downKey
  
  protected String downKey
- activateModifiers
  
  protected int activateModifiers
- upModifiers
  
  protected int upModifiers
- downModifiers
  
  protected int downModifiers
- upCommand
  
  protected String upCommand
- downCommand
  
  protected String downCommand
- activateCommand
  
  protected String activateCommand
- resetCommand
  
  protected String resetCommand
- resetLevel
  
  protected FormattedString resetLevel
- loopLevels
  
  protected boolean loopLevels
- resetKey
  
  protected KeyStroke resetKey
- followProperty
  
  protected boolean followProperty
- propertyName
  
  protected String propertyName
- firstLevelValue
  
  protected int firstLevelValue
- rndKey
  
  protected KeyStroke rndKey
- value
  
  protected int value
- activationStatus
  
  protected String activationStatus
- nValues
  
  protected int nValues
- xOff
  
  protected int xOff
- yOff
  
  protected int yOff
- imageName
  
  protected String[] imageName
- commonName
  
  protected String[] commonName
- size
  
  protected Rectangle[] size
- imagePainter
  
  protected ScaledImagePainter[] imagePainter
- drawUnderneathWhenSelected
  
  protected boolean drawUnderneathWhenSelected
- name
  
  protected String name
- commands
  
  protected KeyCommand[] commands
- up
  
  protected KeyCommand up
- down
  
  protected KeyCommand down
- lastBounds
  
  protected Rectangle lastBounds
- lastShape
  
  protected Area lastShape
Constructor Details
- Embellishment0
  
  public Embellishment0()
- Embellishment0
  
  public Embellishment0(String type, GamePiece d)
Method Details
- isActive
  
  public boolean isActive()
- setActive
  
  public void setActive(boolean val)
- getValue
  
  public int getValue()
- setValue
  
  public void setValue(int val)
  
  Set the current level - First level = 0 Does not change the active status
  
  Parameters:
  
  val - Value to set
- mySetType
  
  public void mySetType(String s)
  
  Description copied from interface: EditablePiece
  
  Set the type information for this piece. See Decorator.myGetType()
  
  Specified by:
  
  mySetType in interface EditablePiece
- getLocalizedName
  
  public String getLocalizedName()
  
  Description copied from class: Decorator
  
  Return the translated name for this piece. Most pieces do not have translatable elements, so just return the standard name
  
  Specified by:
  
  getLocalizedName in interface GamePiece
  
  Overrides:
  
  getLocalizedName in class Decorator
- getName
  
  public String getName()
  
  Description copied from interface: GamePiece
  
  The plain English name for this piece
  
  Specified by:
  
  getName in interface GamePiece
- getName
  
  public String getName(boolean localized)
- mySetState
  
  public void mySetState(String s)
  
  Description copied from class: Decorator
  
  Set just the state of this trait
  
  Specified by:
  
  mySetState in class Decorator
  
  See Also:
  
  Decorator.myGetState()
- myGetType
  
  public String myGetType()
  
  Specified by:
  
  myGetType in class Decorator
  
  Returns:
  
  the type of this trait alone
  
  See Also:
  
  Decorator.getType()
- oldGetType
  
  @Deprecated(since="2020-08-06", forRemoval=true) public String oldGetType()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  No Replacement
- myGetState
  
  public String myGetState()
  
  Specified by:
  
  myGetState in class Decorator
  
  Returns:
  
  the state of this trait alone
  
  See Also:
  
  Decorator.getState()
- draw
  
  public void draw(Graphics g, int x, int y, Component obs, double zoom)
  
  Description copied from interface: GamePiece
  
  Draw this GamePiece
  
  Specified by:
  
  draw in interface GamePiece
  
  x - x-location of the center of the piece
  
  y - y-location of the center of the piece
  
  obs - the Component on which this piece is being drawn
  
  zoom - the scaling factor.
- checkPropertyLevel
  
  protected void checkPropertyLevel()
- myGetKeyCommands
  
  public KeyCommand[] myGetKeyCommands()
  
  Specified by:
  
  myGetKeyCommands in class Decorator
  
  Returns:
  
  the commands for this trait alone
  
  See Also:
  
  Decorator.getKeyCommands()
- myKeyEvent
  
  public Command myKeyEvent(KeyStroke stroke)
  
  Description copied from class: Decorator
  
  The response of this trait alone to the given KeyStroke
  
  Specified by:
  
  myKeyEvent in class Decorator
  
  Parameters:
  
  stroke - Stroke to apply
  
  Returns:
  
  Generated Command or null if no effect
  
  See Also:
  
  Decorator.keyEvent(javax.swing.KeyStroke)
- getCurrentImage
  
  @Deprecated(since="2020-08-06", forRemoval=true) protected Image getCurrentImage() throws IOException
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Use ImageOp.getImage() instead.
  
  Throws:
  
  IOException
- boundingBox
  
  public Rectangle boundingBox()
  
  Description copied from interface: GamePiece
  
  The area which this GamePiece occupies when drawn at the point (0,0)
  
  Specified by:
  
  boundingBox in interface GamePiece
- getCurrentImageBounds
  
  public Rectangle getCurrentImageBounds()
- getShape
  
  public Shape getShape()
  
  Return the Shape of the counter by adding the shape of this layer to the shape of all inner traits. Minimize generation of new Area objects.
  
  Specified by:
  
  getShape in interface GamePiece
- getDescription
  
  public String getDescription()
  
  Description copied from interface: EditablePiece
  
  A plain-English description of this type of piece
  
  Specified by:
  
  getDescription in interface EditablePiece
- getProperty
  
  public Object getProperty(Object key)
  
  Specified by:
  
  getProperty in interface GamePiece
  
  Specified by:
  
  getProperty in interface PropertySource
  
  Overrides:
  
  getProperty in class Decorator
- getLocalizedProperty
  
  public Object getLocalizedProperty(Object key)
  
  Specified by:
  
  getLocalizedProperty in interface PropertySource
  
  Overrides:
  
  getLocalizedProperty in class Decorator
- strip
  
  protected String strip(String s)
- getCommonName
  
  protected String getCommonName(boolean localized, int i)
  
  Get the name of this level (alone)
- getLocalizedCommonName
  
  protected String getLocalizedCommonName(int i)
  
  Get the localized name of this level (alone)
- getHelpFile
  
  public HelpFile getHelpFile()
  
  Specified by:
  
  getHelpFile in interface EditablePiece
- getEditor
  
  public PieceEditor getEditor()
  
  Description copied from interface: EditablePiece
  
  Get the configurer for this trait
  
  Specified by:
  
  getEditor in interface EditablePiece
  
  Overrides:
  
  getEditor in class Decorator
- getLayerWithMatchingActivateCommand
  
  public static Embellishment getLayerWithMatchingActivateCommand(GamePiece piece, KeyStroke stroke, boolean active)
  
  If the argument GamePiece contains a Layer whose "activate" command matches the given keystroke, and whose active status matches the boolean argument, return that Layer
- getI18nData
  
  public PieceI18nData getI18nData()
  
  Description copied from class: Decorator
  
  Return I18n data for this piece
  
  Specified by:
  
  getI18nData in interface TranslatablePiece
  
  Overrides:
  
  getI18nData in class Decorator
  
  Returns:
  
  I18n data

Constructor	Description
`Embellishment0()`
`Embellishment0(String type, GamePiece d)`

Class Embellishment0

Field Summary

Fields inherited from class VASSAL.counters.Decorator

Fields inherited from interface VASSAL.counters.PropertyExporter

Fields inherited from interface VASSAL.i18n.TranslatablePiece

Constructor Summary

Method Summary

Methods inherited from class VASSAL.counters.Decorator

Methods inherited from class java.lang.Object

Methods inherited from interface VASSAL.counters.GamePiece

Methods inherited from interface VASSAL.counters.PropertyExporter

Field Details

OLD_ID

ID

IMAGE

NAME

LEVEL

ACTIVE

activateKey

upKey

downKey

activateModifiers

upModifiers

downModifiers

upCommand

downCommand

activateCommand

resetCommand

resetLevel

loopLevels

resetKey

followProperty

propertyName

firstLevelValue

rndKey

value

activationStatus

nValues

xOff

yOff

imageName

commonName

size

imagePainter

drawUnderneathWhenSelected

name

commands

up

down

lastBounds

lastShape

Constructor Details

Embellishment0

Embellishment0

Method Details

isActive

setActive

getValue

setValue

mySetType

getLocalizedName

getName

getName

mySetState

myGetType

oldGetType

myGetState

draw

checkPropertyLevel

myGetKeyCommands

myKeyEvent

getCurrentImage

boundingBox

getCurrentImageBounds

getShape

getDescription

getProperty

getLocalizedProperty

strip

getCommonName