Package VASSAL.counters

Class DynamicProperty

java.lang.Object

VASSAL.search.AbstractImageFinder

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, Auditable, ImageSearchTarget, SearchTarget

Direct Known Subclasses:

SetGlobalProperty, SetPieceProperty

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

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

Author:

rkinney

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DynamicProperty.DynamicKeyCommand	DynamicKeyCommand A class that represents an action to be performed on a Dynamic property
protected static class	DynamicProperty.DynamicKeyCommandConfigurer	Deprecated, for removal: This API element is subject to removal in a future version. Use DynamicKeyCommandConfigurer
protected static class	DynamicProperty.Ed

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description
protected FormattedString	format
static final String	ID
protected String	key
protected DynamicKeyCommandListConfigurer	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()
protected void	decodeConstraints(String s)
void	draw(Graphics g, int x, int y, Component obs, double zoom)	Draw this GamePiece
protected String	encodeConstraints()
String	getBaseDescription()	Support for a basic-name-only description introduced later, so this default retrofits it from the full description if an explicit one is not defined.
String	getCommandsList()
Component	getComponent()
String	getDescription()	A plain-English description of this type of trait/piece - includes data from fields where appropriate
String	getDescriptionField()	If Decorator contains a description *field*, returns the current contents of it.
PieceEditor	getEditor()
List<String>	getExpressionList()	SearchTarget
HelpFile	getHelpFile()
PieceI18nData	getI18nData()	Return Internationalization (I18n) data for this piece
String	getKey()
Object	getLocalizedProperty(Object key)	Returns a localized translation of the specified property value, if available.
int	getMaximumValue()
List<String>	getMenuTextList()	SearchTarget
int	getMinimumValue()
String	getName()	The plain English name for this piece
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
Object	getProperty(Object key)	Properties can be associated with a piece -- many may be game-specific, but others are standard, such as the LocationName property exposed by BasicPiece -- and can be read through this interface.
List<String>	getPropertyList()	SearchTarget
List<String>	getPropertyNames()	Return Property names exposed by this trait
PropertySource	getPropertySource()
Shape	getShape()
String	getValue()
boolean	isNumeric()
boolean	isWrap()
protected KeyCommand[]	myGetKeyCommands()
String	myGetState()	The "state information" is "game state" information that can change during the course of a game.
String	myGetType()	The "type information" of a piece or trait is information that does not change during the course of a game.
Command	myKeyEvent(KeyStroke stroke)	The response of this trait alone to the given KeyStroke or the virtual keystroke of a NamedKeyStroke.
void	mySetState(String state)	Sets the state of this-trait-only (inverse of Decorator.myGetState()).
void	mySetType(String s)	Sets the information for this piece.
void	setProperty(Object key, Object value)	Within a Trait/Decorator, the default behavior when setting a property is to handle changing our own inner/outer links directly, to cache the selection state (while also passing it inward), and to simply pass every other property change request inward.
void	setValue(String value)
boolean	testEquals(Object o)	Test if this Decorator's Class, Type and State are equal to another trait.

Methods inherited from class VASSAL.counters.Decorator

addImageNamesRecursively, addMenuCommand, buildDescription, buildDescription, buildDescription, getCommandDesc, getCommandDescription, getComponentName, getComponentTypeName, getDecorator, getDecorators, getFormattedStringList, getI18nData, getI18nData, getId, getInner, getInnermost, getKeyCommands, getLocalizedName, getMap, getOuter, getOutermost, getParent, getPersistentProperty, getPosition, getProperties, getState, getTranslation, getType, isMenuCommand, isSelected, keyEvent, mergeState, putOldProperties, repack, repack, reportDataError, reportDataError, reportDataError, setDynamicProperties, setDynamicProperties, setDynamicProperty, setId, setInner, setMap, setParent, setPersistentProperty, setPosition, setSelected, setState, toString

Methods inherited from class VASSAL.search.AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.script.expression.Auditable

getComponentName, getComponentTypeName

Methods inherited from interface VASSAL.counters.EditablePiece

checkTrueMoved, finishMove, finishMove, prepareMove

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.search.ImageSearchTarget

addLocalImageNames, getAllImageNames, getLocalImageNames

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 DynamicKeyCommandListConfigurer keyCommandListConfig

description

protected String description

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

Sets the information for this piece. See Decorator.myGetType()

Specified by:

mySetType in interface EditablePiece

Parameters:

s - a serialized configuration string to set the "type information" of this piece, which is information that doesn't change during the course of a single game (e.g. Image Files, Context Menu strings, etc). Typically ready to be processed e.g. by SequenceEncoder.decode()

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

Parameters:

g - target Graphics object

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

Specified by:

boundingBox in interface GamePiece

Returns:

The area which this GamePiece occupies when drawn at the point (0,0)

getShape

public Shape getShape()

Specified by:

getShape in interface GamePiece

Returns:

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) -- which to be clear is normally aligned with the CENTER of the piece image -- and must be translated to the actual location where the piece is being drawn. For most ordinary pieces, the shape returned here will simply be equivalent to the bounding box, but see NonRectangular.

getProperty

public Object getProperty(Object key)

Description copied from class: Decorator

Properties can be associated with a piece -- many may be game-specific, but others are standard, such as the LocationName property exposed by BasicPiece -- and can be read through this interface. The properties may or may not need to be encoded in the piece's Decorator.getState() method. Properties include the value of e.g. Marker Traits, DynamicProperty Traits, and so forth. Furthermore they include the values of any visible "Global Property" in a Vassal module, whether at the module level, map level, or zone level -- but these "higher level" properties, coming from "outside the piece", CANNOT be written to by the Decorator.setProperty(java.lang.Object, java.lang.Object) method even though they can be read by this method -- in this sense the two methods are NOT perfect mirrors.

Within a Trait/Decorator, default behavior is to process some requests directly (e.g. requests for our "inner" or "outer" link), process our *part* of certain other requests (e.g. request for our game state information we supply state information for this trait and then append any information obtained from passing the same request inward), and then for any other requests that we cannot process we simply pass the request to the next trait/member inward.

When using this interface a piece's own properties are preferred to those of "Global Properties", and those in turn are searched Zone-first then Map, then Module.

This method implements the PropertySource interface, which allows Global Properties to be read by other types of object than GamePieces.

Specified by:

getProperty in interface GamePiece

Specified by:

getProperty in interface PropertySource

Overrides:

getProperty in class Decorator

Parameters:

key - String key of property to be returned

Returns:

Object containing new value of the specified property

getLocalizedProperty

public Object getLocalizedProperty(Object key)

Description copied from class: Decorator

Returns a localized translation of the specified property value, if available. Otherwise returns the non-localized version. See Decorator.getProperty(java.lang.Object).

Specified by:

getLocalizedProperty in interface PropertySource

Overrides:

getLocalizedProperty in class Decorator

Parameters:

key - String key of property to be returned

Returns:

Object containing localized text of the specified property, if available, otherwise non-localized value

setProperty

public void setProperty(Object key,
 Object value)

Description copied from class: Decorator

Within a Trait/Decorator, the default behavior when setting a property is to handle changing our own inner/outer links directly, to cache the selection state (while also passing it inward), and to simply pass every other property change request inward. A Trait with its own properties to maintain would intercept and process those requests, while sending the rest inward to the next member of the piece.

Properties can be associated with a piece -- many may be game-specific, but others are standard, such as the LocationName property exposed by BasicPiece -- and can be set through this interface. The properties may or may not need to be encoded in the piece's Decorator.getState() method. Properties include the value of e.g. Marker Traits, DynamicProperty Traits, and so forth.

NOTE: Not all properties maintained by traits can be "set" by setProperty, even though they can be read by getProperty -- they may be "read only" for instance. You will need to check the code for individual traits to see what they support in this regard.

NOTE: Properties outside the piece CANNOT be set by this method (e.g. Global Properties), even though they can be read by Decorator.getProperty(java.lang.Object) -- in this the two methods are not perfect mirrors.

Specified by:

setProperty in interface GamePiece

Overrides:

setProperty in class Decorator

Parameters:

key - String key of property to be changed

value - Object containing new value of the property

myGetState

public String myGetState()

Description copied from class: Decorator

The "state information" is "game state" information that can change during the course of a game. State information is saved when the game is saved and is transferred between players on the server. For example, the relative order of pieces in a stack is state information, but whether the stack is expanded is not.

Specified by:

myGetState in class Decorator

Returns:

the game state information of this trait alone

See Also:

• which returns state information for all inward piece members as well

getComponent

public Component getComponent()

Specified by:

getComponent in interface PropertyPrompt.DialogParent

mySetState

public void mySetState(String state)

Description copied from class: Decorator

Sets the state of this-trait-only (inverse of Decorator.myGetState()). The "state information" is information that can change during the course of a game. State information is saved when the game is saved and is transferred between players on the server. For example, the relative order of pieces in a stack is state information, but whether the stack is expanded is not.

Specified by:

mySetState in class Decorator

Parameters:

state - New state information serialized in string form, ready to be passed to a SequenceEncoder#decode.

getKey

public String getKey()

getValue

public String getValue()

setValue

public void setValue(String value)

myGetType

public String myGetType()

Description copied from class: Decorator

The "type information" of a piece or trait is information that does not change during the course of a game. Image file names, context menu strings, etc., all should be reflected in the type. The type information is returned serialized string form, ready to be decoded by a SequenceEncoder#decode.

Specified by:

myGetType in class Decorator

Returns:

the type information of this trait alone

See Also:

• BasicCommandEncoder
• which returns type information for all inward piece members as well

myGetKeyCommands

protected KeyCommand[] myGetKeyCommands()

Specified by:

myGetKeyCommands in class Decorator

Returns:

the key commands for this trait alone

See Also:

• which returns the key commands for this trait AND all inner piece members

myKeyEvent

public Command myKeyEvent(KeyStroke stroke)

Description copied from class: Decorator

The response of this trait alone to the given KeyStroke or the virtual keystroke of a NamedKeyStroke. NamedKeyStrokes are allocated a unique internal KeyStroke when they are first used in a module, and that KeyStroke is passed up and down the decorator stack to represent them (see NamedKeyStroke.getKeyStroke()).

Specified by:

myKeyEvent in class Decorator

Parameters:

stroke - KeyStroke to apply (to apply a Named Keystroke send NamedKeyStroke.getKeyStroke()

Returns:

Generated Command to reproduce any changes just made to to the game state, or null if no effect

See Also:

• Decorator.keyEvent(javax.swing.KeyStroke)

getCommandsList

public String getCommandsList()

getDescription

public String getDescription()

Description copied from interface: EditablePiece

A plain-English description of this type of trait/piece - includes data from fields where appropriate

Specified by:

getDescription in interface EditablePiece

getBaseDescription

public String getBaseDescription()

Description copied from interface: EditablePiece

Support for a basic-name-only description introduced later, so this default retrofits it from the full description if an explicit one is not defined.

Specified by:

getBaseDescription in interface EditablePiece

Returns:

name of trait/piece type, w/o additional data

getDescriptionField

public String getDescriptionField()

Description copied from class: Decorator

If Decorator contains a description *field*, returns the current contents of it.

Overrides:

getDescriptionField in class Decorator

Returns:

contents of "description" field, if it exists.

getNamedKeyStrokeList

public List<NamedKeyStroke> getNamedKeyStrokeList()

Description copied from class: Decorator

SearchTarget

Specified by:

getNamedKeyStrokeList in interface SearchTarget

Overrides:

getNamedKeyStrokeList in class Decorator

Returns:

a list of any Named KeyStrokes referenced in the Decorator, if any (for search)

getExpressionList

public List<String> getExpressionList()

Description copied from class: Decorator

SearchTarget

Specified by:

getExpressionList in interface SearchTarget

Overrides:

getExpressionList in class Decorator

Returns:

a list of the Decorator's string/expression fields if any (for search)

getMenuTextList

public List<String> getMenuTextList()

Description copied from class: Decorator

SearchTarget

Specified by:

getMenuTextList in interface SearchTarget

Overrides:

getMenuTextList in class Decorator

Returns:

a list of any Menu Text strings referenced in the Decorator, if any (for search)

getPropertyList

public List<String> getPropertyList()

Description copied from class: Decorator

SearchTarget

Specified by:

getPropertyList in interface SearchTarget

Overrides:

getPropertyList in class Decorator

Returns:

a list of any Property Names referenced in the Decorator, if any (for search)

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface EditablePiece

Returns:

the help file for this trait

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 IncrementProperty.Constraints

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

Returns:

List of property names "exposed" by this piece -- that are available to other Traits and components to read. Default behavior for a Trait is not to expose any properties, but Traits which should expose some (e.g. DynamicProperty or Marker) would provide an array of the property names here.

getPropertySource

public PropertySource getPropertySource()

Specified by:

getPropertySource in interface IncrementProperty.Constraints

Specified by:

getPropertySource in interface PropertyPrompt.Constraints

getEditor

public PieceEditor getEditor()

Specified by:

getEditor in interface EditablePiece

Overrides:

getEditor in class Decorator

Returns:

the configurer for this trait - the dialog which allows the editing the piece's type information. Default configurer is a SimplePieceEditor, but many traits will want to provide custom versions.

getI18nData

public PieceI18nData getI18nData()

Description copied from class: Decorator

Return Internationalization (I18n) data for this piece

Specified by:

getI18nData in interface TranslatablePiece

Overrides:

getI18nData in class Decorator

Returns:

I18n data, used to hold translations of strings

testEquals

public boolean testEquals(Object o)

Description copied from class: Decorator

Test if this Decorator's Class, Type and State are equal to another trait. Implementations of this method should compare the individual values of the fields that make up the Decorators Type and State. Implementations should NOT compare the values returned by myGetType() or myGetState(). This method is intended to be used by Unit Tests to verify that a trait is unchanged after going through a process such as serialization/deserialization.

Overrides:

testEquals in class Decorator

Parameters:

o - Object to compare this Decorator to

Returns:

true if the Class, type and state all match