Package VASSAL.build.module

Class DiceButton

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.AbstractToolbarItem

VASSAL.build.module.DiceButton

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable, ImageSearchTarget, SearchTarget

Direct Known Subclasses:

InternetDiceButton, RandomTextButton

public class DiceButton
extends AbstractToolbarItem

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	DiceButton.IconConfig	Deprecated, for removal: This API element is subject to removal in a future version.
static class	DiceButton.ReportFormatConfig

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static String	ADD_TO_TOTAL
protected int	addToTotal
static String	BUTTON_TEXT	Deprecated, for removal: This API element is subject to removal in a future version.
static String	DEPRECATED_NAME
static String	HOTKEY	Deprecated, for removal: This API element is subject to removal in a future version.
static String	ICON	Deprecated, for removal: This API element is subject to removal in a future version.
protected LaunchButton	launch	Deprecated, for removal: This API element is subject to removal in a future version. use launch from the superclass
static String	N_DICE
static String	N_SIDES
static String	NAME	Deprecated, for removal: This API element is subject to removal in a future version.
protected int	nDice
protected int	nSides
protected int	plus
static String	PLUS
static String	PROMPT_ALWAYS
protected boolean	promptAlways
protected MutableProperty.Impl	property
protected Random	ran
static String	REPORT_FORMAT
static String	REPORT_NAME
static String	REPORT_TOTAL
protected FormattedString	reportFormat
protected boolean	reportTotal
static String	RESULT	Variable name for reporting format
static String	SORT_DICE_RESULTS
protected boolean	sortDice
protected String	tooltip
static String	TOOLTIP	Deprecated, for removal: This API element is subject to removal in a future version.

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

Method Summary

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	In case reports use HTML and refer to any image files
void	addTo(Buildable parent)	Expects to be added to a GameModule.
protected void	DR()	Forwards the result of the roll to the Chatter.send(java.lang.String) method of the Chatter of the GameModule.
protected String	formatResult(String result)	Use the configured FormattedString to format the result of a roll
Class<?>[]	getAllowableConfigureComponents()
String[]	getAttributeDescriptions()	This getAttributeDescriptions() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
String[]	getAttributeNames()	This getAttributeNames() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
Class<?>[]	getAttributeTypes()	This getAttributeTypes() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
String	getAttributeValueString(String key)	Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
static String	getConfigureTypeName()
HelpFile	getHelpFile()
List<String>	getPropertyNames()	Implement PropertyNameSource - Expose roll result property
protected String	getReportPrefix()	Deprecated, for removal: This API element is subject to removal in a future version. No Replacement
protected String	getReportSuffix()	Deprecated, for removal: This API element is subject to removal in a future version. No Replacement
protected void	initLaunchButton()
void	setAttribute(String key, Object o)	Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.

Methods inherited from class VASSAL.build.AbstractToolbarItem

getComponent, getLaunchButton, getMenuTextList, getNamedKeyStrokeList, makeLaunchButton, removeFrom, setButtonTextKey, setHotKeyKey, setIconKey, setLaunchButton, setNameKey, setTooltipKey

Methods inherited from class VASSAL.build.AbstractConfigurable

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

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, 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.build.Buildable

build, getBuildElement

Field Details

ran

protected Random ran

nSides

protected int nSides

nDice

protected int nDice

plus

protected int plus

addToTotal

protected int addToTotal

reportTotal

protected boolean reportTotal

promptAlways

protected boolean promptAlways

sortDice

protected boolean sortDice

reportFormat

protected final FormattedString reportFormat

launch

@Deprecated(since="2021-04-03",
            forRemoval=true)
protected LaunchButton launch

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

use launch from the superclass

tooltip

protected String tooltip

property

protected final MutableProperty.Impl property

BUTTON_TEXT

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String BUTTON_TEXT

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

See Also:

Constant Field Values

TOOLTIP

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String TOOLTIP

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

See Also:

Constant Field Values

NAME

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String NAME

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

See Also:

Constant Field Values

ICON

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String ICON

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

See Also:

Constant Field Values

HOTKEY

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String HOTKEY

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

See Also:

Constant Field Values

DEPRECATED_NAME

public static final String DEPRECATED_NAME

See Also:

Constant Field Values

N_DICE

public static final String N_DICE

See Also:

Constant Field Values

N_SIDES

public static final String N_SIDES

See Also:

Constant Field Values

PLUS

public static final String PLUS

See Also:

Constant Field Values

ADD_TO_TOTAL

public static final String ADD_TO_TOTAL

See Also:

Constant Field Values

REPORT_TOTAL

public static final String REPORT_TOTAL

See Also:

Constant Field Values

PROMPT_ALWAYS

public static final String PROMPT_ALWAYS

See Also:

Constant Field Values

REPORT_FORMAT

public static final String REPORT_FORMAT

See Also:

Constant Field Values

SORT_DICE_RESULTS

public static final String SORT_DICE_RESULTS

See Also:

Constant Field Values

RESULT

public static final String RESULT

Variable name for reporting format

See Also:

Constant Field Values

REPORT_NAME

public static final String REPORT_NAME

See Also:

Constant Field Values

Constructor Details

DiceButton

public DiceButton()

Method Details

initLaunchButton

protected void initLaunchButton()

getConfigureTypeName

public static String getConfigureTypeName()

getReportPrefix

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected String getReportPrefix()

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

No Replacement

The text reported before the results of the roll

getReportSuffix

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected String getReportSuffix()

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

No Replacement

The text reported after the results of the roll;

DR

protected void DR()

Forwards the result of the roll to the Chatter.send(java.lang.String) method of the Chatter of the GameModule. Format is prefix+[comma-separated roll list]+suffix

formatResult

protected String formatResult(String result)

Use the configured FormattedString to format the result of a roll

Parameters:

result - Result format

Returns:

Formatted result

getAttributeNames

public String[] getAttributeNames()

Description copied from class: AbstractToolbarItem

This getAttributeNames() 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.getAttributeNames(), key1, ..., keyN), or supply their own order from scratch.

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

Overrides:

getAttributeNames in class AbstractToolbarItem

Returns:

a list of all buildFile (XML) attribute names for this component

getAttributeDescriptions

public String[] getAttributeDescriptions()

Description copied from class: AbstractToolbarItem

This getAttributeDescriptions() 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.getAttributeDescriptions(), key1, ..., keyN), or supply their own order from scratch.

Specified by:

getAttributeDescriptions in interface AutoConfigurable

Overrides:

getAttributeDescriptions in class AbstractToolbarItem

Returns:

an array of Strings describing the buildFile (XML) attributes of this component. These strings are used as prompts in the Properties window for this object, when the component is configured in the Editor. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()

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 AbstractToolbarItem

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

getAttributeVisibility

public VisibilityCondition getAttributeVisibility(String name)

Description copied from class: AbstractConfigurable

By default, all attributes are visible

Specified by:

getAttributeVisibility in interface AutoConfigurable

Overrides:

getAttributeVisibility in class AbstractConfigurable

Parameters:

name - Name (key) of one of this component's attributes

Returns:

a VisibilityCondition for this attribute, or null if attribute should always be visible.

addTo

public void addTo(Buildable parent)

Expects to be added to a GameModule. Adds the button to the control window's toolbar and registers itself as a @link KeyStrokeListener

Specified by:

addTo in interface Buildable

Overrides:

addTo in class AbstractToolbarItem

Parameters:

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

setAttribute

public void setAttribute(String key,
 Object o)

Description copied from class: AbstractToolbarItem

Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button. Sets a buildFile (XML) attribute value for this component. The key parameter will be one of those listed in AbstractToolbarItem.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractToolbarItem.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value will be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

Specified by:

setAttribute in interface AutoConfigurable

Specified by:

setAttribute in interface Translatable

Overrides:

setAttribute in class AbstractToolbarItem

Parameters:

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

o - If the value parameter is a String, it will be the value returned by AbstractToolbarItem.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value can also be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

getAttributeValueString

public String getAttributeValueString(String key)

Description copied from class: AbstractToolbarItem

Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.

Specified by:

getAttributeValueString in interface AutoConfigurable

Specified by:

getAttributeValueString in interface Translatable

Overrides:

getAttributeValueString in class AbstractToolbarItem

Parameters:

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

Returns:

a String representation of the XML buildFile attribute with the given name. When initializing a module, this String value will loaded from the XML and passed to AbstractToolbarItem.setAttribute(java.lang.String, java.lang.Object). It is also frequently used for checking the current value of an attribute.

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Returns:

a list of valid sub-component Classes. If a Class appears in this list, then instances of that class may be added to this component from the Editor's ConfigureTree window by right-clicking on the component and selecting the appropriate "Add" option.

getHelpFile

public HelpFile getHelpFile()

Returns:

a HelpFile describing how to use and configure * this component

getPropertyNames

public List<String> getPropertyNames()

Implement PropertyNameSource - Expose roll result property

Specified by:

getPropertyNames in interface PropertyNameSource

Overrides:

getPropertyNames in class AbstractBuildable

Returns:

Default implementation of PropertyNameSource - No properties exposed

addLocalImageNames

public void addLocalImageNames(Collection<String> s)

In case reports use HTML and refer to any image files

Specified by:

addLocalImageNames in interface ImageSearchTarget

Overrides:

addLocalImageNames in class AbstractToolbarItem

Parameters:

s - Collection to add image names to