Package VASSAL.counters

Class Immobilized

java.lang.Object

VASSAL.counters.Decorator

VASSAL.counters.Immobilized

All Implemented Interfaces:

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

public class Immobilized
extends Decorator
implements EditablePiece

Decorator that filters events to prevent a GamePiece from being selected and/or moved. Note: The Alt selection filter was originally implemented as a ctl-shift filter, but this conflicts with the standard counter selection interface and has not worked since v3.0.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	Immobilized.MoveIfSelected
class	Immobilized.UseAlt
class	Immobilized.UseShift

Field Summary

Fields

Modifier and Type	Field	Description
protected static char	ALT_BAND_SELECT
protected static char	ALT_SELECT
protected boolean	altToBandSelect
protected boolean	altToSelect
protected EventFilter	bandselectFilter
static String	ID
protected static char	IGNORE_GRID
protected boolean	ignoreGrid
protected static char	MOVE_NORMAL
protected static char	MOVE_SELECTED
protected EventFilter	moveFilter
protected boolean	moveIfSelected
protected static EventFilter	NEVER
protected static char	NEVER_BAND_SELECT
protected static char	NEVER_MOVE
protected static char	NEVER_SELECT
protected boolean	neverBandSelect
protected boolean	neverMove
protected boolean	neverSelect
protected EventFilter	selectFilter
protected static char	SHIFT_SELECT
protected boolean	shiftToSelect

Fields inherited from class VASSAL.counters.Decorator

piece

Fields inherited from interface VASSAL.counters.PropertyExporter

LOCALIZED_NAME

Constructor Summary

Constructors

Constructor	Description
Immobilized()
Immobilized(String type, GamePiece p)
Immobilized(GamePiece p, String type)	Deprecated. Use Immobilized(String, GamePiece) instead.

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()
Object	getLocalizedProperty(Object key)
String	getName()	The plain English name for this piece
Object	getProperty(Object key)
List<String>	getPropertyNames()	Return Property names exposed by this trait
Shape	getShape()	The shape of the piece from the user's viewpoint.
KeyCommand[]	myGetKeyCommands()
String	myGetState()
String	myGetType()
Command	myKeyEvent(KeyStroke e)	The response of this trait alone to the given KeyStroke
void	mySetState(String s)	Set just the state of this trait
void	mySetType(String type)	Set the type information for this piece.

Methods inherited from class VASSAL.counters.Decorator

getCommandDescription, getDecorator, getI18nData, getI18nData, getI18nData, getId, getInner, getInnermost, getKeyCommands, getLocalizedName, getMap, getOuter, getOutermost, getParent, getPersistentProperty, getPosition, getProperties, 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, getState, getType, keyEvent, setId, setMap, setParent, setPosition, setProperty, setState

Methods inherited from interface VASSAL.counters.PropertyExporter

getProperties

Field Details

ID

public static final String ID

See Also:

Constant Field Values

shiftToSelect

protected boolean shiftToSelect

altToSelect

protected boolean altToSelect

ignoreGrid

protected boolean ignoreGrid

neverSelect

protected boolean neverSelect

neverMove

protected boolean neverMove

moveIfSelected

protected boolean moveIfSelected

neverBandSelect

protected boolean neverBandSelect

altToBandSelect

protected boolean altToBandSelect

selectFilter

protected EventFilter selectFilter

moveFilter

protected EventFilter moveFilter

bandselectFilter

protected EventFilter bandselectFilter

MOVE_SELECTED

protected static final char MOVE_SELECTED

See Also:

Constant Field Values

MOVE_NORMAL

protected static final char MOVE_NORMAL

See Also:

Constant Field Values

NEVER_MOVE

protected static final char NEVER_MOVE

See Also:

Constant Field Values

IGNORE_GRID

protected static final char IGNORE_GRID

See Also:

Constant Field Values

SHIFT_SELECT

protected static final char SHIFT_SELECT

See Also:

Constant Field Values

ALT_SELECT

protected static final char ALT_SELECT

See Also:

Constant Field Values

NEVER_SELECT

protected static final char NEVER_SELECT

See Also:

Constant Field Values

NEVER_BAND_SELECT

protected static final char NEVER_BAND_SELECT

See Also:

Constant Field Values

ALT_BAND_SELECT

protected static final char ALT_BAND_SELECT

See Also:

Constant Field Values

NEVER

protected static EventFilter NEVER

Constructor Details

Immobilized

public Immobilized()

Immobilized

@Deprecated
public Immobilized(GamePiece p,
String type)

Deprecated.

Use Immobilized(String, GamePiece) instead.

Immobilized

public Immobilized(String type,
GamePiece p)

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

getName

public String getName()

Description copied from interface: GamePiece

The plain English name for this piece

Specified by:

getName in interface GamePiece

myGetKeyCommands

public KeyCommand[] myGetKeyCommands()

Specified by:

myGetKeyCommands in class Decorator

Returns:

the commands for this trait alone

See Also:

Decorator.getKeyCommands()

myKeyEvent

public Command myKeyEvent(KeyStroke e)

Description copied from class: Decorator

The response of this trait alone to the given KeyStroke

Specified by:

myKeyEvent in class Decorator

Parameters:

e - Stroke to apply

Returns:

Generated Command or null if no effect

See Also:

Decorator.keyEvent(javax.swing.KeyStroke)

getLocalizedProperty

public Object getLocalizedProperty(Object key)

Specified by:

getLocalizedProperty in interface PropertySource

Overrides:

getLocalizedProperty in class Decorator

getProperty

public Object getProperty(Object key)

Specified by:

getProperty in interface GamePiece

Specified by:

getProperty in interface PropertySource

Overrides:

getProperty in class Decorator

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.

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

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

myGetType

public String myGetType()

Specified by:

myGetType in class Decorator

Returns:

the type of this trait alone

See Also:

Decorator.getType()

myGetState

public String myGetState()

Specified by:

myGetState in class Decorator

Returns:

the state of this trait alone

See Also:

Decorator.getState()

mySetState

public void mySetState(String s)

Description copied from class: Decorator

Set just the state of this trait

Specified by:

mySetState in class Decorator

See Also:

Decorator.myGetState()

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

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

getPropertyNames

public List<String> getPropertyNames()

Return Property names exposed by this trait

Specified by:

getPropertyNames in interface PropertyNameSource

Overrides:

getPropertyNames in class Decorator