Package VASSAL.build.module

Class InternetDiceButton

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.AbstractToolbarItem

VASSAL.build.module.DiceButton

VASSAL.build.module.InternetDiceButton

All Implemented Interfaces:

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

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.KeepConfig, DiceButton.ReportFormatConfig

Nested classes/interfaces inherited from class VASSAL.build.AbstractToolbarItem

AbstractToolbarItem.FormattedStringConfig

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

AutoConfigurable.Util

Field Summary

Fields

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

Fields inherited from class VASSAL.build.module.DiceButton

ADD_TO_TOTAL, addToTotal, BUTTON_TEXT, counts, DEPRECATED_NAME, HOTKEY, ICON, KEEP_COUNT, KEEP_DICE, KEEP_EQUAL, KEEP_GREATER, KEEP_LARGEST, KEEP_LESS, KEEP_OPTION, KEEP_SMALLEST, keepCount, keepDice, keepingDice, keepOption, keepProp, keepValue, launch, LOCK_ADD, LOCK_DICE, LOCK_PLUS, LOCK_SIDES, lockAdd, lockDice, lockPlus, lockSides, N_DICE, N_SIDES, NAME, nDice, nSides, NUMERIC_TOTAL, numericTotal, plus, PLUS, PROMPT_ALWAYS, promptAlways, property, ran, rawCounts, rawRolls, REPORT_FORMAT, REPORT_NAME, REPORT_TOTAL, reportFormat, reportTotal, RESULT, RESULT_N, SORT_DICE_RESULTS, sortDice, tooltip, TOOLTIP, totalProp

Fields inherited from class VASSAL.build.AbstractToolbarItem

CAN_DISABLE, canDisable, DISABLED_ICON, disabledIconConfig, HIDE_WHEN_DISABLED, hideWhenDisabled, PROPERTY_GATE, propertyGate, showDisabledOptions

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()	This getAttributeTypes() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
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 from our parent
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended

Methods inherited from class VASSAL.build.module.DiceButton

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

Methods inherited from class VASSAL.build.AbstractToolbarItem

addPropertyGateListener, addPropertyGateListener, checkDisabled, disableIfTrue, getComponent, getLaunchButton, getMenuTextList, getNamedKeyStrokeList, getNameKey, getPropertyList, isShowDisabledOptions, makeLaunchButton, propertyChange, removePropertyGateListener, setButtonTextKey, setHotKeyKey, setIconKey, setLaunchButton, setNameKey, setNamePrompt, setShowDisabledOptions, setTooltipKey

Methods inherited from class VASSAL.build.AbstractConfigurable

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

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, build, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, setAncestor, validate

Methods inherited from class VASSAL.search.AbstractImageFinder

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

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: AbstractToolbarItem

This getAttributeTypes() will return the items specific to the Toolbar Button - classes extending this should add their own items as well. If the "nameKey" is blank, then no "name" configure entry will be generated. Extending classes can use ArrayUtils.addAll(super.getAttributeTypes(), key1, ..., keyN), or supply their own order from scratch.

Specified by:

getAttributeTypes in interface AutoConfigurable

Overrides:

getAttributeTypes in class DiceButton

Returns:

the Class for the buildFile (XML) attributes of this component. Valid classes include: String, Integer, Double, Boolean, Image, Color, and KeyStroke, along with any class for which a Configurer exists in VASSAL.configure. The class determines, among other things, which type of AutoConfigurer will be used to configure the attribute when the object is configured in the Editor.

The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()

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

Parameters:

parent - parent Buildable to add this component to as a subcomponent.

initDieManager

protected void initDieManager()

removeFrom

public void removeFrom(Buildable b)

Description copied from class: AbstractToolbarItem

Remove from our parent

Specified by:

removeFrom in interface Configurable

Overrides:

removeFrom in class AbstractToolbarItem

Parameters:

b - parent

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

Overrides:

setup in class AbstractToolbarItem

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

Overrides:

getRestoreCommand in class AbstractToolbarItem

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 HelpFile describing how to use and configure * this component