Class RegularGridNumbering
java.lang.Object
VASSAL.build.AbstractBuildable
VASSAL.build.AbstractConfigurable
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()
Lists all the buildFile (XML) attribute names for this component.Class<?>[]
getAttributeTypes()
Return the Class for the buildFile (XML) attributes of this component.String
getAttributeValueString(String key)
Called by theBuildable.getBuildElement(org.w3c.dom.Document)
method to write the attributes into an XML elementVisibilityCondition
getAttributeVisibility(String name)
By default, all attributes are visibleabstract Point
getCenterPoint(int col, int row)
abstract int
getColumn(Point p)
Configurer
getConfigurer()
static String
getConfigureTypeName()
protected abstract JComponent
getGridVisualizer()
Return a component that shows how the grid will draw itselfHelpFile
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 a buildFile (XML) 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
-
first
protected char first -
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
-
rotateTextDegrees
protected int rotateTextDegrees -
hDrawOff
protected int hDrawOff -
vDrawOff
protected int vDrawOff -
visualizer
-
locationFormat
-
format
-
FIRST
- See Also:
- Constant Field Values
-
SEP
- See Also:
- Constant Field Values
-
H_TYPE
- See Also:
- Constant Field Values
-
V_TYPE
- See Also:
- Constant Field Values
-
H_LEADING
- See Also:
- Constant Field Values
-
V_LEADING
- See Also:
- Constant Field Values
-
H_OFF
- See Also:
- Constant Field Values
-
V_OFF
- See Also:
- Constant Field Values
-
V_DESCEND
- See Also:
- Constant Field Values
-
H_DESCEND
- See Also:
- Constant Field Values
-
FONT_SIZE
- See Also:
- Constant Field Values
-
COLOR
- See Also:
- Constant Field Values
-
VISIBLE
- See Also:
- Constant Field Values
-
ROTATE_TEXT
- See Also:
- Constant Field Values
-
H_DRAW_OFF
- See Also:
- Constant Field Values
-
V_DRAW_OFF
- See Also:
- Constant Field Values
-
LOCATION_FORMAT
- See Also:
- Constant Field Values
-
GRID_LOCATION
- See Also:
- Constant Field Values
-
ROW
- See Also:
- Constant Field Values
-
COLUMN
- See Also:
- Constant Field Values
-
ALPHABET
- See Also:
- Constant Field Values
-
-
Constructor Details
-
RegularGridNumbering
public RegularGridNumbering()
-
-
Method Details
-
getAttributeValueString
Description copied from interface:AutoConfigurable
Called by theBuildable.getBuildElement(org.w3c.dom.Document)
method to write the attributes into an XML element- Specified by:
getAttributeValueString
in interfaceAutoConfigurable
- Specified by:
getAttributeValueString
in interfaceTranslatable
- Specified by:
getAttributeValueString
in classAbstractBuildable
- Parameters:
key
- the name of the attribute. Will be one of those listed inAbstractBuildable.getAttributeNames()
- Returns:
- 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)
.
-
setAttribute
Description copied from class:AbstractBuildable
Sets a buildFile (XML) attribute value for this component. Thekey
parameter will be one of those listed inAbstractBuildable.getAttributeNames()
. If thevalue
parameter is a String, it will be the value returned byAbstractBuildable.getAttributeValueString(java.lang.String)
for the samekey
. If the implementing class extendsAbstractConfigurable
, thenvalue
will be an instance of the corresponding Class listed inAbstractConfigurable.getAttributeTypes()
- Specified by:
setAttribute
in interfaceAutoConfigurable
- Specified by:
setAttribute
in interfaceTranslatable
- Specified by:
setAttribute
in classAbstractBuildable
- Parameters:
key
- the name of the attribute. Will be one of those listed inAbstractBuildable.getAttributeNames()
value
- If thevalue
parameter is a String, it will be the value returned byAbstractBuildable.getAttributeValueString(java.lang.String)
for the samekey
. If the implementing class extendsAbstractConfigurable
, thenvalue
can also be an instance of the corresponding Class listed inAbstractConfigurable.getAttributeTypes()
-
isVisible
public boolean isVisible()- Specified by:
isVisible
in interfaceGridNumbering
-
getRow
-
getColumn
-
addPropertyChangeListener
Description copied from interface:Configurable
Add a PropertyChangeListener. A PropertyChangeEvent should be fired with property nameConfigurable.NAME_PROPERTY
when the value returned fromConfigurable.getConfigureName()
has changed- Specified by:
addPropertyChangeListener
in interfaceConfigurable
- Overrides:
addPropertyChangeListener
in classAbstractConfigurable
-
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 interfaceConfigurable
-
getAttributeNames
Description copied from class:AbstractBuildable
Lists all the buildFile (XML) attribute names for this component. If this component is ALSO anAbstractConfigurable
, then this list of attributes determines the appropriate attribute order forAbstractConfigurable.getAttributeDescriptions()
andAbstractConfigurable.getAttributeTypes()
.- Specified by:
getAttributeNames
in interfaceAutoConfigurable
- Specified by:
getAttributeNames
in classAbstractBuildable
- Returns:
- a list of all buildFile (XML) attribute names for this component
-
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 interfaceAutoConfigurable
- Specified by:
getAttributeDescriptions
in classAbstractConfigurable
- 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
Description copied from class:AbstractConfigurable
Return 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 ofAutoConfigurer
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 inAbstractBuildable.getAttributeNames()
- Specified by:
getAttributeTypes
in interfaceAutoConfigurable
- Specified by:
getAttributeTypes
in classAbstractConfigurable
-
getGridVisualizer
Return a component that shows how the grid will draw itself -
getAttributeVisibility
Description copied from class:AbstractConfigurable
By default, all attributes are visible- Specified by:
getAttributeVisibility
in interfaceAutoConfigurable
- Overrides:
getAttributeVisibility
in classAbstractConfigurable
- 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.
-
getConfigurer
Description copied from class:AbstractConfigurable
- Specified by:
getConfigurer
in interfaceConfigurable
- Overrides:
getConfigurer
in classAbstractConfigurable
- Returns:
- Configurer for this component
-
getConfigureTypeName
-
getHelpFile
- Specified by:
getHelpFile
in interfaceConfigurable
- Returns:
- a HelpFilte describing how to use and configure this component
-
getName
-
getMatchingPattern
-
getLocation
- Specified by:
getLocation
in interfaceGridNumbering
- Throws:
MapGrid.BadCoords
-
getCenterPoint
-
locationName
- Specified by:
locationName
in interfaceGridNumbering
-
localizedLocationName
- Specified by:
localizedLocationName
in interfaceGridNumbering
-
parseName
-
getName
-
offsetLabelCenter
-
offsetLabelCenter
-