Package VASSAL.counters

Class Attachment

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.counters.Decorator

VASSAL.counters.Attachment

All Implemented Interfaces:

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

public class Attachment
extends Decorator
implements TranslatablePiece, RecursionLimiter.Loopable

Trait allowing creation of an "attachment" to one or more other pieces, which can then be sent GKCs very swiftly and whose properties can be easily read (and if a Dynamic Property can also be set with a Set Global Property trait)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Attachment.Ed

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	allowSelfAttach
static final String	ATTACH_COUNT
static final String	ATTACH_LIST
static final String	ATTACH_NAME
protected String	attachCommandName
protected NamedKeyStroke	attachKey
protected String	attachName
protected boolean	autoAttach
static final String	BEFORE_ATTACH_CLEAR
protected static final String[]	BEFORE_ATTACH_KEYS
static final String	BEFORE_ATTACH_NOTHING
protected static final String[]	BEFORE_ATTACH_OPTIONS
protected String	beforeAttach
protected String	clearAllCommandName
protected NamedKeyStroke	clearAllKey
protected String	clearMatchingCommandName
protected PropertyExpression	clearMatchingFilter
protected NamedKeyStroke	clearMatchingKey
protected GlobalCommandTarget	clearTarget
protected KeyCommand[]	command
protected List<GamePiece>	contents
protected String	desc
protected boolean	fixedRange
protected GlobalAttach	globalAttach
static final String	ID
static final String	ON_ATTACH_ATTACH_ALL
static final String	ON_ATTACH_FOLLOW_BACK
protected static final String[]	ON_ATTACH_KEYS
static final String	ON_ATTACH_NOTHING
protected static final String[]	ON_ATTACH_OPTIONS
protected static final String[]	ON_DETACH_KEYS
static final String	ON_DETACH_NOTHING
protected static final String[]	ON_DETACH_OPTIONS
static final String	ON_DETACH_REMOVE
protected String	onAttach
protected String	onDetach
protected PropertyExpression	propertiesFilter
protected int	range
protected String	rangeProperty
protected boolean	restrictRange
protected GlobalCommandTarget	target

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
Attachment()
Attachment(String type, GamePiece inner)

Method Summary

Modifier and Type	Method	Description
Command	attach()	Runs a search using the provided filter (same as a Global Key Command), and any matching pieces become our attachments (stored in our "contents" list)
void	autoAttach(Attachment attach)	Auto-attach to a piece 1.
Rectangle	boundingBox()
Command	clearAll()	Clears all existing attachment(s)
Command	clearMatching()
void	draw(Graphics g, int x, int y, Component obs, double zoom)	Draw this GamePiece
int	getAttachCount()
GamePiece	getAttachedPieceAt(int index)
List<GamePiece>	getAttachList()
static List<GamePiece>	getAttachList(GamePiece piece, String attachmentName)	Return the named attachment list on the supplied GamePiece
String	getAttachName()
String	getBaseDescription()	Support for a basic-name-only description introduced later, so this default retrofits it from the full description if an explicit one is not defined.
List<GamePiece>	getContents()
String	getDescription()	A plain-English description of this type of trait/piece - includes data from fields where appropriate
String	getDescriptionField()	If Decorator contains a description *field*, returns the current contents of it.
PieceEditor	getEditor()
List<String>	getExpressionList()	SearchTarget
HelpFile	getHelpFile()
Object	getLocalizedProperty(Object key)	Returns a localized translation of the specified property value, if available.
List<String>	getMenuTextList()	SearchTarget
String	getName()	The plain English name for this piece
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
Object	getProperty(Object key)	Properties can be associated with a piece -- many may be game-specific, but others are standard, such as the LocationName property exposed by BasicPiece -- and can be read through this interface.
List<String>	getPropertyList()	SearchTarget
List<String>	getPropertyNames()	Return Property names exposed by this trait
GamePiece	getPropertyPiece()
Shape	getShape()
boolean	hasTarget(GamePiece p)
boolean	isAllowSelfAttach()
boolean	isAutoAttach()
Command	makeAddTargetCommand(GamePiece p)	Adds a target and returns a command to duplicate the operation on another client
Command	makeRemoveTargetCommand(GamePiece p)	Removes a piece from our list of targets, and returns a Command to duplicate the changes on another client
protected KeyCommand[]	myGetKeyCommands()
String	myGetState()	The "state information" is "game state" information that can change during the course of a game.
String	myGetType()	The "type information" of a piece or trait is information that does not change during the course of a game.
Command	myKeyEvent(KeyStroke stroke)	The response of this trait alone to the given KeyStroke or the virtual keystroke of a NamedKeyStroke.
void	mySetState(String newState)	Sets the state of this-trait-only (inverse of Decorator.myGetState()).
void	mySetType(String type)	Sets the information for this piece.
void	removeTarget(GamePiece p)	Removes a piece from our list of targets
void	resolvePendingAtttachment(String target)	An attachment could not be satisfied during game load.
void	setContents(List<GamePiece> newContents)
void	setProperty(Object key, Object value)	Within a Trait/Decorator, the default behavior when setting a property is to handle changing our own inner/outer links directly, to cache the selection state (while also passing it inward), and to simply pass every other property change request inward.
boolean	testEquals(Object o)	Test if this Decorator's Class, Type and State are equal to another trait.
String	translatePropertyName(Object key)	Checks if a property reference could be a reference to a property on an attached piece

Methods inherited from class VASSAL.counters.Decorator

addImageNamesRecursively, addMenuCommand, buildDescription, buildDescription, buildDescription, getCommandDesc, getCommandDescription, getComponentName, getComponentTypeName, getDecorator, getDecorators, getFormattedStringList, getI18nData, getI18nData, getI18nData, getId, getInner, getInnermost, getKeyCommands, getLocalizedName, getMap, getOuter, getOutermost, getParent, getPersistentProperty, getPosition, getProperties, getState, getTranslation, getType, isMenuCommand, isSelected, keyEvent, mergeState, putOldProperties, repack, repack, reportDataError, reportDataError, reportDataError, setDynamicProperties, setDynamicProperties, setDynamicProperty, setId, setInner, setMap, setParent, setPersistentProperty, setPosition, setSelected, setState, toString

Methods inherited from class VASSAL.search.AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface VASSAL.script.expression.Auditable

getComponentName, getComponentTypeName

Methods inherited from interface VASSAL.counters.EditablePiece

checkTrueMoved, finishMove, finishMove, prepareMove

Methods inherited from interface VASSAL.counters.GamePiece

getId, getLocalizedName, getMap, getParent, getPosition, getState, getType, keyEvent, setId, setMap, setParent, setPosition, setState

Methods inherited from interface VASSAL.search.ImageSearchTarget

addLocalImageNames, getAllImageNames, getLocalImageNames

Methods inherited from interface VASSAL.counters.PropertyExporter

getProperties

Methods inherited from interface VASSAL.i18n.TranslatablePiece

getI18nData

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

ATTACH_NAME

public static final String ATTACH_NAME

See Also:

• Constant Field Values

ATTACH_LIST

public static final String ATTACH_LIST

See Also:

• Constant Field Values

ATTACH_COUNT

public static final String ATTACH_COUNT

See Also:

• Constant Field Values

BEFORE_ATTACH_NOTHING

public static final String BEFORE_ATTACH_NOTHING

See Also:

• Constant Field Values

BEFORE_ATTACH_CLEAR

public static final String BEFORE_ATTACH_CLEAR

See Also:

• Constant Field Values

BEFORE_ATTACH_OPTIONS

protected static final String[] BEFORE_ATTACH_OPTIONS

BEFORE_ATTACH_KEYS

protected static final String[] BEFORE_ATTACH_KEYS

ON_ATTACH_NOTHING

public static final String ON_ATTACH_NOTHING

See Also:

• Constant Field Values

ON_ATTACH_FOLLOW_BACK

public static final String ON_ATTACH_FOLLOW_BACK

See Also:

• Constant Field Values

ON_ATTACH_ATTACH_ALL

public static final String ON_ATTACH_ATTACH_ALL

See Also:

• Constant Field Values

ON_ATTACH_OPTIONS

protected static final String[] ON_ATTACH_OPTIONS

ON_ATTACH_KEYS

protected static final String[] ON_ATTACH_KEYS

ON_DETACH_NOTHING

public static final String ON_DETACH_NOTHING

See Also:

• Constant Field Values

ON_DETACH_REMOVE

public static final String ON_DETACH_REMOVE

See Also:

• Constant Field Values

ON_DETACH_OPTIONS

protected static final String[] ON_DETACH_OPTIONS

ON_DETACH_KEYS

protected static final String[] ON_DETACH_KEYS

attachName

protected String attachName

desc

protected String desc

contents

protected List<GamePiece> contents

target

protected GlobalCommandTarget target

clearTarget

protected GlobalCommandTarget clearTarget

command

protected KeyCommand[] command

attachCommandName

protected String attachCommandName

attachKey

protected NamedKeyStroke attachKey

globalAttach

protected GlobalAttach globalAttach

propertiesFilter

protected PropertyExpression propertiesFilter

restrictRange

protected boolean restrictRange

fixedRange

protected boolean fixedRange

range

protected int range

rangeProperty

protected String rangeProperty

clearAllCommandName

protected String clearAllCommandName

clearAllKey

protected NamedKeyStroke clearAllKey

clearMatchingCommandName

protected String clearMatchingCommandName

clearMatchingKey

protected NamedKeyStroke clearMatchingKey

clearMatchingFilter

protected PropertyExpression clearMatchingFilter

onAttach

protected String onAttach

onDetach

protected String onDetach

beforeAttach

protected String beforeAttach

allowSelfAttach

protected boolean allowSelfAttach

autoAttach

protected boolean autoAttach

Constructor Details

Attachment

public Attachment()

Attachment

public Attachment(String type,
 GamePiece inner)

Method Details

isAutoAttach

public boolean isAutoAttach()

isAllowSelfAttach

public boolean isAllowSelfAttach()

getAttachList

public static List<GamePiece> getAttachList(GamePiece piece,
 String attachmentName)

Return the named attachment list on the supplied GamePiece

Parameters:

attachmentName - Attachment name to look up

Returns:

List of attached pieces

mySetType

public void mySetType(String type)

Description copied from interface: EditablePiece

Sets the information for this piece. See Decorator.myGetType()

Specified by:

mySetType in interface EditablePiece

Parameters:

type - a serialized configuration string to set the "type information" of this piece, which is information that doesn't change during the course of a single game (e.g. Image Files, Context Menu strings, etc). Typically ready to be processed e.g. by SequenceEncoder.decode()

myGetType

public String myGetType()

Description copied from class: Decorator

The "type information" of a piece or trait is information that does not change during the course of a game. Image file names, context menu strings, etc., all should be reflected in the type. The type information is returned serialized string form, ready to be decoded by a SequenceEncoder#decode.

Specified by:

myGetType in class Decorator

Returns:

the type information of this trait alone

See Also:

• BasicCommandEncoder
• which returns type information for all inward piece members as well

myGetKeyCommands

protected KeyCommand[] myGetKeyCommands()

Specified by:

myGetKeyCommands in class Decorator

Returns:

the key commands for this trait alone

See Also:

• which returns the key commands for this trait AND all inner piece members

myGetState

public String myGetState()

Description copied from class: Decorator

The "state information" is "game state" information that can change during the course of a game. State information is saved when the game is saved and is transferred between players on the server. For example, the relative order of pieces in a stack is state information, but whether the stack is expanded is not.

Specified by:

myGetState in class Decorator

Returns:

the game state information of this trait alone

See Also:

• which returns state information for all inward piece members as well

attach

public Command attach()

Runs a search using the provided filter (same as a Global Key Command), and any matching pieces become our attachments (stored in our "contents" list)

Returns:

Command to replicate action

clearAll

public Command clearAll()

Clears all existing attachment(s)

Returns:

Command to replicate action

clearMatching

public Command clearMatching()

myKeyEvent

public Command myKeyEvent(KeyStroke stroke)

Description copied from class: Decorator

The response of this trait alone to the given KeyStroke or the virtual keystroke of a NamedKeyStroke. NamedKeyStrokes are allocated a unique internal KeyStroke when they are first used in a module, and that KeyStroke is passed up and down the decorator stack to represent them (see NamedKeyStroke.getKeyStroke()).

Specified by:

myKeyEvent in class Decorator

Parameters:

stroke - KeyStroke to apply (to apply a Named Keystroke send NamedKeyStroke.getKeyStroke()

Returns:

Generated Command to reproduce any changes just made to to the game state, or null if no effect

See Also:

• Decorator.keyEvent(javax.swing.KeyStroke)

getContents

public List<GamePiece> getContents()

setContents

public void setContents(List<GamePiece> newContents)

mySetState

public void mySetState(String newState)

Description copied from class: Decorator

Sets the state of this-trait-only (inverse of Decorator.myGetState()). The "state information" is information that can change during the course of a game. State information is saved when the game is saved and is transferred between players on the server. For example, the relative order of pieces in a stack is state information, but whether the stack is expanded is not.

Specified by:

mySetState in class Decorator

Parameters:

newState - New state information serialized in string form, ready to be passed to a SequenceEncoder#decode.

autoAttach

public void autoAttach(Attachment attach)

Auto-attach to a piece 1. We must be in auto-attach mode 2. Must not already be attached to the piece. NOTE: Auto-attach is handled locally by each client, no Commands are generated

Parameters:

attach - Attachment trait within the target piece

resolvePendingAtttachment

public void resolvePendingAtttachment(String target)

An attachment could not be satisfied during game load. Game Load is now finished and the Attachment Manager is calling us to retry that attachment. This does not need to generate any Commands.

Parameters:

target - Id of target piece

hasTarget

public boolean hasTarget(GamePiece p)

Parameters:

p - a particular game piece

Returns:

true if the given piece is on our list of targets

makeAddTargetCommand

public Command makeAddTargetCommand(GamePiece p)

Adds a target and returns a command to duplicate the operation on another client

Parameters:

p - target to add

Returns:

Command that adds the target

removeTarget

public void removeTarget(GamePiece p)

Removes a piece from our list of targets

Parameters:

p - Cargo to remove

makeRemoveTargetCommand

public Command makeRemoveTargetCommand(GamePiece p)

Removes a piece from our list of targets, and returns a Command to duplicate the changes on another client

Parameters:

p - targetGamePiece to be removed

Returns:

Command to remove the piece

boundingBox

public Rectangle boundingBox()

Specified by:

boundingBox in interface GamePiece

Returns:

The area which this GamePiece occupies when drawn at the point (0,0)

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

Parameters:

g - target Graphics object

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

getShape

public Shape getShape()

Specified by:

getShape in interface GamePiece

Returns:

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) -- which to be clear is normally aligned with the CENTER of the piece image -- and must be translated to the actual location where the piece is being drawn. For most ordinary pieces, the shape returned here will simply be equivalent to the bounding box, but see NonRectangular.

getEditor

public PieceEditor getEditor()

Specified by:

getEditor in interface EditablePiece

Overrides:

getEditor in class Decorator

Returns:

the configurer for this trait - the dialog which allows the editing the piece's type information. Default configurer is a SimplePieceEditor, but many traits will want to provide custom versions.

getDescription

public String getDescription()

Description copied from interface: EditablePiece

A plain-English description of this type of trait/piece - includes data from fields where appropriate

Specified by:

getDescription in interface EditablePiece

getBaseDescription

public String getBaseDescription()

Description copied from interface: EditablePiece

Support for a basic-name-only description introduced later, so this default retrofits it from the full description if an explicit one is not defined.

Specified by:

getBaseDescription in interface EditablePiece

Returns:

name of trait/piece type, w/o additional data

getDescriptionField

public String getDescriptionField()

Description copied from class: Decorator

If Decorator contains a description *field*, returns the current contents of it.

Overrides:

getDescriptionField in class Decorator

Returns:

contents of "description" field, if it exists.

getPropertyPiece

public GamePiece getPropertyPiece()

Returns:

first piece in our list of attachments that still exists (hasn't been deleted), or null if none

translatePropertyName

public String translatePropertyName(Object key)

Checks if a property reference could be a reference to a property on an attached piece

Parameters:

key - Property name to be checked if it's an attachment reference (it's a reference if it is attachName_propertyName

Returns:

propertyName for use in reading property from attached piece, if the key referenced a valid attachment property. (null otherwise)

getAttachName

public String getAttachName()

getAttachCount

public int getAttachCount()

Returns:

number of attached pieces, not counting any that have since been deleted (from the game).

getAttachedPieceAt

public GamePiece getAttachedPieceAt(int index)

Parameters:

index - index (0-based)

Returns:

the attached piece at a given index (0-based)

getAttachList

public List<GamePiece> getAttachList()

Returns:

A list of attached pieces, not counting any that have since been deleted (from the game)

getProperty

public Object getProperty(Object key)

Description copied from class: Decorator

Properties can be associated with a piece -- many may be game-specific, but others are standard, such as the LocationName property exposed by BasicPiece -- and can be read through this interface. The properties may or may not need to be encoded in the piece's Decorator.getState() method. Properties include the value of e.g. Marker Traits, DynamicProperty Traits, and so forth. Furthermore they include the values of any visible "Global Property" in a Vassal module, whether at the module level, map level, or zone level -- but these "higher level" properties, coming from "outside the piece", CANNOT be written to by the Decorator.setProperty(java.lang.Object, java.lang.Object) method even though they can be read by this method -- in this sense the two methods are NOT perfect mirrors.

Within a Trait/Decorator, default behavior is to process some requests directly (e.g. requests for our "inner" or "outer" link), process our *part* of certain other requests (e.g. request for our game state information we supply state information for this trait and then append any information obtained from passing the same request inward), and then for any other requests that we cannot process we simply pass the request to the next trait/member inward.

When using this interface a piece's own properties are preferred to those of "Global Properties", and those in turn are searched Zone-first then Map, then Module.

This method implements the PropertySource interface, which allows Global Properties to be read by other types of object than GamePieces.

Specified by:

getProperty in interface GamePiece

Specified by:

getProperty in interface PropertySource

Overrides:

getProperty in class Decorator

Parameters:

key - String key of property to be returned

Returns:

Object containing new value of the specified property

getLocalizedProperty

public Object getLocalizedProperty(Object key)

Description copied from class: Decorator

Returns a localized translation of the specified property value, if available. Otherwise returns the non-localized version. See Decorator.getProperty(java.lang.Object).

Specified by:

getLocalizedProperty in interface PropertySource

Overrides:

getLocalizedProperty in class Decorator

Parameters:

key - String key of property to be returned

Returns:

Object containing localized text of the specified property, if available, otherwise non-localized value

setProperty

public void setProperty(Object key,
 Object value)

Description copied from class: Decorator

Within a Trait/Decorator, the default behavior when setting a property is to handle changing our own inner/outer links directly, to cache the selection state (while also passing it inward), and to simply pass every other property change request inward. A Trait with its own properties to maintain would intercept and process those requests, while sending the rest inward to the next member of the piece.

Properties can be associated with a piece -- many may be game-specific, but others are standard, such as the LocationName property exposed by BasicPiece -- and can be set through this interface. The properties may or may not need to be encoded in the piece's Decorator.getState() method. Properties include the value of e.g. Marker Traits, DynamicProperty Traits, and so forth.

NOTE: Not all properties maintained by traits can be "set" by setProperty, even though they can be read by getProperty -- they may be "read only" for instance. You will need to check the code for individual traits to see what they support in this regard.

NOTE: Properties outside the piece CANNOT be set by this method (e.g. Global Properties), even though they can be read by Decorator.getProperty(java.lang.Object) -- in this the two methods are not perfect mirrors.

Specified by:

setProperty in interface GamePiece

Overrides:

setProperty in class Decorator

Parameters:

key - String key of property to be changed

value - Object containing new value of the property

testEquals

public boolean testEquals(Object o)

Description copied from class: Decorator

Test if this Decorator's Class, Type and State are equal to another trait. Implementations of this method should compare the individual values of the fields that make up the Decorators Type and State. Implementations should NOT compare the values returned by myGetType() or myGetState(). This method is intended to be used by Unit Tests to verify that a trait is unchanged after going through a process such as serialization/deserialization.

Overrides:

testEquals in class Decorator

Parameters:

o - Object to compare this Decorator to

Returns:

true if the Class, type and state all match

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface EditablePiece

Returns:

the help file for this trait

getPropertyNames

public List<String> getPropertyNames()

Return Property names exposed by this trait

Specified by:

getPropertyNames in interface PropertyNameSource

Overrides:

getPropertyNames in class Decorator

Returns:

List of property names "exposed" by this piece -- that are available to other Traits and components to read. Default behavior for a Trait is not to expose any properties, but Traits which should expose some (e.g. DynamicProperty or Marker) would provide an array of the property names here.

getExpressionList

public List<String> getExpressionList()

SearchTarget

Specified by:

getExpressionList in interface SearchTarget

Overrides:

getExpressionList in class Decorator

Returns:

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

getMenuTextList

public List<String> getMenuTextList()

SearchTarget

Specified by:

getMenuTextList in interface SearchTarget

Overrides:

getMenuTextList in class Decorator

Returns:

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

getNamedKeyStrokeList

public List<NamedKeyStroke> getNamedKeyStrokeList()

SearchTarget

Specified by:

getNamedKeyStrokeList in interface SearchTarget

Overrides:

getNamedKeyStrokeList in class Decorator

Returns:

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

getPropertyList

public List<String> getPropertyList()

SearchTarget

Specified by:

getPropertyList in interface SearchTarget

Overrides:

getPropertyList in class Decorator

Returns:

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