Package VASSAL.counters

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, 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 String	ID

Fields inherited from class VASSAL.counters.PlaceMarker

above, ABOVE, afterBurnerKey, BELOW, command, commands, description, gpId, gpidSupport, key, markerSpec, markerText, matchRotation, newGpId, placement, STACK_BOTTOM, STACK_TOP, xOffset, yOffset

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

Method Summary

Modifier and Type	Method	Description
GamePiece	createMarker()	The marker, with prototypes fully expanded
String	getDescription()	A plain-English description of this type of piece
PieceEditor	getEditor()
HelpFile	getHelpFile()
PieceI18nData	getI18nData()	Return Internationalization (I18n) data for this piece
protected void	matchTraits(GamePiece base, GamePiece marker)
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 VASSAL.counters.PlaceMarker

addImageNamesRecursively, boundingBox, createBaseMarker, draw, getComponentName, getComponentTypeName, getGpId, getMenuTextList, getName, getNamedKeyStrokeList, getShape, isMarkerStandalone, myGetKeyCommands, myGetState, mySetState, mySetType, placeMarker, setGpId, testEquals, updateGpId, updateGpId

Methods inherited from class VASSAL.counters.Decorator

buildDescription, buildDescription, buildDescription, getCommandDescription, getDecorator, getExpressionList, getFormattedStringList, getI18nData, getI18nData, getId, getInner, getInnermost, getKeyCommands, getLocalizedName, getLocalizedProperty, getMap, getOuter, getOutermost, getParent, getPersistentProperty, getPosition, getProperties, getProperty, getPropertyList, getPropertyNames, getState, getTranslation, getType, isSelected, keyEvent, mergeState, putOldProperties, repack, repack, reportDataError, reportDataError, reportDataError, setId, setInner, setMap, setOldProperties, setOldProperties, setParent, setPersistentProperty, setPosition, setProperty, 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.counters.GamePiece

getId, getLocalizedName, getMap, getParent, getPosition, getProperty, getState, getType, keyEvent, setId, setMap, setParent, setPosition, setProperty, setState

Methods inherited from interface VASSAL.search.ImageSearchTarget

addLocalImageNames, getAllImageNames, getLocalImageNames

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

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(javax.swing.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 piece

Specified by:

getDescription in interface EditablePiece

Overrides:

getDescription in class PlaceMarker

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)

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