Package VASSAL.build.module

Class PrivateMap

java.lang.Object

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.Map

VASSAL.build.module.PrivateMap

All Implemented Interfaces:

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

Direct Known Subclasses:

PlayerHand

public class PrivateMap
extends Map

A Map that may be configured to be visible only a particular side. If visible to all, the map will respond to key/mouse events only from the player playing the assigned side

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PrivateMap.View

Nested classes/interfaces inherited from class VASSAL.build.module.Map

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

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
protected String[]	owners
static String	SIDE
protected Map	surrogate
static String	USE_BOARDS
static String	VISIBLE
protected boolean	visibleToAll

Fields inherited from class VASSAL.build.module.Map

activeMap, ALLOW_MULTIPLE, allowMultiple, BACKGROUND_COLOR, bgColor, boardHeights, boards, boardWidths, BUTTON_NAME, CHANGE_FORMAT, changeFormat, changeReportingEnabled, clearFirst, CREATE_FORMAT, createFormat, dragGestureListener, drawComponents, dx, dy, EDGE_HEIGHT, EDGE_WIDTH, edgeBuffer, hideCounters, HIGHLIGHT_COLOR, HIGHLIGHT_THICKNESS, highlighter, highlighters, HOTKEY, ICON, idMgr, launchButton, layeredPane, LOCATION, MAIN_WINDOW_HEIGHT, mainWindowDock, MAP_NAME, mapID, mapName, MARK_MOVED, MARK_UNMOVED_ICON, MARK_UNMOVED_TEXT, MARK_UNMOVED_TOOLTIP, markMovedOption, markUnmovedIcon, 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, picker, PIECE_NAME, pieceMover, pieceOpacity, pieces, PREFERRED_EDGE_DELAY, PREFERRED_EDGE_SCROLL_DELAY, propsContainer, repaintOnPropertyChange, saveKeyListeners, scroll, SCROLL_ZONE, scroller, SUPPRESS_AUTO, sx, sy, theMap, toolBar, tooltip, TOOLTIP, USE_LAUNCH_BUTTON, useLaunchButton, useLaunchButtonEdit, visibilityCondition, 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
PrivateMap()

Method Summary

Modifier and Type	Method	Description
void	build(Element el)	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
protected Window	createParentFrame()
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
static String	getConfigureTypeName()
HelpFile	getHelpFile()
JComponent	getView()
boolean	isAccessibleTo(String playerSide)	Return true if the player playing the given side can access this map
boolean	isVisibleTo(String playerSide)
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
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.
void	setup(boolean show)	When a game is started, create a top-level window, if none exists.
boolean	shouldDockIntoMainWindow()
void	sideChanged(String oldSide, String newSide)

Methods inherited from class VASSAL.build.module.Map

addDrawComponent, addHighlighter, addLocalMouseListener, addLocalMouseListenerFirst, addMutableProperty, addPiece, addTo, appendToTitle, apply, boundingBoxOf, centerAt, centerAt, clearActiveMap, clearMapBorder, componentCoordinates, componentRectangle, componentToDrawing, componentToDrawing, componentToDrawing, componentToMap, componentToMap, componentToMap, 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, getAllBoards, getAllMaps, getAllowableConfigureComponents, getAllPieces, getAttributeVisibility, getBoardByName, getBoardCount, getBoardPicker, getBoards, getChangeFormat, getComponent, getCreateFormat, getDeckNameAt, getDeckNameContaining, getDefaultWindowTitle, getDragGestureListener, getEdgeBuffer, getHighlighter, getHighlighters, getId, getIdentifier, getLayeredPane, getLocalizedDeckNameAt, getLocalizedMapName, getLocalizedProperty, getLocation, getLocation, getMapById, getMapList, getMapName, getMoveKey, getMoveToFormat, getMoveWithinFormat, getMutablePropertiesContainerId, getMutableProperty, getPieceCollection, getPieceOpacity, getPieces, getPreferredSize, getProperty, getRestoreCommand, getStackMetrics, getToolBar, getZoom, getZoomer, indexOf, isChangeReportingEnabled, isLocationRestricted, 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, positionOf, pushMouseListener, removeDrawComponent, removeFrom, removeHighlighter, removeLocalMouseListener, removeMutableProperty, removePiece, repaint, repaint, repaint, reposition, scale, scale, scale, scroll, scrollAtEdge, selectionBoundsOf, setActiveMap, setBoardBoundaries, setBoardPicker, setChangeReportingEnabled, setDragGestureListener, setHighlighter, setId, setMapName, setPieceCollection, setPieceMover, setPieceOpacity, setPiecesVisible, setStackMetrics, setZoomer, snapTo, translateEvent

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

owners

protected String[] owners

visibleToAll

protected boolean visibleToAll

surrogate

protected Map surrogate

VISIBLE

public static final String VISIBLE

See Also:

Constant Field Values

SIDE

public static final String SIDE

See Also:

Constant Field Values

USE_BOARDS

public static final String USE_BOARDS

See Also:

Constant Field Values

Constructor Details

PrivateMap

public PrivateMap()

Method Details

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

Overrides:

getAttributeNames in class Map

Returns:

a list of all buildFile (XML) attribute names for 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

Overrides:

getAttributeDescriptions in class Map

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

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

Overrides:

getAttributeTypes in class Map

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

Overrides:

setAttribute in class Map

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

Overrides:

getAttributeValueString in class Map

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).

getView

public JComponent getView()

Overrides:

getView in class Map

Returns:

the Swing component representing the map

createParentFrame

protected Window createParentFrame()

Overrides:

createParentFrame in class Map

Returns:

the top-level window containing this map

sideChanged

public void sideChanged(String oldSide,
String newSide)

Specified by:

sideChanged in interface PlayerRoster.SideChangeListener

Overrides:

sideChanged in class Map

shouldDockIntoMainWindow

public boolean shouldDockIntoMainWindow()

Overrides:

shouldDockIntoMainWindow in class Map

isAccessibleTo

public boolean isAccessibleTo(String playerSide)

Return true if the player playing the given side can access this map

See Also:

PlayerRoster

isVisibleTo

public boolean isVisibleTo(String playerSide)

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 - if true, a game is starting. If false, then a game is ending

See Also:

GameComponent

setBoards

public void setBoards(Collection<Board> c)

Description copied from class: Map

Set the boards for this map. Each map may contain more than one Board.

Overrides:

setBoards in class Map

setBoards

@Deprecated(since="2020-08-06",
            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.

Description copied from class: Map

Set the boards for this map. Each map may contain more than one Board.

Overrides:

setBoards in class Map

getConfigureTypeName

public static String getConfigureTypeName()

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Overrides:

getHelpFile in class Map

Returns:

a HelpFilte describing how to use and configure this component

build

public void build(Element el)

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 Map

Parameters:

el - the XML element containing the object data