VASSAL.build.module.map.boardPicker.board.mapgrid
Class Zone

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

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, GridContainer, ValidityChecker

public class Zone

extends AbstractConfigurable

implements GridContainer

Inner Class Summary

static class	Zone.Editor
static class	Zone.LocationFormatConfig
static class	Zone.ShapeEditor

Inner classes inherited from class VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

protected FormattedString	format
static java.lang.String	GRID_LOCATION
static java.lang.String	LOCATION_FORMAT
protected java.lang.String	locationFormat
protected java.awt.Polygon	myPolygon
static java.lang.String	NAME
static java.lang.String	PATH
static java.lang.String	USE_PARENT_GRID

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

Zone()

Method Summary

void	addTo(Buildable b) Adds this component to its parent.
boolean	contains(java.awt.Point p)
void	draw(java.awt.Graphics g, java.awt.Rectangle bounds, java.awt.Rectangle visibleRect, double scale, boolean reversed)
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
Board	getBoard()
java.awt.Rectangle	getBounds()
static java.lang.String	getConfigureTypeName()
MapGrid	getGrid()
HelpFile	getHelpFile()
java.lang.String	getName()
java.awt.Shape	getShape()
java.awt.Dimension	getSize()
java.lang.String	locationName(java.awt.Point p)
void	removeFrom(Buildable b) Remove this component from its parent
void	removeGrid(MapGrid grid)
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	setGrid(MapGrid m)
java.awt.Point	snapTo(java.awt.Point p) Snap to the grid in this zone,

Methods inherited from class VASSAL.build.AbstractConfigurable

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

NAME

public static final java.lang.String NAME

PATH

public static final java.lang.String PATH

USE_PARENT_GRID

public static final java.lang.String USE_PARENT_GRID

LOCATION_FORMAT

public static final java.lang.String LOCATION_FORMAT

GRID_LOCATION

public static final java.lang.String GRID_LOCATION

locationFormat

protected java.lang.String locationFormat

format

protected FormattedString format

myPolygon

protected java.awt.Polygon myPolygon

Constructor Detail

Zone

public Zone()

Method Detail

getName

public java.lang.String getName()

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

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

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.

locationName

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

contains

public boolean contains(java.awt.Point p)

snapTo

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

Snap to the grid in this zone,

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

Specified by:

setGrid in interface GridContainer

getGrid

public MapGrid getGrid()

getShape

public java.awt.Shape getShape()

getBounds

public java.awt.Rectangle getBounds()

draw

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