VASSAL.build.module.Map

All Implemented Interfaces:: DropTargetListener, MouseListener, MouseMotionListener, EventListener, AutoConfigurable, Buildable, Configurable, GameComponent, PlayerRoster.SideChangeListener, MutablePropertiesContainer, PropertyNameSource, PropertySource, ValidityChecker, Translatable, ToolBarComponent, UniqueIdManager.Identifyable

Direct Known Subclasses:: PrivateMap, WidgetMap

public class Map
extends AbstractConfigurable
implements GameComponent, MouseListener, MouseMotionListener, DropTargetListener, Configurable, UniqueIdManager.Identifyable, ToolBarComponent, MutablePropertiesContainer, PropertySource, PlayerRoster.SideChangeListener

The Map is the main component for displaying and containing GamePieces during play. Pieces are displayed on a Map and moved by clicking and dragging. Keyboard events are forwarded to selected pieces. Multiple map windows are supported in a single game, with dragging between windows allowed. A Map may contain many different Buildable subcomponents. Components which are added directly to a Map are contained in the VASSAL.build.module.map package

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Map.ChangeFormatConfig`
`static class`	`Map.CreateFormatConfig`
`static class`	`Map.IconConfig`
`static class`	`Map.InsetLayout`	The Layout responsible for arranging insets which overlay the Map InsetLayout currently is responsible for keeping the `GlobalMap` in the upper-left corner of the `Map.View`.
`static class`	`Map.Merger`	Implements default logic for merging pieces at a given location within a map Returns a `Command` that merges the input `GamePiece` with an existing piece at the input position, provided the pieces are stackable, visible, in the same layer, etc.
`static class`	`Map.MoveToFormatConfig`
`static class`	`Map.MoveWithinFormatConfig`
`static class`	`Map.UnmovedIconConfig`
`static class`	`Map.View`	The component that represents the map itself

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

AutoConfigurable.Util

Nested classes/interfaces inherited from interface VASSAL.build.module.properties.MutablePropertiesContainer

MutablePropertiesContainer.Impl

Field Summary

Fields
Modifier and Type	Field	Description
`static Map`	`activeMap`	Mouse events are first translated into map coordinates.
`static String`	`ALLOW_MULTIPLE`
`protected boolean`	`allowMultiple`
`static String`	`BACKGROUND_COLOR`
`protected Color`	`bgColor`
`protected int[][]`	`boardHeights`
`protected List<Board>`	`boards`
`protected int[][]`	`boardWidths`
`static String`	`BUTTON_NAME`
`static String`	`CHANGE_FORMAT`
`protected String`	`changeFormat`
`protected static boolean`	`changeReportingEnabled`
`protected boolean`	`clearFirst`
`static String`	`CREATE_FORMAT`
`protected String`	`createFormat`
`protected DragGestureListener`	`dragGestureListener`
`protected ArrayList<Drawable>`	`drawComponents`
`protected int`	`dx`
`protected int`	`dy`
`static String`	`EDGE_HEIGHT`
`static String`	`EDGE_WIDTH`
`protected Dimension`	`edgeBuffer`
`protected boolean`	`hideCounters`
`static String`	`HIGHLIGHT_COLOR`
`static String`	`HIGHLIGHT_THICKNESS`
`protected Highlighter`	`highlighter`
`protected ArrayList<Highlighter>`	`highlighters`
`static String`	`HOTKEY`
`static String`	`ICON`
`protected static UniqueIdManager`	`idMgr`
`protected LaunchButton`	`launchButton`
`protected JLayeredPane`	`layeredPane`
`static String`	`LOCATION`
`protected static String`	`MAIN_WINDOW_HEIGHT`
`protected ComponentSplitter.SplitPane`	`mainWindowDock`
`static String`	`MAP_NAME`
`protected String`	`mapID`
`protected String`	`mapName`
`static String`	`MARK_MOVED`
`static String`	`MARK_UNMOVED_ICON`
`static String`	`MARK_UNMOVED_TEXT`
`static String`	`MARK_UNMOVED_TOOLTIP`
`protected String`	`markMovedOption`
`protected String`	`markUnmovedIcon`
`protected String`	`markUnmovedText`
`protected String`	`markUnmovedTooltip`
`static String`	`MESSAGE`
`protected StackMetrics`	`metrics`
`protected ArrayList<MouseListener>`	`mouseListenerStack`
`static String`	`MOVE_KEY`
`static String`	`MOVE_TO_FORMAT`
`static String`	`MOVE_WITHIN_FORMAT`
`protected NamedKeyStroke`	`moveKey`
`protected String`	`moveToFormat`
`protected String`	`moveWithinFormat`
`static String`	`MOVING_STACKS_PICKUP_UNITS`
`protected MouseListener`	`multicaster`
`static String`	`NAME`
`static String`	`OLD_LOCATION`
`static String`	`OLD_MAP`
`protected BoardPicker`	`picker`
`static String`	`PIECE_NAME`
`protected PieceMover`	`pieceMover`
`protected float`	`pieceOpacity`
`protected PieceCollection`	`pieces`
`static String`	`PREFERRED_EDGE_DELAY`
`static int`	`PREFERRED_EDGE_SCROLL_DELAY`
`protected MutablePropertiesContainer`	`propsContainer`
`protected PropertyChangeListener`	`repaintOnPropertyChange`
`protected KeyListener[]`	`saveKeyListeners`
`protected JScrollPane`	`scroll`
`static int`	`SCROLL_ZONE`	The width of the hot zone for triggering autoscrolling.
`protected org.jdesktop.animation.timing.Animator`	`scroller`	The animator which controls autoscrolling.
`static String`	`SUPPRESS_AUTO`
`protected int`	`sx`	The horizontal component of the autoscrolling vector, -1, 0, or 1.
`protected int`	`sy`	The vertical component of the autoscrolling vector, -1, 0, or 1.
`protected JPanel`	`theMap`
`protected JToolBar`	`toolBar`
`protected String`	`tooltip`
`static String`	`TOOLTIP`
`static String`	`USE_LAUNCH_BUTTON`
`protected boolean`	`useLaunchButton`
`protected boolean`	`useLaunchButtonEdit`
`protected VisibilityCondition`	`visibilityCondition`
`protected Zoomer`	`zoom`

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

Map()

Method Summary

Modifier and Type	Method	Description
`void`	`addDrawComponent(Drawable theComponent)`	Add a `Drawable` component to this map
`void`	`addHighlighter(Highlighter h)`
`void`	`addLocalMouseListener(MouseListener l)`	Because MouseEvents are received in component coordinates, it is inconvenient for MouseListeners on the map to have to translate to map coordinates.
`void`	`addLocalMouseListenerFirst(MouseListener l)`
`void`	`addMutableProperty(String key, MutableProperty p)`	Add a property under the given key
`void`	`addPiece(GamePiece p)`	Adds a GamePiece to this map.
`void`	`addTo(Buildable b)`	Expects to be added to a `GameModule`.
`void`	`appendToTitle(String s)`
`Command`	`apply(PieceVisitorDispatcher commandFactory)`	Apply the provided `PieceVisitorDispatcher` to all pieces on this map.
`Rectangle`	`boundingBoxOf(GamePiece p)`	Returns the boundingBox of a GamePiece accounting for the offset of a piece within its parent stack.
`void`	`build(Element e)`	Build this component by getting all XML attributes of the XML element and calling `AbstractBuildable.setAttribute(java.lang.String, java.lang.Object)` with the String value of the attribute
`void`	`centerAt(Point p)`	Center the map at given map coordinates within its JScrollPane container
`void`	`centerAt(Point p, int dx, int dy)`	Center the map at the given map coordinates, if the point is not already within (dx,dy) of the center.
`static void`	`clearActiveMap()`
`protected void`	`clearMapBorder(Graphics g)`
`Point`	`componentCoordinates(Point p)`	Deprecated, for removal: This API element is subject to removal in a future version. `mapToComponent(Point)`
`Rectangle`	`componentRectangle(Rectangle r)`	Deprecated, for removal: This API element is subject to removal in a future version. Use `mapToComponent(Rectangle)`
`int`	`componentToDrawing(int c, double os_scale)`
`Point`	`componentToDrawing(Point p, double os_scale)`
`Rectangle`	`componentToDrawing(Rectangle r, double os_scale)`
`int`	`componentToMap(int c)`
`Point`	`componentToMap(Point p)`
`Rectangle`	`componentToMap(Rectangle r)`
`protected Window`	`createParentFrame()`
`void`	`disableKeyListeners()`	Restore the previously disabled KeyListeners
`void`	`dragEnter(DropTargetDragEvent dtde)`
`void`	`dragExit(DropTargetEvent dte)`
`void`	`dragOver(DropTargetDragEvent dtde)`
`void`	`drawBoards(Graphics g, int xoffset, int yoffset, double zoom, Component obs)`	Draw the boards of the map at the given point and zoom factor onto the given Graphics object
`void`	`drawBoardsInRegion(Graphics g, Rectangle visibleRect)`
`void`	`drawBoardsInRegion(Graphics g, Rectangle visibleRect, Component c)`
`void`	`drawDrawable(Graphics g, boolean aboveCounters)`
`int`	`drawingToComponent(int c, double os_scale)`
`Point`	`drawingToComponent(Point p, double os_scale)`
`Rectangle`	`drawingToComponent(Rectangle r, double os_scale)`
`int`	`drawingToMap(int c, double os_scale)`
`Point`	`drawingToMap(Point p, double os_scale)`
`Rectangle`	`drawingToMap(Rectangle r, double os_scale)`
`void`	`drawPieces(Graphics g, int xOffset, int yOffset)`
`void`	`drawPiecesInRegion(Graphics g, Rectangle visibleRect)`
`void`	`drawPiecesInRegion(Graphics g, Rectangle visibleRect, Component c)`
`void`	`drop(DropTargetDropEvent dtde)`
`void`	`dropActionChanged(DropTargetDragEvent dtde)`
`void`	`enableKeyListeners()`	Save all current Key Listeners and remove them from the map.
`void`	`ensureVisible(Rectangle r)`	Ensure that the given region (in map coordinates) is visible
`GamePiece`	`findAnyPiece(Point pt, PieceFinder finder)`	Use the provided `PieceFinder` instance to locate any piece at the given location, regardless of whether it is visible or not
`Board`	`findBoard(Point p)`
`GamePiece`	`findPiece(Point pt, PieceFinder finder)`	Use the provided `PieceFinder` instance to locate a visible piece at the given location
`Region`	`findRegion(String name)`	Search on all boards for a Region with the given name
`Zone`	`findZone(Point p)`
`Zone`	`findZone(String name)`	Search on all boards for a Zone with the given name
`Enumeration<Board>`	`getAllBoards()`	Deprecated, for removal: This API element is subject to removal in a future version. Use `getBoards()` instead.
`static Iterator<Map>`	`getAllMaps()`	Deprecated, for removal: This API element is subject to removal in a future version. Use `getMapList()` instead.
`Class<?>[]`	`getAllowableConfigureComponents()`	Return a list of valid sub-component Classes.
`GamePiece[]`	`getAllPieces()`
`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 buildFile (XML) attributes of this component.
`String`	`getAttributeValueString(String key)`	Called by the `Buildable.getBuildElement(org.w3c.dom.Document)` method to write the attributes into an XML element
`VisibilityCondition`	`getAttributeVisibility(String name)`	By default, all attributes are visible
`Board`	`getBoardByName(String name)`	Return the board with the given name
`int`	`getBoardCount()`
`BoardPicker`	`getBoardPicker()`	Every map must include a `BoardPicker` as one of its build components
`Collection<Board>`	`getBoards()`
`String`	`getChangeFormat()`
`Component`	`getComponent()`
`static String`	`getConfigureTypeName()`
`String`	`getCreateFormat()`
`String`	`getDeckNameAt(Point p)`	Return the name of the deck whose position is p
`String`	`getDeckNameContaining(Point p)`	Return the name of the deck whose bounding box contains p
`protected String`	`getDefaultWindowTitle()`
`DragGestureListener`	`getDragGestureListener()`
`Dimension`	`getEdgeBuffer()`	The buffer of empty space around the boards in the Map window, in component coordinates at 100% zoom
`HelpFile`	`getHelpFile()`
`Highlighter`	`getHighlighter()`
`Iterator<Highlighter>`	`getHighlighters()`
`String`	`getId()`	Each Map must have a unique String id
`String`	`getIdentifier()`	Make a best gues for a unique identifier for the target.
`JLayeredPane`	`getLayeredPane()`
`String`	`getLocalizedDeckNameAt(Point p)`
`String`	`getLocalizedMapName()`
`Object`	`getLocalizedProperty(Object key)`
`protected Point`	`getLocation(int column, int row, double zoom)`
`protected Point`	`getLocation(Board b, double zoom)`
`static Map`	`getMapById(String id)`
`static List<Map>`	`getMapList()`	Utility method to return a `List` of all map components in the module.
`String`	`getMapName()`
`KeyStroke`	`getMoveKey()`	Return the auto-move key.
`String`	`getMoveToFormat()`
`String`	`getMoveWithinFormat()`
`String`	`getMutablePropertiesContainerId()`	Return a unique Id for the container
`MutableProperty`	`getMutableProperty(String name)`	Find a contained Global Variable by name
`PieceCollection`	`getPieceCollection()`
`float`	`getPieceOpacity()`
`GamePiece[]`	`getPieces()`
`Dimension`	`getPreferredSize()`
`Object`	`getProperty(Object key)`
`Command`	`getRestoreCommand()`	When saving a game, each GameComponent should return a `Command` that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null
`StackMetrics`	`getStackMetrics()`	Every map must include a `StackMetrics` as one of its build components, which governs the stacking behavior of GamePieces on the map
`JToolBar`	`getToolBar()`
`JComponent`	`getView()`
`double`	`getZoom()`
`Zoomer`	`getZoomer()`	A map may include a `Zoomer` as one of its build components
`int`	`indexOf(GamePiece s)`	Returns the index of a piece.
`static boolean`	`isChangeReportingEnabled()`
`boolean`	`isLocationRestricted(Point p)`
`boolean`	`isPiecesVisible()`
`boolean`	`isVisibleToAll()`	Is this map visible to all players
`String`	`localizedLocationName(Point p)`
`String`	`locationName(Point p)`
`Point`	`mapCoordinates(Point p)`	Deprecated, for removal: This API element is subject to removal in a future version. Use `componentToMap(Point)`
`Rectangle`	`mapRectangle(Rectangle r)`	Deprecated, for removal: This API element is subject to removal in a future version. Use `componentToMap(Rectangle)`
`Dimension`	`mapSize()`
`int`	`mapToComponent(int c)`
`Point`	`mapToComponent(Point p)`
`Rectangle`	`mapToComponent(Rectangle r)`
`int`	`mapToDrawing(int c, double os_scale)`
`Point`	`mapToDrawing(Point p, double os_scale)`
`Rectangle`	`mapToDrawing(Rectangle r, double os_scale)`
`void`	`mouseClicked(MouseEvent e)`	Mouse events are first translated into map coordinates.
`void`	`mouseDragged(MouseEvent e)`	Mouse motion events are not forwarded to LocalMouseListeners or to listeners on the stack.
`void`	`mouseEntered(MouseEvent e)`
`void`	`mouseExited(MouseEvent e)`
`void`	`mouseMoved(MouseEvent e)`	Mouse motion events are not forwarded to LocalMouseListeners or to listeners on the stack
`void`	`mousePressed(MouseEvent e)`
`void`	`mouseReleased(MouseEvent e)`	Mouse events are first translated into map coordinates.
`void`	`paintRegion(Graphics g, Rectangle visibleRect)`
`void`	`paintRegion(Graphics g, Rectangle visibleRect, Component c)`
`Command`	`placeAt(GamePiece piece, Point pt)`	Place a piece at the destination point.
`Command`	`placeOrMerge(GamePiece p, Point pt)`	Move a piece to the destination point.
`void`	`popMouseListener()`	MouseListeners on a map may be pushed and popped onto a stack.
`Point`	`positionOf(GamePiece p)`	Returns the position of a GamePiece accounting for the offset within a parent stack, if any
`void`	`pushMouseListener(MouseListener l)`	MouseListeners on a map may be pushed and popped onto a stack.
`void`	`removeDrawComponent(Drawable theComponent)`	Remove a `Drawable` component from this map
`void`	`removeFrom(Buildable b)`	Remove this component from its parent
`void`	`removeHighlighter(Highlighter h)`
`void`	`removeLocalMouseListener(MouseListener l)`
`MutableProperty`	`removeMutableProperty(String key)`	Remove the property with the given key
`void`	`removePiece(GamePiece p)`	Removes a piece from the map
`void`	`repaint()`
`void`	`repaint(boolean cf)`
`void`	`repaint(Rectangle r)`	Repaint the given area, specified in map coordinates
`void`	`reposition(GamePiece s, int pos)`	Deprecated, for removal: This API element is subject to removal in a future version. use `PieceCollection.moveToFront(VASSAL.counters.GamePiece)`
`protected int`	`scale(int c, double zoom)`
`protected Point`	`scale(Point p, double zoom)`
`protected Rectangle`	`scale(Rectangle r, double zoom)`
`void`	`scroll(int dx, int dy)`	Scrolls the map in the containing JScrollPane.
`void`	`scrollAtEdge(Point evtPt, int dist)`	Begin autoscrolling the map if the given point is within the given distance from a viewport edge.
`Rectangle`	`selectionBoundsOf(GamePiece p)`	Returns the selection bounding box of a GamePiece accounting for the offset of a piece within a stack
`static void`	`setActiveMap(Map m)`
`void`	`setAttribute(String key, Object value)`	Sets a buildFile (XML) attribute value for this component.
`protected void`	`setBoardBoundaries()`	Adjusts the bounds() rectangle to account for the Board's relative position to other boards.
`void`	`setBoardPicker(BoardPicker picker)`	Every map must include a `BoardPicker` as one of its build components
`void`	`setBoards(Collection<Board> c)`	Set the boards for this map.
`void`	`setBoards(Enumeration<Board> boardList)`	Deprecated, for removal: This API element is subject to removal in a future version. Use `setBoards(Collection)` instead.
`static void`	`setChangeReportingEnabled(boolean b)`
`void`	`setDragGestureListener(DragGestureListener dragGestureListener)`	This listener will be notified when a drag event is initiated, assuming that no MouseListeners are on the stack.
`void`	`setHighlighter(Highlighter h)`
`void`	`setId(String id)`	Each Map must have a unique String id
`void`	`setMapName(String s)`
`void`	`setPieceCollection(PieceCollection pieces)`
`void`	`setPieceMover(PieceMover mover)`
`void`	`setPieceOpacity(float pieceOpacity)`
`void`	`setPiecesVisible(boolean show)`
`void`	`setStackMetrics(StackMetrics sm)`	Every map must include a `StackMetrics` as one of its build components, which governs the stacking behavior of GamePieces on the map
`void`	`setup(boolean show)`	When a game is started, create a top-level window, if none exists.
`void`	`setZoomer(Zoomer z)`	A map may include a `Zoomer` as one of its build components
`boolean`	`shouldDockIntoMainWindow()`
`void`	`sideChanged(String oldSide, String newSide)`
`Point`	`snapTo(Point p)`
`MouseEvent`	`translateEvent(MouseEvent e)`

Methods inherited from class VASSAL.build.AbstractConfigurable

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

Methods inherited from class VASSAL.build.AbstractBuildable

getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, 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

add, getBuildElement

Methods inherited from interface VASSAL.build.Configurable

addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, remove

Methods inherited from interface VASSAL.i18n.Translatable

getI18nData

Methods inherited from interface VASSAL.tools.UniqueIdManager.Identifyable

getConfigureName

Field Details
- changeReportingEnabled
  
  protected static boolean changeReportingEnabled
- mapID
  
  protected String mapID
- mapName
  
  protected String mapName
- MAIN_WINDOW_HEIGHT
  
  protected static final String MAIN_WINDOW_HEIGHT
  
  See Also:
  
  Constant Field Values
- idMgr
  
  protected static final UniqueIdManager idMgr
- theMap
  
  protected JPanel theMap
- drawComponents
  
  protected ArrayList<Drawable> drawComponents
- layeredPane
  
  protected JLayeredPane layeredPane
- scroll
  
  protected JScrollPane scroll
- mainWindowDock
  
  protected ComponentSplitter.SplitPane mainWindowDock
- picker
  
  protected BoardPicker picker
- toolBar
  
  protected JToolBar toolBar
- zoom
  
  protected Zoomer zoom
- metrics
  
  protected StackMetrics metrics
- edgeBuffer
  
  protected Dimension edgeBuffer
- bgColor
  
  protected Color bgColor
- launchButton
  
  protected LaunchButton launchButton
- useLaunchButton
  
  protected boolean useLaunchButton
- useLaunchButtonEdit
  
  protected boolean useLaunchButtonEdit
- markMovedOption
  
  protected String markMovedOption
- markUnmovedIcon
  
  protected String markUnmovedIcon
- markUnmovedText
  
  protected String markUnmovedText
- markUnmovedTooltip
  
  protected String markUnmovedTooltip
- multicaster
  
  protected MouseListener multicaster
- mouseListenerStack
  
  protected ArrayList<MouseListener> mouseListenerStack
- boards
  
  protected List<Board> boards
- boardWidths
  
  protected int[][] boardWidths
- boardHeights
  
  protected int[][] boardHeights
- pieces
  
  protected PieceCollection pieces
- highlighter
  
  protected Highlighter highlighter
- highlighters
  
  protected ArrayList<Highlighter> highlighters
- clearFirst
  
  protected boolean clearFirst
- hideCounters
  
  protected boolean hideCounters
- pieceOpacity
  
  protected float pieceOpacity
- allowMultiple
  
  protected boolean allowMultiple
- visibilityCondition
  
  protected VisibilityCondition visibilityCondition
- dragGestureListener
  
  protected DragGestureListener dragGestureListener
- moveWithinFormat
  
  protected String moveWithinFormat
- moveToFormat
  
  protected String moveToFormat
- createFormat
  
  protected String createFormat
- changeFormat
  
  protected String changeFormat
- moveKey
  
  protected NamedKeyStroke moveKey
- tooltip
  
  protected String tooltip
- propsContainer
  
  protected MutablePropertiesContainer propsContainer
- repaintOnPropertyChange
  
  protected PropertyChangeListener repaintOnPropertyChange
- pieceMover
  
  protected PieceMover pieceMover
- saveKeyListeners
  
  protected KeyListener[] saveKeyListeners
- NAME
  
  public static final String NAME
  
  See Also:
  
  Constant Field Values
- MARK_MOVED
  
  public static final String MARK_MOVED
  
  See Also:
  
  Constant Field Values
- MARK_UNMOVED_ICON
  
  public static final String MARK_UNMOVED_ICON
  
  See Also:
  
  Constant Field Values
- MARK_UNMOVED_TEXT
  
  public static final String MARK_UNMOVED_TEXT
  
  See Also:
  
  Constant Field Values
- MARK_UNMOVED_TOOLTIP
  
  public static final String MARK_UNMOVED_TOOLTIP
  
  See Also:
  
  Constant Field Values
- EDGE_WIDTH
  
  public static final String EDGE_WIDTH
  
  See Also:
  
  Constant Field Values
- EDGE_HEIGHT
  
  public static final String EDGE_HEIGHT
  
  See Also:
  
  Constant Field Values
- BACKGROUND_COLOR
  
  public static final String BACKGROUND_COLOR
  
  See Also:
  
  Constant Field Values
- HIGHLIGHT_COLOR
  
  public static final String HIGHLIGHT_COLOR
  
  See Also:
  
  Constant Field Values
- HIGHLIGHT_THICKNESS
  
  public static final String HIGHLIGHT_THICKNESS
  
  See Also:
  
  Constant Field Values
- ALLOW_MULTIPLE
  
  public static final String ALLOW_MULTIPLE
  
  See Also:
  
  Constant Field Values
- USE_LAUNCH_BUTTON
  
  public static final String USE_LAUNCH_BUTTON
  
  See Also:
  
  Constant Field Values
- BUTTON_NAME
  
  public static final String BUTTON_NAME
  
  See Also:
  
  Constant Field Values
- TOOLTIP
  
  public static final String TOOLTIP
  
  See Also:
  
  Constant Field Values
- ICON
  
  public static final String ICON
  
  See Also:
  
  Constant Field Values
- HOTKEY
  
  public static final String HOTKEY
  
  See Also:
  
  Constant Field Values
- SUPPRESS_AUTO
  
  public static final String SUPPRESS_AUTO
  
  See Also:
  
  Constant Field Values
- MOVE_WITHIN_FORMAT
  
  public static final String MOVE_WITHIN_FORMAT
  
  See Also:
  
  Constant Field Values
- MOVE_TO_FORMAT
  
  public static final String MOVE_TO_FORMAT
  
  See Also:
  
  Constant Field Values
- CREATE_FORMAT
  
  public static final String CREATE_FORMAT
  
  See Also:
  
  Constant Field Values
- CHANGE_FORMAT
  
  public static final String CHANGE_FORMAT
  
  See Also:
  
  Constant Field Values
- MOVE_KEY
  
  public static final String MOVE_KEY
  
  See Also:
  
  Constant Field Values
- MOVING_STACKS_PICKUP_UNITS
  
  public static final String MOVING_STACKS_PICKUP_UNITS
  
  See Also:
  
  Constant Field Values
- activeMap
  
  public static Map activeMap
  
  Mouse events are first translated into map coordinates. Then the event is forwarded to the top MouseListener in the stack, if any, otherwise forwarded to all LocalMouseListeners
  
  See Also:
  
  pushMouseListener(java.awt.event.MouseListener), popMouseListener(), addLocalMouseListener(java.awt.event.MouseListener)
- PREFERRED_EDGE_SCROLL_DELAY
  
  public static final int PREFERRED_EDGE_SCROLL_DELAY
  
  See Also:
  
  Constant Field Values
- PREFERRED_EDGE_DELAY
  
  public static final String PREFERRED_EDGE_DELAY
  
  See Also:
  
  Constant Field Values
- SCROLL_ZONE
  
  public static final int SCROLL_ZONE
  
  The width of the hot zone for triggering autoscrolling.
  
  See Also:
  
  Constant Field Values
- sx
  
  protected int sx
  
  The horizontal component of the autoscrolling vector, -1, 0, or 1.
- sy
  
  protected int sy
  
  The vertical component of the autoscrolling vector, -1, 0, or 1.
- dx
  
  protected int dx
- dy
  
  protected int dy
- scroller
  
  protected org.jdesktop.animation.timing.Animator scroller
  
  The animator which controls autoscrolling.
- LOCATION
  
  public static final String LOCATION
  
  See Also:
  
  Constant Field Values
- OLD_LOCATION
  
  public static final String OLD_LOCATION
  
  See Also:
  
  Constant Field Values
- OLD_MAP
  
  public static final String OLD_MAP
  
  See Also:
  
  Constant Field Values
- MAP_NAME
  
  public static final String MAP_NAME
  
  See Also:
  
  Constant Field Values
- PIECE_NAME
  
  public static final String PIECE_NAME
  
  See Also:
  
  Constant Field Values
- MESSAGE
  
  public static final String MESSAGE
  
  See Also:
  
  Constant Field Values
Constructor Details
- Map
  
  public Map()
Method Details
- getComponent
  
  public Component getComponent()
- setChangeReportingEnabled
  
  public static void setChangeReportingEnabled(boolean b)
- isChangeReportingEnabled
  
  public static boolean isChangeReportingEnabled()
- setAttribute
  
  public void setAttribute(String key, Object value)
  
  Description copied from class: AbstractBuildable
  
  Sets a buildFile (XML) 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:
  
  key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()
  
  value - 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 can also be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()
- getAttributeValueString
  
  public String getAttributeValueString(String key)
  
  Description copied from interface: AutoConfigurable
  
  Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
  
  Specified by:
  
  getAttributeValueString in interface AutoConfigurable
  
  Specified by:
  
  getAttributeValueString in interface Translatable
  
  Specified by:
  
  getAttributeValueString in class AbstractBuildable
  
  Parameters:
  
  key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()
  
  Returns:
  
  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).
- build
  
  public void build(Element e)
  
  Description copied from class: AbstractBuildable
  
  Build this component by getting all XML attributes of the XML element and calling AbstractBuildable.setAttribute(java.lang.String, java.lang.Object) with the String value of the attribute
  
  Specified by:
  
  build in interface Buildable
  
  Overrides:
  
  build in class AbstractBuildable
  
  Parameters:
  
  e - the XML element containing the object data
- setBoardPicker
  
  public void setBoardPicker(BoardPicker picker)
  
  Every map must include a BoardPicker as one of its build components
- getBoardPicker
  
  public BoardPicker getBoardPicker()
  
  Every map must include a BoardPicker as one of its build components
  
  Returns:
  
  the BoardPicker for this map
- setZoomer
  
  public void setZoomer(Zoomer z)
  
  A map may include a Zoomer as one of its build components
- getZoomer
  
  public Zoomer getZoomer()
  
  A map may include a Zoomer as one of its build components
  
  Returns:
  
  the Zoomer for this map
- setStackMetrics
  
  public void setStackMetrics(StackMetrics sm)
  
  Every map must include a StackMetrics as one of its build components, which governs the stacking behavior of GamePieces on the map
- getStackMetrics
  
  public StackMetrics getStackMetrics()
  
  Every map must include a StackMetrics as one of its build components, which governs the stacking behavior of GamePieces on the map
  
  Returns:
  
  the StackMetrics for this map
- getZoom
  
  public double getZoom()
  
  Returns:
  
  the current zoom factor for the map
- getToolBar
  
  public JToolBar getToolBar()
  
  Specified by:
  
  getToolBar in interface ToolBarComponent
  
  Returns:
  
  the toolbar for this map's window
- addDrawComponent
  
  public void addDrawComponent(Drawable theComponent)
  
  Add a Drawable component to this map
- removeDrawComponent
  
  public void removeDrawComponent(Drawable theComponent)
  
  Remove a Drawable component from this map
- addTo
  
  public void addTo(Buildable b)
  
  Expects to be added to a GameModule. Determines a unique id for this Map. Registers itself as KeyStrokeSource. Registers itself as a GameComponent. Registers itself as a drop target and drag source.
  
  Specified by:
  
  addTo in interface Buildable
  
  See Also:
  
  getId(), DragBuffer
- setPieceMover
  
  public void setPieceMover(PieceMover mover)
- removeFrom
  
  public void removeFrom(Buildable b)
  
  Description copied from interface: Configurable
  
  Remove this component from its parent
  
  Specified by:
  
  removeFrom in interface Configurable
- sideChanged
  
  public void sideChanged(String oldSide, String newSide)
  
  Specified by:
  
  sideChanged in interface PlayerRoster.SideChangeListener
- setBoards
  
  public void setBoards(Collection<Board> c)
  
  Set the boards for this map. Each map may contain more than one Board.
- setBoards
  
  @Deprecated(since="2020-08-05", forRemoval=true) public void setBoards(Enumeration<Board> boardList)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Use setBoards(Collection) instead.
  
  Set the boards for this map. Each map may contain more than one Board.
- getRestoreCommand
  
  public Command getRestoreCommand()
  
  Description copied from interface: GameComponent
  
  When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null
  
  Specified by:
  
  getRestoreCommand in interface GameComponent
- findBoard
  
  public Board findBoard(Point p)
  
  Returns:
  
  the Board on this map containing the argument point
- findZone
  
  public Zone findZone(Point p)
  
  Returns:
  
  the Zone on this map containing the argument point
- findZone
  
  public Zone findZone(String name)
  
  Search on all boards for a Zone with the given name
  
  Parameters:
  
  name - Zone Name
  
  Returns:
  
  Located zone
- findRegion
  
  public Region findRegion(String name)
  
  Search on all boards for a Region with the given name
  
  Parameters:
  
  name - Region name
  
  Returns:
  
  Located region
- getBoardByName
  
  public Board getBoardByName(String name)
  
  Return the board with the given name
  
  Parameters:
  
  name - Board Name
  
  Returns:
  
  null if no such board found
- getPreferredSize
  
  public Dimension getPreferredSize()
- mapSize
  
  public Dimension mapSize()
  
  Returns:
  
  the size of the map in pixels at 100% zoom, including the edge buffer
- isLocationRestricted
  
  public boolean isLocationRestricted(Point p)
  
  Returns:
  
  true if the given point may not be a legal location. I.e., if this grid will attempt to snap it to the nearest grid location
- snapTo
  
  public Point snapTo(Point p)
  
  Returns:
  
  the nearest allowable point according to the MapGrid on the Board at this point
  
  See Also:
  
  Board.snapTo(java.awt.Point), MapGrid.snapTo(java.awt.Point)
- getEdgeBuffer
  
  public Dimension getEdgeBuffer()
  
  The buffer of empty space around the boards in the Map window, in component coordinates at 100% zoom
- mapCoordinates
  
  @Deprecated(since="2020-08-05", forRemoval=true) public Point mapCoordinates(Point p)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Use componentToMap(Point)
  
  Translate a point from component coordinates (i.e., x,y position on the JPanel) to map coordinates (i.e., accounting for zoom factor).
  
  See Also:
  
  componentCoordinates(java.awt.Point)
- mapRectangle
  
  @Deprecated(since="2020-08-05", forRemoval=true) public Rectangle mapRectangle(Rectangle r)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Use componentToMap(Rectangle)
- componentCoordinates
  
  @Deprecated(since="2020-08-05", forRemoval=true) public Point componentCoordinates(Point p)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  mapToComponent(Point)
  
  Translate a point from map coordinates to component coordinates
  
  See Also:
  
  mapCoordinates(java.awt.Point)
- componentRectangle
  
  @Deprecated(since="2020-08-05", forRemoval=true) public Rectangle componentRectangle(Rectangle r)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Use mapToComponent(Rectangle)
- scale
  
  protected int scale(int c, double zoom)
- scale
  
  protected Point scale(Point p, double zoom)
- scale
  
  protected Rectangle scale(Rectangle r, double zoom)
- mapToDrawing
  
  public int mapToDrawing(int c, double os_scale)
- mapToDrawing
  
  public Point mapToDrawing(Point p, double os_scale)
- mapToDrawing
  
  public Rectangle mapToDrawing(Rectangle r, double os_scale)
- mapToComponent
  
  public int mapToComponent(int c)
- mapToComponent
  
  public Point mapToComponent(Point p)
- mapToComponent
  
  public Rectangle mapToComponent(Rectangle r)
- componentToDrawing
  
  public int componentToDrawing(int c, double os_scale)
- componentToDrawing
  
  public Point componentToDrawing(Point p, double os_scale)
- componentToDrawing
  
  public Rectangle componentToDrawing(Rectangle r, double os_scale)
- componentToMap
  
  public int componentToMap(int c)
- componentToMap
  
  public Point componentToMap(Point p)
- componentToMap
  
  public Rectangle componentToMap(Rectangle r)
- drawingToMap
  
  public int drawingToMap(int c, double os_scale)
- drawingToMap
  
  public Point drawingToMap(Point p, double os_scale)
- drawingToMap
  
  public Rectangle drawingToMap(Rectangle r, double os_scale)
- drawingToComponent
  
  public int drawingToComponent(int c, double os_scale)
- drawingToComponent
  
  public Point drawingToComponent(Point p, double os_scale)
- drawingToComponent
  
  public Rectangle drawingToComponent(Rectangle r, double os_scale)
- locationName
  
  public String locationName(Point p)
  
  Returns:
  
  a String name for the given location on the map
  
  See Also:
  
  Board.locationName(java.awt.Point)
- localizedLocationName
  
  public String localizedLocationName(Point p)
- isVisibleToAll
  
  public boolean isVisibleToAll()
  
  Is this map visible to all players
- getDeckNameContaining
  
  public String getDeckNameContaining(Point p)
  
  Return the name of the deck whose bounding box contains p
- getDeckNameAt
  
  public String getDeckNameAt(Point p)
  
  Return the name of the deck whose position is p
  
  Parameters:
  
  p - Point to look for Deck
  
  Returns:
  
  Name of Deck
- getLocalizedDeckNameAt
  
  public String getLocalizedDeckNameAt(Point p)
- addLocalMouseListener
  
  public void addLocalMouseListener(MouseListener l)
  
  Because MouseEvents are received in component coordinates, it is inconvenient for MouseListeners on the map to have to translate to map coordinates. MouseListeners added with this method will receive mouse events with points already translated into map coordinates. addLocalMouseListenerFirst inserts the new listener at the start of the chain.
- addLocalMouseListenerFirst
  
  public void addLocalMouseListenerFirst(MouseListener l)
- removeLocalMouseListener
  
  public void removeLocalMouseListener(MouseListener l)
- pushMouseListener
  
  public void pushMouseListener(MouseListener l)
  
  MouseListeners on a map may be pushed and popped onto a stack. Only the top listener on the stack receives mouse events.
- popMouseListener
  
  public void popMouseListener()
  
  MouseListeners on a map may be pushed and popped onto a stack. Only the top listener on the stack receives mouse events
- mouseEntered
  
  public void mouseEntered(MouseEvent e)
  
  Specified by:
  
  mouseEntered in interface MouseListener
- mouseExited
  
  public void mouseExited(MouseEvent e)
  
  Specified by:
  
  mouseExited in interface MouseListener
- translateEvent
  
  public MouseEvent translateEvent(MouseEvent e)
- mouseClicked
  
  public void mouseClicked(MouseEvent e)
  
  Mouse events are first translated into map coordinates. Then the event is forwarded to the top MouseListener in the stack, if any, otherwise forwarded to all LocalMouseListeners
  
  Specified by:
  
  mouseClicked in interface MouseListener
  
  See Also:
  
  pushMouseListener(java.awt.event.MouseListener), popMouseListener(), addLocalMouseListener(java.awt.event.MouseListener)
- setActiveMap
  
  public static void setActiveMap(Map m)
- clearActiveMap
  
  public static void clearActiveMap()
- mousePressed
  
  public void mousePressed(MouseEvent e)
  
  Specified by:
  
  mousePressed in interface MouseListener
- mouseReleased
  
  public void mouseReleased(MouseEvent e)
  
  Mouse events are first translated into map coordinates. Then the event is forwarded to the top MouseListener in the stack, if any, otherwise forwarded to all LocalMouseListeners.
  
  Specified by:
  
  mouseReleased in interface MouseListener
  
  See Also:
  
  pushMouseListener(java.awt.event.MouseListener), popMouseListener(), addLocalMouseListener(java.awt.event.MouseListener)
- enableKeyListeners
  
  public void enableKeyListeners()
  
  Save all current Key Listeners and remove them from the map. Used by Traits that need to prevent Key Commands at certain times.
- disableKeyListeners
  
  public void disableKeyListeners()
  
  Restore the previously disabled KeyListeners
- setDragGestureListener
  
  public void setDragGestureListener(DragGestureListener dragGestureListener)
  
  This listener will be notified when a drag event is initiated, assuming that no MouseListeners are on the stack.
  
  Parameters:
  
  dragGestureListener - Listener
  
  See Also:
  
  pushMouseListener(java.awt.event.MouseListener)
- getDragGestureListener
  
  public DragGestureListener getDragGestureListener()
- dragEnter
  
  public void dragEnter(DropTargetDragEvent dtde)
  
  Specified by:
  
  dragEnter in interface DropTargetListener
- dragOver
  
  public void dragOver(DropTargetDragEvent dtde)
  
  Specified by:
  
  dragOver in interface DropTargetListener
- dropActionChanged
  
  public void dropActionChanged(DropTargetDragEvent dtde)
  
  Specified by:
  
  dropActionChanged in interface DropTargetListener
- dragExit
  
  public void dragExit(DropTargetEvent dte)
  
  Specified by:
  
  dragExit in interface DropTargetListener
- drop
  
  public void drop(DropTargetDropEvent dtde)
  
  Specified by:
  
  drop in interface DropTargetListener
- mouseMoved
  
  public void mouseMoved(MouseEvent e)
  
  Mouse motion events are not forwarded to LocalMouseListeners or to listeners on the stack
  
  Specified by:
  
  mouseMoved in interface MouseMotionListener
- mouseDragged
  
  public void mouseDragged(MouseEvent e)
  
  Mouse motion events are not forwarded to LocalMouseListeners or to listeners on the stack. The map scrolls when dragging the mouse near the edge.
  
  Specified by:
  
  mouseDragged in interface MouseMotionListener
- scrollAtEdge
  
  public void scrollAtEdge(Point evtPt, int dist)
  
  Begin autoscrolling the map if the given point is within the given distance from a viewport edge.
  
  Parameters:
  
  evtPt - Point to check
  
  dist - Distance to check
- repaint
  
  public void repaint(boolean cf)
- paintRegion
  
  public void paintRegion(Graphics g, Rectangle visibleRect)
- paintRegion
  
  public void paintRegion(Graphics g, Rectangle visibleRect, Component c)
- drawBoardsInRegion
  
  public void drawBoardsInRegion(Graphics g, Rectangle visibleRect, Component c)
- drawBoardsInRegion
  
  public void drawBoardsInRegion(Graphics g, Rectangle visibleRect)
- repaint
  
  public void repaint()
- drawPiecesInRegion
  
  public void drawPiecesInRegion(Graphics g, Rectangle visibleRect, Component c)
- drawPiecesInRegion
  
  public void drawPiecesInRegion(Graphics g, Rectangle visibleRect)
- drawPieces
  
  public void drawPieces(Graphics g, int xOffset, int yOffset)
- drawDrawable
  
  public void drawDrawable(Graphics g, boolean aboveCounters)
- getHighlighter
  
  public Highlighter getHighlighter()
- setHighlighter
  
  public void setHighlighter(Highlighter h)
- addHighlighter
  
  public void addHighlighter(Highlighter h)
- removeHighlighter
  
  public void removeHighlighter(Highlighter h)
- getHighlighters
  
  public Iterator<Highlighter> getHighlighters()
- getBoards
  
  public Collection<Board> getBoards()
  
  Returns:
  
  a Collection of all Boards on the Map
- getAllBoards
  
  @Deprecated(since="2020-08-05", forRemoval=true) public Enumeration<Board> getAllBoards()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Use getBoards() instead.
  
  Returns:
  
  an Enumeration of all Boards on the map
- getBoardCount
  
  public int getBoardCount()
- boundingBoxOf
  
  public Rectangle boundingBoxOf(GamePiece p)
  
  Returns the boundingBox of a GamePiece accounting for the offset of a piece within its parent stack. Return null if this piece is not on the map
  
  See Also:
  
  GamePiece.boundingBox()
- selectionBoundsOf
  
  public Rectangle selectionBoundsOf(GamePiece p)
  
  Returns the selection bounding box of a GamePiece accounting for the offset of a piece within a stack
  
  See Also:
  
  GamePiece.getShape()
- positionOf
  
  public Point positionOf(GamePiece p)
  
  Returns the position of a GamePiece accounting for the offset within a parent stack, if any
- getPieces
  
  public GamePiece[] getPieces()
  
  Returns:
  
  an array of all GamePieces on the map. This is a read-only copy. Altering the array does not alter the pieces on the map.
- getAllPieces
  
  public GamePiece[] getAllPieces()
- setPieceCollection
  
  public void setPieceCollection(PieceCollection pieces)
- getPieceCollection
  
  public PieceCollection getPieceCollection()
- clearMapBorder
  
  protected void clearMapBorder(Graphics g)
- setBoardBoundaries
  
  protected void setBoardBoundaries()
  
  Adjusts the bounds() rectangle to account for the Board's relative position to other boards. In other words, if Board A is N pixels wide and Board B is to the right of Board A, then the origin of Board B will be adjusted N pixels to the right.
- getLocation
  
  protected Point getLocation(Board b, double zoom)
- getLocation
  
  protected Point getLocation(int column, int row, double zoom)
- drawBoards
  
  public void drawBoards(Graphics g, int xoffset, int yoffset, double zoom, Component obs)
  
  Draw the boards of the map at the given point and zoom factor onto the given Graphics object
- repaint
  
  public void repaint(Rectangle r)
  
  Repaint the given area, specified in map coordinates
- setPiecesVisible
  
  public void setPiecesVisible(boolean show)
  
  Parameters:
  
  show - if true, enable drawing of GamePiece. If false, don't draw GamePiece when painting the map
- isPiecesVisible
  
  public boolean isPiecesVisible()
- getPieceOpacity
  
  public float getPieceOpacity()
- setPieceOpacity
  
  public void setPieceOpacity(float pieceOpacity)
- getProperty
  
  public Object getProperty(Object key)
  
  Specified by:
  
  getProperty in interface PropertySource
- getLocalizedProperty
  
  public Object getLocalizedProperty(Object key)
  
  Specified by:
  
  getLocalizedProperty in interface PropertySource
- getMoveKey
  
  public KeyStroke getMoveKey()
  
  Return the auto-move key. It may be named, so just return the allocated KeyStroke.
  
  Returns:
  
  auto move keystroke
- createParentFrame
  
  protected Window createParentFrame()
  
  Returns:
  
  the top-level window containing this map
- shouldDockIntoMainWindow
  
  public boolean shouldDockIntoMainWindow()
- setup
  
  public void setup(boolean show)
  
  When a game is started, create a top-level window, if none exists. When a game is ended, remove all boards from the map.
  
  Specified by:
  
  setup in interface GameComponent
  
  Parameters:
  
  show - if true, a game is starting. If false, then a game is ending
  
  See Also:
  
  GameComponent
- appendToTitle
  
  public void appendToTitle(String s)
- getDefaultWindowTitle
  
  protected String getDefaultWindowTitle()
- findPiece
  
  public GamePiece findPiece(Point pt, PieceFinder finder)
  
  Use the provided PieceFinder instance to locate a visible piece at the given location
- findAnyPiece
  
  public GamePiece findAnyPiece(Point pt, PieceFinder finder)
  
  Use the provided PieceFinder instance to locate any piece at the given location, regardless of whether it is visible or not
- placeAt
  
  public Command placeAt(GamePiece piece, Point pt)
  
  Place a piece at the destination point. If necessary, remove the piece from its parent Stack or Map
  
  Returns:
  
  a Command that reproduces this action
- apply
  
  public Command apply(PieceVisitorDispatcher commandFactory)
  
  Apply the provided PieceVisitorDispatcher to all pieces on this map. Returns the first non-null Command returned by commandFactory
  
  Parameters:
  
  commandFactory - Command Factory
- placeOrMerge
  
  public Command placeOrMerge(GamePiece p, Point pt)
  
  Move a piece to the destination point. If a piece is at the point (i.e. has a location exactly equal to it), merge with the piece by forwarding to StackMetrics.merge(VASSAL.counters.GamePiece, VASSAL.counters.GamePiece). Otherwise, place by forwarding to placeAt()
  
  See Also:
  
  StackMetrics.merge(VASSAL.counters.GamePiece, VASSAL.counters.GamePiece)
- addPiece
  
  public void addPiece(GamePiece p)
  
  Adds a GamePiece to this map. Removes the piece from its parent Stack and from its current map, if different from this map
- reposition
  
  @Deprecated(since="2020-08-05", forRemoval=true) public void reposition(GamePiece s, int pos)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  use PieceCollection.moveToFront(VASSAL.counters.GamePiece)
  
  Reorder the argument GamePiece to the new index. When painting the map, pieces are drawn in order of index
- indexOf
  
  public int indexOf(GamePiece s)
  
  Returns the index of a piece. When painting the map, pieces are drawn in order of index Return -1 if the piece is not on this map
- removePiece
  
  public void removePiece(GamePiece p)
  
  Removes a piece from the map
- centerAt
  
  public void centerAt(Point p)
  
  Center the map at given map coordinates within its JScrollPane container
- centerAt
  
  public void centerAt(Point p, int dx, int dy)
  
  Center the map at the given map coordinates, if the point is not already within (dx,dy) of the center.
- ensureVisible
  
  public void ensureVisible(Rectangle r)
  
  Ensure that the given region (in map coordinates) is visible
- scroll
  
  public void scroll(int dx, int dy)
  
  Scrolls the map in the containing JScrollPane.
  
  Parameters:
  
  dx - number of pixels to scroll horizontally
  
  dy - number of pixels to scroll vertically
- getConfigureTypeName
  
  public static String getConfigureTypeName()
- getMapName
  
  public String getMapName()
- getLocalizedMapName
  
  public String getLocalizedMapName()
- setMapName
  
  public void setMapName(String s)
- getHelpFile
  
  public HelpFile getHelpFile()
  
  Specified by:
  
  getHelpFile in interface Configurable
  
  Returns:
  
  a HelpFilte describing how to use and configure this component
- getAttributeDescriptions
  
  public String[] getAttributeDescriptions()
  
  Description copied from interface: AutoConfigurable
  
  Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object.
  
  Specified by:
  
  getAttributeDescriptions in interface AutoConfigurable
  
  Specified by:
  
  getAttributeDescriptions in class AbstractConfigurable
  
  Returns:
  
  an array of Strings describing the buildFile (XML) attributes of this component. These strings are used as prompts in the Properties window for this object, when the component is configured in the Editor. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()
- getAttributeNames
  
  public String[] getAttributeNames()
  
  Description copied from class: AbstractBuildable
  
  Lists all the buildFile (XML) attribute names for this component. If this component is ALSO an AbstractConfigurable, then this list of attributes determines the appropriate attribute order for AbstractConfigurable.getAttributeDescriptions() and AbstractConfigurable.getAttributeTypes().
  
  Specified by:
  
  getAttributeNames in interface AutoConfigurable
  
  Specified by:
  
  getAttributeNames in class AbstractBuildable
  
  Returns:
  
  a list of all buildFile (XML) attribute names for this component
- getAttributeTypes
  
  public Class<?>[] getAttributeTypes()
  
  Description copied from class: AbstractConfigurable
  
  Return the Class for the buildFile (XML) attributes of this component. Valid classes include: String, Integer, Double, Boolean, Image, Color, and KeyStroke, along with any class for which a Configurer exists in VASSAL.configure. The class determines, among other things, which type of AutoConfigurer will be used to configure the attribute when the object is configured in the Editor. 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
- getCreateFormat
  
  public String getCreateFormat()
- getChangeFormat
  
  public String getChangeFormat()
- getMoveToFormat
  
  public String getMoveToFormat()
- getMoveWithinFormat
  
  public String getMoveWithinFormat()
- 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
- 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
  
  Parameters:
  
  name - Name (key) of one of this component's attributes
  
  Returns:
  
  a VisibilityCondition for this attribute, or null if attribute should always be visible.
- setId
  
  public void setId(String id)
  
  Each Map must have a unique String id
  
  Specified by:
  
  setId in interface UniqueIdManager.Identifyable
- getMapById
  
  public static Map getMapById(String id)
- getMapList
  
  public static List<Map> getMapList()
  
  Utility method to return a List of all map components in the module.
  
  Returns:
  
  the list of Maps
- getAllMaps
  
  @Deprecated(since="2020-08-05", forRemoval=true) public static Iterator<Map> getAllMaps()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Use getMapList() instead.
  
  Utility method to return a list of all map components in the module
  
  Returns:
  
  Iterator over all maps
- getMutableProperty
  
  public MutableProperty getMutableProperty(String name)
  
  Find a contained Global Variable by name
  
  Specified by:
  
  getMutableProperty in interface MutablePropertiesContainer
- addMutableProperty
  
  public void addMutableProperty(String key, MutableProperty p)
  
  Description copied from interface: MutablePropertiesContainer
  
  Add a property under the given key
  
  Specified by:
  
  addMutableProperty in interface MutablePropertiesContainer
- removeMutableProperty
  
  public MutableProperty removeMutableProperty(String key)
  
  Description copied from interface: MutablePropertiesContainer
  
  Remove the property with the given key
  
  Specified by:
  
  removeMutableProperty in interface MutablePropertiesContainer
- getMutablePropertiesContainerId
  
  public String getMutablePropertiesContainerId()
  
  Description copied from interface: MutablePropertiesContainer
  
  Return a unique Id for the container
  
  Specified by:
  
  getMutablePropertiesContainerId in interface MutablePropertiesContainer
- getId
  
  public String getId()
  
  Each Map must have a unique String id
  
  Specified by:
  
  getId in interface UniqueIdManager.Identifyable
  
  Returns:
  
  the id for this map
- getIdentifier
  
  public String getIdentifier()
  
  Make a best gues for a unique identifier for the target. Use UniqueIdManager.Identifyable.getConfigureName() if non-null, otherwise use UniqueIdManager.Identifyable.getId()
  
  Returns:
  
  Unique Identifier
- getView
  
  public JComponent getView()
  
  Returns:
  
  the Swing component representing the map
- getLayeredPane
  
  public JLayeredPane getLayeredPane()
  
  Returns:
  
  the JLayeredPane holding map insets

Class Map

Nested Class Summary

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

Nested classes/interfaces inherited from interface VASSAL.build.module.properties.MutablePropertiesContainer

Field Summary

Fields inherited from class VASSAL.build.AbstractConfigurable

Fields inherited from class VASSAL.build.AbstractBuildable

Fields inherited from interface VASSAL.build.Configurable

Constructor Summary

Method Summary

Methods inherited from class VASSAL.build.AbstractConfigurable

Methods inherited from class VASSAL.build.AbstractBuildable

Methods inherited from class java.lang.Object

Methods inherited from interface VASSAL.build.Buildable

Methods inherited from interface VASSAL.build.Configurable

Methods inherited from interface VASSAL.i18n.Translatable

Methods inherited from interface VASSAL.tools.UniqueIdManager.Identifyable

Field Details

changeReportingEnabled

mapID

mapName

MAIN_WINDOW_HEIGHT

idMgr

theMap

drawComponents

layeredPane

scroll

mainWindowDock

picker

toolBar

zoom

metrics

edgeBuffer

bgColor

launchButton

useLaunchButton

useLaunchButtonEdit

markMovedOption

markUnmovedIcon

markUnmovedText

markUnmovedTooltip

multicaster

mouseListenerStack

boards

boardWidths

boardHeights

pieces

highlighter

highlighters

clearFirst

hideCounters

pieceOpacity

allowMultiple

visibilityCondition

dragGestureListener

moveWithinFormat

moveToFormat

createFormat

changeFormat

moveKey

tooltip

propsContainer

repaintOnPropertyChange

pieceMover

saveKeyListeners

NAME

MARK_MOVED

MARK_UNMOVED_ICON

MARK_UNMOVED_TEXT

MARK_UNMOVED_TOOLTIP

EDGE_WIDTH

EDGE_HEIGHT

BACKGROUND_COLOR

HIGHLIGHT_COLOR

HIGHLIGHT_THICKNESS

ALLOW_MULTIPLE

USE_LAUNCH_BUTTON

BUTTON_NAME

TOOLTIP

ICON