Package VASSAL.counters

Class GlobalCommandTarget

java.lang.Object

VASSAL.counters.GlobalCommandTarget

All Implemented Interfaces:

ConfigurerFactory, SearchTarget

public class GlobalCommandTarget
extends Object
implements ConfigurerFactory, SearchTarget

GlobalCommandTarget configures and stores the "Fast Match" parameters of Global Key Commands, allowing certain simple filters to be "pre-matched" without having to initiate the (relatively slower) BeanShell filters.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GlobalCommandTarget.CompareMode	Comparison Modes for property match
static enum	GlobalCommandTarget.GKCtype	Specifies the type of GKC being configured (affects which Target options are allowed)
static enum	GlobalCommandTarget.Target	Specifies the kind of target matching

Field Summary

Fields

Modifier and Type	Field	Description
protected static final char	ENCODE_DELIMITER
protected boolean	fastMatchLocation
protected boolean	fastMatchProperty
protected GlobalCommandTarget.GKCtype	gkcType
protected FormattedStringExpression	targetAttachment
protected FormattedStringExpression	targetAttachmentId
protected FormattedStringExpression	targetBoard
protected GlobalCommandTarget.CompareMode	targetCompare
protected FormattedStringExpression	targetDeck
protected FormattedStringExpression	targetLocation
protected FormattedStringExpression	targetMap
protected FormattedStringExpression	targetProperty
protected GlobalCommandTarget.Target	targetType
protected FormattedStringExpression	targetValue
protected FormattedStringExpression	targetX
protected FormattedStringExpression	targetY
protected FormattedStringExpression	targetZone

Constructor Summary

Constructors

Constructor	Description
GlobalCommandTarget()
GlobalCommandTarget(String s)
GlobalCommandTarget(GlobalCommandTarget gc)
GlobalCommandTarget(GlobalCommandTarget.GKCtype gkc)

Method Summary

Modifier and Type	Method	Description
void	decode(String code)	Decoder for loading GlobalCommandTarget from the module XML
String	encode()	Encoder for the part of GlobalCommandTarget that gets stored in the module
boolean	equals(Object o)	Compares two GlobalCommandTargets
Configurer	getConfigurer(AutoConfigurable c, String key, String name)
GamePiece	getCurPiece()
List<String>	getExpressionList()
List<String>	getFormattedStringList()
GlobalCommandTarget.GKCtype	getGKCtype()
List<String>	getMenuTextList()
List<NamedKeyStroke>	getNamedKeyStrokeList()
List<String>	getPropertyList()
FormattedStringExpression	getTargetAttachment()
FormattedStringExpression	getTargetAttachmentId()
FormattedStringExpression	getTargetBoard()
GlobalCommandTarget.CompareMode	getTargetCompare()
FormattedStringExpression	getTargetDeck()
FormattedStringExpression	getTargetLocation()
FormattedStringExpression	getTargetMap()
FormattedStringExpression	getTargetProperty()
GlobalCommandTarget.Target	getTargetType()
FormattedStringExpression	getTargetValue()
Expression	getTargetX()
Expression	getTargetY()
FormattedStringExpression	getTargetZone()
int	hashCode()
boolean	isFastMatchLocation()
boolean	isFastMatchProperty()
void	setCurPiece(GamePiece curPiece)
void	setFastMatchLocation(boolean fastMatchLocation)
void	setFastMatchProperty(boolean fastMatchProperty)
void	setGKCtype(GlobalCommandTarget.GKCtype gkcType)
void	setTargetAttachment(String targetAttachment)
void	setTargetAttachmentId(String targetAttachmentId)
void	setTargetBoard(String targetBoard)
void	setTargetBoard(FormattedStringExpression targetBoard)
void	setTargetCompare(String targetCompare)
void	setTargetCompare(GlobalCommandTarget.CompareMode targetCompare)
void	setTargetDeck(String targetDeck)
void	setTargetDeck(FormattedStringExpression targetDeck)
void	setTargetLocation(String targetLocation)
void	setTargetLocation(FormattedStringExpression targetLocation)
void	setTargetMap(String targetMap)
void	setTargetMap(FormattedStringExpression targetMap)
void	setTargetProperty(String targetProperty)
void	setTargetProperty(FormattedStringExpression targetProperty)
void	setTargetType(String targetType)
void	setTargetType(GlobalCommandTarget.Target targetType)
void	setTargetValue(String targetValue)
void	setTargetValue(FormattedStringExpression targetValue)
void	setTargetX(int targetX)
void	setTargetX(String targetX)
void	setTargetX(FormattedStringExpression targetX)
void	setTargetY(int targetY)
void	setTargetY(String targetY)
void	setTargetY(FormattedStringExpression targetY)
void	setTargetZone(String targetZone)
void	setTargetZone(FormattedStringExpression targetZone)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

ENCODE_DELIMITER

protected static final char ENCODE_DELIMITER

See Also:

• Constant Field Values

gkcType

protected GlobalCommandTarget.GKCtype gkcType

fastMatchLocation

protected boolean fastMatchLocation

targetType

protected GlobalCommandTarget.Target targetType

targetMap

protected FormattedStringExpression targetMap

targetBoard

protected FormattedStringExpression targetBoard

targetZone

protected FormattedStringExpression targetZone

targetLocation

protected FormattedStringExpression targetLocation

targetDeck

protected FormattedStringExpression targetDeck

targetX

protected FormattedStringExpression targetX

targetY

protected FormattedStringExpression targetY

targetAttachment

protected FormattedStringExpression targetAttachment

targetAttachmentId

protected FormattedStringExpression targetAttachmentId

fastMatchProperty

protected boolean fastMatchProperty

targetProperty

protected FormattedStringExpression targetProperty

targetValue

protected FormattedStringExpression targetValue

targetCompare

protected GlobalCommandTarget.CompareMode targetCompare

Constructor Details

GlobalCommandTarget

public GlobalCommandTarget()

GlobalCommandTarget

public GlobalCommandTarget(GlobalCommandTarget.GKCtype gkc)

GlobalCommandTarget

public GlobalCommandTarget(String s)

GlobalCommandTarget

public GlobalCommandTarget(GlobalCommandTarget gc)

Method Details

getConfigurer

public Configurer getConfigurer(AutoConfigurable c,
 String key,
 String name)

Specified by:

getConfigurer in interface ConfigurerFactory

encode

public String encode()

Encoder for the part of GlobalCommandTarget that gets stored in the module

Returns:

Fast Match parameters encoded in string form

decode

public void decode(String code)

Decoder for loading GlobalCommandTarget from the module XML

Parameters:

code - String to decode into our fields.

equals

public boolean equals(Object o)

Compares two GlobalCommandTargets

Overrides:

equals in class Object

Parameters:

o - GlobalCommandTarget to compare to this one

Returns:

true if their meaningful parts are equal

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getExpressionList

public List<String> getExpressionList()

Specified by:

getExpressionList in interface SearchTarget

Returns:

a list of the item's string/expression fields if any (for search)

getFormattedStringList

public List<String> getFormattedStringList()

Specified by:

getFormattedStringList in interface SearchTarget

Returns:

a list of any Message Format strings referenced in the item, if any (for search)

getMenuTextList

public List<String> getMenuTextList()

Specified by:

getMenuTextList in interface SearchTarget

Returns:

a list of any Menu/Button/Tooltip Text strings referenced in the item, if any (for search)

getNamedKeyStrokeList

public List<NamedKeyStroke> getNamedKeyStrokeList()

Specified by:

getNamedKeyStrokeList in interface SearchTarget

Returns:

a list of any Named KeyStrokes referenced in the item, if any (for search)

getPropertyList

public List<String> getPropertyList()

Specified by:

getPropertyList in interface SearchTarget

Returns:

a list of any Property Names referenced in the item, if any (for search)

getGKCtype

public GlobalCommandTarget.GKCtype getGKCtype()

setGKCtype

public void setGKCtype(GlobalCommandTarget.GKCtype gkcType)

isFastMatchLocation

public boolean isFastMatchLocation()

setFastMatchLocation

public void setFastMatchLocation(boolean fastMatchLocation)

isFastMatchProperty

public boolean isFastMatchProperty()

setFastMatchProperty

public void setFastMatchProperty(boolean fastMatchProperty)

getTargetType

public GlobalCommandTarget.Target getTargetType()

setTargetType

public void setTargetType(GlobalCommandTarget.Target targetType)

setTargetType

public void setTargetType(String targetType)

getTargetMap

public FormattedStringExpression getTargetMap()

setTargetMap

public void setTargetMap(FormattedStringExpression targetMap)

setTargetMap

public void setTargetMap(String targetMap)

getTargetBoard

public FormattedStringExpression getTargetBoard()

setTargetBoard

public void setTargetBoard(FormattedStringExpression targetBoard)

setTargetBoard

public void setTargetBoard(String targetBoard)

getTargetZone

public FormattedStringExpression getTargetZone()

setTargetZone

public void setTargetZone(FormattedStringExpression targetZone)

setTargetZone

public void setTargetZone(String targetZone)

getTargetLocation

public FormattedStringExpression getTargetLocation()

setTargetLocation

public void setTargetLocation(FormattedStringExpression targetLocation)

setTargetLocation

public void setTargetLocation(String targetLocation)

getTargetDeck

public FormattedStringExpression getTargetDeck()

setTargetDeck

public void setTargetDeck(FormattedStringExpression targetDeck)

setTargetDeck

public void setTargetDeck(String targetDeck)

getTargetProperty

public FormattedStringExpression getTargetProperty()

setTargetProperty

public void setTargetProperty(FormattedStringExpression targetProperty)

setTargetProperty

public void setTargetProperty(String targetProperty)

getTargetValue

public FormattedStringExpression getTargetValue()

setTargetValue

public void setTargetValue(FormattedStringExpression targetValue)

setTargetValue

public void setTargetValue(String targetValue)

getTargetCompare

public GlobalCommandTarget.CompareMode getTargetCompare()

setTargetCompare

public void setTargetCompare(GlobalCommandTarget.CompareMode targetCompare)

setTargetCompare

public void setTargetCompare(String targetCompare)

getTargetX

public Expression getTargetX()

setTargetX

public void setTargetX(FormattedStringExpression targetX)

setTargetX

public void setTargetX(String targetX)

setTargetX

public void setTargetX(int targetX)

getTargetY

public Expression getTargetY()

setTargetY

public void setTargetY(FormattedStringExpression targetY)

setTargetY

public void setTargetY(String targetY)

setTargetY

public void setTargetY(int targetY)

getTargetAttachment

public FormattedStringExpression getTargetAttachment()

setTargetAttachment

public void setTargetAttachment(String targetAttachment)

getTargetAttachmentId

public FormattedStringExpression getTargetAttachmentId()

setTargetAttachmentId

public void setTargetAttachmentId(String targetAttachmentId)

setCurPiece

public void setCurPiece(GamePiece curPiece)

getCurPiece

public GamePiece getCurPiece()