Package VASSAL.build.module
Class PlayerHand
java.lang.Object
VASSAL.build.AbstractBuildable
VASSAL.build.AbstractConfigurable
VASSAL.build.module.Map
VASSAL.build.module.PrivateMap
VASSAL.build.module.PlayerHand
- All Implemented Interfaces:
DropTargetListener
,MouseListener
,MouseMotionListener
,EventListener
,AutoConfigurable
,Buildable
,Configurable
,GameComponent
,PlayerRoster.SideChangeListener
,MutablePropertiesContainer
,PropertyNameSource
,PropertySource
,ValidityChecker
,Translatable
,ToolBarComponent
,UniqueIdManager.Identifyable
public class PlayerHand extends PrivateMap
-
Nested Class Summary
Nested classes/interfaces inherited from class VASSAL.build.module.PrivateMap
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 inherited from class VASSAL.build.module.PrivateMap
owners, SIDE, surrogate, USE_BOARDS, VISIBLE, 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 PlayerHand()
-
Method Summary
Modifier and Type Method Description void
build(Element el)
Build this component by getting all XML attributes of the XML element and callingAbstractBuildable.setAttribute(java.lang.String, java.lang.Object)
with the String value of the attributestatic String
getConfigureTypeName()
HelpFile
getHelpFile()
StackMetrics
getStackMetrics()
Every map must include aStackMetrics
as one of its build components, which governs the stacking behavior of GamePieces on the mapDimension
mapSize()
Methods inherited from class VASSAL.build.module.PrivateMap
createParentFrame, getAttributeDescriptions, getAttributeNames, getAttributeTypes, getAttributeValueString, getView, isAccessibleTo, isVisibleTo, setAttribute, setBoards, setBoards, setup, shouldDockIntoMainWindow, sideChanged
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, getToolBar, getZoom, getZoomer, indexOf, isChangeReportingEnabled, isLocationRestricted, isPiecesVisible, isVisibleToAll, localizedLocationName, locationName, mapCoordinates, mapRectangle, 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
-
Constructor Details
-
PlayerHand
public PlayerHand()
-
-
Method Details
-
build
Description copied from class:AbstractBuildable
Build this component by getting all XML attributes of the XML element and callingAbstractBuildable.setAttribute(java.lang.String, java.lang.Object)
with the String value of the attribute- Specified by:
build
in interfaceBuildable
- Overrides:
build
in classPrivateMap
- Parameters:
el
- the XML element containing the object data
-
getConfigureTypeName
-
getHelpFile
- Specified by:
getHelpFile
in interfaceConfigurable
- Overrides:
getHelpFile
in classPrivateMap
- Returns:
- a HelpFilte describing how to use and configure this component
-
getStackMetrics
Description copied from class:Map
Every map must include aStackMetrics
as one of its build components, which governs the stacking behavior of GamePieces on the map- Overrides:
getStackMetrics
in classMap
- Returns:
- the StackMetrics for this map
-
mapSize
-