VASSAL.build.module.map.boardPicker
Class Board

java.lang.Object
  |
  +--VASSAL.build.AbstractBuildable
        |
        +--VASSAL.build.AbstractConfigurable
              |
              +--VASSAL.build.module.map.boardPicker.Board

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable

public class Board

extends AbstractConfigurable

Inner Class Summary

static class

Board.Cleanup Cleans up Boards (by invoking cleanUp()) when a game is closed

Inner classes inherited from class VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

protected java.awt.Image	boardImage
protected java.lang.String	boardName
protected java.awt.Rectangle	boundaries
static java.lang.String	COLOR
static java.lang.String	HEIGHT
static java.lang.String	IMAGE
protected java.lang.String	imageFile
static java.lang.String	NAME A Board is a piece of a Map.
protected java.awt.Point	pos
protected boolean	reversed
protected boolean	reversible
static java.lang.String	REVERSIBLE
protected java.util.Hashtable	scaledCache Deprecated.
static java.lang.String	WIDTH

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

Board()

Method Summary

void	addTo(Buildable b) Adds this component to its parent.
java.awt.Rectangle	bounds()
void	cleanUp() Removes board images from the DataArchive cache
void	draw(java.awt.Graphics g, int x, int y, double zoom, java.awt.Component obs)
void	drawRegion(java.awt.Graphics g, java.awt.Point location, java.awt.Rectangle visibleRect, double zoom, java.awt.Component obs)
java.lang.String	fileName()
void	fixImage(java.awt.Component map)
java.lang.Class[]	getAllowableConfigureComponents() Return a list of valid sub-component Classes.
java.lang.String[]	getAttributeDescriptions() Return an array of Strings describing the attributes of this object.
java.lang.String[]	getAttributeNames()
java.lang.Class[]	getAttributeTypes() Return the Class for the attributes of this object.
java.lang.String	getAttributeValueString(java.lang.String key) Called by the AbstractBuildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
VisibilityCondition	getAttributeVisibility(java.lang.String name) By default, all attributes are visible
java.lang.String	getConfigureName() The name of this Configurable Object
MapGrid	getGrid()
HelpFile	getHelpFile()
java.lang.String	getName()
java.awt.Image	getScaledImage(double zoom, java.awt.Component obs)
java.awt.Point	globalCoordinates(java.awt.Point p) If this board is reversed, return the location in reversed coordinates
boolean	isReversed()
java.awt.Point	localCoordinates(java.awt.Point p) If this board is reversed, return the location in un-reversed coordinates
java.lang.String	locationName(java.awt.Point p)
java.awt.Point	relativePosition()
void	removeFrom(Buildable b) Remove this component from its parent
void	setAttribute(java.lang.String key, java.lang.Object val) Called by the AbstractBuildable.build(org.w3c.dom.Element) method, where value is the String value read by the XML attribute.
void	setGrid(MapGrid mg)
void	setLocation(int x, int y) Set the location of this board
void	setReversed(boolean val)
java.awt.Point	snapTo(java.awt.Point p)
void	translate(int x, int y) Translate the location of the board by the given number of pixels

Methods inherited from class VASSAL.build.AbstractConfigurable

addPropertyChangeListener, getConfigureComponents, getConfigurer, remove, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

add, build, 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.Buildable

add, build, getBuildElement

Field Detail

NAME

public static final java.lang.String NAME

A Board is a piece of a Map. A Map can cantain a set of boards layed out in a rectangular grid.

IMAGE

public static final java.lang.String IMAGE

WIDTH

public static final java.lang.String WIDTH

HEIGHT

public static final java.lang.String HEIGHT

COLOR

public static final java.lang.String COLOR

REVERSIBLE

public static final java.lang.String REVERSIBLE

boardImage

protected java.awt.Image boardImage

scaledCache

protected java.util.Hashtable scaledCache

Deprecated.

pos

protected java.awt.Point pos

boundaries

protected java.awt.Rectangle boundaries

imageFile

protected java.lang.String imageFile

boardName

protected java.lang.String boardName

reversible

protected boolean reversible

reversed

protected boolean reversed

Constructor Detail

Board

public Board()

Method Detail

getName

public java.lang.String getName()

addTo

public void addTo(Buildable b)

Description copied from interface: Buildable

Adds this component to its parent. In order to make Buildable objects extensible, the child is reponsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.

removeFrom

public void removeFrom(Buildable b)

Description copied from interface: Configurable

Remove this component from its parent

getAttributeNames

public java.lang.String[] getAttributeNames()

Overrides:

getAttributeNames in class AbstractBuildable

Following copied from interface: VASSAL.build.AutoConfigurable

Returns:

an array of Strings giving all attributes of this Buildable component that will be written to/read from an XML element

getAttributeDescriptions

public java.lang.String[] getAttributeDescriptions()

Description copied from class: AbstractConfigurable

Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()

Overrides:

getAttributeDescriptions in class AbstractConfigurable

getAttributeTypes

public java.lang.Class[] getAttributeTypes()

Description copied from class: AbstractConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, Color, and KeyStroke The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()

Overrides:

getAttributeTypes in class AbstractConfigurable

getConfigureName

public java.lang.String getConfigureName()

Description copied from interface: Configurable

The name of this Configurable Object

Overrides:

getConfigureName in class AbstractConfigurable

getAttributeVisibility

public VisibilityCondition getAttributeVisibility(java.lang.String name)

Description copied from class: AbstractConfigurable

By default, all attributes are visible

Overrides:

getAttributeVisibility in class AbstractConfigurable

Following copied from class: VASSAL.build.AbstractConfigurable

Parameters:

name -

Returns:

getAttributeValueString

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

Overrides:

getAttributeValueString in class AbstractBuildable

Following copied from class: VASSAL.build.AbstractBuildable

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.Object val)

Description copied from interface: AutoConfigurable

Called by the Buildable.build(org.w3c.dom.Element) method, where value is the String value read by the XML attribute. Can also be called with Object value to set the attribute.

Overrides:

setAttribute in class AbstractBuildable

Following copied from class: VASSAL.build.AbstractBuildable

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

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.

draw

public void draw(java.awt.Graphics g,
                 int x,
                 int y,
                 double zoom,
                 java.awt.Component obs)

drawRegion

public void drawRegion(java.awt.Graphics g,
                       java.awt.Point location,
                       java.awt.Rectangle visibleRect,
                       double zoom,
                       java.awt.Component obs)

getScaledImage

public java.awt.Image getScaledImage(double zoom,
                                     java.awt.Component obs)

setReversed

public void setReversed(boolean val)

isReversed

public boolean isReversed()

localCoordinates

public java.awt.Point localCoordinates(java.awt.Point p)

If this board is reversed, return the location in un-reversed coordinates

globalCoordinates

public java.awt.Point globalCoordinates(java.awt.Point p)

If this board is reversed, return the location in reversed coordinates

setGrid

public void setGrid(MapGrid mg)

getGrid

public MapGrid getGrid()

fixImage

public void fixImage(java.awt.Component map)

locationName

public java.lang.String locationName(java.awt.Point p)

snapTo

public java.awt.Point snapTo(java.awt.Point p)

fileName

public java.lang.String fileName()

relativePosition

public java.awt.Point relativePosition()

Returns:

Position of this board relative to the other boards (0,0) is the upper left, (0,1) is to the right, etc.

bounds

public java.awt.Rectangle bounds()

Returns:

The (read-only) boundaries of this Board within the overall Map

translate

public void translate(int x,
                      int y)

Translate the location of the board by the given number of pixels

See Also:

bounds()

setLocation

public void setLocation(int x,
                        int y)

Set the location of this board

See Also:

bounds()

getHelpFile

public HelpFile getHelpFile()

Following copied from interface: VASSAL.build.Configurable

Returns:

a HelpFilte describing how to use and configure this component

cleanUp

public void cleanUp()

Removes board images from the DataArchive cache