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:

AutoConfigurable, Buildable, Configurable, java.util.EventListener, java.awt.event.FocusListener, GameComponent, java.awt.event.MouseListener, java.awt.event.MouseMotionListener

public class PlayerHand

extends PrivateMap

Nested Class Summary

Nested classes inherited from class VASSAL.build.module.PrivateMap

PrivateMap.View

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

Map.View

Nested classes inherited from class VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

Fields inherited from class VASSAL.build.module.PrivateMap

SIDE, USE_BOARDS, VISIBLE

Fields inherited from class VASSAL.build.module.Map

ALLOW_MULTIPLE, boards, BUTTON_NAME, EDGE_HEIGHT, EDGE_WIDTH, edgeBuffer, HIGHLIGHT_COLOR, HIGHLIGHT_THICKNESS, highlighter, HOTKEY, launchButton, MARK_MOVED, markMovedOption, maxStacks, metrics, moreStacks, mouseListenerStack, multicaster, NAME, nstacks, picker, scroll, stack, theMap, toolBar, topWindow, USE_LAUNCH_BUTTON, useLaunchButton, zoom

Fields inherited from class VASSAL.build.AbstractConfigurable

changeSupport, config, name

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

PlayerHand()

Method Summary

void	addPiece(GamePiece p) Adds a GamePiece to this map.
void	build(org.w3c.dom.Element el) Build the object
static java.lang.String	getConfigureTypeName()
HelpFile	getHelpFile()
StackMetrics	getStackMetrics() Every map must include a StackMetrics as one of its build components, which governs the stacking behavior of GamePieces on the map
java.awt.Dimension	mapSize()
Command	placeAt(GamePiece piece, java.awt.Point pt) Place a piece at the destination point.

Methods inherited from class VASSAL.build.module.PrivateMap

addTo, getAttributeDescriptions, getAttributeNames, getAttributeTypes, getAttributeValueString, getParentFrame, getView, isAccessibleTo, setAttribute, setBoards, setup

Methods inherited from class VASSAL.build.module.Map

addDrawComponent, addLocalMouseListener, appendToTitle, boundingBoxOf, centerAt, centerAt, clearMapBorder, componentCoordinates, componentRectangle, drawBoards, drawBoardsInRegion, drawDrawable, drawPieces, drawPiecesInRegion, ensureVisible, findBoard, findPiece, focusGained, focusLost, getAllBoards, getAllowableConfigureComponents, getAttributeVisibility, getBoardPicker, getEdgeBuffer, getHighlighter, getId, getMapName, getPieces, getPreferredSize, getRestoreCommand, getToolBar, getZoom, getZoomer, indexOf, isPiecesVisible, locationName, mapCoordinates, mapRectangle, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, paint, paint, paintRegion, placeOrMerge, popMouseListener, pushMouseListener, removeDrawComponent, removeFrom, removeLocalMouseListener, removePiece, repaint, repaint, repaint, reposition, scroll, selectionBoundsOf, setBoardBoundaries, setBoardPicker, setHighlighter, setID, setMapName, setPiecesVisible, setStackMetrics, setZoomer, snapTo

Methods inherited from class VASSAL.build.AbstractConfigurable

addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, remove, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

add, getBuildComponents, getBuildElement, getComponents

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.build.Configurable

addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, remove

Methods inherited from interface VASSAL.build.Buildable

add, getBuildElement

Constructor Detail

PlayerHand

public PlayerHand()

Method Detail

build

public void build(org.w3c.dom.Element el)

Description copied from interface: Buildable

Build the object

Specified by:

build in interface Buildable

Overrides:

build in class PrivateMap

Parameters:

el - the XML element containing the object data

getConfigureTypeName

public static java.lang.String getConfigureTypeName()

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Overrides:

getHelpFile in class PrivateMap

Returns:

a HelpFilte describing how to use and configure this component

getStackMetrics

public StackMetrics getStackMetrics()

Description copied from class: Map

Every map must include a StackMetrics as one of its build components, which governs the stacking behavior of GamePieces on the map

Overrides:

getStackMetrics in class Map

Returns:

the StackMetrics for this map

mapSize

public java.awt.Dimension mapSize()

Overrides:

mapSize in class Map

Returns:

the size of the map in pixels at 100% zoom, including the edge buffer

placeAt

public Command placeAt(GamePiece piece,
                       java.awt.Point pt)

Description copied from class: Map

Place a piece at the destination point. If necessary, remove the piece from its parent Stack or Map

Overrides:

placeAt in class Map

Returns:

a Command that reproduces this action

addPiece

public void addPiece(GamePiece p)

Description copied from class: Map

Adds a GamePiece to this map. Removes the piece from its parent Stack and from its current map, if different from this map

Overrides:

addPiece in class Map