Class RegionGrid

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.map.boardPicker.board.RegionGrid

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, MapGrid, PropertyNameSource, ConfigureTree.Mutable, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget

public class RegionGrid
extends AbstractConfigurable
implements MapGrid, ConfigureTree.Mutable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RegionGrid.Config

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

AutoConfigurable.Util

Nested classes/interfaces inherited from interface VASSAL.build.module.map.boardPicker.board.MapGrid

MapGrid.BadCoords

Field Summary

Fields

Modifier and Type	Field	Description
protected GridContainer	container
static final String	FONT_SIZE
protected int	fontSize
protected GridNumbering	gridNumbering
protected static boolean	inConfig
protected RegionGrid.Config	regionConfigurer
protected Map<Point,Region>	regionList
protected boolean	snapTo
static final String	SNAPTO
protected boolean	visible
static final String	VISIBLE

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

Method Summary

Modifier and Type	Method	Description
void	addRegion(Region a)
void	addTo(Buildable b)	Adds this component to its parent.
void	configureRegions()
protected Point	doSnap(Point p)
void	draw(Graphics g, Rectangle bounds, Rectangle visibleRect, double scale, boolean reversed)	Draw the grid
Region	findRegion(String name)	Return Region by Name
void	forceDraw(Graphics g, Rectangle bounds, Rectangle visibleRect, double scale, boolean reversed)
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()
String	getConfigureName()	ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
static String	getConfigureTypeName()
int	getFontSize()
GridNumbering	getGridNumbering()
HelpFile	getHelpFile()
Point	getLocation(String name)
Region	getRegion(Point p)	Return Region selected by Point
Map<Point,Region>	getRegionList()
Zone	getZone()
boolean	isLocationRestricted(Point p)
boolean	isOutsideZone(Point pt)
boolean	isVisible()	Whether this grid should be drawn on the map
String	localizedLocationName(Point p)
String	locationName(Point p)
int	range(Point p1, Point p2)
void	removeAllRegions()
void	removeFrom(Buildable b)	Remove this component from its parent
void	removeRegion(Region a)
void	setAttribute(String key, Object val)	Sets a buildFile (XML) attribute value for this component.
void	setGridNumbering(GridNumbering gridNumbering)
void	setVisible(boolean b)
Point	snapTo(Point p)
Point	snapTo(Point p, boolean force)
Point	snapTo(Point p, boolean force, boolean onlyCenter)
void	unSelect(Region r)
void	unSelectAll()

Methods inherited from class VASSAL.build.AbstractConfigurable

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

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, build, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, getPropertyNames, setAncestor, validate

Methods inherited from class VASSAL.search.AbstractImageFinder

addLocalImageNames, 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.script.expression.Auditable

getComponentName, getComponentTypeName

Methods inherited from interface VASSAL.build.Buildable

build, getBuildElement, isMandatory, isMovable, isUnique

Methods inherited from interface VASSAL.build.module.map.boardPicker.board.MapGrid

getMaxPixelsPerRangeUnit

Field Details

regionList

protected Map<Point,Region> regionList

container

protected GridContainer container

visible

protected boolean visible

inConfig

protected static boolean inConfig

fontSize

protected int fontSize

snapTo

protected boolean snapTo

regionConfigurer

protected RegionGrid.Config regionConfigurer

gridNumbering

protected GridNumbering gridNumbering

SNAPTO

public static final String SNAPTO

See Also:

• Constant Field Values

VISIBLE

public static final String VISIBLE

See Also:

• Constant Field Values

FONT_SIZE

public static final String FONT_SIZE

See Also:

• Constant Field Values

Constructor Details

RegionGrid

public RegionGrid()

Method Details

getRegionList

public Map<Point,Region> getRegionList()

addRegion

public void addRegion(Region a)

removeRegion

public void removeRegion(Region a)

removeAllRegions

public void removeAllRegions()

getZone

public Zone getZone()

Returns:

Parent zone (if any) of this grid.

isOutsideZone

public boolean isOutsideZone(Point pt)

getGridNumbering

public GridNumbering getGridNumbering()

Specified by:

getGridNumbering in interface MapGrid

setGridNumbering

public void setGridNumbering(GridNumbering gridNumbering)

getFontSize

public int getFontSize()

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

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

getConfigurer

public Configurer getConfigurer()

Description copied from class: AbstractConfigurable

The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer

Specified by:

getConfigurer in interface Configurable

Overrides:

getConfigurer in class AbstractConfigurable

Returns:

Configurer for this component

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

getConfigureTypeName

public static String getConfigureTypeName()

getConfigureName

public String getConfigureName()

Description copied from class: AbstractConfigurable

ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.

Specified by:

getConfigureName in interface Configurable

Overrides:

getConfigureName in class AbstractConfigurable

Returns:

The language-independent name of this component used for programmatic identification (including within Modules by e.g. Traits and module components)

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * this component

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.

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.

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

configureRegions

public void configureRegions()

isVisible

public boolean isVisible()

Description copied from interface: MapGrid

Whether this grid should be drawn on the map

Specified by:

isVisible in interface MapGrid

setVisible

public void setVisible(boolean b)

getBoard

public Board getBoard()

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.

getLocation

public Point getLocation(String name)
                  throws MapGrid.BadCoords

Specified by:

getLocation in interface MapGrid

Returns:

A point p such that locationName(p).equals(location).

Throws:

MapGrid.BadCoords - if the location is not valid or formatted incorrectly.

range

public int range(Point p1,
 Point p2)

Specified by:

range in interface MapGrid

Returns:

the range between two points, in some unit appropriate to the grid (e.g. hexes or squares)

snapTo

public Point snapTo(Point p,
 boolean force,
 boolean onlyCenter)

Specified by:

snapTo in interface MapGrid

Parameters:

onlyCenter - If true, snaps only to the center, never to the edge or corner.

Returns:

The nearest grid location to the given point. This can for instance snap to center, edge or corner, depending on settings and arguments.

snapTo

public Point snapTo(Point p,
 boolean force)

Specified by:

snapTo in interface MapGrid

See Also:

• MapGrid.snapTo(Point p, boolean force, boolean onlyCenter)

snapTo

public Point snapTo(Point p)

Specified by:

snapTo in interface MapGrid

See Also:

• MapGrid.snapTo(Point p, boolean force, boolean onlyCenter)

isLocationRestricted

public boolean isLocationRestricted(Point p)

Specified by:

isLocationRestricted in interface MapGrid

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

doSnap

protected Point doSnap(Point p)

locationName

public String locationName(Point p)

Specified by:

locationName in interface MapGrid

Returns:

a string describing the location containing the given point

localizedLocationName

public String localizedLocationName(Point p)

Specified by:

localizedLocationName in interface MapGrid

getRegion

public Region getRegion(Point p)

Return Region selected by Point

findRegion

public Region findRegion(String name)

Return Region by Name

draw

public void draw(Graphics g,
 Rectangle bounds,
 Rectangle visibleRect,
 double scale,
 boolean reversed)

Description copied from interface: MapGrid

Draw the grid

Specified by:

draw in interface MapGrid

Parameters:

bounds - the boundaries of the grid (in magnified coordinates)

scale - the magnification factor

forceDraw

public void forceDraw(Graphics g,
 Rectangle bounds,
 Rectangle visibleRect,
 double scale,
 boolean reversed)

unSelectAll

public void unSelectAll()

unSelect

public void unSelect(Region r)