Class GlobalMap.CounterViewer

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.map.CounterDetailViewer

VASSAL.build.module.map.GlobalMap.CounterViewer

All Implemented Interfaces:

DragSourceMotionListener, KeyListener, MouseListener, MouseMotionListener, EventListener, AutoConfigurable, Buildable, Configurable, Drawable, PropertyNameSource, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget

Enclosing class:

GlobalMap

protected class GlobalMap.CounterViewer
extends CounterDetailViewer

Nested Class Summary

Nested classes/interfaces inherited from class CounterDetailViewer

CounterDetailViewer.CounterFormatConfig, CounterDetailViewer.DisplayConfig, CounterDetailViewer.EmptyFormatConfig, CounterDetailViewer.Filter, CounterDetailViewer.MinConfig, CounterDetailViewer.ReportFormatConfig, CounterDetailViewer.TerrainConfig, CounterDetailViewer.Visitor

Modifier and Type	Class	Description
static class	CounterDetailViewer.CounterFormatConfig
static class	CounterDetailViewer.DisplayConfig
static class	CounterDetailViewer.EmptyFormatConfig
protected class	CounterDetailViewer.Filter	Utility class to select the pieces we wish to view.
static class	CounterDetailViewer.MinConfig
static class	CounterDetailViewer.ReportFormatConfig
static class	CounterDetailViewer.TerrainConfig
protected static class	CounterDetailViewer.Visitor

Nested classes/interfaces inherited from interface AutoConfigurable

AutoConfigurable.Util

Modifier and Type	Interface	Description
static class	AutoConfigurable.Util

Field Summary

Fields inherited from class CounterDetailViewer

ALL_LAYERS, ALWAYS, BG_COLOR, bgColor, BORDER_COLOR, BORDER_INNER_THICKNESS, BORDER_THICKNESS, BORDER_WIDTH, borderColor, borderInnerThickness, borderThickness, borderWidth, bounds, CENTER_ALL, CENTER_PIECES_VERTICALLY, CENTER_TEXT, centerAll, centerPiecesVertically, centerText, COMBINE_COUNTER_SUMMARY, combineCounterSummary, COUNTER_REPORT_FORMAT, counterReportFormat, currentMousePosition, delay, DELAY, delayTimer, desc, DESCRIPTION, DISPLAY, displayablePieces, displayableTerrain, displayLayers, displayWhat, DRAW_PIECES, DRAW_PIECES_AT_ZOOM, drawPieces, drawSingleDeprecated, EMPTY_HEX_REPORT_FORMAT, emptyHexReportFormat, ENABLE_HTML, enableHTML, EXC_LAYERS, EXTRA_TEXT_PADDING, extraTextPadding, FG_COLOR, fgColor, FILTER, font, FONT_SIZE, fontSize, GRAPH_SINGLE_DEPRECATED, graphicsVisible, graphicsZoomLevel, hotkey, HOTKEY, IF_ONE, INC_LAYERS, lastPieceBounds, LATEST_VERSION, LAYER_LIST, map, MINIMUM_DISPLAYABLE, minimumDisplayablePieces, mouseInView, NEVER, ONLY_SHOW_FIRST_SUMMARY, onlyShowFirstSummary, PREFERRED_DELAY, PROPERTY_FILTER, propertyFilter, SHOW_DECK, SHOW_DECK_DEPTH, SHOW_DECK_MASKED, SHOW_MOVE_SELECTED, SHOW_NON_MOVABLE, SHOW_NOSTACK, SHOW_ONLY_TOP_OF_STACK, SHOW_OVERLAP, SHOW_TERRAIN_BENEATH, SHOW_TERRAIN_HEIGHT, SHOW_TERRAIN_SNAPPY, SHOW_TERRAIN_TEXT, SHOW_TERRAIN_WIDTH, SHOW_TERRAIN_ZOOM, SHOW_TEXT, SHOW_TEXT_SINGLE_DEPRECATED, showDeck, showDeckDepth, showDeckMasked, showMoveSelected, showNonMovable, showNoStack, showNumberFromDeck, showOnlyTopOfStack, showOverlap, showTerrainBeneath, showTerrainHeight, showTerrainSnappy, showTerrainText, showTerrainWidth, showTerrainZoom, showText, showTextSingleDeprecated, STOP_AFTER_SHOWING, stopAfterShowing, STRETCH_WIDTH_PIECES, STRETCH_WIDTH_SUMMARY, stretchWidthPieces, stretchWidthSummary, SUM, SUMMARY_REPORT_FORMAT, summaryReportFormat, textVisible, TOP_LAYER, UNROTATE_PIECES, unrotatePieces, USE_KEYBOARD, version, VERSION, VERTICAL_BOTTOM_TEXT, VERTICAL_OFFSET, VERTICAL_TOP_TEXT, verticalBottomText, verticalOffset, verticalTopText, view, ZOOM_LEVEL, zoomLevel

Modifier and Type	Field	Description
static final String	ALL_LAYERS
static final String	ALWAYS
static final String	BG_COLOR
protected Color	bgColor
static final String	BORDER_COLOR
static final String	BORDER_INNER_THICKNESS
static final String	BORDER_THICKNESS
static final String	BORDER_WIDTH
protected Color	borderColor
protected int	borderInnerThickness
protected int	borderThickness
protected int	borderWidth
protected Rectangle	bounds
static final String	CENTER_ALL
static final String	CENTER_PIECES_VERTICALLY
static final String	CENTER_TEXT
protected boolean	centerAll
protected boolean	centerPiecesVertically
protected boolean	centerText
static final String	COMBINE_COUNTER_SUMMARY
protected boolean	combineCounterSummary
static final String	COUNTER_REPORT_FORMAT
protected FormattedString	counterReportFormat
protected MouseEvent	currentMousePosition
protected int	delay
static final String	DELAY
protected Timer	delayTimer
protected String	desc
static final String	DESCRIPTION
static final String	DISPLAY
protected List<GamePiece>	displayablePieces
protected boolean	displayableTerrain
protected String[]	displayLayers
protected String	displayWhat
static final String	DRAW_PIECES
static final String	DRAW_PIECES_AT_ZOOM
protected boolean	drawPieces
protected boolean	drawSingleDeprecated
static final String	EMPTY_HEX_REPORT_FORMAT
protected FormattedString	emptyHexReportFormat
static final String	ENABLE_HTML
protected boolean	enableHTML
static final String	EXC_LAYERS
static final String	EXTRA_TEXT_PADDING
protected int	extraTextPadding
static final String	FG_COLOR
protected Color	fgColor
static final String	FILTER
protected Font	font
static final String	FONT_SIZE
protected int	fontSize
static final String	GRAPH_SINGLE_DEPRECATED
protected boolean	graphicsVisible
protected double	graphicsZoomLevel
protected KeyStroke	hotkey
static final String	HOTKEY
static final String	IF_ONE
static final String	INC_LAYERS
protected Rectangle	lastPieceBounds
static final String	LATEST_VERSION
static final String	LAYER_LIST
protected Map	map
static final String	MINIMUM_DISPLAYABLE
protected int	minimumDisplayablePieces
protected boolean	mouseInView
static final String	NEVER
static final String	ONLY_SHOW_FIRST_SUMMARY
protected boolean	onlyShowFirstSummary
static final String	PREFERRED_DELAY
static final String	PROPERTY_FILTER
protected PropertyExpression	propertyFilter
static final String	SHOW_DECK
static final String	SHOW_DECK_DEPTH
static final String	SHOW_DECK_MASKED
static final String	SHOW_MOVE_SELECTED
static final String	SHOW_NON_MOVABLE
static final String	SHOW_NOSTACK
static final String	SHOW_ONLY_TOP_OF_STACK
static final String	SHOW_OVERLAP
static final String	SHOW_TERRAIN_BENEATH
static final String	SHOW_TERRAIN_HEIGHT
static final String	SHOW_TERRAIN_SNAPPY
static final String	SHOW_TERRAIN_TEXT
static final String	SHOW_TERRAIN_WIDTH
static final String	SHOW_TERRAIN_ZOOM
static final String	SHOW_TEXT
static final String	SHOW_TEXT_SINGLE_DEPRECATED
protected boolean	showDeck
protected static int	showDeckDepth	Deprecated, for removal: This API element is subject to removal in a future version.
protected boolean	showDeckMasked
protected boolean	showMoveSelected
protected boolean	showNonMovable
protected boolean	showNoStack
protected int	showNumberFromDeck
protected boolean	showOnlyTopOfStack
protected boolean	showOverlap
protected String	showTerrainBeneath
protected int	showTerrainHeight
protected boolean	showTerrainSnappy
protected FormattedString	showTerrainText
protected int	showTerrainWidth
protected double	showTerrainZoom
protected boolean	showText
protected boolean	showTextSingleDeprecated
static final String	STOP_AFTER_SHOWING
protected boolean	stopAfterShowing
static final String	STRETCH_WIDTH_PIECES
static final String	STRETCH_WIDTH_SUMMARY
protected boolean	stretchWidthPieces
protected boolean	stretchWidthSummary
static final String	SUM
static final String	SUMMARY_REPORT_FORMAT
protected FormattedString	summaryReportFormat
protected boolean	textVisible
static final String	TOP_LAYER
static final String	UNROTATE_PIECES
protected boolean	unrotatePieces
static final String	USE_KEYBOARD
protected String	version
static final String	VERSION
static final String	VERTICAL_BOTTOM_TEXT
static final String	VERTICAL_OFFSET
static final String	VERTICAL_TOP_TEXT
protected int	verticalBottomText
protected int	verticalOffset
protected int	verticalTopText
protected JComponent	view	the JComponent which is repainted when the detail viewer changes
static final String	ZOOM_LEVEL
protected double	zoomLevel

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

Method Summary

Modifier and Type	Method	Description
protected List<GamePiece>	getDisplayablePieces()	Build an ArrayList of pieces to be displayed in order from bottom up, based on selection criteria setup in config.
protected double	getZoom()

Methods inherited from class CounterDetailViewer

addLocalImageNames, addTo, checkUpgrade, dragMouseMoved, draw, draw, drawAboveCounters, drawGraphics, drawLabel, drawLabel, drawLabel, drawText, fixBounds, fixBounds, getAllowableConfigureComponents, getAttributeDescriptions, getAttributeNames, getAttributeTypes, getAttributeValueString, getAttributeVisibility, getBounds, getConfigureName, getConfigurer, getConfigureTypeName, getExpressionList, getFormattedStringList, getHelpFile, getMap, getNamedKeyStrokeList, getPreferredDelay, hideDetails, isDrawingMouseOver, isStopAfterShowing, isTextUnderCounters, keyPressed, keyReleased, keyTyped, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, removeFrom, setAttribute, showDetails, upgrade

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	In case our labels refer to any image files
void	addTo(Buildable b)	Adds this component to its parent.
protected void	checkUpgrade()	Compatibility.
void	dragMouseMoved(DragSourceDragEvent e)
void	draw(Graphics g, Point pt, JComponent comp)
void	draw(Graphics g, Map map)
boolean	drawAboveCounters()
protected void	drawGraphics(Graphics g, Point pt, JComponent comp, List<GamePiece> pieces)
protected void	drawLabel(Graphics g, Point pt, String label, int hAlign, int vAlign)
protected void	drawLabel(Graphics g, Point pt, String label, int hAlign, int vAlign, int objectWidth, int minWidth, int extraBorder, boolean skipBox)
protected void	drawLabel(Graphics g, Point pt, String label, int hAlign, int vAlign, int objectWidth, int minWidth, int extraBorder, boolean skipBox, int extraTop, int extraBottom)	Next, we go to this intermediate method, which deals with a couple of things (like deciding whether we're drawing in HTML mode or not) and then calls the LabelUtils to do the Hard Work.
protected void	drawText(Graphics g, Point pt, JComponent comp, List<GamePiece> pieces)	Label with the location If the counter viewer is being displayed, then place the location name just above the left hand end of the counters.
protected void	fixBounds(List<GamePiece> pieces)
protected void	fixBounds(List<GamePiece> pieces, Graphics g)	Set the bounds field large enough to accommodate the given set of pieces
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
protected Rectangle	getBounds(GamePiece piece)
String	getConfigureName()	ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
static String	getConfigureTypeName()
List<String>	getExpressionList()	SearchTarget
List<String>	getFormattedStringList()	SearchTarget
HelpFile	getHelpFile()
Map	getMap()
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
protected int	getPreferredDelay()
protected void	hideDetails()
static boolean	isDrawingMouseOver()	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isStopAfterShowing()
protected boolean	isTextUnderCounters()
void	keyPressed(KeyEvent e)
void	keyReleased(KeyEvent e)
void	keyTyped(KeyEvent e)
void	mouseClicked(MouseEvent e)
void	mouseDragged(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
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.
protected void	showDetails()
protected void	upgrade()

Methods inherited from class AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getI18nData, getI18nPrefix, getLocalizedConfigureName, getMenuTextList, 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()
ComponentI18nData	getI18nData()
protected String	getI18nPrefix()
String	getLocalizedConfigureName()
List<String>	getMenuTextList()	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

getAllImageNames, getLocalImageNames

Modifier and Type	Method	Description
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

isMandatory, isMovable, isUnique

Modifier and Type	Method	Description
default boolean	isMandatory()	Is this component a reqired component within its parent?
default boolean	isMovable()	Is this component allowed to be moved around the Configure Tree?
default boolean	isUnique()	Does this component need to be unique within it's parent?

Constructor Details

CounterViewer

public CounterViewer()

Method Details

getDisplayablePieces

protected List<GamePiece> getDisplayablePieces()

Description copied from class: CounterDetailViewer

Build an ArrayList of pieces to be displayed in order from bottom up, based on selection criteria setup in config.

Overrides:

getDisplayablePieces in class CounterDetailViewer

getZoom

protected double getZoom()

Overrides:

getZoom in class CounterDetailViewer