Class WidgetMap

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.AbstractToolbarItem

VASSAL.build.module.Map

VASSAL.build.widget.WidgetMap

All Implemented Interfaces:

DropTargetListener, MouseListener, MouseMotionListener, PropertyChangeListener, EventListener, AutoConfigurable, Buildable, Configurable, GameComponent, PlayerRoster.SideChangeListener, MutablePropertiesContainer, PropertyNameSource, PropertySource, ComponentDescription, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget, ToolBarComponent, UniqueIdManager.Identifyable

public class WidgetMap
extends Map

Nested Class Summary

Nested classes/interfaces inherited from class Map

Map.ChangeFormatConfig, Map.CreateFormatConfig, Map.IconConfig, Map.InsetLayout, Map.Merger, Map.MoveToFormatConfig, Map.MoveWithinFormatConfig, Map.UnmovedIconConfig, Map.UnmovedReportConfig, Map.View

Modifier and Type	Class	Description
static class	Map.ChangeFormatConfig	Report format configurer for "modified on map"
static class	Map.CreateFormatConfig	Report format configurer for "created on map"
static class	Map.IconConfig	Autoconfigurer for map's icon used on its launch button
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 (into a Stack or Deck} 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	Report format configurer for "moved to map"
static class	Map.MoveWithinFormatConfig	Report format configurer for "moved within map"
static class	Map.UnmovedIconConfig	Autoconfigurer for mark-unmoved icon
static class	Map.UnmovedReportConfig	Report format configurer for clear movement history
static class	Map.View	The (JPanel-extending) component that represents the map itself

Nested classes/interfaces inherited from class AbstractToolbarItem

AbstractToolbarItem.FormattedStringConfig

Modifier and Type	Class	Description
static class	AbstractToolbarItem.FormattedStringConfig

Nested classes/interfaces inherited from interface AutoConfigurable

AutoConfigurable.Util

Modifier and Type	Interface	Description
static class	AutoConfigurable.Util

Nested classes/interfaces inherited from interface MutablePropertiesContainer

MutablePropertiesContainer.Impl

Modifier and Type	Interface	Description
static class	MutablePropertiesContainer.Impl	Simple implementation of MutablePropertiesContainer

Field Summary

Fields inherited from class Map

activeMap, ALLOW_MULTIPLE, allowMultiple, BACKGROUND_COLOR, bgColor, boardHeights, boards, boardWidths, BUTTON_NAME, CHANGE_FORMAT, changeFormat, changeReportingEnabled, clearFirst, CREATE_FORMAT, createFormat, DEFAULT_EDGE_SCROLL_DELAY_PROPERTY, DEFAULT_EDGE_SCROLL_RATE_PROPERTY, DEFAULT_EDGE_SCROLL_ZONE_PROPERTY, description, DESCRIPTION, dragGestureListener, drawComponents, dx, dy, EDGE_HEIGHT, EDGE_SCROLL_RATE, EDGE_WIDTH, edgeBuffer, HIDE_KEY, hideCounters, hideKeyListener, HIGHLIGHT_COLOR, HIGHLIGHT_THICKNESS, highlighter, highlighters, HOTKEY, ICON, idMgr, keyBufferer, launchButton, layeredPane, LOCATION, mainWindowDock, MAP_NAME, mapID, mapName, MARK_MOVED, MARK_UNMOVED_HOTKEY, MARK_UNMOVED_ICON, MARK_UNMOVED_REPORT, MARK_UNMOVED_TEXT, MARK_UNMOVED_TOOLTIP, markMovedOption, markUnmovedHotkey, markUnmovedIcon, markUnmovedReport, markUnmovedText, markUnmovedTooltip, MESSAGE, metrics, mouseListenerStack, MOVE_KEY, MOVE_TO_FORMAT, MOVE_WITHIN_FORMAT, moveKey, moveToFormat, moveWithinFormat, MOVING_STACKS_PICKUP_UNITS, multicaster, NAME, OLD_LOCATION, OLD_MAP, ONLY_REPORT_CHANGED_LOCATION, onlyReportChangedLocation, picker, PIECE_NAME, pieceMover, pieceOpacity, pieces, PREFERRED_EDGE_DELAY, PREFERRED_EDGE_SCROLL_DELAY, PREFERRED_EDGE_SCROLL_RATE, PREFERRED_EDGE_SCROLL_RATE_STANDARD_DEFAULT, PREFERRED_EDGE_SCROLL_ZONE_STANDARD_DEFAULT, PREFERRED_SCROLL_ZONE, preferredCenter, propsContainer, repaintOnPropertyChange, saveKeyListeners, scroll, SCROLL_ZONE, scroller, SHOW_KEY, showKeyListener, splitPane, SUPPRESS_AUTO, sx, sy, theMap, toolBar, tooltip, TOOLTIP, USE_LAUNCH_BUTTON, useLaunchButton, useLaunchButtonEdit, visibilityCondition, zoom

Modifier and Type	Field	Description
static Map	activeMap
static final String	ALLOW_MULTIPLE
protected boolean	allowMultiple
static final String	BACKGROUND_COLOR
protected Color	bgColor
protected int[][]	boardHeights
protected List<Board>	boards
protected int[][]	boardWidths
static final String	BUTTON_NAME
static final String	CHANGE_FORMAT
protected String	changeFormat
protected static boolean	changeReportingEnabled
protected boolean	clearFirst
static final String	CREATE_FORMAT
protected String	createFormat
protected static final String	DEFAULT_EDGE_SCROLL_DELAY_PROPERTY
protected static final String	DEFAULT_EDGE_SCROLL_RATE_PROPERTY
protected static final String	DEFAULT_EDGE_SCROLL_ZONE_PROPERTY
protected String	description
static final String	DESCRIPTION
protected DragGestureListener	dragGestureListener
protected ArrayList<Drawable>	drawComponents
protected int	dx
protected int	dy
static final String	EDGE_HEIGHT
static double	EDGE_SCROLL_RATE
static final String	EDGE_WIDTH
protected Dimension	edgeBuffer
static final String	HIDE_KEY
protected boolean	hideCounters
protected NamedKeyStrokeListener	hideKeyListener
static final String	HIGHLIGHT_COLOR
static final String	HIGHLIGHT_THICKNESS
protected Highlighter	highlighter
protected ArrayList<Highlighter>	highlighters
static final String	HOTKEY
static final String	ICON
protected static final UniqueIdManager	idMgr
protected KeyBufferer	keyBufferer
protected LaunchButton	launchButton	Deprecated, for removal: This API element is subject to removal in a future version. use launch from the superclass
protected JLayeredPane	layeredPane
static final String	LOCATION
protected ComponentSplitter.SplitPane	mainWindowDock	Deprecated, for removal: This API element is subject to removal in a future version.
static final String	MAP_NAME
protected String	mapID
protected String	mapName
static final String	MARK_MOVED
static final String	MARK_UNMOVED_HOTKEY
static final String	MARK_UNMOVED_ICON
static final String	MARK_UNMOVED_REPORT
static final String	MARK_UNMOVED_TEXT
static final String	MARK_UNMOVED_TOOLTIP
protected String	markMovedOption
protected NamedKeyStroke	markUnmovedHotkey
protected String	markUnmovedIcon
protected String	markUnmovedReport
protected String	markUnmovedText
protected String	markUnmovedTooltip
static final String	MESSAGE
protected StackMetrics	metrics
protected ArrayList<MouseListener>	mouseListenerStack
static final String	MOVE_KEY
static final String	MOVE_TO_FORMAT
static final String	MOVE_WITHIN_FORMAT
protected NamedKeyStroke	moveKey
protected String	moveToFormat
protected String	moveWithinFormat
static final String	MOVING_STACKS_PICKUP_UNITS
protected MouseListener	multicaster
static final String	NAME
static final String	OLD_LOCATION
static final String	OLD_MAP
static final String	ONLY_REPORT_CHANGED_LOCATION
protected boolean	onlyReportChangedLocation
protected BoardPicker	picker
static final String	PIECE_NAME
protected PieceMover	pieceMover
protected float	pieceOpacity
protected PieceCollection	pieces
static final String	PREFERRED_EDGE_DELAY
static final int	PREFERRED_EDGE_SCROLL_DELAY
static final String	PREFERRED_EDGE_SCROLL_RATE
static final double	PREFERRED_EDGE_SCROLL_RATE_STANDARD_DEFAULT	The rate at which things scroll
static final int	PREFERRED_EDGE_SCROLL_ZONE_STANDARD_DEFAULT	The width of the hot zone for triggering autoscrolling.
static final String	PREFERRED_SCROLL_ZONE
protected Point	preferredCenter
protected MutablePropertiesContainer	propsContainer
protected PropertyChangeListener	repaintOnPropertyChange
protected KeyListener[]	saveKeyListeners
protected JScrollPane	scroll
static int	SCROLL_ZONE
protected org.jdesktop.animation.timing.Animator	scroller	The animator which controls autoscrolling.
static final String	SHOW_KEY
protected NamedKeyStrokeListener	showKeyListener
protected SplitPane	splitPane
static final 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 final String	TOOLTIP
static final String	USE_LAUNCH_BUTTON
protected boolean	useLaunchButton
protected boolean	useLaunchButtonEdit
protected VisibilityCondition	visibilityCondition
protected Zoomer	zoom

Fields inherited from class AbstractToolbarItem

BUTTON_TEXT, CAN_DISABLE, canDisable, DISABLED_ICON, disabledIconConfig, HIDE_WHEN_DISABLED, hideWhenDisabled, launch, property, PROPERTY_GATE, propertyGate, showDisabledOptions

Modifier and Type	Field	Description
static final String	BUTTON_TEXT
static final String	CAN_DISABLE
protected boolean	canDisable
static final String	DISABLED_ICON
protected IconConfigurer	disabledIconConfig
static final String	HIDE_WHEN_DISABLED
protected boolean	hideWhenDisabled
protected LaunchButton	launch
protected MutableProperty.Impl	property
static final String	PROPERTY_GATE
protected String	propertyGate
protected boolean	showDisabledOptions

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

Method Summary

Modifier and Type	Method	Description
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
JScrollPane	getScroll()
void	setup(boolean show)	When a game is started, create a top-level window, if none exists.
boolean	shouldDockIntoMainWindow()	Widget maps are always undocked

Methods inherited from class Map

addDrawComponent, addHighlighter, addLocalImageNames, addLocalMouseListener, addLocalMouseListenerFirst, addMutableProperty, addPiece, addTo, appendToTitle, apply, boundingBoxOf, build, centerAt, centerAt, clearActiveMap, clearMapBorder, componentCoordinates, componentRectangle, componentToDrawing, componentToDrawing, componentToDrawing, componentToMap, componentToMap, componentToMap, createParentFrame, disableKeyListeners, dragEnter, dragExit, dragOver, drawBoards, drawBoardsInRegion, drawBoardsInRegion, drawDrawable, drawingToComponent, drawingToComponent, drawingToComponent, drawingToMap, drawingToMap, drawingToMap, drawPieces, drawPiecesInRegion, drawPiecesInRegion, drop, dropActionChanged, enableKeyListeners, ensureVisible, findAnyPiece, findBoard, findPiece, findRegion, findZone, findZone, getAllowableConfigureComponents, getAllPieces, getAttributeDescriptions, getAttributeNames, getAttributeTypes, getAttributeValueString, getBoardByName, getBoardCount, getBoardPicker, getBoards, getCenter, getChangeFormat, getChangeFormat, getComponent, getConfigureTypeName, getCreateFormat, getDeckNameAt, getDeckNameContaining, getDefaultWindowTitle, getDescription, getDragGestureListener, getEdgeBuffer, getFormattedStringList, getHelpFile, getHighlighter, getHighlighters, getId, getIdentifier, getKeyBufferer, getLayeredPane, getLocalizedDeckNameAt, getLocalizedMapName, getLocalizedProperty, getLocation, getLocation, getLocation2D, getLocation2D, getMapById, getMapList, getMapName, getMaxPixelsPerRangeUnit, getMenuTextList, getMoveKey, getMoveToFormat, getMoveWithinFormat, getMutablePropertiesContainerId, getMutableProperty, getNamedKeyStrokeList, getPieceCollection, getPieceMover, getPieceOpacity, getPieces, getPreferredCenter, getPreferredSize, getProperty, getPropertyNames, getRestoreCommand, getStackMetrics, getToolBar, getView, getVisibleRect, getZoom, getZoomer, hideMap, indexOf, isAnyMouseoverDrawn, isChangeReportingEnabled, isDrawingMouseOver, isFirstMap, isLocationRestricted, isMarkMoved, isNotPieceDrag, isOnlyReportChangedLocation, isPiecesVisible, isVisibleToAll, localizedLocationName, locationName, mapCoordinates, mapRectangle, mapSize, mapToComponent, mapToComponent, mapToComponent, mapToDrawing, mapToDrawing, mapToDrawing, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, paintRegion, paintRegion, placeAt, placeOrMerge, popMouseListener, popMouseListener, positionOf, pushMouseListener, removeDrawComponent, removeFrom, removeHighlighter, removeLocalMouseListener, removeMutableProperty, removePiece, repaint, repaint, repaint, scale, scale, scale, scroll, scrollAtEdge, selectionBoundsOf, setActiveMap, setAnyMouseoverDrawn, setAttribute, setBoardBoundaries, setBoardPicker, setBoards, setChangeReportingEnabled, setDragGestureListener, setDrawingMouseOver, setHighlighter, setId, setKeyBufferer, setMapName, setPieceCollection, setPieceMover, setPieceOpacity, setPiecesVisible, setStackMetrics, setUpView, setZoomer, showMap, sideChanged, snapTo, snapTo, snapTo, translateEvent, updateCenter, updateTitleBar

Modifier and Type	Method	Description
void	addDrawComponent(Drawable theComponent)	Registers a Drawable component to this map.
void	addHighlighter(Highlighter h)
void	addLocalImageNames(Collection<String> s)	In case reports use HTML and refer to any image files
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)	Because MouseEvents are received in Component coordinates, it is inconvenient for MouseListeners on the map to have to translate to Map coordinates.
void	addMutableProperty(String key, MutableProperty p)	Adds a new Global Property to this map.
void	addPiece(GamePiece p)	Adds a GamePiece to this map's list of pieces.
void	addTo(Buildable b)	Registers this Map as a child of another buildable component, usually the GameModule.
void	appendToTitle(String s)	Deprecated, for removal: This API element is subject to removal in a future version. use Map.updateTitleBar()
Command	apply(PieceVisitorDispatcher commandFactory)	Attempts to apply the provided PieceVisitorDispatcher to all pieces on this map, until it finds one that returns a non-null Command.
Rectangle	boundingBoxOf(GamePiece p)
void	build(Element e)	Builds the map's component hierarchy from a given XML element, or a null one is given initializes a brand new default "new map" hierarchy.
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()	Repaints the current ActiveMap (see Map.setActiveMap(Map)) and unmarks it.
protected void	clearMapBorder(Graphics g)	Clears the map border region, if any.
Point	componentCoordinates(Point p)	Deprecated, for removal: This API element is subject to removal in a future version. Use Map.mapToComponent(Point)
Rectangle	componentRectangle(Rectangle r)	Deprecated, for removal: This API element is subject to removal in a future version. Use Map.mapToComponent(Rectangle)
int	componentToDrawing(int c, double os_scale)	Converts an integer value from Component coordinates system to Drawing coordinates for rendering.
Point	componentToDrawing(Point p, double os_scale)	Converts a Point from Component coordinates to Drawing coordinates for rendering.
Rectangle	componentToDrawing(Rectangle r, double os_scale)	Converts a Rectangle from Component coordinates to Drawing coordinates for rendering.
int	componentToMap(int c)	Converts an integer value from swing Component coordinates to the Map's coordinate system.
Point	componentToMap(Point p)	Converts a Point from swing Component coordinates to the Map's coordinate system.
Rectangle	componentToMap(Rectangle r)	Converts a Rectangle from swing Component coordinates to the Map's coordinate system.
protected Window	createParentFrame()	Creates the top-level window for this map.
void	disableKeyListeners()	Restore the previously disabled KeyListeners
void	dragEnter(DropTargetDragEvent dtde)
void	dragExit(DropTargetEvent dte)
void	dragOver(DropTargetDragEvent dtde)	Handles scrolling when dragging an gamepiece to the edge of the window
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)	For each Board overlapping the given region, update the appropriate section of the board image.
void	drawBoardsInRegion(Graphics g, Rectangle visibleRect, Component c)	For each Board overlapping the given region, update the appropriate section of the board image.
void	drawDrawable(Graphics g, boolean aboveCounters)	Draws all of our "Drawable" components.
int	drawingToComponent(int c, double os_scale)	Converts an integer value from Drawing coordinates to swing Component coordinates.
Point	drawingToComponent(Point p, double os_scale)	Converts a Point from Drawing coordinates to swing Component coordinates.
Rectangle	drawingToComponent(Rectangle r, double os_scale)	Converts a Rectangle from Drawing coordinates to swing Component coordinates.
int	drawingToMap(int c, double os_scale)	Converts an integer value from Drawing coordinates to the Map's coordinate system.
Point	drawingToMap(Point p, double os_scale)	Converts a Point from Drawing coordinates to the Map's coordinate system.
Rectangle	drawingToMap(Rectangle r, double os_scale)	Converts a Rectangle from Drawing coordinates to the Map's coordinate system.
void	drawPieces(Graphics g, int xOffset, int yOffset)	Draws the map pieces at a given offset
void	drawPiecesInRegion(Graphics g, Rectangle visibleRect)	Draws all pieces visible in a rectangular area of the map
void	drawPiecesInRegion(Graphics g, Rectangle visibleRect, Component c)	Draws all pieces visible in a rectangular area of the map
void	drop(DropTargetDropEvent dtde)	We put the "drop" in drag-n-drop!
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)	Since a map can have multiple boards in use at once (laid out above and beside each other), this method accepts a Point in the map's coordinate space and will return the Board which contains that point, or null if none.
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 (location on an Irregular Grid) with the given name
Zone	findZone(Point p)	If the given point in the map's coordinate space is within a Zone on a board with a ZonedGrid (aka Multi-zoned Grid), returns the Zone.
Zone	findZone(String name)	Search on all boards for a Zone with the given name
Class<?>[]	getAllowableConfigureComponents()	List of subcomponents which can be added to a Map.
GamePiece[]	getAllPieces()
String[]	getAttributeDescriptions()	This getAttributeDescriptions() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
Class<?>[]	getAttributeTypes()	This getAttributeTypes() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
String	getAttributeValueString(String key)	Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.
Board	getBoardByName(String name)	Searches our list of boards for one with the given name
int	getBoardCount()
BoardPicker	getBoardPicker()	Every map must include a BoardPicker as one of its build components.
Collection<Board>	getBoards()
Point	getCenter()
String	getChangeFormat()
String	getChangeFormat(boolean noSuppress)
Component	getComponent()	The component to be added to the control window toolbar
static String	getConfigureTypeName()	Gets the generic name for this type of class across all instances of it.
String	getCreateFormat()
String	getDeckNameAt(Point p)	Return the name of the Deck whose position is precisely p
String	getDeckNameContaining(Point p)
protected String	getDefaultWindowTitle()
String	getDescription()
DragGestureListener	getDragGestureListener()
Dimension	getEdgeBuffer()
List<String>	getFormattedStringList()	SearchTarget
HelpFile	getHelpFile()
Highlighter	getHighlighter()
Iterator<Highlighter>	getHighlighters()
String	getId()	Each Map must have a unique String id
String	getIdentifier()	Make a best guess for a unique identifier for the target.
KeyBufferer	getKeyBufferer()
JLayeredPane	getLayeredPane()
String	getLocalizedDeckNameAt(Point p)	Return the localized name of the Deck whose position is precisely p
String	getLocalizedMapName()
Object	getLocalizedProperty(Object key)	Gets the value of map-level global property, or a module-level one if a map-level one is not found.
protected Point	getLocation(int column, int row, double zoom)	Finds the location of a board (in Map space) at a particular column and row, based on passed zoom factor
Point	getLocation(Board b, double zoom)	Gets the location of a board in Map space, based on a passed zoom factor
protected Point2D	getLocation2D(int column, int row, double zoom)
Point2D	getLocation2D(Board b, double zoom)
static Map	getMapById(String id)	Find the map that corresponds to a known unique id
static List<Map>	getMapList()	Utility method to return a List of all map components (on all maps!)
String	getMapName()
int	getMaxPixelsPerRangeUnit(Point p)
List<String>	getMenuTextList()	SearchTarget
KeyStroke	getMoveKey()	Return the apply-on-move key.
String	getMoveToFormat()
String	getMoveWithinFormat()
String	getMutablePropertiesContainerId()	Return a unique Id for the container
MutableProperty	getMutableProperty(String name)	Find a contained Global Property (variable) by name.
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
PieceCollection	getPieceCollection()
PieceMover	getPieceMover()
float	getPieceOpacity()
GamePiece[]	getPieces()
Point	getPreferredCenter()
Dimension	getPreferredSize()
Object	getProperty(Object key)	Gets the value of a map-level global property.
List<String>	getPropertyNames()	Override this method to provide a list of properties to be exposed for use by expressions in the module.
Command	getRestoreCommand()	As a GameComponent, Map does not have any action inherently needing to be taken for "restoring" itself for load/save and network play purposes (the locations of pieces, etc, are stored in the pieces, and are restored from GameState in its GameState.getRestorePiecesCommand() method, which creates an AddPiece command for each piece).
StackMetrics	getStackMetrics()	Every map must include a single StackMetrics object as one of its build components, which governs the visuals of stacking of GamePieces on the map
JToolBar	getToolBar()	Every map window has a toolbar, and this method returns swing toolbar component for this map.
JComponent	getView()
Rectangle	getVisibleRect()
double	getZoom()	If the map has a Zoomer (see Map.setZoomer(Zoomer)), then returns the Zoomer's current zoom factor.
Zoomer	getZoomer()	A map may include a Zoomer as one of its build components.
void	hideMap()
int	indexOf(GamePiece s)	Returns the index of a piece.
boolean	isAnyMouseoverDrawn()
static boolean	isChangeReportingEnabled()
boolean	isDrawingMouseOver()
boolean	isFirstMap()
boolean	isLocationRestricted(Point p)
boolean	isMarkMoved()
boolean	isNotPieceDrag(Transferable trans)
boolean	isOnlyReportChangedLocation()
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 Map.componentToMap(Point)
Rectangle	mapRectangle(Rectangle r)	Deprecated, for removal: This API element is subject to removal in a future version. Use Map.componentToMap(Rectangle)
Dimension	mapSize()
int	mapToComponent(int c)	Converts an integer value from the Map's coordinate system to Component coordinates used for interactions between swing components.
Point	mapToComponent(Point p)	Converts a Point from the Map's coordinate system to Component coordinates used for interactions between swing components.
Rectangle	mapToComponent(Rectangle r)	Converts a Rectangle from the Map's coordinate system to Component coordinates used for interactions between swing components.
int	mapToDrawing(int c, double os_scale)	Converts an integer value from the Map's coordinate system to Drawing coordinates for rendering.
Point	mapToDrawing(Point p, double os_scale)	Converts a point from the Map's coordinate system to Drawing coordinates for rendering.
Rectangle	mapToDrawing(Rectangle r, double os_scale)	Converts a rectangle from the Map's coordinate system to Drawing coordinates for rendering.
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)	Mouse events are first translated into map coordinates.
void	mouseReleased(MouseEvent e)	Mouse events are first translated into map coordinates.
void	paintRegion(Graphics g, Rectangle visibleRect)	Paints a specific region of the map, denoted by a Rectangle.
void	paintRegion(Graphics g, Rectangle visibleRect, Component c)	Paints a specific region of the map, denoted by a Rectangle.
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.
void	popMouseListener(MouseListener l)	Remove the most recently pushed mouse listener only if it is the supplied listener
Point	positionOf(GamePiece p)
void	pushMouseListener(MouseListener l)	MouseListeners on a map may be pushed and popped onto a stack.
void	removeDrawComponent(Drawable theComponent)	Unregister a Drawable component from this map
void	removeFrom(Buildable b)	Unregisters this Map from its Buildable parent (usually a GameModule), reversing the process of Map.addTo(Buildable).
void	removeHighlighter(Highlighter h)
void	removeLocalMouseListener(MouseListener l)	Because MouseEvents are received in Component coordinates, it is inconvenient for MouseListeners on the map to have to translate to Map coordinates.
MutableProperty	removeMutableProperty(String key)	Removes a new Global Property from this map.
void	removePiece(GamePiece p)	Removes a piece from the map
void	repaint()	Repaints the map.
void	repaint(boolean cf)	Repaints the map.
void	repaint(Rectangle r)	Repaint the given area, specified in map coordinates
protected int	scale(int c, double zoom)	Scales an integer value to a zoom factor
protected Point	scale(Point p, double zoom)	Scales a point to a zoom factor
protected Rectangle	scale(Rectangle r, double zoom)	Scales a Rectangle to a zoom factor
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)
static void	setActiveMap(Map m)	Marks an ActiveMap for certain drag and drop operations, so that the map can be repainted when the operation is complete.
void	setAnyMouseoverDrawn(boolean flag)
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 single BoardPicker as one of its build components.
void	setBoards(Collection<Board> c)	Set the boards for this map.
static void	setChangeReportingEnabled(boolean b)	Global Change Reporting control - used by Global Key Commands (see GlobalCommand) to temporarily disable reporting while they run, if their "Suppress individual reports" option is selected.
void	setDragGestureListener(DragGestureListener dragGestureListener)	This listener will be notified when a drag event is initiated, assuming that no MouseListeners are on the stack.
void	setDrawingMouseOver(boolean flag)
void	setHighlighter(Highlighter h)
void	setId(String id)	Each Map must have a unique String id Sets our unique ID (among Maps), so that e.g. commands sent to different maps don't inadvertently get confused when we send commands to other clients.
void	setKeyBufferer(KeyBufferer kb)	Registers the keyBufferer for this map (old way of scanning through components to find one is silly)
void	setMapName(String s)
void	setPieceCollection(PieceCollection pieces)
void	setPieceMover(PieceMover mover)	Every map must include a single PieceMover component as one of its build components, which handles drag-and-drop behavior for the map.
void	setPieceOpacity(float pieceOpacity)
void	setPiecesVisible(boolean show)
void	setStackMetrics(StackMetrics sm)	Every map must include a single StackMetrics as one of its build components, which governs the visuals of stacking of GamePieces on the map.
void	setUpView()	Common view setup code for Map and PrivateMap, which confusingly have different View classes that sharing the same name
void	setZoomer(Zoomer z)	A map may include a single Zoomer as one of its build components.
void	showMap()
void	sideChanged(String oldSide, String newSide)	Takes action when the local player has switched sides.
Point	snapTo(Point p)
Point	snapTo(Point p, boolean force)
Point	snapTo(Point p, boolean force, boolean onlyCenter)
MouseEvent	translateEvent(MouseEvent e)	Because MouseEvents are received in Component coordinates, it is inconvenient for MouseListeners on the map to have to translate to Map coordinates.
void	updateCenter()	Accepts the current actual center of the map as the new "preferred center" (e.g. if we scroll) Just not if suppressed after a zoom level change (we don't want zoom level changes to cause us to lose track of the user's preferred ceter point)
void	updateTitleBar()	Updates the title bar of the current window

Methods inherited from class AbstractToolbarItem

addPropertyGateListener, addPropertyGateListener, checkDisabled, disableIfTrue, getLaunchButton, getNameKey, getPropertyList, isShowDisabledOptions, makeLaunchButton, propertyChange, removePropertyGateListener, setButtonTextKey, setHotKeyKey, setIconKey, setLaunchButton, setNameKey, setNamePrompt, setShowDisabledOptions, setTooltipKey

Modifier and Type	Method	Description
protected void	addPropertyGateListener()
protected void	addPropertyGateListener(boolean dontCheck)	If we have a disable-this-button property, set a listener on it
void	checkDisabled()	Check our disable-this-button property and enable/disable our button as appropriate based on its value
void	disableIfTrue(boolean disable)
LaunchButton	getLaunchButton()
protected String	getNameKey()
List<String>	getPropertyList()	SearchTarget
boolean	isShowDisabledOptions()
protected LaunchButton	makeLaunchButton(String tooltip, String button_text, String iconFile, ActionListener action)	Create a standard toolbar launcher button for this item
void	propertyChange(PropertyChangeEvent evt)	Listens to our disable-this-button property; enables/disables our button as appropriate when it changes
protected void	removePropertyGateListener()	Remove any existing disable-this-button property
protected void	setButtonTextKey(String buttonTextKey)
protected void	setHotKeyKey(String hotKeyKey)
protected void	setIconKey(String iconKey)
protected void	setLaunchButton(LaunchButton launch)	Sets launch button for this toolbar item
protected void	setNameKey(String nameKey)
protected void	setNamePrompt(String namePrompt)
protected void	setShowDisabledOptions(boolean show)
protected void	setTooltipKey(String tooltipKey)

Methods inherited from class AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, getExpressionList, getI18nData, getI18nPrefix, getLocalizedConfigureName, 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()
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
List<String>	getExpressionList()	SearchTarget
ComponentI18nData	getI18nData()
protected String	getI18nPrefix()
String	getLocalizedConfigureName()
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, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, 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
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()
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?

Methods inherited from interface ToolBarComponent

updateToolbarButtons

Modifier and Type	Method	Description
default void	updateToolbarButtons()	Update the text labels in the toolbar's component buttons (for mutable button label support)

Methods inherited from interface UniqueIdManager.Identifyable

getConfigureName

Modifier and Type	Method	Description
String	getConfigureName()

Constructor Details

WidgetMap

public WidgetMap()

Method Details

setup

public void setup(boolean show)

Description copied from class: Map

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

Overrides:

setup in class Map

Parameters:

show - true if a game is starting, false if a game is ending

See Also:

• GameComponent

shouldDockIntoMainWindow

public boolean shouldDockIntoMainWindow()

Widget maps are always undocked

Overrides:

shouldDockIntoMainWindow in class Map

Returns:

whether this map should dock into the main window

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 Map

Parameters:

name - Name (key) of one of this component's attributes

Returns:

Visibility condition for the corresponding component

getScroll

public JScrollPane getScroll()