Package VASSAL.counters

Class SendToLocation

java.lang.Object

VASSAL.counters.Decorator

VASSAL.counters.SendToLocation

All Implemented Interfaces:

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

public class SendToLocation
extends Decorator
implements TranslatablePiece

This trait adds a command that sends a piece to another location. Options for the target location are:

Specified x,y co-ords on a named map/board

The centre of a named Zone on a named map

A named Region on a named map

The location of another counter selected by a Property Match String

A specified grid-location on a given board & map

Once the target location is identified, it can be further offset in the X and Y directions by a set of multipliers. All Input Fields may use $...$ variable names

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SendToLocation.Ed

Field Summary

Fields

Modifier and Type	Field	Description
static String	BACK_MAP
static String	BACK_POINT
protected KeyCommand	backCommand
protected String	backCommandName
protected NamedKeyStroke	backKey
protected FormattedString	boardName
protected KeyCommand[]	command
protected String	commandName
protected String	description
protected static String	DEST_COUNTER
protected static String	DEST_GRIDLOCATION
protected static String	DEST_LOCATION
protected static String[]	DEST_OPTIONS
protected static String	DEST_REGION
protected static String	DEST_ZONE
protected String	destination
protected FormattedString	gridLocation
static String	ID
protected NamedKeyStroke	key
protected FormattedString	mapId
protected PropertyExpression	propertyFilter
protected FormattedString	region
protected KeyCommand	sendCommand
protected FormattedString	x
protected FormattedString	xIndex
protected FormattedString	xOffset
protected FormattedString	y
protected FormattedString	yIndex
protected FormattedString	yOffset
protected FormattedString	zone

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
SendToLocation()
SendToLocation(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
Shape	getShape()	The shape of the piece from the user's viewpoint.
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.
protected Point	offsetDestination(int x, int y, GamePiece outer)

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, keyEvent, 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, keyEvent, 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

BACK_MAP

public static final String BACK_MAP

See Also:

Constant Field Values

BACK_POINT

public static final String BACK_POINT

See Also:

Constant Field Values

DEST_GRIDLOCATION

protected static final String DEST_GRIDLOCATION

See Also:

Constant Field Values

DEST_LOCATION

protected static final String DEST_LOCATION

See Also:

Constant Field Values

DEST_ZONE

protected static final String DEST_ZONE

See Also:

Constant Field Values

DEST_REGION

protected static final String DEST_REGION

See Also:

Constant Field Values

DEST_COUNTER

protected static final String DEST_COUNTER

See Also:

Constant Field Values

DEST_OPTIONS

protected static final String[] DEST_OPTIONS

command

protected KeyCommand[] command

commandName

protected String commandName

backCommandName

protected String backCommandName

key

protected NamedKeyStroke key

backKey

protected NamedKeyStroke backKey

mapId

protected FormattedString mapId

boardName

protected FormattedString boardName

x

protected FormattedString x

xIndex

protected FormattedString xIndex

xOffset

protected FormattedString xOffset

y

protected FormattedString y

yIndex

protected FormattedString yIndex

yOffset

protected FormattedString yOffset

gridLocation

protected FormattedString gridLocation

sendCommand

protected KeyCommand sendCommand

backCommand

protected KeyCommand backCommand

description

protected String description

destination

protected String destination

zone

protected FormattedString zone

region

protected FormattedString region

propertyFilter

protected PropertyExpression propertyFilter

Constructor Details

SendToLocation

public SendToLocation()

SendToLocation

public SendToLocation(String type,
GamePiece inner)

Method Details

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

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

myGetState

public String myGetState()

Specified by:

myGetState in class Decorator

Returns:

the state of this trait alone

See Also:

Decorator.getState()

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)

offsetDestination

protected Point offsetDestination(int x,
int y,
GamePiece outer)

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

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

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

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

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

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