Class Replace

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.counters.Decorator

VASSAL.counters.PlaceMarker

VASSAL.counters.Replace

All Implemented Interfaces:

PropertyNameSource, PropertySource, EditablePiece, GamePiece, PropertyExporter, StateMergeable, TranslatablePiece, PersistentPropertyContainer, Auditable, ImageSearchTarget, SearchTarget, RecursionLimiter.Loopable

public class Replace
extends PlaceMarker

GamePiece trait that replaces a GamePiece with another one

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	Replace.Ed

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID

Fields inherited from class PlaceMarker

above, ABOVE, afterBurnerKey, BELOW, command, commands, copyDPsByName, description, descString, gpId, gpidSupport, key, markerSpec, markerText, matchRotation, newGpId, parameterList, PARENT_ID, PLACEMARKER_VERSION, placement, STACK_BOTTOM, STACK_TOP, version, xOffset, xOffsetExpression, yOffset, yOffsetExpression

Modifier and Type	Field	Description
protected boolean	above
protected static final int	ABOVE
protected NamedKeyStroke	afterBurnerKey
protected static final int	BELOW
protected KeyCommand	command
protected KeyCommand[]	commands
protected boolean	copyDPsByName
protected String	description
protected String	descString
protected String	gpId
protected GpIdSupport	gpidSupport
protected NamedKeyStroke	key
protected String	markerSpec
protected String	markerText
protected boolean	matchRotation
protected String	newGpId
protected List<Parameter>	parameterList
static final String	PARENT_ID
static final int	PLACEMARKER_VERSION
protected int	placement
protected static final int	STACK_BOTTOM
protected static final int	STACK_TOP
protected int	version
protected int	xOffset
protected FormattedStringExpression	xOffsetExpression
protected int	yOffset
protected FormattedStringExpression	yOffsetExpression

Fields inherited from class Decorator

piece

Modifier and Type	Field	Description
protected GamePiece	piece

Fields inherited from interface PropertyExporter

LOCALIZED_NAME

Modifier and Type	Field	Description
static final String	LOCALIZED_NAME

Fields inherited from interface TranslatablePiece

PREFIX

Modifier and Type	Field	Description
static final String	PREFIX

Constructor Summary

Constructors

Constructor	Description
Replace()
Replace(String type, GamePiece inner)

Method Summary

Modifier and Type	Method	Description
GamePiece	createMarker()	The marker, with prototypes fully expanded
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	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()
HelpFile	getHelpFile()
PieceI18nData	getI18nData()	Return Internationalization (I18n) data for this piece
List<String>	getPropertyNames()
protected void	matchTraits(GamePiece base, GamePiece marker)	Match trait states from the supplied base Decorator to the marker - Markers are never matched - Dynamic Properties are matched on Name only - All other traits matched on full Type
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.
protected Command	replacePiece()
protected void	selectMarker(GamePiece marker)

Methods inherited from class PlaceMarker

addImageNamesRecursively, boundingBox, createBaseMarker, draw, getExpressionList, getGpId, getMenuTextList, getName, getNamedKeyStrokeList, getPropertyList, getShape, isMarkerStandalone, myGetKeyCommands, myGetState, mySetState, mySetType, placeMarker, placeMarker, setGpId, testEquals, updateDescString, updateGpId, updateGpId

Modifier and Type	Method	Description
void	addImageNamesRecursively(Collection<String> s)	ImageSearchTarget Adds all images used by this component AND any children to the collection
Rectangle	boundingBox()
GamePiece	createBaseMarker()	The marker, with prototypes unexpanded
void	draw(Graphics g, int x, int y, Component obs, double zoom)	Draw this GamePiece
List<String>	getExpressionList()	SearchTarget
String	getGpId()
List<String>	getMenuTextList()	SearchTarget
String	getName()	The plain English name for this piece
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
List<String>	getPropertyList()	SearchTarget
Shape	getShape()
boolean	isMarkerStandalone()
protected KeyCommand[]	myGetKeyCommands()
String	myGetState()	The "state information" is "game state" information that can change during the course of a game.
void	mySetState(String newState)	Sets the state of this-trait-only (inverse of Decorator.myGetState()).
void	mySetType(String type)	Sets the information for this piece.
protected Command	placeMarker()
protected Command	placeMarker(boolean clearParentId)
void	setGpId(String s)
boolean	testEquals(Object o)	Test if this Decorator's Class, Type and State are equal to another trait.
void	updateDescString()
void	updateGpId()
void	updateGpId(GpIdSupport s)

Methods inherited from class Decorator

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

Modifier and Type	Method	Description
protected void	addMenuCommand(List<KeyCommand> list, String menuText, NamedKeyStroke keyStroke)	If text/keystroke pair is valid, add it to the provided list
protected String	buildDescription(String i18nKey)
protected String	buildDescription(String i18nKey, String description)	Build a description of a trait of the form Type - Description Where Type is the translated trait type description and Description is a supplied additional description
protected String	buildDescription(String i18nKey, String value, String description)	Build a description of a trait of the form Type - value - Description
String	getCommandDesc(String command, NamedKeyStroke key)
protected String	getCommandDescription(String description, String command)
String	getComponentName()	Return the name of the GamePiece this Decorator is a part of.
String	getComponentTypeName()	Return a description of the Type of trait or Component an Auditable is
static GamePiece	getDecorator(GamePiece p, Class<?> type)
static List<GamePiece>	getDecorators(GamePiece p, Class<?> type)
List<String>	getFormattedStringList()	SearchTarget
protected PieceI18nData	getI18nData(String[] commands, String[] descriptions)
protected PieceI18nData	getI18nData(String command, String description)
String	getId()	Each GamePiece must have a unique String identifier
GamePiece	getInner()
static GamePiece	getInnermost(GamePiece p)
protected KeyCommand[]	getKeyCommands()
String	getLocalizedName()	And the translated name for this piece
Object	getLocalizedProperty(Object key)	Returns a localized translation of the specified property value, if available.
Map	getMap()
Decorator	getOuter()
static GamePiece	getOutermost(GamePiece p)
Stack	getParent()
Object	getPersistentProperty(Object key)
Point	getPosition()
Map<String,Object>	getProperties(Map<String,Object> result)	Implement PropertyExporter.getProperties at the Decorator level.
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.
String	getState()
protected String	getTranslation(String key)
String	getType()	The type of a Decorator/Trait is a composition of Decorator.myGetType() and the type information of its inner piece member(s).
protected boolean	isMenuCommand(String menuText, NamedKeyStroke keystroke)
protected boolean	isSelected()	Support caching Selection status locally
Command	keyEvent(KeyStroke stroke)	The primary way for the piece or trait to receive events.
void	mergeState(String newState, String oldState)	Compute the difference between newState and oldState and apply that difference to the current state.
static Command	putOldProperties(GamePiece p)	* Set the Oldxxxx properties related to movement (e.g.
static void	repack(Component c)	Utility methods to allow Decorator Editors to repack themselves.
static void	repack(Configurer c)	Utility methods to allow Decorator Editors to repack themselves.
protected static void	reportDataError(EditablePiece piece, String message)	Report a Data Error detected by a trait
protected static void	reportDataError(EditablePiece piece, String message, String data)	Report a Data Error detected by a trait
protected static void	reportDataError(EditablePiece piece, String message, String data, Throwable e)	Report a Data Error detected by a trait
static Command	setDynamicProperties(List<Parameter> parameters, GamePiece piece, PropertySource source, Auditable owner)	Find and set a series of Dynamic Properties in the supplied GamePiece named propertyName and generate a Command to set it to the specified values in other clients
static Command	setDynamicProperties(List<Parameter> parameters, GamePiece piece, PropertySource source, Auditable owner, AuditTrail auditSoFar)
static Command	setDynamicProperty(String propertyName, String value, GamePiece piece, PropertySource source, Auditable owner, AuditTrail audit)	Find a Dynamic Property in the supplied GamePiece named propertyName and generate a Command to set it to the specified value
void	setId(String id)	Each GamePiece must have a unique String identifier
void	setInner(GamePiece p)
void	setMap(Map m)
void	setParent(Stack s)
Command	setPersistentProperty(Object key, Object val)	Default behavior for a Trait/Decorator is to pass requests to set persistent properties inward to the next member of the piece.
void	setPosition(Point p)
void	setProperty(Object key, Object val)	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.
protected void	setSelected(boolean b)	Support caching Selection status locally
void	setState(String newState)	Extract the string describing this trait's state and forward the remaining string to the inner piece.
String	toString()

Methods inherited from class AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	Classes extending AbstractImageFinder should override this method in order to add the names of any image files they use to the collection.
SortedSet<String>	getAllImageNames()
SortedSet<String>	getLocalImageNames()

Methods inherited from class Object

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

Methods inherited from interface EditablePiece

checkTrueMoved, finishMove, finishMove, prepareMove

Modifier and Type	Method	Description
default Command	checkTrueMoved()	Centralized method used when finishing up after a piece moves.
default Command	finishMove(Command c, boolean afterburner, boolean findmat)
default Command	finishMove(Command c, boolean afterburner, boolean findmat, boolean mark_moved)	Centralized method for finishing up after a piece moves.
default Command	prepareMove(Command c, boolean mark_moved)	Centralized method for preparing a piece to move.

Methods inherited from interface PropertyExporter

getProperties

Modifier and Type	Method	Description
default Map<String,Object>	getProperties()	Return a Map of properties

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

Constructor Details

Replace

public Replace()

Replace

public Replace(String type,
 GamePiece inner)

Method Details

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

Overrides:

myKeyEvent in class PlaceMarker

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

replacePiece

protected Command replacePiece()

selectMarker

protected void selectMarker(GamePiece marker)

Overrides:

selectMarker in class PlaceMarker

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

Overrides:

getDescription in class PlaceMarker

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

Overrides:

getBaseDescription in class PlaceMarker

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 PlaceMarker

Returns:

contents of "description" field, if it exists.

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface EditablePiece

Overrides:

getHelpFile in class PlaceMarker

Returns:

the help file for this trait

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.

Overrides:

myGetType in class PlaceMarker

Returns:

the type information of this trait alone

See Also:

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

getEditor

public PieceEditor getEditor()

Specified by:

getEditor in interface EditablePiece

Overrides:

getEditor in class PlaceMarker

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.

createMarker

public GamePiece createMarker()

Description copied from class: PlaceMarker

The marker, with prototypes fully expanded

Overrides:

createMarker in class PlaceMarker

Returns:

new Marker

matchTraits

protected void matchTraits(GamePiece base,
 GamePiece marker)

Match trait states from the supplied base Decorator to the marker - Markers are never matched - Dynamic Properties are matched on Name only - All other traits matched on full Type

Parameters:

base - Decorator in Base marker to start matching

marker - Marker to set matched values into

getPropertyNames

public List<String> getPropertyNames()

Specified by:

getPropertyNames in interface PropertyNameSource

Overrides:

getPropertyNames in class PlaceMarker

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.

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 PlaceMarker

Returns:

I18n data, used to hold translations of strings