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

Class HexGridNumbering

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

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

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

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, GridNumbering, PropertyNameSource, ValidityChecker, Translatable, ImageSearchTarget, SearchTarget

public class HexGridNumbering
extends RegularGridNumbering

Nested Class Summary

Nested classes/interfaces inherited from class VASSAL.build.module.map.boardPicker.board.mapgrid.RegularGridNumbering

RegularGridNumbering.F, RegularGridNumbering.LocationFormatConfig, RegularGridNumbering.R, RegularGridNumbering.T

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static String	STAGGER

Fields inherited from class VASSAL.build.module.map.boardPicker.board.mapgrid.RegularGridNumbering

ALPHABET, color, COLOR, COLUMN, first, FIRST, FONT_SIZE, fontSize, format, GRID_LOCATION, H_DESCEND, H_DRAW_OFF, H_LEADING, H_OFF, H_TYPE, hDescending, hDrawOff, hLeading, hOff, hType, LOCATION_FORMAT, locationFormat, propSupport, ROTATE_TEXT, rotateTextDegrees, ROW, sep, SEP, V_DESCEND, V_DRAW_OFF, V_LEADING, V_OFF, V_TYPE, vDescending, vDrawOff, visible, VISIBLE, visualizer, vLeading, vOff, 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
HexGridNumbering()

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Adds this component to its parent.
void	draw(Graphics g, Rectangle bounds, Rectangle visibleRect, double scale, boolean reversed)	Draw the numbering if visible
void	forceDraw(Graphics g, Rectangle bounds, Rectangle visibleRect, double scale, boolean reversed)	Draw the numbering, even if not visible
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
Point	getCenterPoint(int col, int row)
int	getColumn(Point p)
HexGrid	getGrid()
protected JComponent	getGridVisualizer()	Return a component that shows how the grid will draw itself
protected int	getMaxColumns()
protected int	getMaxRows()
int	getRawColumn(Point p)
int	getRawRow(Point p)
int	getRow(Point p)
void	removeFrom(Buildable parent)	Remove this component from its parent
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.

Methods inherited from class VASSAL.build.module.map.boardPicker.board.mapgrid.RegularGridNumbering

addPropertyChangeListener, getAllowableConfigureComponents, getAttributeVisibility, getConfigurer, getConfigureTypeName, getHelpFile, getLocation, getMatchingPattern, getName, getName, isVisible, localizedLocationName, locationName, offsetLabelCenter, offsetLabelCenter, parseName

Methods inherited from class VASSAL.build.AbstractConfigurable

add, getConfigureComponents, getConfigureName, getExpressionList, getFormattedStringList, getI18nData, getI18nPrefix, getLocalizedConfigureName, getMenuTextList, getNamedKeyStrokeList, getPropertyList, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

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

build, getBuildElement

Field Details

STAGGER

public static final String STAGGER

See Also:

Constant Field Values

Constructor Details

HexGridNumbering

public HexGridNumbering()

Method Details

addTo

public void addTo(Buildable parent)

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.

Parameters:

parent - parent Buildable to add this component to as a subcomponent.

getGrid

public HexGrid getGrid()

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

Overrides:

getAttributeDescriptions in class RegularGridNumbering

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

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

Overrides:

getAttributeNames in class RegularGridNumbering

Returns:

a list of all buildFile (XML) attribute names for this component

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

Overrides:

getAttributeTypes in class RegularGridNumbering

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

setAttribute

public void setAttribute(String key,
 Object value)

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

Overrides:

setAttribute in class RegularGridNumbering

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

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

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

Overrides:

getAttributeValueString in class RegularGridNumbering

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.

draw

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

Draw the numbering if visible

forceDraw

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

Draw the numbering, even if not visible

getCenterPoint

public Point getCenterPoint(int col,
 int row)

Specified by:

getCenterPoint in class RegularGridNumbering

getColumn

public int getColumn(Point p)

Specified by:

getColumn in class RegularGridNumbering

getRawColumn

public int getRawColumn(Point p)

getGridVisualizer

protected JComponent getGridVisualizer()

Description copied from class: RegularGridNumbering

Return a component that shows how the grid will draw itself

Specified by:

getGridVisualizer in class RegularGridNumbering

getRow

public int getRow(Point p)

Specified by:

getRow in class RegularGridNumbering

getRawRow

public int getRawRow(Point p)

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

getMaxRows

protected int getMaxRows()

getMaxColumns

protected int getMaxColumns()