VASSAL.counters
Class ReportState

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

All Implemented Interfaces:

EditablePiece, GamePiece, StateMergeable

public class ReportState

extends Decorator

implements EditablePiece

A GamePiece with this trait will echo the piece's current name when any of a given key commands are pressed (and after they take effect)

Inner Class Summary

static class

ReportState.Ed

Field Summary

static java.lang.String	COMMAND_NAME
static java.lang.String	ID
static java.lang.String	LOCATION_NAME
static java.lang.String	MAP_NAME
static java.lang.String	NEW_UNIT_NAME
static java.lang.String	OLD_LOCATION_NAME
static java.lang.String	OLD_MAP_NAME
static java.lang.String	OLD_UNIT_NAME

Fields inherited from class VASSAL.counters.Decorator

piece

Constructor Summary

ReportState()

ReportState(java.lang.String type, GamePiece inner)

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
java.lang.String	getDescription() A plain-English description of this type of piece
PieceEditor	getEditor() Get the configurer for this trait
HelpFile	getHelpFile()
java.lang.String	getName() The plain English name for this piece
protected java.lang.String	getPieceName()
java.awt.Shape	getShape() The shape of the piece from the user's viewpoint.
Command	keyEvent(javax.swing.KeyStroke stroke) Keyboard events are forward to this method when a piece is selected The GamePiece can respond in any way it likes
protected 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 newState) Set just the state of this trait
void	mySetType(java.lang.String type) Set the type information for this piece.

Methods inherited from class VASSAL.counters.Decorator

getDecorator, getId, getInner, getInnermost, getKeyCommands, getMap, getOutermost, getParent, getPosition, getProperty, getState, getType, 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, setId, setMap, setParent, setPosition, setProperty, setState

Field Detail

ID

public static final java.lang.String ID

OLD_UNIT_NAME

public static final java.lang.String OLD_UNIT_NAME

NEW_UNIT_NAME

public static final java.lang.String NEW_UNIT_NAME

MAP_NAME

public static final java.lang.String MAP_NAME

OLD_MAP_NAME

public static final java.lang.String OLD_MAP_NAME

LOCATION_NAME

public static final java.lang.String LOCATION_NAME

OLD_LOCATION_NAME

public static final java.lang.String OLD_LOCATION_NAME

COMMAND_NAME

public static final java.lang.String COMMAND_NAME

Constructor Detail

ReportState

public ReportState()

ReportState

public ReportState(java.lang.String type,
                   GamePiece inner)

Method Detail

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

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.

getName

public java.lang.String getName()

Description copied from interface: GamePiece

The plain English name for this piece

Specified by:

getName in interface GamePiece

myGetKeyCommands

protected 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()

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()

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()

keyEvent

public Command keyEvent(javax.swing.KeyStroke stroke)

Description copied from interface: GamePiece

Keyboard events are forward to this method when a piece is selected The GamePiece can respond in any way it likes

Specified by:

keyEvent in interface GamePiece

Overrides:

keyEvent in class Decorator

Following copied from interface: VASSAL.counters.GamePiece

Returns:

a Command that, when executed, will invoke the same response. Usually a ChangePiece command.

See Also:

ForwardToKeyBuffer

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)

getPieceName

protected java.lang.String getPieceName()

mySetState

public void mySetState(java.lang.String newState)

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()

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

mySetType

public void mySetType(java.lang.String type)

Description copied from interface: EditablePiece

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

Specified by:

mySetType 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