Package VASSAL.counters

Class Labeler

java.lang.Object

VASSAL.counters.Decorator

VASSAL.counters.Labeler

All Implemented Interfaces:

PropertyNameSource, PropertySource, EditablePiece, GamePiece, PropertyExporter, StateMergeable, TranslatablePiece, PersistentPropertyContainer, RecursionLimiter.Loopable

public class Labeler
extends Decorator
implements TranslatablePiece, RecursionLimiter.Loopable

Displays a text label, with content specified by the user at runtime.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	Labeler.HTMLLabelOp
protected static class	Labeler.LabelOp

Field Summary

Fields

Modifier and Type	Field	Description
static int	BOTTOM	Deprecated, for removal: This API element is subject to removal in a future version.
static int	CENTER	Deprecated, for removal: This API element is subject to removal in a future version.
protected String	description
static int	HORIZONTAL_ALIGNMENT	Deprecated, for removal: This API element is subject to removal in a future version.
static String	ID
protected ScaledImagePainter	imagePainter	Deprecated.
protected Rectangle	lastRect
protected Area	lastShape
static int	LEFT	Deprecated, for removal: This API element is subject to removal in a future version.
protected KeyCommand	menuKeyCommand
protected String	propertyName
static int	RIGHT	Deprecated, for removal: This API element is subject to removal in a future version.
protected int	rotateDegrees
protected Color	textBg
protected Color	textFg
static int	TOP	Deprecated, for removal: This API element is subject to removal in a future version.
static int	VERTICAL_ALIGNMENT	Deprecated, for removal: This API element is subject to removal in a future version.

Fields inherited from class VASSAL.counters.Decorator

piece

Fields inherited from interface VASSAL.counters.PropertyExporter

LOCALIZED_NAME

Fields inherited from interface VASSAL.i18n.TranslatablePiece

PREFIX

Constructor Summary

Constructors

Constructor	Description
Labeler()
Labeler(String s, GamePiece d)

Method Summary

Modifier and Type	Method	Description
Rectangle	boundingBox()	The area which this GamePiece occupies when drawn at the point (0,0)
protected String	clean(String s)
void	draw(Graphics g, int x, int y, Component obs, double zoom)	Draw this GamePiece
static void	drawLabel(Graphics g, String text, int x, int y, int hAlign, int vAlign, Color fgColor, Color bgColor)	Deprecated, for removal: This API element is subject to removal in a future version. Use LabelUtils.drawLabel(Graphics, String, int, int, int, int, Color, Color) instead.
static void	drawLabel(Graphics g, String text, int x, int y, Font f, int hAlign, int vAlign, Color fgColor, Color bgColor, Color borderColor)	Deprecated, for removal: This API element is subject to removal in a future version. Use LabelUtils.drawLabel(Graphics, String, int, int, Font, int, int, Color, Color, Color) instead.
String	getComponentName()
String	getComponentTypeName()
String	getDescription()	A plain-English description of this type of piece
PieceEditor	getEditor()	Get the configurer for this trait
HelpFile	getHelpFile()
PieceI18nData	getI18nData()	Return I18n data for this piece
String	getLabel()
String	getLocalizedLabel()
String	getLocalizedName()	Return the translated name for this piece.
Object	getLocalizedProperty(Object key)
String	getName()	The plain English name for this piece
Object	getProperty(Object key)
List<String>	getPropertyNames()	Return Property names exposed by this trait
Shape	getShape()	Return the Shape of the counter by adding the shape of this label to the shape of all inner traits.
KeyCommand[]	myGetKeyCommands()
String	myGetState()
String	myGetType()
Command	myKeyEvent(KeyStroke stroke)	The response of this trait alone to the given KeyStroke
void	mySetState(String s)	Set just the state of this trait
void	mySetType(String type)	Set the type information for this piece.
void	setBackground(Color textBg)
void	setForeground(Color textFg)
void	setLabel(String s)
protected void	updateCachedImage()

Methods inherited from class VASSAL.counters.Decorator

getCommandDescription, getDecorator, getI18nData, getI18nData, getId, getInner, getInnermost, getKeyCommands, getMap, getOuter, getOutermost, getParent, getPersistentProperty, getPosition, getProperties, getState, getTranslation, getType, isSelected, keyEvent, mergeState, putOldProperties, repack, reportDataError, reportDataError, reportDataError, setId, setInner, setMap, setOldProperties, setOldProperties, setParent, setPersistentProperty, setPosition, setProperty, setSelected, setState, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface VASSAL.counters.GamePiece

getId, getMap, getParent, getPosition, getState, getType, keyEvent, setId, setMap, setParent, setPosition, setProperty, setState

Methods inherited from interface VASSAL.counters.PropertyExporter

getProperties

Field Details

ID

public static final String ID

See Also:

Constant Field Values

textBg

protected Color textBg

textFg

protected Color textFg

CENTER

@Deprecated(since="2020-08-27",
            forRemoval=true)
public static final int CENTER

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

Constant Field Values

RIGHT

@Deprecated(since="2020-08-27",
            forRemoval=true)
public static final int RIGHT

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

Constant Field Values

LEFT

@Deprecated(since="2020-08-27",
            forRemoval=true)
public static final int LEFT

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

Constant Field Values

TOP

@Deprecated(since="2020-08-27",
            forRemoval=true)
public static final int TOP

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

Constant Field Values

BOTTOM

@Deprecated(since="2020-08-27",
            forRemoval=true)
public static final int BOTTOM

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

Constant Field Values

HORIZONTAL_ALIGNMENT

@Deprecated(since="2020-08-27",
            forRemoval=true)
public static int HORIZONTAL_ALIGNMENT

Deprecated, for removal: This API element is subject to removal in a future version.

VERTICAL_ALIGNMENT

@Deprecated(since="2020-08-27",
            forRemoval=true)
public static int VERTICAL_ALIGNMENT

Deprecated, for removal: This API element is subject to removal in a future version.

imagePainter

@Deprecated
protected ScaledImagePainter imagePainter

Deprecated.

rotateDegrees

protected int rotateDegrees

propertyName

protected String propertyName

menuKeyCommand

protected KeyCommand menuKeyCommand

description

protected String description

lastRect

protected Rectangle lastRect

lastShape

protected Area lastShape

Constructor Details

Labeler

public Labeler()

Labeler

public Labeler(String s,
GamePiece d)

Method Details

mySetType

public void mySetType(String type)

Description copied from interface: EditablePiece

Set the type information for this piece. See Decorator.myGetType()

Specified by:

mySetType in interface EditablePiece

clean

protected String clean(String s)

getLocalizedProperty

public Object getLocalizedProperty(Object key)

Specified by:

getLocalizedProperty in interface PropertySource

Overrides:

getLocalizedProperty in class Decorator

getProperty

public Object getProperty(Object key)

Specified by:

getProperty in interface GamePiece

Specified by:

getProperty in interface PropertySource

Overrides:

getProperty in class Decorator

myGetType

public String myGetType()

Specified by:

myGetType in class Decorator

Returns:

the type of this trait alone

See Also:

Decorator.getType()

myGetState

public String myGetState()

Specified by:

myGetState in class Decorator

Returns:

the state of this trait alone

See Also:

Decorator.getState()

mySetState

public void mySetState(String s)

Description copied from class: Decorator

Set just the state of this trait

Specified by:

mySetState in class Decorator

See Also:

Decorator.myGetState()

getName

public String getName()

Description copied from interface: GamePiece

The plain English name for this piece

Specified by:

getName in interface GamePiece

getLocalizedName

public String getLocalizedName()

Description copied from class: Decorator

Return the translated name for this piece. Most pieces do not have translatable elements, so just return the standard name

Specified by:

getLocalizedName in interface GamePiece

Overrides:

getLocalizedName in class Decorator

draw

public void draw(Graphics g,
int x,
int y,
Component obs,
double zoom)

Description copied from interface: GamePiece

Draw this GamePiece

Specified by:

draw in interface GamePiece

x - x-location of the center of the piece

y - y-location of the center of the piece

obs - the Component on which this piece is being drawn

zoom - the scaling factor.

updateCachedImage

protected void updateCachedImage()

setLabel

public void setLabel(String s)

setBackground

public void setBackground(Color textBg)

setForeground

public void setForeground(Color textFg)

getLabel

public String getLabel()

getLocalizedLabel

public String getLocalizedLabel()

boundingBox

public Rectangle boundingBox()

Description copied from interface: GamePiece

The area which this GamePiece occupies when drawn at the point (0,0)

Specified by:

boundingBox in interface GamePiece

getShape

public Shape getShape()

Return the Shape of the counter by adding the shape of this label to the shape of all inner traits. Minimize generation of new Area objects.

Specified by:

getShape in interface GamePiece

myGetKeyCommands

public KeyCommand[] myGetKeyCommands()

Specified by:

myGetKeyCommands in class Decorator

Returns:

the commands for this trait alone

See Also:

Decorator.getKeyCommands()

myKeyEvent

public Command myKeyEvent(KeyStroke stroke)

Description copied from class: Decorator

The response of this trait alone to the given KeyStroke

Specified by:

myKeyEvent in class Decorator

Parameters:

stroke - Stroke to apply

Returns:

Generated Command or null if no effect

See Also:

Decorator.keyEvent(javax.swing.KeyStroke)

getDescription

public String getDescription()

Description copied from interface: EditablePiece

A plain-English description of this type of piece

Specified by:

getDescription in interface EditablePiece

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface EditablePiece

getEditor

public PieceEditor getEditor()

Description copied from interface: EditablePiece

Get the configurer for this trait

Specified by:

getEditor in interface EditablePiece

Overrides:

getEditor in class Decorator

getPropertyNames

public List<String> getPropertyNames()

Return Property names exposed by this trait

Specified by:

getPropertyNames in interface PropertyNameSource

Overrides:

getPropertyNames in class Decorator

getI18nData

public PieceI18nData getI18nData()

Description copied from class: Decorator

Return I18n data for this piece

Specified by:

getI18nData in interface TranslatablePiece

Overrides:

getI18nData in class Decorator

Returns:

I18n data

getComponentTypeName

public String getComponentTypeName()

Specified by:

getComponentTypeName in interface RecursionLimiter.Loopable

getComponentName

public String getComponentName()

Specified by:

getComponentName in interface RecursionLimiter.Loopable

drawLabel

@Deprecated(since="2020-08-27",
            forRemoval=true)
public static void drawLabel(Graphics g,
String text,
int x,
int y,
int hAlign,
int vAlign,
Color fgColor,
Color bgColor)

Deprecated, for removal: This API element is subject to removal in a future version.

Use LabelUtils.drawLabel(Graphics, String, int, int, int, int, Color, Color) instead.

drawLabel

@Deprecated(since="2020-08-27",
            forRemoval=true)
public static void drawLabel(Graphics g,
String text,
int x,
int y,
Font f,
int hAlign,
int vAlign,
Color fgColor,
Color bgColor,
Color borderColor)

Deprecated, for removal: This API element is subject to removal in a future version.

Use LabelUtils.drawLabel(Graphics, String, int, int, Font, int, int, Color, Color, Color) instead.