Class Zone

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

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

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, GameComponent, GridContainer, MutablePropertiesContainer, PropertyNameSource, PropertySource, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget

public class Zone
extends AbstractConfigurable
implements GridContainer, MutablePropertiesContainer, PropertySource, GameComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Zone.Editor	Our configurer for the Zone, including ability to edit the polygon
static class	Zone.LocationFormatConfig
static class	Zone.ShapeEditor

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

AutoConfigurable.Util

Nested classes/interfaces inherited from interface VASSAL.build.module.properties.MutablePropertiesContainer

MutablePropertiesContainer.Impl

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Dimension	DEFAULT_SIZE
protected FormattedString	format
protected PropertyChangeListener	globalPropertyListener
protected MapGrid	grid
static final String	GRID_LOCATION
static final String	HIGHLIGHT_PROPERTY
protected ZoneHighlight	highlighter
protected MutableProperty	highlightProperty
protected PropertyChangeListener	highlightPropertyChangeListener
protected String	highlightPropertyName
protected int	lastBoundsX
protected int	lastBoundsY
protected Polygon	lastPolygon
protected double	lastScale
protected Shape	lastScaledShape
protected Shape	lastTransformedShape
static final String	LOCATION_FORMAT
protected String	locationFormat
protected Polygon	myPolygon
static final String	NAME
protected ZonedGrid	parentGrid
static final String	PATH
protected MutablePropertiesContainer	propsContainer
protected PropertyChangeListener	repaintOnPropertyChange
static final String	USE_HIGHLIGHT
static final String	USE_PARENT_GRID
protected boolean	useHighlight
protected boolean	useParentGrid

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

Method Summary

Modifier and Type	Method	Description
void	addMutableProperty(String key, MutableProperty p)	Add a property under the given key
void	addTo(Buildable b)	Adds this component to its parent.
boolean	contains(Point p)
void	draw(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()
Rectangle	getBounds()
protected Shape	getCachedShape(Polygon poly, int x, int y, double scale)
static String	getConfigureTypeName()
List<String>	getFormattedStringList()	SearchTarget
MapGrid	getGrid()
HelpFile	getHelpFile()
String	getLocalizedName()
Object	getLocalizedProperty(Object key)	Returns a localized translation of the specified property value, if available.
Point	getLocation(String location)
Map	getMap()
String	getMutablePropertiesContainerId()	Return a unique Id for the container
MutableProperty	getMutableProperty(String name)	Find a GlobalProperty object with the given name
String	getName()
ZonedGrid	getParentGrid()
Polygon	getPolygon()
Object	getProperty(Object key)	When using this interface a piece's own properties are preferred to those of "Global Properties", and those in turn are searched Zone-first then Map, then Module.
List<String>	getPropertyNames()	Implement PropertyNameSource - expose names of my ZoneProperties
Point	getRegionLocation(String location)
Command	getRestoreCommand()	When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null
protected Shape	getScaledShape(Polygon myPolygon, double scale)
Shape	getShape()
Dimension	getSize()
boolean	isUseParentGrid()
String	localizedLocationName(Point p)
String	locationName(Point p)
void	removeFrom(Buildable b)	Remove this component from its parent
void	removeGrid(MapGrid grid)
MutableProperty	removeMutableProperty(String key)	Remove the property with the given key
void	repaint()
void	setAttribute(String key, Object val)	Sets a buildFile (XML) attribute value for this component.
void	setGrid(MapGrid m)
void	setHighlight(ZoneHighlight h)
void	setHighlighter(String highlightName)
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended
Point	snapTo(Point p)
Point	snapTo(Point p, boolean force)
Point	snapTo(Point p, boolean force, boolean centerOnly)

Methods inherited from class VASSAL.build.AbstractConfigurable

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

PATH

public static final String PATH

See Also:

• Constant Field Values

USE_PARENT_GRID

public static final String USE_PARENT_GRID

See Also:

• Constant Field Values

LOCATION_FORMAT

public static final String LOCATION_FORMAT

See Also:

• Constant Field Values

GRID_LOCATION

public static final String GRID_LOCATION

See Also:

• Constant Field Values

USE_HIGHLIGHT

public static final String USE_HIGHLIGHT

See Also:

• Constant Field Values

HIGHLIGHT_PROPERTY

public static final String HIGHLIGHT_PROPERTY

See Also:

• Constant Field Values

DEFAULT_SIZE

protected static final Dimension DEFAULT_SIZE

locationFormat

protected String locationFormat

format

protected FormattedString format

myPolygon

protected Polygon myPolygon

grid

protected MapGrid grid

parentGrid

protected ZonedGrid parentGrid

useParentGrid

protected boolean useParentGrid

globalPropertyListener

protected PropertyChangeListener globalPropertyListener

propsContainer

protected MutablePropertiesContainer propsContainer

repaintOnPropertyChange

protected PropertyChangeListener repaintOnPropertyChange

lastBoundsX

protected int lastBoundsX

lastBoundsY

protected int lastBoundsY

lastScale

protected double lastScale

lastScaledShape

protected Shape lastScaledShape

lastTransformedShape

protected Shape lastTransformedShape

lastPolygon

protected Polygon lastPolygon

highlighter

protected ZoneHighlight highlighter

useHighlight

protected boolean useHighlight

highlightPropertyName

protected String highlightPropertyName

highlightProperty

protected MutableProperty highlightProperty

highlightPropertyChangeListener

protected PropertyChangeListener highlightPropertyChangeListener

Constructor Details

Zone

public Zone()

Method Details

getName

public String getName()

getLocalizedName

public String getLocalizedName()

getPolygon

public Polygon getPolygon()

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

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.

repaint

public void repaint()

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

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.

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

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.

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.

addMutableProperty

public void addMutableProperty(String key,
 MutableProperty p)

Description copied from interface: MutablePropertiesContainer

Add a property under the given key

Specified by:

addMutableProperty in interface MutablePropertiesContainer

Parameters:

key - key

p - property

removeMutableProperty

public MutableProperty removeMutableProperty(String key)

Description copied from interface: MutablePropertiesContainer

Remove the property with the given key

Specified by:

removeMutableProperty in interface MutablePropertiesContainer

Parameters:

key - key

getLocation

public Point getLocation(String location)
                  throws MapGrid.BadCoords

Throws:

MapGrid.BadCoords

getRegionLocation

public Point getRegionLocation(String location)

locationName

public String locationName(Point p)

localizedLocationName

public String localizedLocationName(Point p)

contains

public boolean contains(Point p)

Specified by:

contains in interface GridContainer

snapTo

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

See Also:

• MapGrid.snapTo(java.awt.Point)

snapTo

public Point snapTo(Point p,
 boolean force)

See Also:

• MapGrid.snapTo(java.awt.Point)

snapTo

public Point snapTo(Point p)

See Also:

• MapGrid.snapTo(java.awt.Point)

getSize

public 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

getMap

public Map getMap()

getParentGrid

public ZonedGrid getParentGrid()

setGrid

public void setGrid(MapGrid m)

Specified by:

setGrid in interface GridContainer

getGrid

public MapGrid getGrid()

isUseParentGrid

public boolean isUseParentGrid()

getShape

public Shape getShape()

getBounds

public Rectangle getBounds()

setHighlight

public void setHighlight(ZoneHighlight h)

draw

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

getScaledShape

protected Shape getScaledShape(Polygon myPolygon,
 double scale)

getCachedShape

protected Shape getCachedShape(Polygon poly,
 int x,
 int y,
 double scale)

getProperty

public Object getProperty(Object key)

Description copied from interface: PropertySource

When using this interface a piece's own properties are preferred to those of "Global Properties", and those in turn are searched Zone-first then Map, then Module.

Specified by:

getProperty in interface PropertySource

Parameters:

key - String key of property to be returned

Returns:

Object containing value of the specified property

getLocalizedProperty

public Object getLocalizedProperty(Object key)

Description copied from interface: PropertySource

Returns a localized translation of the specified property value, if available. Otherwise returns the non-localized version.

Specified by:

getLocalizedProperty in interface PropertySource

Parameters:

key - String key of property to be returned

Returns:

Object containing localized text of the specified property, if available, otherwise non-localized value

getPropertyNames

public List<String> getPropertyNames()

Implement PropertyNameSource - expose names of my ZoneProperties

Specified by:

getPropertyNames in interface PropertyNameSource

Overrides:

getPropertyNames in class AbstractBuildable

Returns:

Default implementation of PropertyNameSource - No properties exposed

getMutableProperty

public MutableProperty getMutableProperty(String name)

Description copied from interface: MutablePropertiesContainer

Find a GlobalProperty object with the given name

Specified by:

getMutableProperty in interface MutablePropertiesContainer

getMutablePropertiesContainerId

public String getMutablePropertiesContainerId()

Description copied from interface: MutablePropertiesContainer

Return a unique Id for the container

Specified by:

getMutablePropertiesContainerId in interface MutablePropertiesContainer

setup

public void setup(boolean gameStarting)

Description copied from interface: GameComponent

Notify the GameComponent that a game has started/ended

Specified by:

setup in interface GameComponent

Parameters:

gameStarting - if true, a game is starting. If false, then a game is ending

setHighlighter

public void setHighlighter(String highlightName)

getRestoreCommand

public Command getRestoreCommand()

Description copied from interface: GameComponent

When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null

Specified by:

getRestoreCommand in interface GameComponent

getFormattedStringList

public List<String> getFormattedStringList()

SearchTarget

Specified by:

getFormattedStringList in interface SearchTarget

Overrides:

getFormattedStringList in class AbstractConfigurable

Returns:

a list of any Message Format strings referenced in the Configurable, if any (for search)