Class DeckGlobalKeyCommand.DeckGlobalCommand

java.lang.Object

VASSAL.counters.GlobalCommand

VASSAL.build.module.map.DeckGlobalKeyCommand.DeckGlobalCommand

All Implemented Interfaces:

Auditable

Enclosing class:

DeckGlobalKeyCommand

public static class DeckGlobalKeyCommand.DeckGlobalCommand
extends GlobalCommand

Nested Class Summary

Nested classes/interfaces inherited from class GlobalCommand

GlobalCommand.IndexedFastmatchDeckPolicyManager, GlobalCommand.Visitor

Modifier and Type	Class	Description
protected class	GlobalCommand.IndexedFastmatchDeckPolicyManager	A class to manage the application of GKC's against multiple Decks by the Fast Match Code that uses Location indexes.
protected class	GlobalCommand.Visitor

Field Summary

Fields inherited from class GlobalCommand

keyStroke, owner, parameters, reportFormat, reportSingle, selectFromDeck, selectFromDeckExpression, source, suppressSounds, target

Modifier and Type	Field	Description
protected KeyStroke	keyStroke
protected RecursionLimiter.Loopable	owner
protected List<Parameter>	parameters
protected FormattedString	reportFormat
protected boolean	reportSingle
protected int	selectFromDeck
protected String	selectFromDeckExpression
protected PropertySource	source
protected boolean	suppressSounds
protected GlobalCommandTarget	target

Constructor Summary

Constructors

Constructor	Description
DeckGlobalCommand(RecursionLimiter.Loopable l)

Method Summary

Modifier and Type	Method	Description
Command	apply(Deck d, PieceFilter filter)
String	getComponentTypeName()	Return a description of the Type of trait or Component an Auditable is

Methods inherited from class GlobalCommand

apply, apply, apply, apply, apply, apply, checkForMatchingAttachments, equals, getComponentName, getKeyStroke, getParameters, getPropertySource, getReportFormat, getSelectFromDeck, getSelectFromDeckExpression, getTarget, getVisitor, hashCode, isAbortIfNoCommand, isReportSingle, isSuppressSounds, setKeyStroke, setKeyStroke, setParameters, setPropertySource, setRange, setReportFormat, setReportSingle, setSelectFromDeck, setSelectFromDeckExpression, setSuppressSounds, setTarget

Modifier and Type	Method	Description
Command	apply(Map[] maps, PieceFilter filter)	(Legacy - applies GKC without Fast Match)
Command	apply(Map[] maps, PieceFilter filter, GlobalCommandTarget fastMatch)	Apply the key command to all pieces that pass the given filter and our Fast Match GlobalCommandTarget parameters on all the given maps
Command	apply(Map[] maps, PieceFilter filter, GlobalCommandTarget fastMatch, AuditTrail audit)	Apply the key command to all pieces that pass the given filter and our Fast Match GlobalCommandTarget parameters on all the given maps
Command	apply(Map map, PieceFilter filter)	(Legacy - applies GKC without Fast Match)
Command	apply(Map map, PieceFilter filter, GlobalCommandTarget fastMatch)	Apply the key command on ONE SPECIFIC MAP to all pieces that pass the given filter and our Fast Match parameters.
Command	apply(Map map, PieceFilter filter, GlobalCommandTarget fastMatch, AuditTrail audit)
protected void	checkForMatchingAttachments(Attachment attach, String attachmentName, String attachmentId, Set<GamePiece> pieces)
boolean	equals(Object obj)
String	getComponentName()	Return the name of the trait or Component an Auditable is
KeyStroke	getKeyStroke()
List<Parameter>	getParameters()
PropertySource	getPropertySource()
String	getReportFormat()
int	getSelectFromDeck()
String	getSelectFromDeckExpression()
GlobalCommandTarget	getTarget()
protected GlobalCommandVisitor	getVisitor(Command command, PieceFilter filter, KeyStroke keyStroke, AuditTrail audit, Auditable owner, int selectFromDeck)
int	hashCode()
boolean	isAbortIfNoCommand()	Allows subclasses like GlobalAttach to operate with no key command to send
boolean	isReportSingle()
boolean	isSuppressSounds()
void	setKeyStroke(KeyStroke keyStroke)
void	setKeyStroke(NamedKeyStroke keyStroke)
void	setParameters(List<Parameter> parameters)
void	setPropertySource(PropertySource ps)
void	setRange(Integer fastRange)
void	setReportFormat(String format)
void	setReportSingle(boolean reportSingle)
void	setSelectFromDeck(int selectFromDeck)	Set the number of pieces to select from a deck that the command will apply to.
void	setSelectFromDeckExpression(String selectFromDeck)	Set the number of pieces to select from a deck that the command will apply to.
void	setSuppressSounds(boolean suppressSounds)
void	setTarget(GlobalCommandTarget target)

Methods inherited from class Object

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

Constructor Details

DeckGlobalCommand

public DeckGlobalCommand(RecursionLimiter.Loopable l)

Method Details

getComponentTypeName

public String getComponentTypeName()

Description copied from interface: Auditable

Return a description of the Type of trait or Component an Auditable is

Specified by:

getComponentTypeName in interface Auditable

Overrides:

getComponentTypeName in class GlobalCommand

Returns:

Component Type

apply

public Command apply(Deck d,
 PieceFilter filter)