Package VASSAL.counters

Class PlaceMarker

java.lang.Object

VASSAL.counters.Decorator

VASSAL.counters.PlaceMarker

All Implemented Interfaces:

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

Direct Known Subclasses:

Replace

public class PlaceMarker
extends Decorator
implements TranslatablePiece

This Decorator defines a key command to places another counter on top of this one.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	PlaceMarker.Ed

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	above
protected static int	ABOVE
protected NamedKeyStroke	afterBurnerKey
protected static int	BELOW
protected KeyCommand	command
protected KeyCommand[]	commands
protected String	description
protected String	gpId
protected GpIdSupport	gpidSupport
static String	ID
protected NamedKeyStroke	key
protected String	markerSpec
protected String	markerText
protected boolean	matchRotation
protected String	newGpId
protected int	placement
protected static int	STACK_BOTTOM
protected static int	STACK_TOP
protected int	xOffset
protected int	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
PlaceMarker()
PlaceMarker(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)
GamePiece	createBaseMarker()	The marker, with prototypes unexpanded
GamePiece	createMarker()	The marker, with prototypes fully expanded
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
String	getGpId()
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.
boolean	isMarkerStandalone()
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 Command	placeMarker()
protected void	selectMarker(GamePiece marker)
void	setGpId(String s)
void	updateGpId()
void	updateGpId(GpIdSupport s)

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

command

protected KeyCommand command

key

protected NamedKeyStroke key

markerSpec

protected String markerSpec

markerText

protected String markerText

xOffset

protected int xOffset

yOffset

protected int yOffset

matchRotation

protected boolean matchRotation

commands

protected KeyCommand[] commands

afterBurnerKey

protected NamedKeyStroke afterBurnerKey

description

protected String description

gpId

protected String gpId

newGpId

protected String newGpId

gpidSupport

protected GpIdSupport gpidSupport

STACK_TOP

protected static final int STACK_TOP

See Also:

Constant Field Values

STACK_BOTTOM

protected static final int STACK_BOTTOM

See Also:

Constant Field Values

ABOVE

protected static final int ABOVE

See Also:

Constant Field Values

BELOW

protected static final int BELOW

See Also:

Constant Field Values

placement

protected int placement

above

protected boolean above

Constructor Details

PlaceMarker

public PlaceMarker()

PlaceMarker

public PlaceMarker(String type,
GamePiece inner)

Method Details

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

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

myGetType

public String myGetType()

Specified by:

myGetType in class Decorator

Returns:

the type of this trait alone

See Also:

Decorator.getType()

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)

placeMarker

protected Command placeMarker()

selectMarker

protected void selectMarker(GamePiece marker)

createMarker

public GamePiece createMarker()

The marker, with prototypes fully expanded

Returns:

new Marker

createBaseMarker

public GamePiece createBaseMarker()

The marker, with prototypes unexpanded

Returns:

New Base Marker

isMarkerStandalone

public boolean isMarkerStandalone()

Returns:

true if the marker is defined from scratch. Return false if the marker is defined as a component in the Game Piece Palette

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

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

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

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

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

getGpId

public String getGpId()

setGpId

public void setGpId(String s)

updateGpId

public void updateGpId(GpIdSupport s)

updateGpId

public void updateGpId()