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

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

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, GridContainer, MapGrid, ValidityChecker

public class ZonedGrid

extends AbstractConfigurable

implements MapGrid, GridContainer

Map Grid that contains any number of Zones against a background MapGrid

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

MapGrid.BadCoords

Inner classes inherited from class VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Fields inherited from class VASSAL.build.AbstractConfigurable

changeSupport, config, name

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

ZonedGrid()

Method Summary

void	addTo(Buildable parent) Adds this component to its parent.
void	addZone(Zone z)
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
MapGrid	getBackgroundGrid()
Board	getBoard()
Configurer	getConfigurer() The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
static java.lang.String	getConfigureTypeName()
GridContainer	getContainer()
GridNumbering	getGridNumbering()
HelpFile	getHelpFile()
java.awt.Point	getLocation(java.lang.String location)
java.awt.Dimension	getSize()
java.util.Iterator	getZones()
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 parent) Remove this component from its parent
void	removeGrid(MapGrid grid)
void	removeZone(Zone z)
void	setAttribute(java.lang.String key, java.lang.Object value) Called by the AbstractBuildable.build(org.w3c.dom.Element) method, where value is the String value read by the XML attribute.
void	setBackgroundGrid(MapGrid background)
void	setGrid(MapGrid grid)
java.awt.Point	snapTo(java.awt.Point p)

Methods inherited from class VASSAL.build.AbstractConfigurable

addPropertyChangeListener, getAttributeVisibility, getConfigureComponents, getConfigureName, remove, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

add, build, getBuildComponents, getBuildElement, getComponents, validate

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

Constructor Detail

ZonedGrid

public ZonedGrid()

Method Detail

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

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

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

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

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

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.

getContainer

public GridContainer getContainer()

getSize

public java.awt.Dimension getSize()

Specified by:

getSize 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

setGrid

public void setGrid(MapGrid grid)

Specified by:

setGrid in interface GridContainer

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.

getConfigureTypeName

public static java.lang.String getConfigureTypeName()

getHelpFile

public HelpFile getHelpFile()

Following copied from interface: VASSAL.build.Configurable

Returns:

a HelpFilte describing how to use and configure this component

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

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

getGridNumbering

public GridNumbering getGridNumbering()

Specified by:

getGridNumbering in interface MapGrid

getLocation

public java.awt.Point getLocation(java.lang.String location)
                           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)

isVisible

public boolean isVisible()

Description copied from interface: MapGrid

Whether this grid should be drawn on the map

Specified by:

isVisible in interface MapGrid

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

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

addZone

public void addZone(Zone z)

removeZone

public void removeZone(Zone z)

getZones

public java.util.Iterator getZones()

getBackgroundGrid

public MapGrid getBackgroundGrid()

setBackgroundGrid

public void setBackgroundGrid(MapGrid background)