Class BorderOutline

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.counters.Decorator

VASSAL.counters.BorderOutline

All Implemented Interfaces:

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

public class BorderOutline
extends Decorator
implements TranslatablePiece

Trait to draw a colored border around a piece

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BorderOutline.LogicalCompareMode	Comparison Modes for property match

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID

Fields inherited from class Decorator

piece

Modifier and Type	Field	Description
protected GamePiece	piece

Fields inherited from interface PropertyExporter

LOCALIZED_NAME

Modifier and Type	Field	Description
static final String	LOCALIZED_NAME

Fields inherited from interface TranslatablePiece

PREFIX

Modifier and Type	Field	Description
static final String	PREFIX

Constructor Summary

Constructors

Constructor	Description
BorderOutline()
BorderOutline(String type, GamePiece p)

Method Summary

Modifier and Type	Method	Description
Rectangle	boundingBox()
protected boolean	checkProperties()
protected boolean	checkProperty(String name)
void	draw(Graphics g, int x, int y, Component obs, double zoom)	Draw this GamePiece
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.
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()
HelpFile	getHelpFile()
Object	getLocalizedProperty(Object key)	Returns a localized translation of the specified property value, if available.
String	getName()	The plain English name for this piece
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
Shape	getShape()
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	setDescription(String description)
boolean	testEquals(Object o)	Test if this Decorator's Class, Type and State are equal to another trait.

Methods inherited from class Decorator

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

Modifier and Type	Method	Description
void	addImageNamesRecursively(Collection<String> s)	ImageSearchTarget Adds all images used by this component AND any children to the collection
protected void	addMenuCommand(List<KeyCommand> list, String menuText, NamedKeyStroke keyStroke)	If text/keystroke pair is valid, add it to the provided list
protected String	buildDescription(String i18nKey)
protected String	buildDescription(String i18nKey, String description)	Build a description of a trait of the form Type - Description Where Type is the translated trait type description and Description is a supplied additional description
protected String	buildDescription(String i18nKey, String value, String description)	Build a description of a trait of the form Type - value - Description
String	getCommandDesc(String command, NamedKeyStroke key)
protected String	getCommandDescription(String description, String command)
String	getComponentName()	Return the name of the GamePiece this Decorator is a part of.
String	getComponentTypeName()	Return a description of the Type of trait or Component an Auditable is
static GamePiece	getDecorator(GamePiece p, Class<?> type)
static List<GamePiece>	getDecorators(GamePiece p, Class<?> type)
List<String>	getExpressionList()	SearchTarget
List<String>	getFormattedStringList()	SearchTarget
PieceI18nData	getI18nData()	Return Internationalization (I18n) data for this piece
protected PieceI18nData	getI18nData(String[] commands, String[] descriptions)
protected PieceI18nData	getI18nData(String command, String description)
String	getId()	Each GamePiece must have a unique String identifier
GamePiece	getInner()
static GamePiece	getInnermost(GamePiece p)
protected KeyCommand[]	getKeyCommands()
String	getLocalizedName()	And the translated name for this piece
Map	getMap()
List<String>	getMenuTextList()	SearchTarget
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
Decorator	getOuter()
static GamePiece	getOutermost(GamePiece p)
Stack	getParent()
Object	getPersistentProperty(Object key)
Point	getPosition()
Map<String,Object>	getProperties(Map<String,Object> result)	Implement PropertyExporter.getProperties at the Decorator level.
List<String>	getPropertyNames()
String	getState()
protected String	getTranslation(String key)
String	getType()	The type of a Decorator/Trait is a composition of Decorator.myGetType() and the type information of its inner piece member(s).
protected boolean	isMenuCommand(String menuText, NamedKeyStroke keystroke)
protected boolean	isSelected()	Support caching Selection status locally
Command	keyEvent(KeyStroke stroke)	The primary way for the piece or trait to receive events.
void	mergeState(String newState, String oldState)	Compute the difference between newState and oldState and apply that difference to the current state.
static Command	putOldProperties(GamePiece p)	* Set the Oldxxxx properties related to movement (e.g.
static void	repack(Component c)	Utility methods to allow Decorator Editors to repack themselves.
static void	repack(Configurer c)	Utility methods to allow Decorator Editors to repack themselves.
protected static void	reportDataError(EditablePiece piece, String message)	Report a Data Error detected by a trait
protected static void	reportDataError(EditablePiece piece, String message, String data)	Report a Data Error detected by a trait
protected static void	reportDataError(EditablePiece piece, String message, String data, Throwable e)	Report a Data Error detected by a trait
static Command	setDynamicProperties(List<Parameter> parameters, GamePiece piece, PropertySource source, Auditable owner)	Find and set a series of Dynamic Properties in the supplied GamePiece named propertyName and generate a Command to set it to the specified values in other clients
static Command	setDynamicProperties(List<Parameter> parameters, GamePiece piece, PropertySource source, Auditable owner, AuditTrail auditSoFar)
static Command	setDynamicProperty(String propertyName, String value, GamePiece piece, PropertySource source, Auditable owner, AuditTrail audit)	Find a Dynamic Property in the supplied GamePiece named propertyName and generate a Command to set it to the specified value
void	setId(String id)	Each GamePiece must have a unique String identifier
void	setInner(GamePiece p)
void	setMap(Map m)
void	setParent(Stack s)
Command	setPersistentProperty(Object key, Object val)	Default behavior for a Trait/Decorator is to pass requests to set persistent properties inward to the next member of the piece.
void	setPosition(Point p)
void	setProperty(Object key, Object val)	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.
protected void	setSelected(boolean b)	Support caching Selection status locally
void	setState(String newState)	Extract the string describing this trait's state and forward the remaining string to the inner piece.
String	toString()

Methods inherited from class AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	Classes extending AbstractImageFinder should override this method in order to add the names of any image files they use to the collection.
SortedSet<String>	getAllImageNames()
SortedSet<String>	getLocalImageNames()

Methods inherited from class Object

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

Methods inherited from interface EditablePiece

checkTrueMoved, finishMove, finishMove, prepareMove

Modifier and Type	Method	Description
default Command	checkTrueMoved()	Centralized method used when finishing up after a piece moves.
default Command	finishMove(Command c, boolean afterburner, boolean findmat)
default Command	finishMove(Command c, boolean afterburner, boolean findmat, boolean mark_moved)	Centralized method for finishing up after a piece moves.
default Command	prepareMove(Command c, boolean mark_moved)	Centralized method for preparing a piece to move.

Methods inherited from interface PropertyExporter

getProperties

Modifier and Type	Method	Description
default Map<String,Object>	getProperties()	Return a Map of properties

Methods inherited from interface TranslatablePiece

getI18nData

Modifier and Type	Method	Description
PieceI18nData	getI18nData()	Return a PieceI18nData object returning the I18n data about this GamePiece.

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

Constructor Details

BorderOutline

public BorderOutline()

BorderOutline

public BorderOutline(String type,
 GamePiece p)

Method Details

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

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.

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

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

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(KeyStroke)

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.

boundingBox

public Rectangle boundingBox()

Specified by:

boundingBox in interface GamePiece

Returns:

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

getName

public String getName()

Description copied from interface: GamePiece

The plain English name for this piece

Specified by:

getName in interface GamePiece

checkProperty

protected boolean checkProperty(String name)

checkProperties

protected boolean checkProperties()

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.

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.

setDescription

public void setDescription(String description)

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface EditablePiece

Returns:

the help file for this trait

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.

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

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(Object, 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(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

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)