Package VASSAL.counters

Class TriggerAction

java.lang.Object

VASSAL.counters.Decorator

VASSAL.counters.TriggerAction

All Implemented Interfaces:

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

public class TriggerAction
extends Decorator
implements TranslatablePiece, RecursionLimiter.Loopable

Macro Execute a series of Keystrokes against this same piece - Triggered by own KeyCommand or list of keystrokes - Match against an optional Property Filter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TriggerAction.Ed

Field Summary

Fields

Modifier and Type	Field	Description
protected NamedKeyStroke[]	actionKeys
protected String	command
static String	ID
protected boolean	index
protected String	indexProperty
protected FormattedString	indexStart
protected FormattedString	indexStep
protected int	indexValue
protected NamedKeyStroke	key
protected boolean	loop
protected FormattedString	loopCount
protected String	loopType
protected String	name
protected GamePiece	outer
protected NamedKeyStroke	postLoopKey
protected NamedKeyStroke	preLoopKey
protected PropertyExpression	propertyMatch
protected PropertyExpression	untilExpression
protected NamedKeyStroke[]	watchKeys
protected PropertyExpression	whileExpression

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
TriggerAction()
TriggerAction(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)
protected Command	doLoopOnce()
void	draw(Graphics g, int x, int y, Component obs, double zoom)	Draw this GamePiece
protected Command	executeKey(NamedKeyStroke key)
String	getComponentName()
String	getComponentTypeName()
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
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.
protected boolean	isIndex()
Command	keyEvent(KeyStroke stroke)	Apply key commands to inner pieces first
protected boolean	matchesFilter()
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.
void	setCommandName(String s)
void	setKey(NamedKeyStroke k)
void	setPropertyMatch(String s)

Methods inherited from class VASSAL.counters.Decorator

getCommandDescription, getDecorator, getI18nData, getI18nData, getId, getInner, getInnermost, getKeyCommands, getLocalizedName, getMap, getOuter, getOutermost, getParent, getPersistentProperty, getPosition, getProperties, getState, getTranslation, getType, isSelected, 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, 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

name

protected String name

command

protected String command

key

protected NamedKeyStroke key

propertyMatch

protected PropertyExpression propertyMatch

watchKeys

protected NamedKeyStroke[] watchKeys

actionKeys

protected NamedKeyStroke[] actionKeys

loop

protected boolean loop

preLoopKey

protected NamedKeyStroke preLoopKey

postLoopKey

protected NamedKeyStroke postLoopKey

loopType

protected String loopType

whileExpression

protected PropertyExpression whileExpression

untilExpression

protected PropertyExpression untilExpression

loopCount

protected FormattedString loopCount

index

protected boolean index

indexProperty

protected String indexProperty

indexStart

protected FormattedString indexStart

indexStep

protected FormattedString indexStep

indexValue

protected int indexValue

outer

protected GamePiece outer

Constructor Details

TriggerAction

public TriggerAction()

TriggerAction

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

keyEvent

public Command keyEvent(KeyStroke stroke)

Apply key commands to inner pieces first

Specified by:

keyEvent in interface GamePiece

Overrides:

keyEvent in class Decorator

Parameters:

stroke -

Returns:

See Also:

ForwardToKeyBuffer

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)

isIndex

protected boolean isIndex()

getProperty

public Object getProperty(Object key)

Specified by:

getProperty in interface GamePiece

Specified by:

getProperty in interface PropertySource

Overrides:

getProperty in class Decorator

getLocalizedProperty

public Object getLocalizedProperty(Object key)

Specified by:

getLocalizedProperty in interface PropertySource

Overrides:

getLocalizedProperty in class Decorator

doLoopOnce

protected Command doLoopOnce()
                      throws RecursionLimitException

Throws:

RecursionLimitException

executeKey

protected Command executeKey(NamedKeyStroke key)

matchesFilter

protected boolean matchesFilter()

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

getPropertyNames

public List<String> getPropertyNames()

Return Property names exposed by this trait

Specified by:

getPropertyNames in interface PropertyNameSource

Overrides:

getPropertyNames in class Decorator

setPropertyMatch

public void setPropertyMatch(String s)

setCommandName

public void setCommandName(String s)

setKey

public void setKey(NamedKeyStroke k)

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

getComponentName

public String getComponentName()

Specified by:

getComponentName in interface RecursionLimiter.Loopable

getComponentTypeName

public String getComponentTypeName()

Specified by:

getComponentTypeName in interface RecursionLimiter.Loopable