Package VASSAL.counters

Class DynamicProperty

java.lang.Object

VASSAL.counters.Decorator

VASSAL.counters.DynamicProperty

All Implemented Interfaces:

IncrementProperty.Constraints, PropertyChangerConfigurer.Constraints, PropertyNameSource, PropertyPrompt.Constraints, PropertyPrompt.DialogParent, PropertySource, EditablePiece, GamePiece, PropertyExporter, StateMergeable, TranslatablePiece, PersistentPropertyContainer

Direct Known Subclasses:

SetGlobalProperty

public class DynamicProperty
extends Decorator
implements TranslatablePiece, PropertyPrompt.DialogParent, PropertyChangerConfigurer.Constraints

Trait that contains a property accessible via getProperty() and updateable dynamically via key commands

Author:

rkinney

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	DynamicProperty.DynamicKeyCommand	DynamicKeyCommand A class that represents an action to be performed on a Dynamic property
protected static class	DynamicProperty.DynamicKeyCommandConfigurer	Configure a single Dynamic Key Command line
protected static class	DynamicProperty.Ed

Field Summary

Fields

Modifier and Type	Field	Description
protected FormattedString	format
static String	ID
protected String	key
protected ListConfigurer	keyCommandListConfig
protected DynamicProperty.DynamicKeyCommand[]	keyCommands
protected int	maxValue
protected KeyCommand[]	menuCommands
protected int	minValue
protected boolean	numeric
protected String	value
protected boolean	wrap

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
DynamicProperty()
DynamicProperty(String type, GamePiece p)

Method Summary

Modifier and Type	Method	Description
Rectangle	boundingBox()	The area which this GamePiece occupies when drawn at the point (0,0)
protected void	decodeConstraints(String s)
void	draw(Graphics g, int x, int y, Component obs, double zoom)	Draw this GamePiece
protected String	encodeConstraints()
Component	getComponent()
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	getKey()
Object	getLocalizedProperty(Object key)
int	getMaximumValue()
int	getMinimumValue()
String	getName()	The plain English name for this piece
Object	getProperty(Object key)
List<String>	getPropertyNames()	Return Property names exposed by this trait
PropertySource	getPropertySource()
Shape	getShape()	The shape of the piece from the user's viewpoint.
String	getValue()
boolean	isNumeric()
boolean	isWrap()
protected KeyCommand[]	myGetKeyCommands()
String	myGetState()
String	myGetType()
Command	myKeyEvent(KeyStroke stroke)	The response of this trait alone to the given KeyStroke
void	mySetState(String state)	Set just the state of this trait
void	mySetType(String s)	Set the type information for this piece.
void	setProperty(Object key, Object value)	Other properties, possibly game-specific, can be associated with a piece.
void	setValue(String value)

Methods inherited from class VASSAL.counters.Decorator

getCommandDescription, getDecorator, getI18nData, getI18nData, getId, getInner, getInnermost, getKeyCommands, getLocalizedName, getMap, getOuter, getOutermost, getParent, getPersistentProperty, getPosition, getProperties, getState, getTranslation, getType, isSelected, keyEvent, mergeState, putOldProperties, repack, reportDataError, reportDataError, reportDataError, setId, setInner, setMap, setOldProperties, setOldProperties, setParent, setPersistentProperty, setPosition, 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, getState, getType, keyEvent, setId, setMap, setParent, setPosition, setState

Methods inherited from interface VASSAL.counters.PropertyExporter

getProperties

Field Details

ID

public static final String ID

See Also:

Constant Field Values

value

protected String value

key

protected String key

numeric

protected boolean numeric

minValue

protected int minValue

maxValue

protected int maxValue

wrap

protected boolean wrap

format

protected FormattedString format

keyCommands

protected DynamicProperty.DynamicKeyCommand[] keyCommands

menuCommands

protected KeyCommand[] menuCommands

keyCommandListConfig

protected ListConfigurer keyCommandListConfig

Constructor Details

DynamicProperty

public DynamicProperty()

DynamicProperty

public DynamicProperty(String type,
GamePiece p)

Method Details

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

decodeConstraints

protected void decodeConstraints(String s)

encodeConstraints

protected String encodeConstraints()

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

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

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

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

setProperty

public void setProperty(Object key,
Object value)

Description copied from interface: GamePiece

Other properties, possibly game-specific, can be associated with a piece. The properties may or may not need to be encoded in the piece's GamePiece.getState() method.

Specified by:

setProperty in interface GamePiece

Overrides:

setProperty in class Decorator

myGetState

public String myGetState()

Specified by:

myGetState in class Decorator

Returns:

the state of this trait alone

See Also:

Decorator.getState()

getComponent

public Component getComponent()

Specified by:

getComponent in interface PropertyPrompt.DialogParent

mySetState

public void mySetState(String state)

Description copied from class: Decorator

Set just the state of this trait

Specified by:

mySetState in class Decorator

See Also:

Decorator.myGetState()

getKey

public String getKey()

getValue

public String getValue()

setValue

public void setValue(String value)

myGetType

public String myGetType()

Specified by:

myGetType in class Decorator

Returns:

the type of this trait alone

See Also:

Decorator.getType()

myGetKeyCommands

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

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

getMaximumValue

public int getMaximumValue()

Specified by:

getMaximumValue in interface IncrementProperty.Constraints

Specified by:

getMaximumValue in interface PropertyPrompt.Constraints

getMinimumValue

public int getMinimumValue()

Specified by:

getMinimumValue in interface IncrementProperty.Constraints

Specified by:

getMinimumValue in interface PropertyPrompt.Constraints

isNumeric

public boolean isNumeric()

Specified by:

isNumeric in interface PropertyPrompt.Constraints

isWrap

public boolean isWrap()

Specified by:

isWrap in interface IncrementProperty.Constraints

getPropertyNames

public List<String> getPropertyNames()

Return Property names exposed by this trait

Specified by:

getPropertyNames in interface PropertyNameSource

Overrides:

getPropertyNames in class Decorator

getPropertySource

public PropertySource getPropertySource()

Specified by:

getPropertySource in interface IncrementProperty.Constraints

Specified by:

getPropertySource in interface PropertyPrompt.Constraints

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