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

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

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, MapGrid

public class RegionGrid

extends AbstractConfigurable

implements MapGrid

Inner Class Summary

static class

RegionGrid.Config

Inner classes inherited from class VASSAL.build.module.map.boardPicker.board.MapGrid

MapGrid.BadCoords

Inner classes inherited from class VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

static java.lang.String	FONT_SIZE
static java.lang.String	SNAPTO
static java.lang.String	VISIBLE

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

RegionGrid()

Method Summary

void	addRegion(Region a)
void	addTo(Buildable b) Adds this component to its parent.
void	configureRegions()
protected java.awt.Point	doSnap(java.awt.Point p)
void	draw(java.awt.Graphics g, java.awt.Rectangle bounds, java.awt.Rectangle visibleRect, double scale, boolean reversed) Draw the grid
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
Board	getBoard()
java.lang.String	getConfigureName() The name of this Configurable Object
Configurer	getConfigurer() The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
static java.lang.String	getConfigureTypeName()
int	getFontSize()
GridNumbering	getGridNumbering()
HelpFile	getHelpFile()
java.awt.Point	getLocation(java.lang.String name)
Region	getRegion(java.awt.Point p) Return Region selected by Point
boolean	isVisible() Whether this grid should be drawn on the map
java.lang.String	locationName(java.awt.Point p)
int	range(java.awt.Point p1, java.awt.Point p2)
void	removeFrom(Buildable b) Remove this component from its parent
void	removeRegion(Region a)
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	setBoard(Board b)
void	setGridNumbering(GridNumbering gridNumbering)
void	setVisible(boolean b)
java.awt.Point	snapTo(java.awt.Point p)
void	unSelect(Region r)
void	unSelectAll()

Methods inherited from class VASSAL.build.AbstractConfigurable

addPropertyChangeListener, getConfigureComponents, 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

SNAPTO

public static final java.lang.String SNAPTO

VISIBLE

public static final java.lang.String VISIBLE

FONT_SIZE

public static final java.lang.String FONT_SIZE

Constructor Detail

RegionGrid

public RegionGrid()

Method Detail

setBoard

public void setBoard(Board b)

getBoard

public Board getBoard()

addRegion

public void addRegion(Region a)

removeRegion

public void removeRegion(Region a)

getGridNumbering

public GridNumbering getGridNumbering()

Specified by:

getGridNumbering in interface MapGrid

setGridNumbering

public void setGridNumbering(GridNumbering gridNumbering)

getFontSize

public int getFontSize()

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

getConfigurer

public Configurer getConfigurer()

Description copied from class: AbstractConfigurable

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

Overrides:

getConfigurer in class AbstractConfigurable

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

getConfigureTypeName

public static java.lang.String getConfigureTypeName()

getConfigureName

public java.lang.String getConfigureName()

Description copied from interface: Configurable

The name of this Configurable Object

Overrides:

getConfigureName in class AbstractConfigurable

getHelpFile

public HelpFile getHelpFile()

Following copied from interface: VASSAL.build.Configurable

Returns:

a HelpFilte describing how to use and configure this component

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

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:

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

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)

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.

getLocation

public java.awt.Point getLocation(java.lang.String name)
                           throws MapGrid.BadCoords

Specified by:

getLocation in interface MapGrid

Following copied from interface: VASSAL.build.module.map.boardPicker.board.MapGrid

Returns:

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

range

public int range(java.awt.Point p1,
                 java.awt.Point p2)

Specified by:

range in interface MapGrid

Following copied from interface: VASSAL.build.module.map.boardPicker.board.MapGrid

Returns:

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

snapTo

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

Specified by:

snapTo in interface MapGrid

Following copied from interface: VASSAL.build.module.map.boardPicker.board.MapGrid

Returns:

the nearest grid location to the given point

doSnap

protected java.awt.Point doSnap(java.awt.Point p)

locationName

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

Specified by:

locationName in interface MapGrid

Following copied from interface: VASSAL.build.module.map.boardPicker.board.MapGrid

Returns:

a string describing the location containing the given point

getRegion

public Region getRegion(java.awt.Point p)

Return Region selected by Point

draw

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

Description copied from interface: MapGrid

Draw the grid

Specified by:

draw in interface MapGrid

Following copied from interface: VASSAL.build.module.map.boardPicker.board.MapGrid

Parameters:

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

scale - the magnification factor

unSelectAll

public void unSelectAll()

unSelect

public void unSelect(Region r)