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

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

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, MapGrid, ValidityChecker

public class SquareGrid

extends AbstractConfigurable

implements 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

Field Summary

static java.lang.String	COLOR
protected GridContainer	container
static java.lang.String	CORNERS
static java.lang.String	DOTS_VISIBLE
static java.lang.String	DX
static java.lang.String	DY
static java.lang.String	EDGES
static java.lang.String	VISIBLE
static java.lang.String	X0
static java.lang.String	Y0

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

SquareGrid()

Method Summary

void	addTo(Buildable b) Adds this component to its parent.
void	draw(java.awt.Graphics g, java.awt.Rectangle bounds, java.awt.Rectangle visibleRect, double scale, boolean reversed) Draw the grid, if visible, and accompanying numbering, if set
void	forceDraw(java.awt.Graphics g, java.awt.Rectangle bounds, java.awt.Rectangle visibleRect, double scale, boolean reversed) Draw the grid even if not marked visible
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
static java.lang.String	getConfigureTypeName()
GridContainer	getContainer()
double	getDx()
double	getDy()
GridNumbering	getGridNumbering()
HelpFile	getHelpFile()
java.awt.Point	getLocation(java.lang.String name)
java.awt.Point	getOrigin()
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
protected void	reverse(java.awt.Point p, java.awt.Rectangle bounds)
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	setGridNumbering(GridNumbering gridNumbering)
java.awt.Point	snapTo(java.awt.Point p)

Methods inherited from class VASSAL.build.AbstractConfigurable

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

Field Detail

container

protected GridContainer container

DX

public static final java.lang.String DX

DY

public static final java.lang.String DY

X0

public static final java.lang.String X0

Y0

public static final java.lang.String Y0

VISIBLE

public static final java.lang.String VISIBLE

CORNERS

public static final java.lang.String CORNERS

EDGES

public static final java.lang.String EDGES

COLOR

public static final java.lang.String COLOR

DOTS_VISIBLE

public static final java.lang.String DOTS_VISIBLE

Constructor Detail

SquareGrid

public SquareGrid()

Method Detail

getGridNumbering

public GridNumbering getGridNumbering()

Specified by:

getGridNumbering in interface MapGrid

setGridNumbering

public void setGridNumbering(GridNumbering gridNumbering)

getDx

public double getDx()

getDy

public double getDy()

getOrigin

public java.awt.Point getOrigin()

getContainer

public GridContainer getContainer()

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

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:

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

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.

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

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

isVisible

public boolean isVisible()

Description copied from interface: MapGrid

Whether this grid should be drawn on the map

Specified by:

isVisible in interface MapGrid

reverse

protected void reverse(java.awt.Point p,
                       java.awt.Rectangle bounds)

draw

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

Draw the grid, if visible, and accompanying numbering, if set

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

forceDraw

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

Draw the grid even if not marked visible