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

All Implemented Interfaces:: AutoConfigurable, Buildable, Configurable, GridNumbering, PropertyNameSource, ValidityChecker, Translatable

Direct Known Subclasses:: HexGridNumbering, SquareGridNumbering

public abstract class RegularGridNumbering
extends AbstractConfigurable
implements GridNumbering

Abstract base class for grid numbering classes for hexagonal and rectangular grids

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`RegularGridNumbering.F`
`static class`	`RegularGridNumbering.LocationFormatConfig`
`static class`	`RegularGridNumbering.R`
`static class`	`RegularGridNumbering.T`

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

AutoConfigurable.Util

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ALPHABET`
`protected Color`	`color`
`static String`	`COLOR`
`static String`	`COLUMN`
`protected char`	`first`
`static String`	`FIRST`
`static String`	`FONT_SIZE`
`protected int`	`fontSize`
`protected FormattedString`	`format`
`static String`	`GRID_LOCATION`
`static String`	`H_DESCEND`
`static String`	`H_DRAW_OFF`
`static String`	`H_LEADING`
`static String`	`H_OFF`
`static String`	`H_TYPE`
`protected boolean`	`hDescending`
`protected int`	`hDrawOff`
`protected int`	`hLeading`
`protected int`	`hOff`
`protected char`	`hType`
`static String`	`LOCATION_FORMAT`
`protected String`	`locationFormat`
`protected PropertyChangeSupport`	`propSupport`
`static String`	`ROTATE_TEXT`
`protected int`	`rotateTextDegrees`
`static String`	`ROW`
`protected String`	`sep`
`static String`	`SEP`
`static String`	`V_DESCEND`
`static String`	`V_DRAW_OFF`
`static String`	`V_LEADING`
`static String`	`V_OFF`
`static String`	`V_TYPE`
`protected boolean`	`vDescending`
`protected int`	`vDrawOff`
`protected boolean`	`visible`
`static String`	`VISIBLE`
`protected JComponent`	`visualizer`
`protected int`	`vLeading`
`protected int`	`vOff`
`protected char`	`vType`

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

RegularGridNumbering()

Method Summary

Modifier and Type	Method	Description
`void`	`addPropertyChangeListener(PropertyChangeListener l)`	Add a PropertyChangeListener.
`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
`abstract Point`	`getCenterPoint(int col, int row)`
`abstract int`	`getColumn(Point p)`
`Configurer`	`getConfigurer()`	The default `Configurer` of an `AbstractConfigurable` class is an instance of `AutoConfigurer`
`static String`	`getConfigureTypeName()`
`protected abstract JComponent`	`getGridVisualizer()`	Return a component that shows how the grid will draw itself
`HelpFile`	`getHelpFile()`
`Point`	`getLocation(String location)`
`protected String`	`getMatchingPattern(char type, int leading)`
`protected String`	`getName(int rowOrColumn, char type, int leading)`
`protected String`	`getName(int row, int column)`
`abstract int`	`getRow(Point p)`
`boolean`	`isVisible()`
`String`	`localizedLocationName(Point pt)`
`String`	`locationName(Point pt)`
`Point`	`offsetLabelCenter(int x, int y, double zoom)`
`Point`	`offsetLabelCenter(Point p, double zoom)`
`protected int`	`parseName(String name, char type)`
`void`	`setAttribute(String key, Object value)`	Sets an attribute value for this component.

Methods inherited from class VASSAL.build.AbstractConfigurable

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

Methods inherited from class VASSAL.build.AbstractBuildable

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

addTo, build, getBuildElement

Methods inherited from interface VASSAL.build.Configurable

removeFrom

Methods inherited from interface VASSAL.build.module.map.boardPicker.board.mapgrid.GridNumbering

draw

Field Details
- propSupport
  
  protected PropertyChangeSupport propSupport
- first
  
  protected char first
- sep
  
  protected String sep
- hType
  
  protected char hType
- vType
  
  protected char vType
- hLeading
  
  protected int hLeading
- vLeading
  
  protected int vLeading
- hOff
  
  protected int hOff
- vOff
  
  protected int vOff
- hDescending
  
  protected boolean hDescending
- vDescending
  
  protected boolean vDescending
- visible
  
  protected boolean visible
- fontSize
  
  protected int fontSize
- color
  
  protected Color color
- rotateTextDegrees
  
  protected int rotateTextDegrees
- hDrawOff
  
  protected int hDrawOff
- vDrawOff
  
  protected int vDrawOff
- visualizer
  
  protected JComponent visualizer
- locationFormat
  
  protected String locationFormat
- format
  
  protected FormattedString format
- FIRST
  
  public static final String FIRST
  
  See Also:
  
  Constant Field Values
- SEP
  
  public static final String SEP
  
  See Also:
  
  Constant Field Values
- H_TYPE
  
  public static final String H_TYPE
  
  See Also:
  
  Constant Field Values
- V_TYPE
  
  public static final String V_TYPE
  
  See Also:
  
  Constant Field Values
- H_LEADING
  
  public static final String H_LEADING
  
  See Also:
  
  Constant Field Values
- V_LEADING
  
  public static final String V_LEADING
  
  See Also:
  
  Constant Field Values
- H_OFF
  
  public static final String H_OFF
  
  See Also:
  
  Constant Field Values
- V_OFF
  
  public static final String V_OFF
  
  See Also:
  
  Constant Field Values
- V_DESCEND
  
  public static final String V_DESCEND
  
  See Also:
  
  Constant Field Values
- H_DESCEND
  
  public static final String H_DESCEND
  
  See Also:
  
  Constant Field Values
- FONT_SIZE
  
  public static final String FONT_SIZE
  
  See Also:
  
  Constant Field Values
- COLOR
  
  public static final String COLOR
  
  See Also:
  
  Constant Field Values
- VISIBLE
  
  public static final String VISIBLE
  
  See Also:
  
  Constant Field Values
- ROTATE_TEXT
  
  public static final String ROTATE_TEXT
  
  See Also:
  
  Constant Field Values
- H_DRAW_OFF
  
  public static final String H_DRAW_OFF
  
  See Also:
  
  Constant Field Values
- V_DRAW_OFF
  
  public static final String V_DRAW_OFF
  
  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
- ROW
  
  public static final String ROW
  
  See Also:
  
  Constant Field Values
- COLUMN
  
  public static final String COLUMN
  
  See Also:
  
  Constant Field Values
- ALPHABET
  
  public static final String ALPHABET
  
  See Also:
  
  Constant Field Values
Constructor Details
- RegularGridNumbering
  
  public RegularGridNumbering()
Method Details
- 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 value)
  
  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()
- isVisible
  
  public boolean isVisible()
  
  Specified by:
  
  isVisible in interface GridNumbering
- getRow
  
  public abstract int getRow(Point p)
- getColumn
  
  public abstract int getColumn(Point p)
- addPropertyChangeListener
  
  public void addPropertyChangeListener(PropertyChangeListener l)
  
  Description copied from interface: Configurable
  
  Add a PropertyChangeListener. A PropertyChangeEvent should be fired with property name Configurable.NAME_PROPERTY when the value returned from Configurable.getConfigureName() has changed
  
  Specified by:
  
  addPropertyChangeListener in interface Configurable
  
  Overrides:
  
  addPropertyChangeListener in class AbstractConfigurable
- 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
- 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
- getGridVisualizer
  
  protected abstract JComponent getGridVisualizer()
  
  Return a component that shows how the grid will draw itself
- 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;
- getConfigurer
  
  public Configurer getConfigurer()
  
  Description copied from class: AbstractConfigurable
  
  The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
  
  Specified by:
  
  getConfigurer in interface Configurable
  
  Overrides:
  
  getConfigurer in class AbstractConfigurable
- 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
- getName
  
  protected String getName(int row, int column)
- getMatchingPattern
  
  protected String getMatchingPattern(char type, int leading)
- getLocation
  
  public Point getLocation(String location) throws MapGrid.BadCoords
  
  Specified by:
  
  getLocation in interface GridNumbering
  
  Throws:
  
  MapGrid.BadCoords
- getCenterPoint
  
  public abstract Point getCenterPoint(int col, int row)
- locationName
  
  public String locationName(Point pt)
  
  Specified by:
  
  locationName in interface GridNumbering
- localizedLocationName
  
  public String localizedLocationName(Point pt)
  
  Specified by:
  
  localizedLocationName in interface GridNumbering
- parseName
  
  protected int parseName(String name, char type)
- getName
  
  protected String getName(int rowOrColumn, char type, int leading)
- offsetLabelCenter
  
  public Point offsetLabelCenter(Point p, double zoom)
- offsetLabelCenter
  
  public Point offsetLabelCenter(int x, int y, double zoom)

Class RegularGridNumbering