Package VASSAL.build.module.chessclockcontrol

Class ChessClock

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.chessclockcontrol.ChessClock

All Implemented Interfaces:

ActionListener, EventListener, AutoConfigurable, Buildable, Configurable, GameComponent, PropertyNameSource, CommandEncoder, ComponentDescription, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget

public class ChessClock
extends AbstractConfigurable
implements CommandEncoder, GameComponent, ActionListener, ComponentDescription

CHESS CLOCK class for VASSAL. The ChessClock class itself implements a single timer, which is added as a button to the Module toolbar. Clicking the button starts and stops the clock, which we attempt to keep (roughly) in sync across multiple players' computers. A pair (or more, or I suppose only one) of them are then added to ChessClockControl.

Author:

Brian Reynolds and Michael Kiefte Class originally created by Michael Kiefte for Twilight Struggle, including handshaking for verification of time totals between online machines. Made more generically configurable, ChessClockControl added, and integrated into standard VASSAL, by Brian Reynolds.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChessClock.ColorConfig	Color auto-configurer.
static class	ChessClock.ColorConfig2	Color auto-configurer.
static class	ChessClock.ColorConfig3	Color auto-configurer.
static class	ChessClock.IconConfig	Autoconfigurer for the icon for this timer.
static class	ChessClock.PlayerSidesConfig	PlayerSidesConfig makes a dropdown of all the player sides

Nested classes/interfaces inherited from interface VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUTTON_TEXT
protected String	buttonText
static final String	CHESSMENU_NEXT
static final String	CHESSMENU_RESET
static final String	CHESSMENU_START
static final String	CHESSMENU_STOP
protected boolean	clockTicking
static final String	COMMAND_PREFIX
static final char	DELIMITER
protected String	description
static final String	DESCRIPTION
protected long	elapsedTime
static final String	GENERIC
static final String	ICON
protected String	image
protected boolean	instanceIsActive
protected String	side
static final String	SIDE
static final String	START_HOTKEY
protected NamedKeyStrokeListener	startListener
protected long	startTime
static final String	STOP_HOTKEY
protected NamedKeyStrokeListener	stopListener
static final String	TICKING_BACKGROUND_COLOR
static final String	TICKING_FONT_COLOR
protected Color	tickingBackgroundColor
protected Color	tickingFontColor
protected static Timer	timer
protected LaunchButton	timerButton
protected boolean	tocking
static final String	TOCKING_FONT_COLOR
protected Color	tockingFontColor
static final String	TOOLTIP
protected long	verifiedTime

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
ChessClock()
ChessClock(String side)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent evt)	This processes our timer updates every 100ms
void	addTo(Buildable parent)	Registers us with game module, command encoder, and the Chess Clock Control.
void	addToToolbar()	Adds our clock button to the Module's toolbar
Command	decode(String command)	Deserializes our command from a string version, if the command belongs to us.
String	encode(Command c)	Serializes our command into a string, if it belongs to us
Class[]	getAllowableConfigureComponents()
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 attributes of this object.
String	getAttributeValueString(String key)	Gets the value of one of this component's XML attributes
static String	getConfigureTypeName()
String	getDescription()
long	getElapsed()
HelpFile	getHelpFile()
String	getName()
Command	getRestoreCommand()	When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null
String	getSide()
long	getVerified()
void	hideClock()	Hides this clock
protected static boolean	isReferee(String name)
boolean	isTicking()
void	removeFrom(Buildable parent)	Unregisters us when we are shutting down
Command	resetState()	Creates a command to reset the clock and turn it off
void	setAttribute(String key, Object value)	Sets the value of one of this component's XML attributes
boolean	setTimerButton()	Updates clock text on the button, based on our configured style
void	setup(boolean gameStarting)	Detect when game is starting.
void	showClock()	Shows this clock
Command	startClock()	Creates a command to make this clock the currently ticking clock
protected void	startTimer()	Make sure the static millisecond timer is actually running (unless it hasn't even been initialized yet)
Command	stopClock()	Creates a command to make this clock the currently ticking clock
void	updateDisplay()	Updates the clock display for this clock (1) Checks new elapsed value from millisecond timer
Command	updateState(boolean ticking)	Creates a command to update the clock and/or turn it on/off.
protected void	updateTimerColor()	Updates the color of this chess clock's button/display.

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getAttributeVisibility, getConfigureComponents, getConfigureName, getConfigurer, getExpressionList, getFormattedStringList, getI18nData, getI18nPrefix, getLocalizedConfigureName, getMenuTextList, getNamedKeyStrokeList, getPropertyList, getTypeName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, build, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, getPropertyNames, setAncestor, 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.script.expression.Auditable

getComponentName, getComponentTypeName

Methods inherited from interface VASSAL.build.Buildable

build, getBuildElement, isMandatory, isMovable, isUnique

Field Details

DELIMITER

public static final char DELIMITER

See Also:

• Constant Field Values

COMMAND_PREFIX

public static final String COMMAND_PREFIX

See Also:

• Constant Field Values

ICON

public static final String ICON

See Also:

• Constant Field Values

SIDE

public static final String SIDE

See Also:

• Constant Field Values

TOOLTIP

public static final String TOOLTIP

See Also:

• Constant Field Values

BUTTON_TEXT

public static final String BUTTON_TEXT

See Also:

• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

• Constant Field Values

START_HOTKEY

public static final String START_HOTKEY

See Also:

• Constant Field Values

STOP_HOTKEY

public static final String STOP_HOTKEY

See Also:

• Constant Field Values

TICKING_BACKGROUND_COLOR

public static final String TICKING_BACKGROUND_COLOR

See Also:

• Constant Field Values

TICKING_FONT_COLOR

public static final String TICKING_FONT_COLOR

See Also:

• Constant Field Values

TOCKING_FONT_COLOR

public static final String TOCKING_FONT_COLOR

See Also:

• Constant Field Values

GENERIC

public static final String GENERIC

See Also:

• Constant Field Values

CHESSMENU_START

public static final String CHESSMENU_START

CHESSMENU_NEXT

public static final String CHESSMENU_NEXT

CHESSMENU_STOP

public static final String CHESSMENU_STOP

CHESSMENU_RESET

public static final String CHESSMENU_RESET

startListener

protected NamedKeyStrokeListener startListener

stopListener

protected NamedKeyStrokeListener stopListener

tickingBackgroundColor

protected Color tickingBackgroundColor

tickingFontColor

protected Color tickingFontColor

tockingFontColor

protected Color tockingFontColor

timer

protected static Timer timer

startTime

protected long startTime

timerButton

protected LaunchButton timerButton

image

protected String image

side

protected String side

buttonText

protected String buttonText

elapsedTime

protected long elapsedTime

verifiedTime

protected long verifiedTime

clockTicking

protected boolean clockTicking

tocking

protected boolean tocking

instanceIsActive

protected boolean instanceIsActive

description

protected String description

Constructor Details

ChessClock

public ChessClock(String side)

ChessClock

public ChessClock()

Method Details

getSide

public String getSide()

Returns:

side this clock is assigned to

isTicking

public boolean isTicking()

Returns:

true if this clock is running

getElapsed

public long getElapsed()

Returns:

elapsed time from local perspective

getVerified

public long getVerified()

Returns:

elapsed time verified by handshake (or fiat, depending on situation)

isReferee

protected static boolean isReferee(String name)

Parameters:

name - side to check if a referee

Returns:

True if passed side is a referee

getDescription

public String getDescription()

Specified by:

getDescription in interface ComponentDescription

Returns:

Description to be displayed next to component type/name in the main Editor window. Or null or "" to not display anything.

startTimer

protected void startTimer()

Make sure the static millisecond timer is actually running (unless it hasn't even been initialized yet)

updateTimerColor

protected void updateTimerColor()

Updates the color of this chess clock's button/display. Non-ticking clock uses "default" button look. Ticking clock uses special background and pulsing foreground.

hideClock

public void hideClock()

Hides this clock

showClock

public void showClock()

Shows this clock

updateDisplay

public void updateDisplay()

Updates the clock display for this clock (1) Checks new elapsed value from millisecond timer. (2) Calls setTimerButton to clock time (text) on the button (3) Updates timer button colors if appropriate

setTimerButton

public boolean setTimerButton()

Updates clock text on the button, based on our configured style

Returns:

half second tick-tock pulse on/off

getName

public String getName()

addTo

public void addTo(Buildable parent)

Registers us with game module, command encoder, and the Chess Clock Control.

Specified by:

addTo in interface Buildable

Parameters:

parent - Should be ChessClockControl

addToToolbar

public void addToToolbar()

Adds our clock button to the Module's toolbar

removeFrom

public void removeFrom(Buildable parent)

Unregisters us when we are shutting down

Specified by:

removeFrom in interface Configurable

Parameters:

parent - Should be ChessClockControl

getAttributeNames

public String[] getAttributeNames()

Description copied from class: AbstractBuildable

Lists all the buildFile (XML) attribute names for this component. If this component is ALSO an AbstractConfigurable, then this list of attributes determines the appropriate attribute order for AbstractConfigurable.getAttributeDescriptions() and AbstractConfigurable.getAttributeTypes().

Specified by:

getAttributeNames in interface AutoConfigurable

Specified by:

getAttributeNames in class AbstractBuildable

Returns:

Key names for our attributes from the buildFile (XML) definition.

getAttributeDescriptions

public String[] 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 interface AutoConfigurable

Specified by:

getAttributeDescriptions in class AbstractConfigurable

Returns:

Descriptions for our buildFile (XML) attributes. These appear when our component is configured in the Editor window.

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from interface: AutoConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, File, Color, and KeyStroke

Specified by:

getAttributeTypes in interface AutoConfigurable

Specified by:

getAttributeTypes in class AbstractConfigurable

Returns:

Class types for configuring each of our buildFile (XML) attributes. Specifies which flavor of configurer to uses.

setAttribute

public void setAttribute(String key,
 Object value)

Sets the value of one of this component's XML attributes

Specified by:

setAttribute in interface AutoConfigurable

Specified by:

setAttribute in interface Translatable

Specified by:

setAttribute in class AbstractBuildable

Parameters:

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

value - New value for the attribute. Can be either String version or the actual Object.

getAttributeValueString

public String getAttributeValueString(String key)

Gets the value of one of this component's XML attributes

Specified by:

getAttributeValueString in interface AutoConfigurable

Specified by:

getAttributeValueString in interface Translatable

Specified by:

getAttributeValueString in class AbstractBuildable

Parameters:

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

Returns:

String value of the attribute.

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

The help file for this component. Used when user clicks "Help" button while configuring the component in the Editor.

getConfigureTypeName

public static String getConfigureTypeName()

Returns:

Configure Tree name for component. Appears in [..] in module editor.

getAllowableConfigureComponents

public Class[] getAllowableConfigureComponents()

Specified by:

getAllowableConfigureComponents in interface Configurable

Returns:

Array of subcomponent types that can be added to this component

decode

public Command decode(String command)

Deserializes our command from a string version, if the command belongs to us.

Specified by:

decode in interface CommandEncoder

Parameters:

command - Serialized string command

Returns:

An ChessClock.UpdateTimerCommand

encode

public String encode(Command c)

Serializes our command into a string, if it belongs to us

Specified by:

encode in interface CommandEncoder

Parameters:

c - Command to serialize. Only serialized if it's an UpdateTimerCommand.

Returns:

Serialized command, or null if command passed wasn't an UpdateTimerCommand.

setup

public void setup(boolean gameStarting)

Detect when game is starting.

Specified by:

setup in interface GameComponent

Parameters:

gameStarting - if true, a game is starting. If false, then a game is ending

getRestoreCommand

public Command getRestoreCommand()

Description copied from interface: GameComponent

When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null

Specified by:

getRestoreCommand in interface GameComponent

Returns:

Our command for restoring from a saved game (or adding an online player)

actionPerformed

public void actionPerformed(ActionEvent evt)

This processes our timer updates every 100ms

Specified by:

actionPerformed in interface ActionListener

Parameters:

evt - Timer event

startClock

public Command startClock()

Creates a command to make this clock the currently ticking clock

Returns:

a command to set currently ticking clock to us

stopClock

public Command stopClock()

Creates a command to make this clock the currently ticking clock

Returns:

a command to set our clock to non-ticking

updateState

public Command updateState(boolean ticking)

Creates a command to update the clock and/or turn it on/off.

Parameters:

ticking - If true, the clock will be set to "running". If false the clock will be set to "stopped".

Returns:

a command to communicate the status of this clock to others

resetState

public Command resetState()

Creates a command to reset the clock and turn it off

Returns:

a command to communicate the status of this clock to others