Package VASSAL.build.module.map

Class GlobalMap

java.lang.Object

VASSAL.build.module.map.GlobalMap

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, GameComponent, Drawable, Translatable

public class GlobalMap
extends Object
implements AutoConfigurable, GameComponent, Drawable

This is scaled version of a Map that gives an overview. Users can navigate around the Map by clicking on the GlobalMap, which draws a rectangular region of interest (ROI) indicating the current viewable area in the map window.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	GlobalMap.CounterViewer
protected class	GlobalMap.GlobalMapScrollPane	The scroll pane in which the map GlobalMap.View is displayed.
static class	GlobalMap.IconConfig
protected class	GlobalMap.View	The Map view that appears inside the ScrollPane

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	BUTTON_TEXT
protected static String	COLOR
protected static String	DEFAULT_ICON
protected static String	HOTKEY
protected static String	ICON_NAME
protected LaunchButton	launch
protected Map	map
protected CounterDetailViewer	mouseOverViewer
protected ComponentI18nData	myI18nData
protected Color	rectColor
protected double	scale
protected static String	SCALE
protected ScrollPane	scroll
protected static String	TOOLTIP
protected GlobalMap.View	view

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
GlobalMap()

Method Summary

Modifier and Type	Method	Description
void	add(Buildable b)	Adds a child component.
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener.
void	addTo(Buildable b)	Expects to be added to a Map.
void	build(Element e)	Build the object
Point	componentCoordinates(Point p)	Deprecated, for removal: This API element is subject to removal in a future version. Use mapToComponent(Point)
Point	componentToMap(Point p)
void	draw(Graphics g, Map m)
boolean	drawAboveCounters()
Class<?>[]	getAllowableConfigureComponents()	Return a list of valid sub-component Classes.
String[]	getAttributeDescriptions()	Return an array of Strings describing the attributes of this object.
String[]	getAttributeNames()
Class<?>[]	getAttributeTypes()	Return the Class for the attributes of this object.
String	getAttributeValueString(String key)	Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
VisibilityCondition	getAttributeVisibility(String name)	Because attributes are not always applicable in all cases, this method returns an interface to determine when the controls for specifying the named attribute should be visible.
Element	getBuildElement(Document doc)
Configurable[]	getConfigureComponents()
String	getConfigureName()	The name of this Configurable Object
Configurer	getConfigurer()	Return a Configurer object which can be used to set the attributes of this object
static String	getConfigureTypeName()
HelpFile	getHelpFile()
ComponentI18nData	getI18nData()
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
String	getToolTipText(MouseEvent e)
Point	mapCoordinates(Point p)	Deprecated, for removal: This API element is subject to removal in a future version. Use componentToMap(Point)
Point	mapToComponent(Point p)
Point	mapToDrawing(Point p, double os_scale)
Rectangle	mapToDrawing(Rectangle r, double os_scale)
void	remove(Buildable b)	Remove a child component
void	removeFrom(Buildable b)	Remove this component from its parent
void	setAttribute(String key, Object value)	Called by the Buildable.build(org.w3c.dom.Element) method, where value is the String value read by the XML attribute.
void	setup(boolean show)	Notify the GameComponent that a game has started/ended

Methods inherited from class java.lang.Object

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

Field Details

map

protected Map map

scale

protected double scale

rectColor

protected Color rectColor

launch

protected final LaunchButton launch

mouseOverViewer

protected CounterDetailViewer mouseOverViewer

scroll

protected final ScrollPane scroll

view

protected final GlobalMap.View view

myI18nData

protected ComponentI18nData myI18nData

SCALE

protected static final String SCALE

See Also:

Constant Field Values

COLOR

protected static final String COLOR

See Also:

Constant Field Values

HOTKEY

protected static final String HOTKEY

See Also:

Constant Field Values

ICON_NAME

protected static final String ICON_NAME

See Also:

Constant Field Values

TOOLTIP

protected static final String TOOLTIP

See Also:

Constant Field Values

BUTTON_TEXT

protected static final String BUTTON_TEXT

See Also:

Constant Field Values

DEFAULT_ICON

protected static final String DEFAULT_ICON

See Also:

Constant Field Values

Constructor Details

GlobalMap

public GlobalMap()

Method Details

addTo

public void addTo(Buildable b)

Expects to be added to a Map. Adds itself as a GameComponent and a Drawablecomponent

Specified by:

addTo in interface Buildable

add

public void add(Buildable b)

Description copied from interface: Buildable

Adds a child component. Both this method and Buildable.addTo(VASSAL.build.Buildable) are invoked when adding a child to a parent

Specified by:

add in interface Buildable

remove

public void remove(Buildable b)

Description copied from interface: Configurable

Remove a child component

Specified by:

remove in interface Configurable

removeFrom

public void removeFrom(Buildable b)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

build

public void build(Element e)

Description copied from interface: Buildable

Build the object

Specified by:

build in interface Buildable

Parameters:

e - the XML element containing the object data

getAttributeNames

public String[] getAttributeNames()

Specified by:

getAttributeNames in interface AutoConfigurable

Returns:

an array of Strings giving all attributes of this Buildable component that will be written to/read from an XML element

getAttributeVisibility

public VisibilityCondition getAttributeVisibility(String name)

Description copied from interface: AutoConfigurable

Because attributes are not always applicable in all cases, this method returns an interface to determine when the controls for specifying the named attribute should be visible.

Specified by:

getAttributeVisibility in interface AutoConfigurable

Returns:

null if the attribute controls should always be visible;

setAttribute

public void setAttribute(String key,
Object value)

Description copied from interface: AutoConfigurable

Called by the Buildable.build(org.w3c.dom.Element) method, where value is the String value read by the XML attribute. Can also be called with Object value to set the attribute.

Specified by:

setAttribute in interface AutoConfigurable

Specified by:

setAttribute in interface Translatable

Parameters:

key - the name of the attribute. If the implementing class extends AbstractConfigurable, will be one of those listed in AbstractBuildable.getAttributeNames().

value - If the value parameter is a String, it will be the value returned by Translatable.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

Parameters:

key - the name of the attribute. If the implementing class extends AbstractConfigurable, 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 Translatable.setAttribute(java.lang.String, java.lang.Object).

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

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from interface: AutoConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, File, Color, and KeyStroke

Specified by:

getAttributeTypes in interface AutoConfigurable

draw

public void draw(Graphics g,
Map m)

Specified by:

draw in interface Drawable

drawAboveCounters

public boolean drawAboveCounters()

Specified by:

drawAboveCounters in interface Drawable

componentCoordinates

@Deprecated(since="2020-08-06",
            forRemoval=true)
public Point componentCoordinates(Point p)

Deprecated, for removal: This API element is subject to removal in a future version.

Use mapToComponent(Point)

Transform a point from Map coordinates to coordinates in the overview window

Parameters:

p - Point

Returns:

Transformed Point

mapCoordinates

@Deprecated(since="2020-08-06",
            forRemoval=true)
public Point mapCoordinates(Point p)

Deprecated, for removal: This API element is subject to removal in a future version.

Use componentToMap(Point)

Transform a point from coordinates in the overview window to Map coordinates

Parameters:

p - Point

Returns:

Transformed Point

componentToMap

public Point componentToMap(Point p)

mapToComponent

public Point mapToComponent(Point p)

mapToDrawing

public Point mapToDrawing(Point p,
double os_scale)

mapToDrawing

public Rectangle mapToDrawing(Rectangle r,
double os_scale)

getToolTipText

public String getToolTipText(MouseEvent e)

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

setup

public void setup(boolean show)

Description copied from interface: GameComponent

Notify the GameComponent that a game has started/ended

Specified by:

setup in interface GameComponent

Parameters:

show - if true, a game is starting. If false, then a game is ending

getConfigureTypeName

public static String getConfigureTypeName()

getConfigureName

public String getConfigureName()

Description copied from interface: Configurable

The name of this Configurable Object

Specified by:

getConfigureName in interface Configurable

getConfigurer

public Configurer getConfigurer()

Description copied from interface: Configurable

Return a Configurer object which can be used to set the attributes of this object

Specified by:

getConfigurer in interface Configurable

getConfigureComponents

public Configurable[] getConfigureComponents()

Specified by:

getConfigureComponents in interface Configurable

Returns:

an array of Configurer objects representing the Configurable children of this Configurable object

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

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Description copied from interface: Configurable

Add a PropertyChangeListener. A PropertyChangeEvent should be fired with property name Configurable.NAME_PROPERTY when the value returned from Configurable.getConfigureName() has changed

Specified by:

addPropertyChangeListener in interface Configurable

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFilte describing how to use and configure this component

getBuildElement

public Element getBuildElement(Document doc)

Specified by:

getBuildElement in interface Buildable

Returns:

an XML element from which this component can be built

getI18nData

public ComponentI18nData getI18nData()

Specified by:

getI18nData in interface Translatable