VASSAL.counters
Class Embellishment

java.lang.Object
  |
  +--VASSAL.counters.Decorator
        |
        +--VASSAL.counters.Embellishment

All Implemented Interfaces:

EditablePiece, GamePiece

public class Embellishment

extends Decorator

implements EditablePiece

The "Layer" trait. Contains a list of images that the user may cycle through. The current image is superimposed over the inner piece. The entire layer may be activated or deactivated.

Field Summary

protected java.lang.String	activateCommand
protected java.lang.String	activateKey
protected java.lang.String	activationStatus
protected KeyCommand[]	commands
protected java.lang.String[]	commonName
protected java.lang.String	downCommand
protected java.lang.String	downKey
protected boolean	drawUnderneathWhenSelected
static java.lang.String	ID
protected java.lang.String[]	imageName
protected int	nValues
protected java.awt.Rectangle[]	size
protected java.lang.String	upCommand
protected java.lang.String	upKey
protected int	value
protected int	xOff
protected int	yOff

Fields inherited from class VASSAL.counters.Decorator

piece

Constructor Summary

Embellishment()

Embellishment(java.lang.String type, GamePiece d)

Method Summary

java.awt.Rectangle	boundingBox() The area which this GamePiece occupies when drawn at the point (0,0)
void	draw(java.awt.Graphics g, int x, int y, java.awt.Component obs, double zoom) Draw this GamePiece
protected java.awt.Image	getCurrentImage()
java.awt.Rectangle	getCurrentImageBounds()
java.lang.String	getDescription() A plain-English description of this type of piece
PieceEditor	getEditor() Get the configurer for this trait
HelpFile	getHelpFile()
static Embellishment	getLayerWithMatchingActivateCommand(GamePiece piece, javax.swing.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
java.lang.String	getName() The plain English name for this piece
java.awt.Shape	getShape() The shape of the piece from the user's viewpoint.
int	getValue()
boolean	isActive()
KeyCommand[]	myGetKeyCommands()
java.lang.String	myGetState()
java.lang.String	myGetType()
Command	myKeyEvent(javax.swing.KeyStroke stroke) The response of this trait alone to the given KeyStroke
void	mySetState(java.lang.String s) Set just the state of this trait
void	mySetType(java.lang.String s) Set the type information for this piece.
void	setActive(boolean val)
void	setValue(int val)

Methods inherited from class VASSAL.counters.Decorator

getDecorator, getId, getInner, getInnermost, getKeyCommands, getMap, getOutermost, getParent, getPosition, getProperty, getState, getType, keyEvent, mergeState, setId, setInner, setMap, setParent, setPosition, setProperty, setState

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.counters.GamePiece

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

Field Detail

ID

public static final java.lang.String ID

activateKey

protected java.lang.String activateKey

upKey

protected java.lang.String upKey

downKey

protected java.lang.String downKey

upCommand

protected java.lang.String upCommand

downCommand

protected java.lang.String downCommand

activateCommand

protected java.lang.String activateCommand

value

protected int value

activationStatus

protected java.lang.String activationStatus

nValues

protected int nValues

xOff

protected int xOff

yOff

protected int yOff

imageName

protected java.lang.String[] imageName

commonName

protected java.lang.String[] commonName

size

protected java.awt.Rectangle[] size

drawUnderneathWhenSelected

protected boolean drawUnderneathWhenSelected

commands

protected KeyCommand[] commands

Constructor Detail

Embellishment

public Embellishment()

Embellishment

public Embellishment(java.lang.String type,
                     GamePiece d)

Method Detail

isActive

public boolean isActive()

setActive

public void setActive(boolean val)

getValue

public int getValue()

setValue

public void setValue(int val)

mySetType

public void mySetType(java.lang.String s)

Description copied from interface: EditablePiece

Set the type information for this piece. See Decorator.myGetType()

Specified by:

mySetType in interface EditablePiece

getName

public java.lang.String getName()

Description copied from interface: GamePiece

The plain English name for this piece

Specified by:

getName in interface GamePiece

mySetState

public void mySetState(java.lang.String s)

Description copied from class: Decorator

Set just the state of this trait

Overrides:

mySetState in class Decorator

Following copied from class: VASSAL.counters.Decorator

See Also:

Decorator.myGetState()

myGetType

public java.lang.String myGetType()

Overrides:

myGetType in class Decorator

Following copied from class: VASSAL.counters.Decorator

Returns:

the type of this trait alone

See Also:

Decorator.getType()

myGetState

public java.lang.String myGetState()

Overrides:

myGetState in class Decorator

Following copied from class: VASSAL.counters.Decorator

Returns:

the state of this trait alone

See Also:

Decorator.getState()

draw

public void draw(java.awt.Graphics g,
                 int x,
                 int y,
                 java.awt.Component obs,
                 double zoom)

Description copied from interface: GamePiece

Draw this GamePiece

Specified by:

draw in interface GamePiece

Following copied from interface: VASSAL.counters.GamePiece

Parameters:

g -

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.

myGetKeyCommands

public KeyCommand[] myGetKeyCommands()

Overrides:

myGetKeyCommands in class Decorator

Following copied from class: VASSAL.counters.Decorator

Returns:

the commands for this trait alone

See Also:

Decorator.getKeyCommands()

myKeyEvent

public Command myKeyEvent(javax.swing.KeyStroke stroke)

Description copied from class: Decorator

The response of this trait alone to the given KeyStroke

Overrides:

myKeyEvent in class Decorator

Following copied from class: VASSAL.counters.Decorator

Parameters:

stroke -

Returns:

null if no effect

See Also:

Decorator.keyEvent(javax.swing.KeyStroke)

getCurrentImage

protected java.awt.Image getCurrentImage()
                                  throws java.io.IOException

boundingBox

public java.awt.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 java.awt.Rectangle getCurrentImageBounds()

getShape

public java.awt.Shape getShape()

Description copied from interface: GamePiece

The shape of the piece from the user's viewpoint. This defines the area in which the user must click to select or move the piece, for example. Like GamePiece.boundingBox(), it assumes the position is (0,0) and must be translated to the actual location where the piece is being drawn.

Specified by:

getShape in interface GamePiece

getDescription

public java.lang.String getDescription()

Description copied from interface: EditablePiece

A plain-English description of this type of piece

Specified by:

getDescription in interface EditablePiece

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,
                                                                javax.swing.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