Package VASSAL.build.module.map.boardPicker

Class Board

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.map.boardPicker.Board

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, GridContainer, PropertyNameSource, ValidityChecker, Translatable, ImageSearchTarget, SearchTarget

public class Board
extends AbstractConfigurable
implements GridContainer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Board.Cleanup	Deprecated, for removal: This API element is subject to removal in a future version. Only used to cleanup Board images, which is now handled automatically by the cache.

Nested classes/interfaces inherited from interface VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
protected Image	boardImage	Deprecated, for removal: This API element is subject to removal in a future version.
protected SourceOp	boardImageOp
protected String	boardName	Deprecated, for removal: This API element is subject to removal in a future version.
protected Rectangle	boundaries
protected boolean	cacheGrid
protected Color	color
static String	COLOR
protected boolean	fixedBoundaries
protected MapGrid	grid
static String	HEIGHT
static String	IMAGE
protected String	imageFile
protected double	magnification
protected Map	map
static String	NAME	A Board is a piece of a Map.
protected Point	pos
protected boolean	reversed
protected boolean	reversible
static String	REVERSIBLE
protected ScaleOp	scaledImageOp
static String	WIDTH

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

Method Summary

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	Classes extending AbstractImageFinder should override this method in order to add the names of any image files they use to the collection.
void	addTo(Buildable b)	Adds this component to its parent.
Rectangle	bounds()
void	cleanUp()	Deprecated, for removal: This API element is subject to removal in a future version. Board images are removed automatically now, when under memory pressure.
boolean	contains(Point p)
Board	copy()
void	draw(Graphics g, int x, int y, double zoom, Component obs)
void	drawRegion(Graphics g, Point location, Rectangle visibleRect, double zoom, Component obs)
protected void	drawTile(Graphics g, Future<BufferedImage> fim, int tx, int ty, Component obs)
String	fileName()
protected void	fixBounds()	Deprecated, for removal: This API element is subject to removal in a future version. Bounds are now fixed automagically by ImageOps.
void	fixImage()	Deprecated, for removal: This API element is subject to removal in a future version. Images are now fixed automagically using ImageOps.
void	fixImage(Component map)	Deprecated, for removal: This API element is subject to removal in a future version. Images are now fixed automagically using ImageOps.
Class<?>[]	getAllowableConfigureComponents()
String[]	getAttributeDescriptions()	Return an array of Strings describing the attributes of this object.
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
Class<?>[]	getAttributeTypes()	Return the Class for the attributes of this object.
String	getAttributeValueString(String key)	Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
Board	getBoard()
static String	getConfigureTypeName()
MapGrid	getGrid()
HelpFile	getHelpFile()
String	getLocalizedName()
double	getMagnification()
Map	getMap()
String	getName()
Image	getScaledImage(double zoom, Component obs)	Deprecated, for removal: This API element is subject to removal in a future version.
Dimension	getSize()
Point	globalCoordinates(Point p)	If this board is reversed, return the location in reversed coordinates
boolean	isLocationRestricted(Point p)
boolean	isReversed()
Point	localCoordinates(Point p)	If this board is reversed, return the location in un-reversed coordinates
String	localizedLocationName(Point p)
String	locationName(Point p)
Point	relativePosition()
void	removeFrom(Buildable b)	Remove this component from its parent
void	removeGrid(MapGrid grid)
void	setAttribute(String key, Object val)	Sets a buildFile (XML) attribute value for this component.
void	setCacheGrid(boolean cg)
void	setGrid(MapGrid mg)
void	setLocation(int x, int y)	Set the location of this board
void	setMagnification(double magnification)
void	setMap(Map map)
void	setReversed(boolean val)
Point	snapTo(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

add, addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, getExpressionList, getFormattedStringList, getI18nData, getI18nPrefix, getLocalizedConfigureName, getMenuTextList, getNamedKeyStrokeList, getPropertyList, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getPropertyNames, 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.build.Buildable

build, getBuildElement

Field Details

NAME

public static final String NAME

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

See Also:

Constant Field Values

IMAGE

public static final String IMAGE

See Also:

Constant Field Values

WIDTH

public static final String WIDTH

See Also:

Constant Field Values

HEIGHT

public static final String HEIGHT

See Also:

Constant Field Values

COLOR

public static final String COLOR

See Also:

Constant Field Values

REVERSIBLE

public static final String REVERSIBLE

See Also:

Constant Field Values

pos

protected Point pos

boundaries

protected Rectangle boundaries

imageFile

protected String imageFile

reversible

protected boolean reversible

reversed

protected boolean reversed

fixedBoundaries

protected boolean fixedBoundaries

color

protected Color color

grid

protected MapGrid grid

map

protected Map map

magnification

protected double magnification

cacheGrid

protected boolean cacheGrid

boardName

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected String boardName

Deprecated, for removal: This API element is subject to removal in a future version.

boardImage

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected Image boardImage

Deprecated, for removal: This API element is subject to removal in a future version.

boardImageOp

protected SourceOp boardImageOp

scaledImageOp

protected ScaleOp scaledImageOp

Constructor Details

Board

public Board()

Method Details

getMap

public Map getMap()

Returns:

this Board's Map. Until a game is started that is using this board, the map will be null.

setCacheGrid

public void setCacheGrid(boolean cg)

setMap

public void setMap(Map map)

getLocalizedName

public String getLocalizedName()

getName

public 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 responsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.

Specified by:

addTo in interface Buildable

Parameters:

b - parent Buildable to add this component to as a subcomponent.

removeFrom

public void removeFrom(Buildable b)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

getAttributeNames

public String[] getAttributeNames()

Description copied from class: AbstractBuildable

Lists all the buildFile (XML) attribute names for this component. If this component is ALSO an AbstractConfigurable, then this list of attributes determines the appropriate attribute order for AbstractConfigurable.getAttributeDescriptions() and AbstractConfigurable.getAttributeTypes().

Specified by:

getAttributeNames in interface AutoConfigurable

Specified by:

getAttributeNames in class AbstractBuildable

Returns:

a list of all buildFile (XML) attribute names for this component

getAttributeDescriptions

public String[] getAttributeDescriptions()

Description copied from interface: AutoConfigurable

Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object.

Specified by:

getAttributeDescriptions in interface AutoConfigurable

Specified by:

getAttributeDescriptions in class AbstractConfigurable

Returns:

an array of Strings describing the buildFile (XML) attributes of this component. These strings are used as prompts in the Properties window for this object, when the component is configured in the Editor. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()

getConfigureTypeName

public static String getConfigureTypeName()

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from interface: AutoConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, File, Color, and KeyStroke

Specified by:

getAttributeTypes in interface AutoConfigurable

Specified by:

getAttributeTypes in class AbstractConfigurable

Returns:

the Class for the buildFile (XML) attributes of this component. Valid classes include: String, Integer, Double, Boolean, Image, Color, and KeyStroke, along with any class for which a Configurer exists in VASSAL.configure. The class determines, among other things, which type of AutoConfigurer will be used to configure the attribute when the object is configured in the Editor. The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()

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 AbstractConfigurable

Parameters:

name - Name (key) of one of this component's attributes

Returns:

a VisibilityCondition for this attribute, or null if attribute should always be visible.

getAttributeValueString

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

Specified by:

getAttributeValueString in interface AutoConfigurable

Specified by:

getAttributeValueString in interface Translatable

Specified by:

getAttributeValueString in class AbstractBuildable

Parameters:

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

Returns:

a String representation of the XML buildFile attribute with the given name. When initializing a module, this String value will loaded from the XML and passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object). It is also frequently used for checking the current value of an attribute.

setAttribute

public void setAttribute(String key,
 Object val)

Description copied from class: AbstractBuildable

Sets a buildFile (XML) attribute value for this component. The key parameter will be one of those listed in AbstractBuildable.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value will be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

Specified by:

setAttribute in interface AutoConfigurable

Specified by:

setAttribute in interface Translatable

Specified by:

setAttribute in class AbstractBuildable

Parameters:

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

val - If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value can also be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Specified by:

getAllowableConfigureComponents in interface Configurable

Returns:

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 Editor's ConfigureTree window by right-clicking on the component and selecting the appropriate "Add" option.

draw

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

drawTile

protected void drawTile(Graphics g,
 Future<BufferedImage> fim,
 int tx,
 int ty,
 Component obs)

drawRegion

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

getScaledImage

@Deprecated(since="2020-08-06",
            forRemoval=true)
public Image getScaledImage(double zoom,
 Component obs)

Deprecated, for removal: This API element is subject to removal in a future version.

setReversed

public void setReversed(boolean val)

isReversed

public boolean isReversed()

localCoordinates

public Point localCoordinates(Point p)

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

globalCoordinates

public Point globalCoordinates(Point p)

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

setGrid

public void setGrid(MapGrid mg)

Specified by:

setGrid in interface GridContainer

removeGrid

public void removeGrid(MapGrid grid)

Specified by:

removeGrid in interface GridContainer

getBoard

public Board getBoard()

Specified by:

getBoard in interface GridContainer

getSize

public Dimension getSize()

Specified by:

getSize in interface GridContainer

contains

public boolean contains(Point p)

Specified by:

contains in interface GridContainer

getGrid

public MapGrid getGrid()

copy

public Board copy()

fixImage

@Deprecated(since="2020-08-06",
            forRemoval=true)
public void fixImage(Component map)

Deprecated, for removal: This API element is subject to removal in a future version.

Images are now fixed automagically using ImageOps.

fixImage

@Deprecated(since="2020-08-06",
            forRemoval=true)
public void fixImage()

Deprecated, for removal: This API element is subject to removal in a future version.

Images are now fixed automagically using ImageOps.

locationName

public String locationName(Point p)

localizedLocationName

public String localizedLocationName(Point p)

snapTo

public Point snapTo(Point p)

isLocationRestricted

public boolean isLocationRestricted(Point p)

Returns:

true if the given point may not be a local location. I.e., if this grid will attempt to snap it to the nearest grid location.

fileName

public String fileName()

relativePosition

public 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 Rectangle bounds()

Returns:

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

fixBounds

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected void fixBounds()

Deprecated, for removal: This API element is subject to removal in a future version.

Bounds are now fixed automagically by ImageOps.

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

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * this component

cleanUp

@Deprecated(since="2020-08-06",
            forRemoval=true)
public void cleanUp()

Deprecated, for removal: This API element is subject to removal in a future version.

Board images are removed automatically now, when under memory pressure.

Removes board images from the DataArchive cache

getMagnification

public double getMagnification()

setMagnification

public void setMagnification(double magnification)

addLocalImageNames

public void addLocalImageNames(Collection<String> s)

Description copied from class: AbstractImageFinder

Classes extending AbstractImageFinder should override this method in order to add the names of any image files they use to the collection.

Specified by:

addLocalImageNames in interface ImageSearchTarget

Overrides:

addLocalImageNames in class AbstractImageFinder

Parameters:

s - Collection to add image names to