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

Class SquareGridNumbering

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

All Implemented Interfaces:

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

public class SquareGridNumbering
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 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
SquareGridNumbering()

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
Point	getCenterPoint(int col, int row)
int	getColumn(Point p)
protected JComponent	getGridVisualizer()	Return a component that shows how the grid will draw itself
protected int	getMaxColumns()
protected int	getMaxRows()
int	getRow(Point p)
void	removeFrom(Buildable parent)	Remove this component from its parent

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

addPropertyChangeListener, getAllowableConfigureComponents, getAttributeDescriptions, getAttributeNames, getAttributeTypes, getAttributeValueString, getAttributeVisibility, getConfigurer, getConfigureTypeName, getHelpFile, getLocation, getMatchingPattern, getName, getName, isVisible, localizedLocationName, locationName, offsetLabelCenter, offsetLabelCenter, parseName, setAttribute

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

Constructor Details

SquareGridNumbering

public SquareGridNumbering()

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.

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

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

getColumn

public int getColumn(Point p)

Specified by:

getColumn in class RegularGridNumbering

getRow

public int getRow(Point p)

Specified by:

getRow in class RegularGridNumbering

getCenterPoint

public Point getCenterPoint(int col,
 int row)

Specified by:

getCenterPoint in class RegularGridNumbering

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