VASSAL.counters
Class Labeler

java.lang.Object
  |
  +--VASSAL.counters.Decorator
        |
        +--VASSAL.counters.Labeler

All Implemented Interfaces:

EditablePiece, GamePiece, StateMergeable

public class Labeler

extends Decorator

implements EditablePiece

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

Field Summary

static int	BOTTOM
static int	CENTER
static int	HORIZONTAL_ALIGNMENT
static java.lang.String	ID
static int	LEFT
static int	RIGHT
protected int	rotateDegrees
protected java.awt.Color	textBg
protected java.awt.Color	textFg
static int	TOP
static int	VERTICAL_ALIGNMENT

Fields inherited from class VASSAL.counters.Decorator

piece

Constructor Summary

Labeler()

Labeler(java.lang.String s, GamePiece d)

Method Summary

java.awt.Rectangle	boundingBox() The area which this GamePiece occupies when drawn at the point (0,0)
protected java.awt.Image	createImage(java.awt.Component obs)
void	draw(java.awt.Graphics g, int x, int y, java.awt.Component obs, double zoom) Draw this GamePiece
static void	drawLabel(java.awt.Graphics g, java.lang.String text, int x, int y, java.awt.Font f, int hAlign, int vAlign, java.awt.Color fgColor, java.awt.Color bgColor, java.awt.Color borderColor)
static void	drawLabel(java.awt.Graphics g, java.lang.String text, int x, int y, int hAlign, int vAlign, java.awt.Color fgColor, java.awt.Color bgColor)
java.lang.String	getDescription() A plain-English description of this type of piece
PieceEditor	getEditor() Get the configurer for this trait
HelpFile	getHelpFile()
java.lang.String	getLabel()
java.lang.String	getName() The plain English name for this piece
java.awt.Shape	getShape() The shape of the piece from the user's viewpoint.
KeyCommand[]	myGetKeyCommands()
java.lang.String	myGetState()
java.lang.String	myGetType()
Command	myKeyEvent(javax.swing.KeyStroke stroke) The response of this trait alone to the given KeyStroke
void	mySetState(java.lang.String s) Set just the state of this trait
void	mySetType(java.lang.String type) Set the type information for this piece.
void	setBackground(java.awt.Color textBg)
void	setForeground(java.awt.Color textFg)
void	setLabel(java.lang.String s)

Methods inherited from class VASSAL.counters.Decorator

getDecorator, getId, getInner, getInnermost, getKeyCommands, getMap, getOutermost, getParent, getPosition, getProperty, getState, getType, keyEvent, mergeState, setId, setInner, setMap, setParent, setPosition, setProperty, setState

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.counters.GamePiece

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

Field Detail

ID

public static final java.lang.String ID

textBg

protected java.awt.Color textBg

textFg

protected java.awt.Color textFg

CENTER

public static final int CENTER

RIGHT

public static final int RIGHT

LEFT

public static final int LEFT

TOP

public static final int TOP

BOTTOM

public static final int BOTTOM

HORIZONTAL_ALIGNMENT

public static int HORIZONTAL_ALIGNMENT

VERTICAL_ALIGNMENT

public static int VERTICAL_ALIGNMENT

rotateDegrees

protected int rotateDegrees

Constructor Detail

Labeler

public Labeler()

Labeler

public Labeler(java.lang.String s,
               GamePiece d)

Method Detail

mySetType

public void mySetType(java.lang.String type)

Description copied from interface: EditablePiece

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

Specified by:

mySetType in interface EditablePiece

myGetType

public java.lang.String myGetType()

Overrides:

myGetType in class Decorator

Following copied from class: VASSAL.counters.Decorator

Returns:

the type of this trait alone

See Also:

Decorator.getType()

myGetState

public java.lang.String myGetState()

Overrides:

myGetState in class Decorator

Following copied from class: VASSAL.counters.Decorator

Returns:

the state of this trait alone

See Also:

Decorator.getState()

mySetState

public void mySetState(java.lang.String s)

Description copied from class: Decorator

Set just the state of this trait

Overrides:

mySetState in class Decorator

Following copied from class: VASSAL.counters.Decorator

See Also:

Decorator.myGetState()

getName

public java.lang.String getName()

Description copied from interface: GamePiece

The plain English name for this piece

Specified by:

getName in interface GamePiece

drawLabel

public static void drawLabel(java.awt.Graphics g,
                             java.lang.String text,
                             int x,
                             int y,
                             int hAlign,
                             int vAlign,
                             java.awt.Color fgColor,
                             java.awt.Color bgColor)

drawLabel

public static void drawLabel(java.awt.Graphics g,
                             java.lang.String text,
                             int x,
                             int y,
                             java.awt.Font f,
                             int hAlign,
                             int vAlign,
                             java.awt.Color fgColor,
                             java.awt.Color bgColor,
                             java.awt.Color borderColor)

draw

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

Description copied from interface: GamePiece

Draw this GamePiece

Specified by:

draw in interface GamePiece

Following copied from interface: VASSAL.counters.GamePiece

Parameters:

g -

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.

setLabel

public void setLabel(java.lang.String s)

setBackground

public void setBackground(java.awt.Color textBg)

setForeground

public void setForeground(java.awt.Color textFg)

createImage

protected java.awt.Image createImage(java.awt.Component obs)

getLabel

public java.lang.String getLabel()

boundingBox

public java.awt.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 java.awt.Shape getShape()

Description copied from interface: GamePiece

The shape of the piece from the user's viewpoint. This defines the area in which the user must click to select or move the piece, for example. Like GamePiece.boundingBox(), it assumes the position is (0,0) and must be translated to the actual location where the piece is being drawn.

Specified by:

getShape in interface GamePiece

myGetKeyCommands

public KeyCommand[] myGetKeyCommands()

Overrides:

myGetKeyCommands in class Decorator

Following copied from class: VASSAL.counters.Decorator

Returns:

the commands for this trait alone

See Also:

Decorator.getKeyCommands()

myKeyEvent

public Command myKeyEvent(javax.swing.KeyStroke stroke)

Description copied from class: Decorator

The response of this trait alone to the given KeyStroke

Overrides:

myKeyEvent in class Decorator

Following copied from class: VASSAL.counters.Decorator

Parameters:

stroke -

Returns:

null if no effect

See Also:

Decorator.keyEvent(javax.swing.KeyStroke)

getDescription

public java.lang.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