VASSAL.build.module.map.CounterDetailViewer

All Implemented Interfaces:: DragSourceMotionListener, KeyListener, MouseListener, MouseMotionListener, EventListener, AutoConfigurable, Buildable, Configurable, Drawable, PropertyNameSource, ValidityChecker, Translatable

Direct Known Subclasses:: GlobalMap.CounterViewer

public class CounterDetailViewer
extends AbstractConfigurable
implements Drawable, DragSourceMotionListener, MouseMotionListener, MouseListener, KeyListener

This is a Drawable class that draws the counters horizontally when the mouse is held over a stack with the control key down.

Version:: 1.0
Author:: David Sullivan

Nested Class Summary

Nested Classes
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`
`protected static class`	`CounterDetailViewer.Visitor`

Nested classes/interfaces inherited from interface VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ALL_LAYERS`
`static String`	`ALWAYS_SHOW_LOC`
`protected boolean`	`alwaysShowLoc`
`static String`	`BG_COLOR`
`protected Color`	`bgColor`
`static String`	`BORDER_WIDTH`
`protected int`	`borderWidth`
`protected Rectangle`	`bounds`
`static String`	`COUNTER_REPORT_FORMAT`
`protected FormattedString`	`counterReportFormat`
`protected MouseEvent`	`currentMousePosition`
`protected int`	`delay`
`static String`	`DELAY`
`protected Timer`	`delayTimer`
`static String`	`DISPLAY`
`protected List<GamePiece>`	`displayablePieces`
`protected String[]`	`displayLayers`
`protected String`	`displayWhat`
`static String`	`DRAW_PIECES`
`static String`	`DRAW_PIECES_AT_ZOOM`
`protected boolean`	`drawPieces`
`protected boolean`	`drawSingleDeprecated`
`static String`	`EMPTY_HEX_REPORT_FORMAT`
`protected FormattedString`	`emptyHexReportFormat`
`static String`	`EXC_LAYERS`
`static String`	`FG_COLOR`
`protected Color`	`fgColor`
`static String`	`FILTER`
`protected Font`	`font`
`static String`	`FONT_SIZE`
`protected int`	`fontSize`
`static String`	`GRAPH_SINGLE_DEPRECATED`
`protected boolean`	`graphicsVisible`
`protected double`	`graphicsZoomLevel`
`protected KeyStroke`	`hotkey`
`static String`	`HOTKEY`
`static String`	`INC_LAYERS`
`static String`	`LATEST_VERSION`
`static String`	`LAYER_LIST`
`protected Map`	`map`
`static String`	`MINIMUM_DISPLAYABLE`
`protected int`	`minimumDisplayablePieces`
`protected boolean`	`mouseInView`
`static String`	`PREFERRED_DELAY`
`static String`	`PROPERTY_FILTER`
`protected PropertyExpression`	`propertyFilter`
`static String`	`SHOW_DECK`
`static String`	`SHOW_MOVE_SELECTED`
`static String`	`SHOW_NON_MOVABLE`
`static String`	`SHOW_NOSTACK`
`static String`	`SHOW_TEXT`
`static String`	`SHOW_TEXT_SINGLE_DEPRECATED`
`protected boolean`	`showDeck`
`protected boolean`	`showMoveSelected`
`protected boolean`	`showNonMovable`
`protected boolean`	`showNoStack`
`protected boolean`	`showText`
`protected boolean`	`showTextSingleDeprecated`
`static String`	`SUM`
`static String`	`SUMMARY_REPORT_FORMAT`
`protected FormattedString`	`summaryReportFormat`
`protected boolean`	`textVisible`
`static String`	`TOP_LAYER`
`static String`	`UNROTATE_PIECES`
`protected boolean`	`unrotatePieces`
`static String`	`USE_KEYBOARD`
`protected String`	`version`
`static String`	`VERSION`
`protected JComponent`	`view`	the JComponent which is repainted when the detail viewer changes
`static String`	`ZOOM_LEVEL`
`protected double`	`zoomLevel`

Fields inherited from class VASSAL.build.AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

Constructors

Constructor Description

CounterDetailViewer()

Method Summary

Modifier and Type	Method	Description
`void`	`addTo(Buildable b)`	Adds this component to its parent.
`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`	`drawText(Graphics g, Point pt, JComponent comp, List<GamePiece> pieces)`
`protected void`	`fixBounds(List<GamePiece> pieces)`	Set the bounds field large enough to accommodate the given set of pieces
`Class<?>[]`	`getAllowableConfigureComponents()`	Return a list of valid sub-component Classes.
`String[]`	`getAttributeDescriptions()`	Return an array of Strings describing the attributes of this object.
`String[]`	`getAttributeNames()`
`Class<?>[]`	`getAttributeTypes()`	Return the Class for the attributes of this object.
`String`	`getAttributeValueString(String name)`	Return a String representation of the attribute with the given name.
`VisibilityCondition`	`getAttributeVisibility(String name)`	By default, all attributes are visible
`protected Rectangle`	`getBounds(GamePiece piece)`
`Configurer`	`getConfigurer()`	The default `Configurer` of an `AbstractConfigurable` class is an instance of `AutoConfigurer`
`static String`	`getConfigureTypeName()`
`protected List<GamePiece>`	`getDisplayablePieces()`	Build an ArrayList of pieces to be displayed in order from bottom up, based on selection criteria setup in config.
`HelpFile`	`getHelpFile()`
`protected int`	`getPreferredDelay()`
`protected double`	`getZoom()`
`protected void`	`hideDetails()`
`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 an attribute value for this component.
`protected void`	`showDetails()`
`protected void`	`upgrade()`

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getConfigureName, getI18nData, getI18nPrefix, getLocalizedConfigureName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

build, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponentsOf, getPropertyNames, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.build.Buildable

build, getBuildElement

Field Details
- LATEST_VERSION
  
  public static final String LATEST_VERSION
  
  See Also:
  
  Constant Field Values
- USE_KEYBOARD
  
  public static final String USE_KEYBOARD
  
  See Also:
  
  Constant Field Values
- PREFERRED_DELAY
  
  public static final String PREFERRED_DELAY
  
  See Also:
  
  Constant Field Values
- DELAY
  
  public static final String DELAY
  
  See Also:
  
  Constant Field Values
- ALWAYS_SHOW_LOC
  
  public static final String ALWAYS_SHOW_LOC
  
  See Also:
  
  Constant Field Values
- DRAW_PIECES
  
  public static final String DRAW_PIECES
  
  See Also:
  
  Constant Field Values
- GRAPH_SINGLE_DEPRECATED
  
  public static final String GRAPH_SINGLE_DEPRECATED
  
  See Also:
  
  Constant Field Values
- MINIMUM_DISPLAYABLE
  
  public static final String MINIMUM_DISPLAYABLE
  
  See Also:
  
  Constant Field Values
- HOTKEY
  
  public static final String HOTKEY
  
  See Also:
  
  Constant Field Values
- SHOW_TEXT
  
  public static final String SHOW_TEXT
  
  See Also:
  
  Constant Field Values
- SHOW_TEXT_SINGLE_DEPRECATED
  
  public static final String SHOW_TEXT_SINGLE_DEPRECATED
  
  See Also:
  
  Constant Field Values
- ZOOM_LEVEL
  
  public static final String ZOOM_LEVEL
  
  See Also:
  
  Constant Field Values
- DRAW_PIECES_AT_ZOOM
  
  public static final String DRAW_PIECES_AT_ZOOM
  
  See Also:
  
  Constant Field Values
- BORDER_WIDTH
  
  public static final String BORDER_WIDTH
  
  See Also:
  
  Constant Field Values
- SHOW_NOSTACK
  
  public static final String SHOW_NOSTACK
  
  See Also:
  
  Constant Field Values
- SHOW_MOVE_SELECTED
  
  public static final String SHOW_MOVE_SELECTED
  
  See Also:
  
  Constant Field Values
- SHOW_NON_MOVABLE
  
  public static final String SHOW_NON_MOVABLE
  
  See Also:
  
  Constant Field Values
- SHOW_DECK
  
  public static final String SHOW_DECK
  
  See Also:
  
  Constant Field Values
- UNROTATE_PIECES
  
  public static final String UNROTATE_PIECES
  
  See Also:
  
  Constant Field Values
- DISPLAY
  
  public static final String DISPLAY
  
  See Also:
  
  Constant Field Values
- LAYER_LIST
  
  public static final String LAYER_LIST
  
  See Also:
  
  Constant Field Values
- SUMMARY_REPORT_FORMAT
  
  public static final String SUMMARY_REPORT_FORMAT
  
  See Also:
  
  Constant Field Values
- COUNTER_REPORT_FORMAT
  
  public static final String COUNTER_REPORT_FORMAT
  
  See Also:
  
  Constant Field Values
- EMPTY_HEX_REPORT_FORMAT
  
  public static final String EMPTY_HEX_REPORT_FORMAT
  
  See Also:
  
  Constant Field Values
- VERSION
  
  public static final String VERSION
  
  See Also:
  
  Constant Field Values
- FG_COLOR
  
  public static final String FG_COLOR
  
  See Also:
  
  Constant Field Values
- BG_COLOR
  
  public static final String BG_COLOR
  
  See Also:
  
  Constant Field Values
- FONT_SIZE
  
  public static final String FONT_SIZE
  
  See Also:
  
  Constant Field Values
- PROPERTY_FILTER
  
  public static final String PROPERTY_FILTER
  
  See Also:
  
  Constant Field Values
- TOP_LAYER
  
  public static final String TOP_LAYER
  
  See Also:
  
  Constant Field Values
- ALL_LAYERS
  
  public static final String ALL_LAYERS
  
  See Also:
  
  Constant Field Values
- INC_LAYERS
  
  public static final String INC_LAYERS
  
  See Also:
  
  Constant Field Values
- EXC_LAYERS
  
  public static final String EXC_LAYERS
  
  See Also:
  
  Constant Field Values
- FILTER
  
  public static final String FILTER
  
  See Also:
  
  Constant Field Values
- SUM
  
  public static final String SUM
  
  See Also:
  
  Constant Field Values
- hotkey
  
  protected KeyStroke hotkey
- map
  
  protected Map map
- delay
  
  protected int delay
- delayTimer
  
  protected Timer delayTimer
- graphicsVisible
  
  protected boolean graphicsVisible
- textVisible
  
  protected boolean textVisible
- currentMousePosition
  
  protected MouseEvent currentMousePosition
- minimumDisplayablePieces
  
  protected int minimumDisplayablePieces
- alwaysShowLoc
  
  protected boolean alwaysShowLoc
- drawPieces
  
  protected boolean drawPieces
- drawSingleDeprecated
  
  protected boolean drawSingleDeprecated
- showText
  
  protected boolean showText
- showTextSingleDeprecated
  
  protected boolean showTextSingleDeprecated
- unrotatePieces
  
  protected boolean unrotatePieces
- showDeck
  
  protected boolean showDeck
- zoomLevel
  
  protected double zoomLevel
- graphicsZoomLevel
  
  protected double graphicsZoomLevel
- borderWidth
  
  protected int borderWidth
- showNoStack
  
  protected boolean showNoStack
- showMoveSelected
  
  protected boolean showMoveSelected
- showNonMovable
  
  protected boolean showNonMovable
- displayWhat
  
  protected String displayWhat
- displayLayers
  
  protected String[] displayLayers
- summaryReportFormat
  
  protected FormattedString summaryReportFormat
- counterReportFormat
  
  protected FormattedString counterReportFormat
- emptyHexReportFormat
  
  protected FormattedString emptyHexReportFormat
- version
  
  protected String version
- fgColor
  
  protected Color fgColor
- bgColor
  
  protected Color bgColor
- fontSize
  
  protected int fontSize
- font
  
  protected Font font
- propertyFilter
  
  protected PropertyExpression propertyFilter
- bounds
  
  protected Rectangle bounds
- mouseInView
  
  protected boolean mouseInView
- displayablePieces
  
  protected List<GamePiece> displayablePieces
- view
  
  protected JComponent view
  
  the JComponent which is repainted when the detail viewer changes
Constructor Details
- CounterDetailViewer
  
  public CounterDetailViewer()
Method Details
- addTo
  
  public void addTo(Buildable b)
  
  Description copied from interface: Buildable
  
  Adds this component to its parent. In order to make Buildable objects extensible, the child is reponsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.
  
  Specified by:
  
  addTo in interface Buildable
- draw
  
  public void draw(Graphics g, Map map)
  
  Specified by:
  
  draw in interface Drawable
- drawAboveCounters
  
  public boolean drawAboveCounters()
  
  Specified by:
  
  drawAboveCounters in interface Drawable
- draw
  
  public void draw(Graphics g, Point pt, JComponent comp)
- drawGraphics
  
  protected void drawGraphics(Graphics g, Point pt, JComponent comp, List<GamePiece> pieces)
- fixBounds
  
  protected void fixBounds(List<GamePiece> pieces)
  
  Set the bounds field large enough to accommodate the given set of pieces
- getBounds
  
  protected Rectangle getBounds(GamePiece piece)
- isTextUnderCounters
  
  protected boolean isTextUnderCounters()
- drawText
  
  protected void drawText(Graphics g, Point pt, JComponent comp, List<GamePiece> pieces)
- drawLabel
  
  protected void drawLabel(Graphics g, Point pt, String label, int hAlign, int vAlign)
- showDetails
  
  protected void showDetails()
- getZoom
  
  protected double getZoom()
- getDisplayablePieces
  
  protected List<GamePiece> getDisplayablePieces()
  
  Build an ArrayList of pieces to be displayed in order from bottom up, based on selection criteria setup in config.
- mouseMoved
  
  public void mouseMoved(MouseEvent e)
  
  Specified by:
  
  mouseMoved in interface MouseMotionListener
- getPreferredDelay
  
  protected int getPreferredDelay()
- mouseDragged
  
  public void mouseDragged(MouseEvent e)
  
  Specified by:
  
  mouseDragged in interface MouseMotionListener
- mouseClicked
  
  public void mouseClicked(MouseEvent e)
  
  Specified by:
  
  mouseClicked in interface MouseListener
- mouseEntered
  
  public void mouseEntered(MouseEvent e)
  
  Specified by:
  
  mouseEntered in interface MouseListener
- mouseExited
  
  public void mouseExited(MouseEvent e)
  
  Specified by:
  
  mouseExited in interface MouseListener
- mousePressed
  
  public void mousePressed(MouseEvent e)
  
  Specified by:
  
  mousePressed in interface MouseListener
- mouseReleased
  
  public void mouseReleased(MouseEvent e)
  
  Specified by:
  
  mouseReleased in interface MouseListener
- dragMouseMoved
  
  public void dragMouseMoved(DragSourceDragEvent e)
  
  Specified by:
  
  dragMouseMoved in interface DragSourceMotionListener
- keyTyped
  
  public void keyTyped(KeyEvent e)
  
  Specified by:
  
  keyTyped in interface KeyListener
- keyPressed
  
  public void keyPressed(KeyEvent e)
  
  Specified by:
  
  keyPressed in interface KeyListener
- keyReleased
  
  public void keyReleased(KeyEvent e)
  
  Specified by:
  
  keyReleased in interface KeyListener
- hideDetails
  
  protected void hideDetails()
- getConfigurer
  
  public Configurer getConfigurer()
  
  Description copied from class: AbstractConfigurable
  
  The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
  
  Specified by:
  
  getConfigurer in interface Configurable
  
  Overrides:
  
  getConfigurer in class AbstractConfigurable
- upgrade
  
  protected void upgrade()
- getAttributeNames
  
  public String[] getAttributeNames()
  
  Specified by:
  
  getAttributeNames in interface AutoConfigurable
  
  Specified by:
  
  getAttributeNames in class AbstractBuildable
  
  Returns:
  
  a list of all attribute names for this component
- getAttributeDescriptions
  
  public String[] getAttributeDescriptions()
  
  Description copied from class: AbstractConfigurable
  
  Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()
  
  Specified by:
  
  getAttributeDescriptions in interface AutoConfigurable
  
  Specified by:
  
  getAttributeDescriptions in class AbstractConfigurable
- getAttributeTypes
  
  public Class<?>[] getAttributeTypes()
  
  Description copied from class: AbstractConfigurable
  
  Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, Color, and KeyStroke The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()
  
  Specified by:
  
  getAttributeTypes in interface AutoConfigurable
  
  Specified by:
  
  getAttributeTypes in class AbstractConfigurable
- getAllowableConfigureComponents
  
  public Class<?>[] getAllowableConfigureComponents()
  
  Description copied from interface: Configurable
  
  Return a list of valid sub-component Classes. If a Class appears in this list, then instances of that class may be added to this component from the Configuration Window.
  
  Specified by:
  
  getAllowableConfigureComponents in interface Configurable
- getHelpFile
  
  public HelpFile getHelpFile()
  
  Specified by:
  
  getHelpFile in interface Configurable
  
  Returns:
  
  a HelpFilte describing how to use and configure this component
- removeFrom
  
  public void removeFrom(Buildable parent)
  
  Description copied from interface: Configurable
  
  Remove this component from its parent
  
  Specified by:
  
  removeFrom in interface Configurable
- setAttribute
  
  public void setAttribute(String name, Object value)
  
  Description copied from class: AbstractBuildable
  
  Sets an attribute value for this component. The key parameter will be one of those listed in AbstractBuildable.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value will be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()
  
  Specified by:
  
  setAttribute in interface AutoConfigurable
  
  Specified by:
  
  setAttribute in interface Translatable
  
  Specified by:
  
  setAttribute in class AbstractBuildable
  
  Parameters:
  
  name - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()
- getAttributeValueString
  
  public String getAttributeValueString(String name)
  
  Description copied from class: AbstractBuildable
  
  Return a String representation of the attribute with the given name. When initializing a module, this String value will be passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object).
  
  Specified by:
  
  getAttributeValueString in interface AutoConfigurable
  
  Specified by:
  
  getAttributeValueString in interface Translatable
  
  Specified by:
  
  getAttributeValueString in class AbstractBuildable
  
  Parameters:
  
  name - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()
- getConfigureTypeName
  
  public static String getConfigureTypeName()
- getAttributeVisibility
  
  public VisibilityCondition getAttributeVisibility(String name)
  
  Description copied from class: AbstractConfigurable
  
  By default, all attributes are visible
  
  Specified by:
  
  getAttributeVisibility in interface AutoConfigurable
  
  Overrides:
  
  getAttributeVisibility in class AbstractConfigurable
  
  Returns:
  
  null if the attribute controls should always be visible;

Class CounterDetailViewer