Package VASSAL.build.module

Class InternetDiceButton

java.lang.Object

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.DiceButton

VASSAL.build.module.InternetDiceButton

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, GameComponent, PropertyNameSource, CommandEncoder, ValidityChecker, Translatable

public class InternetDiceButton
extends DiceButton
implements GameComponent, CommandEncoder

This component places a button into the controls window toolbar. Pressing the button generates random numbers and displays the result in the Chatter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InternetDiceButton.InternetReportFormatConfig

Nested classes/interfaces inherited from class VASSAL.build.module.DiceButton

DiceButton.IconConfig, DiceButton.ReportFormatConfig

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static String	DETAILS	Report format variale
protected static DieManager	dieManager

Fields inherited from class VASSAL.build.module.DiceButton

ADD_TO_TOTAL, addToTotal, BUTTON_TEXT, DEPRECATED_NAME, HOTKEY, ICON, launch, N_DICE, N_SIDES, NAME, nDice, nSides, plus, PLUS, PROMPT_ALWAYS, promptAlways, property, ran, REPORT_FORMAT, REPORT_NAME, REPORT_TOTAL, reportFormat, reportTotal, RESULT, SORT_DICE_RESULTS, sortDice, tooltip, TOOLTIP

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

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Expects to be added to the DieManager.
Command	decode(String command)	Translate a String into a Command
protected void	DR()	Ask the die manager to do our roll!
String	encode(Command c)	Translate a Command into a String
Class<?>[]	getAttributeTypes()	Return the Class for the attributes of this object.
static String	getConfigureTypeName()
HelpFile	getHelpFile()
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
protected void	initDieManager()
void	removeFrom(Buildable b)	Remove this component from its parent
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended

Methods inherited from class VASSAL.build.module.DiceButton

formatResult, getAllowableConfigureComponents, getAttributeDescriptions, getAttributeNames, getAttributeValueString, getAttributeVisibility, getComponent, getPropertyNames, initLaunchButton, setAttribute

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, getI18nData, getI18nPrefix, getLocalizedConfigureName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

build, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponentsOf, 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

build, getBuildElement

Field Details

dieManager

protected static DieManager dieManager

DETAILS

public static final String DETAILS

Report format variale

See Also:

Constant Field Values

Constructor Details

InternetDiceButton

public InternetDiceButton()

Method Details

getConfigureTypeName

public static String getConfigureTypeName()

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from class: AbstractConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, Color, and KeyStroke The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()

Specified by:

getAttributeTypes in interface AutoConfigurable

Overrides:

getAttributeTypes in class DiceButton

DR

protected void DR()

Ask the die manager to do our roll!

Overrides:

DR in class DiceButton

addTo

public void addTo(Buildable parent)

Expects to be added to the DieManager.

Specified by:

addTo in interface Buildable

Overrides:

addTo in class DiceButton

initDieManager

protected void initDieManager()

removeFrom

public void removeFrom(Buildable b)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

Overrides:

removeFrom in class DiceButton

setup

public void setup(boolean gameStarting)

Description copied from interface: GameComponent

Notify the GameComponent that a game has started/ended

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

decode

public Command decode(String command)

Description copied from interface: CommandEncoder

Translate a String into a Command

Specified by:

decode in interface CommandEncoder

encode

public String encode(Command c)

Description copied from interface: CommandEncoder

Translate a Command into a String

Specified by:

encode in interface CommandEncoder

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Overrides:

getHelpFile in class DiceButton

Returns:

a HelpFilte describing how to use and configure this component