VASSAL.build.module
Class SymbolDice

java.lang.Object
  |
  +--VASSAL.build.AbstractBuildable
        |
        +--VASSAL.build.AbstractConfigurable
              |
              +--VASSAL.build.module.Map
                    |
                    +--VASSAL.build.module.SymbolDice

All Implemented Interfaces:

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

public class SymbolDice

extends Map

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

Map.IconConfig, Map.View

Inner classes inherited from class VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Fields inherited from class VASSAL.build.module.Map

ALLOW_MULTIPLE, boards, BUTTON_NAME, EDGE_HEIGHT, EDGE_WIDTH, edgeBuffer, HIGHLIGHT_COLOR, HIGHLIGHT_THICKNESS, highlighter, HOTKEY, ICON, launchButton, mainWindowDock, MARK_MOVED, markMovedOption, metrics, mouseListenerStack, multicaster, NAME, picker, pieces, scroll, theMap, toolBar, 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

SymbolDice()

Method Summary

void	build(org.w3c.dom.Element el) Build the object
java.lang.Class[]	getAllowableConfigureComponents() Return a list of valid sub-component Classes.
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
void	mousePressed(java.awt.event.MouseEvent e) Mouse events are first translated into map coordinates.
void	mouseReleased(java.awt.event.MouseEvent e) Mouse events are first translated into map coordinates.

Methods inherited from class VASSAL.build.module.Map

addDrawComponent, addLocalMouseListener, addPiece, addTo, appendToTitle, boundingBoxOf, centerAt, centerAt, clearMapBorder, componentCoordinates, componentRectangle, createParentFrame, dragEnter, dragExit, dragOver, drawBoards, drawBoardsInRegion, drawDrawable, drawPieces, drawPiecesInRegion, drop, dropActionChanged, ensureVisible, findBoard, findPiece, focusGained, focusLost, getAllBoards, getAttributeDescriptions, getAttributeNames, getAttributeTypes, getAttributeValueString, getAttributeVisibility, getBoardByName, getBoardPicker, getDefaultWindowTitle, getDragGestureListener, getEdgeBuffer, getHighlighter, getId, getMapById, getMapName, getPieceCollection, getPieces, getPreferredSize, getRestoreCommand, getToolBar, getView, getZoom, getZoomer, indexOf, isPiecesVisible, locationName, mapCoordinates, mapRectangle, mapSize, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, paint, paint, paintRegion, placeAt, placeOrMerge, popMouseListener, pushMouseListener, removeDrawComponent, removeFrom, removeLocalMouseListener, removePiece, repaint, repaint, repaint, reposition, scroll, scrollAtEdge, selectionBoundsOf, setAttribute, setBoardBoundaries, setBoardPicker, setBoards, setDragGestureListener, setHighlighter, setID, setMapName, setPieceCollection, setPiecesVisible, setStackMetrics, setup, setZoomer, shouldDockIntoMainWindow, 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

SymbolDice

public SymbolDice()

Method Detail

build

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

Description copied from interface: Buildable

Build the object

Overrides:

build in class Map

Following copied from interface: VASSAL.build.Buildable

Parameters:

e - the XML element containing the object data

getConfigureTypeName

public static java.lang.String getConfigureTypeName()

getAllowableConfigureComponents

public java.lang.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.

Overrides:

getAllowableConfigureComponents in class Map

getHelpFile

public HelpFile getHelpFile()

Overrides:

getHelpFile in class Map

Following copied from interface: VASSAL.build.Configurable

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

Following copied from class: VASSAL.build.module.Map

Returns:

the StackMetrics for this map

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Description copied from class: Map

Mouse events are first translated into map coordinates. Then the event is forwarded to the top MouseListener in the stack, if any, otherwise forwarded to all LocalMouseListeners

Overrides:

mouseReleased in class Map

Following copied from class: VASSAL.build.module.Map

See Also:

Map.pushMouseListener(java.awt.event.MouseListener), Map.popMouseListener(), Map.addLocalMouseListener(java.awt.event.MouseListener)

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Description copied from class: Map

Mouse events are first translated into map coordinates. Then the event is forwarded to the top MouseListener in the stack, if any, otherwise forwarded to all LocalMouseListeners

Overrides:

mousePressed in class Map

Following copied from class: VASSAL.build.module.Map

See Also:

Map.pushMouseListener(java.awt.event.MouseListener), Map.popMouseListener(), Map.addLocalMouseListener(java.awt.event.MouseListener)