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

All Implemented Interfaces:: AutoConfigurable, Buildable, Configurable, GameComponent, GridContainer, MutablePropertiesContainer, PropertyNameSource, PropertySource, ValidityChecker, Translatable

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

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class Zone.Editor

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 Dimension`	`DEFAULT_SIZE`
`protected FormattedString`	`format`
`protected PropertyChangeListener`	`globalPropertyListener`
`protected MapGrid`	`grid`
`static String`	`GRID_LOCATION`
`static 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 String`	`LOCATION_FORMAT`
`protected String`	`locationFormat`
`protected Polygon`	`myPolygon`
`static String`	`NAME`
`protected ZonedGrid`	`parentGrid`
`static String`	`PATH`
`protected MutablePropertiesContainer`	`propsContainer`
`protected PropertyChangeListener`	`repaintOnPropertyChange`
`static String`	`USE_HIGHLIGHT`
`static 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()`	Return a list of valid sub-component Classes.
`String[]`	`getAttributeDescriptions()`	Return an array of Strings describing the attributes of this object.
`String[]`	`getAttributeNames()`
`Class<?>[]`	`getAttributeTypes()`	Return the Class for the attributes of this object.
`String`	`getAttributeValueString(String key)`	Return a String representation of the attribute with the given name.
`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()`
`MapGrid`	`getGrid()`
`HelpFile`	`getHelpFile()`
`String`	`getLocalizedName()`
`Object`	`getLocalizedProperty(Object key)`
`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()`
`Object`	`getProperty(Object key)`
`List<String>`	`getPropertyNames()`	Implement PropertNameSource - expose names of my ZoneProperties
`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 an 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)`	Snap to the grid in this zone,

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, getI18nData, getI18nPrefix, getLocalizedConfigureName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

build, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponentsOf, 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

build, getBuildElement

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()
- getAttributeNames
  
  public String[] getAttributeNames()
  
  Specified by:
  
  getAttributeNames in interface AutoConfigurable
  
  Specified by:
  
  getAttributeNames in class AbstractBuildable
  
  Returns:
  
  a list of all attribute names for this component
- getAttributeDescriptions
  
  public 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()
  
  Specified by:
  
  getAttributeDescriptions in interface AutoConfigurable
  
  Specified by:
  
  getAttributeDescriptions in class AbstractConfigurable
- getAttributeTypes
  
  public 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()
  
  Specified by:
  
  getAttributeTypes in interface AutoConfigurable
  
  Specified by:
  
  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.
  
  Specified by:
  
  addTo in interface Buildable
- 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 HelpFilte describing how to use and configure this component
- getAttributeValueString
  
  public String getAttributeValueString(String key)
  
  Description copied from class: AbstractBuildable
  
  Return a String representation of the attribute with the given name. When initializing a module, this String value will be passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object).
  
  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()
- setAttribute
  
  public void setAttribute(String key, Object val)
  
  Description copied from class: AbstractBuildable
  
  Sets an 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()
- 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
  
  Returns:
  
  null if the attribute controls should always be visible;
- getAllowableConfigureComponents
  
  public 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.
  
  Specified by:
  
  getAllowableConfigureComponents in interface Configurable
- 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
- removeMutableProperty
  
  public MutableProperty removeMutableProperty(String key)
  
  Description copied from interface: MutablePropertiesContainer
  
  Remove the property with the given key
  
  Specified by:
  
  removeMutableProperty in interface MutablePropertiesContainer
- getLocation
  
  public Point getLocation(String location) throws MapGrid.BadCoords
  
  Throws:
  
  MapGrid.BadCoords
- 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)
  
  Snap to the grid in this zone,
- 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)
  
  Specified by:
  
  getProperty in interface PropertySource
- getLocalizedProperty
  
  public Object getLocalizedProperty(Object key)
  
  Specified by:
  
  getLocalizedProperty in interface PropertySource
- getPropertyNames
  
  public List<String> getPropertyNames()
  
  Implement PropertNameSource - expose names of my ZoneProperties
  
  Specified by:
  
  getPropertyNames in interface PropertyNameSource
  
  Overrides:
  
  getPropertyNames in class AbstractBuildable
- 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

Modifier and Type	Class	Description
`static class`	`Zone.Editor`
`static class`	`Zone.LocationFormatConfig`
`static class`	`Zone.ShapeEditor`

Class Zone

Nested Class Summary

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

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

Field Summary

Fields inherited from class VASSAL.build.AbstractConfigurable

Fields inherited from class VASSAL.build.AbstractBuildable

Fields inherited from interface VASSAL.build.Configurable

Constructor Summary

Method Summary

Methods inherited from class VASSAL.build.AbstractConfigurable

Methods inherited from class VASSAL.build.AbstractBuildable

Methods inherited from class java.lang.Object

Methods inherited from interface VASSAL.build.Buildable

Field Details

Constructor Details

Method Details