Package VASSAL.counters

Class ReportState

java.lang.Object

VASSAL.counters.Decorator

VASSAL.counters.ReportState

All Implemented Interfaces:

PropertyNameSource, PropertySource, EditablePiece, GamePiece, PropertyExporter, StateMergeable, TranslatablePiece, PersistentPropertyContainer

public class ReportState
extends Decorator
implements TranslatablePiece

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)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReportState.Ed

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMMAND_NAME
protected NamedKeyStroke[]	cycleDownKeys
protected int	cycleIndex
protected String[]	cycleReportFormat
protected String	description
protected FormattedString	format
static String	ID
protected NamedKeyStroke[]	keys
static String	LOCATION_NAME
static String	MAP_NAME
static String	NEW_UNIT_NAME
static String	OLD_LOCATION_NAME
static String	OLD_MAP_NAME
static String	OLD_UNIT_NAME
protected String	reportFormat

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
ReportState()
ReportState(String type, GamePiece inner)

Method Summary

Modifier and Type	Method	Description
Rectangle	boundingBox()	The area which this GamePiece occupies when drawn at the point (0,0)
void	draw(Graphics g, int x, int y, Component obs, double zoom)	Draw this GamePiece
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
String	getName()	The plain English name for this piece
protected String	getPieceName()
Shape	getShape()	The shape of the piece from the user's viewpoint.
Command	keyEvent(KeyStroke stroke)	Append the command returned by Decorator.myKeyEvent(javax.swing.KeyStroke) with the command returned by the inner piece's GamePiece.keyEvent(javax.swing.KeyStroke) method.
protected KeyCommand[]	myGetKeyCommands()
String	myGetState()
String	myGetType()
Command	myKeyEvent(KeyStroke stroke)	The response of this trait alone to the given KeyStroke
void	mySetState(String newState)	Set just the state of this trait
void	mySetType(String type)	Set the type information for this piece.

Methods inherited from class VASSAL.counters.Decorator

getCommandDescription, getDecorator, getI18nData, getI18nData, getId, getInner, getInnermost, getKeyCommands, getLocalizedName, getLocalizedProperty, getMap, getOuter, getOutermost, getParent, getPersistentProperty, getPosition, getProperties, getProperty, getPropertyNames, getState, getTranslation, getType, isSelected, 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, getLocalizedName, getMap, getParent, getPosition, getProperty, getState, getType, setId, setMap, setParent, setPosition, setProperty, setState

Methods inherited from interface VASSAL.counters.PropertyExporter

getProperties

Methods inherited from interface VASSAL.build.module.properties.PropertySource

getLocalizedProperty

Field Details

ID

public static final String ID

See Also:

Constant Field Values

keys

protected NamedKeyStroke[] keys

format

protected FormattedString format

reportFormat

protected String reportFormat

cycleReportFormat

protected String[] cycleReportFormat

cycleDownKeys

protected NamedKeyStroke[] cycleDownKeys

cycleIndex

protected int cycleIndex

description

protected String description

OLD_UNIT_NAME

public static final String OLD_UNIT_NAME

See Also:

Constant Field Values

NEW_UNIT_NAME

public static final String NEW_UNIT_NAME

See Also:

Constant Field Values

MAP_NAME

public static final String MAP_NAME

See Also:

Constant Field Values

OLD_MAP_NAME

public static final String OLD_MAP_NAME

See Also:

Constant Field Values

LOCATION_NAME

public static final String LOCATION_NAME

See Also:

Constant Field Values

OLD_LOCATION_NAME

public static final String OLD_LOCATION_NAME

See Also:

Constant Field Values

COMMAND_NAME

public static final String COMMAND_NAME

See Also:

Constant Field Values

Constructor Details

ReportState

public ReportState()

ReportState

public ReportState(String type,
GamePiece inner)

Method Details

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

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.

getName

public String getName()

Description copied from interface: GamePiece

The plain English name for this piece

Specified by:

getName in interface GamePiece

myGetKeyCommands

protected KeyCommand[] myGetKeyCommands()

Specified by:

myGetKeyCommands in class Decorator

Returns:

the commands for this trait alone

See Also:

Decorator.getKeyCommands()

myGetState

public String myGetState()

Specified by:

myGetState in class Decorator

Returns:

the state of this trait alone

See Also:

Decorator.getState()

myGetType

public String myGetType()

Specified by:

myGetType in class Decorator

Returns:

the type of this trait alone

See Also:

Decorator.getType()

keyEvent

public Command keyEvent(KeyStroke stroke)

Description copied from class: Decorator

Append the command returned by Decorator.myKeyEvent(javax.swing.KeyStroke) with the command returned by the inner piece's GamePiece.keyEvent(javax.swing.KeyStroke) method.

Specified by:

keyEvent in interface GamePiece

Overrides:

keyEvent in class Decorator

Parameters:

stroke - Stroke to apply

Returns:

Generated Command or null if no effect

See Also:

ForwardToKeyBuffer

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)

getPieceName

protected String getPieceName()

mySetState

public void mySetState(String newState)

Description copied from class: Decorator

Set just the state of this trait

Specified by:

mySetState in class Decorator

See Also:

Decorator.myGetState()

getShape

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

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