Package VASSAL.build.widget

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 VASSAL.build.module.Map

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

Nested classes/interfaces inherited from class VASSAL.build.AbstractToolbarItem

AbstractToolbarItem.FormattedStringConfig

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 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, 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

Fields inherited from class VASSAL.build.AbstractToolbarItem

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

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
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 VASSAL.build.module.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

Methods inherited from class VASSAL.build.AbstractToolbarItem

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

Methods inherited from class VASSAL.build.AbstractConfigurable

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

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, setAncestor, validate

Methods inherited from class VASSAL.search.AbstractImageFinder

getAllImageNames, getLocalImageNames

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.script.expression.Auditable

getComponentName, getComponentTypeName

Methods inherited from interface VASSAL.build.Buildable

add, getBuildElement, isMandatory, isMovable, isUnique

Methods inherited from interface VASSAL.build.Configurable

addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, remove

Methods inherited from interface VASSAL.tools.ToolBarComponent

updateToolbarButtons

Methods inherited from interface VASSAL.i18n.Translatable

getI18nData

Methods inherited from interface VASSAL.tools.UniqueIdManager.Identifyable

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