Class HandMetrics

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.map.StackMetrics

VASSAL.build.module.map.HandMetrics

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget

public class HandMetrics
extends StackMetrics

Handles the drawing of cards in a PlayerHand. Lays out the cards horizontally with no overlap and even spacing.

Nested Class Summary

Nested classes/interfaces inherited from interface AutoConfigurable

AutoConfigurable.Util

Modifier and Type	Interface	Description
static class	AutoConfigurable.Util

Field Summary

Fields inherited from class StackMetrics

blankColor, BOTTOM_KEY, bottomKey, COLOR, DEFAULT_EXSEP_X, DEFAULT_EXSEP_Y, DEFAULT_UNEXSEP_X, DEFAULT_UNEXSEP_Y, disabled, DISABLED, DOWN_KEY, downKey, EXSEP_X, EXSEP_Y, exSepX, exSepY, map, selectedVisible, TOP_KEY, topKey, UNEXSEP_X, UNEXSEP_Y, unexSepX, unexSepY, unselectedVisible, UP_KEY, upKey

Modifier and Type	Field	Description
protected Color	blankColor
static final String	BOTTOM_KEY
protected KeyStroke	bottomKey
static final String	COLOR
static final int	DEFAULT_EXSEP_X
static final int	DEFAULT_EXSEP_Y
static final int	DEFAULT_UNEXSEP_X
static final int	DEFAULT_UNEXSEP_Y
protected boolean	disabled
static final String	DISABLED
static final String	DOWN_KEY
protected KeyStroke	downKey
static final String	EXSEP_X
static final String	EXSEP_Y
protected int	exSepX
protected int	exSepY
protected Map	map
protected PieceFilter	selectedVisible
static final String	TOP_KEY
protected KeyStroke	topKey
static final String	UNEXSEP_X
static final String	UNEXSEP_Y
protected int	unexSepX
protected int	unexSepY
protected PieceFilter	unselectedVisible
static final String	UP_KEY
protected KeyStroke	upKey

Fields inherited from class AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Modifier and Type	Field	Description
protected PropertyChangeSupport	changeSupport
protected Configurer	config
protected String	localizedName
protected ComponentI18nData	myI18nData
protected String	name

Fields inherited from class AbstractBuildable

buildComponents, validator

Modifier and Type	Field	Description
protected List<Buildable>	buildComponents
protected ValidityChecker	validator

Fields inherited from interface Configurable

NAME_PROPERTY

Modifier and Type	Field	Description
static final String	NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
HandMetrics()

Method Summary

Modifier and Type	Method	Description
void	draw(Stack stack, Graphics g, int x, int y, Component obs, double zoom)	Different instances of StackMetrics may render a Stack in different ways.
void	draw(Stack stack, Point location, Graphics g, Map map, double zoom, Rectangle visibleRect)	Draw only those pieces in the target stack whose boundingBoxes fall within the given visibleRect This method is considerably faster than the other draw method.
Command	merge(GamePiece fixed, GamePiece moving)	Place a GamePiece on top of another GamePiece Create/remove stacks as necessary, even if stacking is disabled for this instance
protected void	nextPosition(Point currentPos, Rectangle currentBounds, Point nextPos, Rectangle nextBounds, int dx, int dy)

Methods inherited from class StackMetrics

addTo, createStack, createStack, drawUnexpanded, getAllowableConfigureComponents, getAttributeDescriptions, getAttributeNames, getAttributeTypes, getAttributeValueString, getAttributeVisibility, getBlankColor, getConfigureName, getConfigureTypeName, getContents, getHelpFile, getMoveBottomKey, getMoveDownKey, getMoveTopKey, getMoveUpKey, isMandatory, isStackingEnabled, isUnique, placeOrMerge, relativePosition, removeFrom, setAttribute

Modifier and Type	Method	Description
void	addTo(Buildable b)	Adds this component to its parent.
Stack	createStack(GamePiece p)
Stack	createStack(GamePiece p, boolean force)
protected void	drawUnexpanded(GamePiece p, Graphics g, int x, int y, Component obs, double zoom)	Draw a GamePiece that is not the top piece in an unexpanded Stack Default implementation is a white square with a black border
Class<?>[]	getAllowableConfigureComponents()
String[]	getAttributeDescriptions()	Return an array of Strings describing the attributes of this object.
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
Class<?>[]	getAttributeTypes()	Return the Class for the attributes of this object.
String	getAttributeValueString(String name)	Called by the Buildable.getBuildElement(Document) method to write the attributes into an XML element
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
Color	getBlankColor()	The color used to draw boxes representing counters beneath the top one in a stack.
String	getConfigureName()	ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.
static String	getConfigureTypeName()
int	getContents(Stack parent, Point[] positions, Shape[] shapes, Rectangle[] boundingBoxes, int x, int y)	Fill the argument arrays with the positions, selection bounds and bounding boxes of the pieces in the argument stack
HelpFile	getHelpFile()
KeyStroke	getMoveBottomKey()
KeyStroke	getMoveDownKey()
KeyStroke	getMoveTopKey()
KeyStroke	getMoveUpKey()
boolean	isMandatory()	Is this component a reqired component within its parent?
boolean	isStackingEnabled()
boolean	isUnique()	Does this component need to be unique within it's parent?
Command	placeOrMerge(GamePiece fixed, GamePiece moving)	Merge the two pieces if stacking is enabled.
Point	relativePosition(Stack parent, GamePiece c)
void	removeFrom(Buildable parent)	Remove this component from its parent
void	setAttribute(String name, Object value)	Sets a buildFile (XML) attribute value for this component.

Methods inherited from class AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getConfigurer, getExpressionList, getFormattedStringList, getI18nData, getI18nPrefix, getLocalizedConfigureName, getMenuTextList, getNamedKeyStrokeList, getPropertyList, getTypeName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Modifier and Type	Method	Description
void	add(Buildable b)	Set the owning translatable of this component
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener.
Configurable[]	getConfigureComponents()
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
List<String>	getExpressionList()	SearchTarget
List<String>	getFormattedStringList()	SearchTarget
ComponentI18nData	getI18nData()
protected String	getI18nPrefix()
String	getLocalizedConfigureName()
List<String>	getMenuTextList()	SearchTarget
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
List<String>	getPropertyList()	SearchTarget
String	getTypeName()	Returns the name of the configurable type for display purposes.
void	remove(Buildable b)	Remove a Buildable object from this object
void	removePropertyChangeListener(PropertyChangeListener l)
protected void	setAllAttributesUntranslatable()	Sets all attributes untranslatable.
protected void	setAttributeTranslatable(String attr, boolean b)	Over-ride the default attribute translatability.
void	setConfigureName(String s)	Sets the name and fires a PropertyChangeEvent

Methods inherited from class AbstractBuildable

addImageNamesRecursively, build, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, getPropertyNames, setAncestor, validate

Modifier and Type	Method	Description
void	addImageNamesRecursively(Collection<String> s)	Adds all images used by this component AND any subcomponents to the collection
void	build(Element e)	Build this component by getting all XML attributes of the XML element and calling AbstractBuildable.setAttribute(String, Object) with the String value of the attribute
String	buildString()
<T> List<T>	getAllDescendantComponentsOf(Class<T> target)	Recursively descend the build tree and return a List of all components that are instances of the given class
Buildable	getAncestor()
List<Buildable>	getBuildables()
Enumeration<Buildable>	getBuildComponents()	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getBuildables() instead.
Element	getBuildElement(Document doc)
<T> Enumeration<T>	getComponents(Class<T> target)	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getComponentsOf(Class) instead.
<T> List<T>	getComponentsOf(Class<T> target)
Buildable	getNonFolderAncestor()
List<String>	getPropertyNames()	Override this method to provide a list of properties to be exposed for use by expressions in the module.
void	setAncestor(Buildable ancestor)
void	validate(Buildable target, ValidationReport report)

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, toString, wait, wait, wait

Methods inherited from interface Auditable

getComponentName, getComponentTypeName

Modifier and Type	Method	Description
default String	getComponentName()	Return the name of the trait or Component an Auditable is
default String	getComponentTypeName()	Return a description of the Type of trait or Component an Auditable is

Methods inherited from interface Buildable

isMovable

Modifier and Type	Method	Description
default boolean	isMovable()	Is this component allowed to be moved around the Configure Tree?

Constructor Details

HandMetrics

public HandMetrics()

Method Details

draw

public void draw(Stack stack,
 Graphics g,
 int x,
 int y,
 Component obs,
 double zoom)

Description copied from class: StackMetrics

Different instances of StackMetrics may render a Stack in different ways. The default algorithm is: If not expanded, all but the top visible GamePiece is drawn as a white square with size given by GamePiece.getShape(). The separation between GamePieces is given by StackMetrics.relativePosition(Stack, GamePiece) If expanded, all GamePieces are drawn with separation given by StackMetrics.relativePosition(Stack, GamePiece). GamePiece that are selected are drawn in front of other GamePieces, even those above them in the stack.

Overrides:

draw in class StackMetrics

draw

public void draw(Stack stack,
 Point location,
 Graphics g,
 Map map,
 double zoom,
 Rectangle visibleRect)

Description copied from class: StackMetrics

Draw only those pieces in the target stack whose boundingBoxes fall within the given visibleRect This method is considerably faster than the other draw method.

Overrides:

draw in class StackMetrics

Parameters:

stack -

location - the location of the stack in component coordinates

g -

zoom -

visibleRect - the visible rectangle in component coordinates

nextPosition

protected void nextPosition(Point currentPos,
 Rectangle currentBounds,
 Point nextPos,
 Rectangle nextBounds,
 int dx,
 int dy)

Overrides:

nextPosition in class StackMetrics

merge

public Command merge(GamePiece fixed,
 GamePiece moving)

Description copied from class: StackMetrics

Place a GamePiece on top of another GamePiece Create/remove stacks as necessary, even if stacking is disabled for this instance

Overrides:

merge in class StackMetrics

Parameters:

fixed - the GamePiece defining the location and contents of the existing stack

moving - the GamePiece that will be merged into the stack

Returns:

a Command that accomplishes this task