Package VASSAL.build.module

Class SpecialDiceButton

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.AbstractToolbarItem

VASSAL.build.module.DoActionButton

VASSAL.build.module.SpecialDiceButton

All Implemented Interfaces:

PropertyChangeListener, EventListener, AutoConfigurable, Buildable, Configurable, GameComponent, PropertyNameSource, CommandEncoder, ComponentDescription, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget, RecursionLimiter.Loopable, UniqueIdManager.Identifyable

public class SpecialDiceButton
extends DoActionButton
implements CommandEncoder, UniqueIdManager.Identifyable, ComponentDescription

...

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpecialDiceButton.IconConfig	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractToolbarItem.IconConfig instead.
static class	SpecialDiceButton.ReportFormatConfig
static class	SpecialDiceButton.ShowResults	Command for displaying the results of a roll of the dice

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

DoActionButton.HotkeyConfig, DoActionButton.LoopConfig, DoActionButton.LoopCountConfig, DoActionButton.LoopTypeConfig, DoActionButton.NamedHotkeyListConfigurer, DoActionButton.SoundConfig

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	BACKGROUND_COLOR
protected Color	bgColor
static final String	BUTTON_TEXT	Deprecated, for removal: This API element is subject to removal in a future version.
static final String	CHAT_RESULT_FORMAT
protected String	chatResultFormat
protected String	description
static final String	DESCRIPTION
protected JDialog	dialog
protected JLabel	dialogLabel
protected List<SpecialDie>	dice
static final String	DICE_SET
protected FormattedString	format
static final String	HOTKEY	Deprecated, for removal: This API element is subject to removal in a future version.
static final String	ICON	Deprecated, for removal: This API element is subject to removal in a future version.
protected String	id
protected static final UniqueIdManager	idMgr
static final String	NAME	Deprecated, for removal: This API element is subject to removal in a future version.
static final String	NONE
protected final MutableProperty.Impl	property
protected Random	ran
protected boolean	reportResultAsText
protected boolean	reportResultInButton
protected boolean	reportResultInWindow
static final String	RESULT_BUTTON
static final String	RESULT_CHATTER
static final String	RESULT_N
static final String	RESULT_TOTAL
static final String	RESULT_WINDOW
protected VASSAL.build.module.SpecialDiceButton.ResultsIcon	resultsIcon
static final String	SHOW_RESULTS_COMMAND
protected String	sMapName
protected String	tooltip
static final String	TOOLTIP	Deprecated, for removal: This API element is subject to removal in a future version.
static final String	WINDOW_TITLE_RESULT_FORMAT
static final String	WINDOW_X
static final String	WINDOW_Y
protected String	windowTitleResultFormat

Fields inherited from class VASSAL.build.module.DoActionButton

DO_HOTKEY, DO_LOOP, DO_REPORT, DO_SOUND, doHotkey, doLoop, doReport, doSound, hasIndex, hotkeys, HOTKEYS, INDEX, INDEX_PROPERTY, INDEX_START, INDEX_STEP, indexProperty, indexStart, indexStep, indexValue, launch, LOOP_COUNT, LOOP_TYPE, loopCount, loopIndexProperty, loopPropertyRegistered, loopType, POST_LOOP_HOTKEY, postLoopKey, PRE_LOOP_HOTKEY, preLoopKey, REPORT_FORMAT, reportFormat, SOUND_CLIP, soundClip, UNTIL_EXPRESSION, untilExpression, WHILE_EXPRESSION, whileExpression

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

Method Summary

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	In case reports use HTML and refer to any image files
void	addSpecialDie(SpecialDie d)
void	addTo(Buildable parent)	Expects to be added to a SymbolDice.
Command	decode(String s)	Translate a String into a Command
protected void	DR()	Forwards the result of the roll to the Chatter.send(java.lang.String) method of the Chatter of the GameModule.
String	encode(Command c)	Translate a Command into a String
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()	The Attributes of a DiceButton are: BUTTON_TEXT the label of the button in the toolbar ICON the icon of the button in the toolbar HOTKEY the hotkey equivalent of the button DICE_SET list of dice sets, an entry can be: [number]name of die[+|-modifier] "name of die" must be SpecialDie "modifier" is added/subtracted to/from total of dice [number]Dnumber of sides (e.g.
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()
String	getDescription()
List<String>	getFormattedStringList()	SearchTarget
HelpFile	getHelpFile()
String	getId()
String	getIdentifier()	Make a best guess for a unique identifier for the target.
List<String>	getPropertyNames()	Implement PropertyNameSource - Expose roll result property
protected String	getReportPrefix()	The text reported before the results of the roll
static String	intArrayToString(int[] ia)	create String from int array
void	removeFrom(Buildable b)	Remove from our parent
void	removeSpecialDie(SpecialDie d)
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.
protected void	setFormat(int[] results)
void	setId(String id)
static int[]	stringToIntArray(String s)	get int array from string

Methods inherited from class VASSAL.build.module.DoActionButton

decodeHotkeys, doActions, doHotKey, encodeHotkeys, executeActions, getComponentName, getComponentTypeName, getExpressionList, getNamedKeyStrokeList, getPropertyList, setIndexPropertyValue, updateLoopPropertyRegistration

Methods inherited from class VASSAL.build.AbstractToolbarItem

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

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, 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.build.Buildable

build, getBuildElement, isMandatory, isMovable, isUnique

Methods inherited from interface VASSAL.tools.UniqueIdManager.Identifyable

getConfigureName

Field Details

idMgr

protected static final UniqueIdManager idMgr

SHOW_RESULTS_COMMAND

public static final String SHOW_RESULTS_COMMAND

See Also:

• Constant Field Values

dice

protected List<SpecialDie> dice

ran

protected Random ran

reportResultAsText

protected boolean reportResultAsText

reportResultInWindow

protected boolean reportResultInWindow

reportResultInButton

protected boolean reportResultInButton

id

protected String id

sMapName

protected String sMapName

dialog

protected JDialog dialog

dialogLabel

protected JLabel dialogLabel

bgColor

protected Color bgColor

resultsIcon

protected VASSAL.build.module.SpecialDiceButton.ResultsIcon resultsIcon

format

protected FormattedString format

chatResultFormat

protected String chatResultFormat

windowTitleResultFormat

protected String windowTitleResultFormat

tooltip

protected String tooltip

property

protected final MutableProperty.Impl property

description

protected String description

RESULT_CHATTER

public static final String RESULT_CHATTER

See Also:

• Constant Field Values

CHAT_RESULT_FORMAT

public static final String CHAT_RESULT_FORMAT

See Also:

• Constant Field Values

RESULT_N

public static final String RESULT_N

See Also:

• Constant Field Values

RESULT_TOTAL

public static final String RESULT_TOTAL

See Also:

• Constant Field Values

RESULT_WINDOW

public static final String RESULT_WINDOW

See Also:

• Constant Field Values

WINDOW_TITLE_RESULT_FORMAT

public static final String WINDOW_TITLE_RESULT_FORMAT

See Also:

• Constant Field Values

RESULT_BUTTON

public static final String RESULT_BUTTON

See Also:

• Constant Field Values

WINDOW_X

public static final String WINDOW_X

See Also:

• Constant Field Values

WINDOW_Y

public static final String WINDOW_Y

See Also:

• Constant Field Values

BACKGROUND_COLOR

public static final String BACKGROUND_COLOR

See Also:

• Constant Field Values

DICE_SET

public static final String DICE_SET

See Also:

• Constant Field Values

NONE

public static final String NONE

See Also:

• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

• Constant Field Values

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

Constructor Details

SpecialDiceButton

public SpecialDiceButton()

Method Details

getConfigureTypeName

public static String getConfigureTypeName()

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.

getReportPrefix

protected String getReportPrefix()

The text reported before 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 additionally a command for every die is generated

setFormat

protected void setFormat(int[] results)

getAttributeNames

public String[] getAttributeNames()

The Attributes of a DiceButton are: BUTTON_TEXT the label of the button in the toolbar ICON the icon of the button in the toolbar HOTKEY the hotkey equivalent of the button DICE_SET list of dice sets, an entry can be: [number]name of die[+|-modifier] "name of die" must be SpecialDie "modifier" is added/subtracted to/from total of dice [number]Dnumber of sides (e.g. 2D6) NUMERIC result of all dice is numeric REPORT_TOTAL If numeric and true, add the results of the dice together and report the total. Otherwise, report the individual results SORT if true sort results per die by numeric value RESULT_CHATTER if true report results in chatter RESULT_WINDOW if true show result graphical in extra window WINDOW_X width of window or button WINDOW_Y height of window or button RESULT_MAP :TODO: if true show result in special area in map MAP_NAME :TODO: name of map RESULT_BUTTON if true show result graphical in button

Specified by:

getAttributeNames in interface AutoConfigurable

Overrides:

getAttributeNames in class DoActionButton

Returns:

an array 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 DoActionButton

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 DoActionButton

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 DoActionButton

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.

addSpecialDie

public void addSpecialDie(SpecialDie d)

removeSpecialDie

public void removeSpecialDie(SpecialDie d)

addTo

public void addTo(Buildable parent)

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

Specified by:

addTo in interface Buildable

Overrides:

addTo in class AbstractToolbarItem

Parameters:

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

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

setId

public void setId(String id)

Specified by:

setId in interface UniqueIdManager.Identifyable

getId

public String getId()

Specified by:

getId in interface UniqueIdManager.Identifyable

getIdentifier

public String getIdentifier()

Make a best guess for a unique identifier for the target. Use UniqueIdManager.Identifyable.getConfigureName() if non-null, otherwise use UniqueIdManager.Identifyable.getId()

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 DoActionButton

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 DoActionButton

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

Specified by:

getAllowableConfigureComponents in interface Configurable

Overrides:

getAllowableConfigureComponents in class DoActionButton

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

Specified by:

getHelpFile in interface Configurable

Overrides:

getHelpFile in class DoActionButton

Returns:

a HelpFile describing how to use and configure * this component

intArrayToString

public static String intArrayToString(int[] ia)

create String from int array

Parameters:

ia - int-array

Returns:

encoded String

stringToIntArray

public static int[] stringToIntArray(String s)

get int array from string

Parameters:

s - string with encoded int array

Returns:

int array

getPropertyNames

public List<String> getPropertyNames()

Implement PropertyNameSource - Expose roll result property

Specified by:

getPropertyNames in interface PropertyNameSource

Overrides:

getPropertyNames in class DoActionButton

Returns:

Default implementation of PropertyNameSource - No properties exposed

encode

public String encode(Command c)

Description copied from interface: CommandEncoder

Translate a Command into a String

Specified by:

encode in interface CommandEncoder

decode

public Command decode(String s)

Description copied from interface: CommandEncoder

Translate a String into a Command

Specified by:

decode in interface CommandEncoder

getFormattedStringList

public List<String> getFormattedStringList()

SearchTarget

Specified by:

getFormattedStringList in interface SearchTarget

Overrides:

getFormattedStringList in class DoActionButton

Returns:

a list of any Message Format strings referenced in the Configurable, if any (for search)

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 DoActionButton

Parameters:

s - Collection to add image names to