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

java.lang.Object
  |
  +--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

public class HexGridNumbering

extends RegularGridNumbering

Nested Class Summary

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

RegularGridNumbering.F, RegularGridNumbering.T

Nested classes inherited from class VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

static java.lang.String

STAGGER

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

ALPHABET, color, COLOR, first, FIRST, FONT_SIZE, fontSize, H_LEADING, H_OFF, H_TYPE, hLeading, hOff, hType, propSupport, sep, SEP, V_LEADING, V_OFF, V_TYPE, visible, VISIBLE, visualizer, vLeading, vOff, vType

Fields inherited from class VASSAL.build.AbstractConfigurable

changeSupport, config, name

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

HexGridNumbering()

Method Summary

void	addTo(Buildable parent) Adds this component to its parent.
void	draw(java.awt.Graphics g, java.awt.Rectangle bounds, java.awt.Rectangle visibleRect, double scale, boolean reversed)
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
int	getColumn(java.awt.Point p)
protected javax.swing.JComponent	getGridVisualizer() Return a component that shows how the grid will draw itself
java.lang.String	getName(int row, int column)
int	getRow(java.awt.Point p)
void	removeFrom(Buildable parent) Remove this component from its parent
void	setAttribute(java.lang.String key, java.lang.Object value) Called by the AbstractBuildable.build(org.w3c.dom.Element) method, where value is the String value read by the XML attribute.

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

addPropertyChangeListener, getAllowableConfigureComponents, getAttributeVisibility, getConfigurer, getConfigureTypeName, getHelpFile, getName, isVisible, locationName

Methods inherited from class VASSAL.build.AbstractConfigurable

getConfigureComponents, getConfigureName, remove, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

add, build, getBuildComponents, getBuildElement, getComponents

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

STAGGER

public static final java.lang.String STAGGER

See Also:

Constant Field Values

Constructor Detail

HexGridNumbering

public HexGridNumbering()

Method Detail

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 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.

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

Specified by:

getAttributeDescriptions in interface AutoConfigurable

Overrides:

getAttributeDescriptions in class RegularGridNumbering

getAttributeNames

public java.lang.String[] getAttributeNames()

Specified by:

getAttributeNames in interface AutoConfigurable

Overrides:

getAttributeNames in class RegularGridNumbering

Returns:

an array of Strings giving all attributes of this Buildable component that will be written to/read from an XML element

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

Specified by:

getAttributeTypes in interface AutoConfigurable

Overrides:

getAttributeTypes in class RegularGridNumbering

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.Object value)

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.

Specified by:

setAttribute in interface AutoConfigurable

Overrides:

setAttribute in class RegularGridNumbering

Parameters:

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

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

Specified by:

getAttributeValueString in interface AutoConfigurable

Overrides:

getAttributeValueString in class RegularGridNumbering

Parameters:

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

draw

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

getColumn

public int getColumn(java.awt.Point p)

Specified by:

getColumn in class RegularGridNumbering

getGridVisualizer

protected javax.swing.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(java.awt.Point p)

Specified by:

getRow in class RegularGridNumbering

getName

public java.lang.String getName(int row,
                                int column)

Overrides:

getName in class RegularGridNumbering

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent