Package VASSAL.build.module

Class DieManager

java.lang.Object

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.DieManager

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable

public class DieManager
extends AbstractConfigurable

Author:

Brent Easton Internet Die Roller Manager. Includes all the smarts to interface to web-based Die Servers

Nested Class Summary

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static String	ADDRESS_BOOK
static String	DESC
static String	DFLT_NDICE
static String	DFLT_NSIDES
static String	DICE_SERVER
static String	DIE_MANAGER
static String	MULTI_ROLL
static String	PRIMARY_EMAIL
static String	SECONDARY_EMAIL
static String	SERVER_PW
static String	USE_EMAIL
static String	USE_INTERNET_DICE

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

Method Summary

Modifier and Type	Method	Description
void	addDieButton(InternetDiceButton d)
void	addTo(Buildable parent)	Adds this component to its parent.
Class<?>[]	getAllowableConfigureComponents()	Return a list of valid sub-component Classes.
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 buildFile (XML) attributes of this component.
String	getAttributeValueString(String key)	Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
static String	getConfigureTypeName()
String[]	getDescriptions()
int	getDfltNDice()
int	getDfltNSides()
HelpFile	getHelpFile()
MultiRoll	getMultiRoll(int nDice, int nSides)
String[]	getNames()
DieServer	getServer()
String	getServerDescription()
DieServer	getServerForName(String name)
DieServer	getServerFromDescription(String de)
String	getServerName()
void	removeDieButton(InternetDiceButton d)
void	removeFrom(Buildable parent)	Remove this component from its parent
void	roll(int nDice, int nSides, int plus, boolean reportTotal, String description, FormattedString format)
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
void	setSecondaryEmail(String email)
void	setSemailValues()

Methods inherited from class VASSAL.build.AbstractConfigurable

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

Methods inherited from class VASSAL.build.AbstractBuildable

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

USE_INTERNET_DICE

public static final String USE_INTERNET_DICE

See Also:

Constant Field Values

DICE_SERVER

public static final String DICE_SERVER

See Also:

Constant Field Values

SERVER_PW

public static final String SERVER_PW

See Also:

Constant Field Values

USE_EMAIL

public static final String USE_EMAIL

See Also:

Constant Field Values

PRIMARY_EMAIL

public static final String PRIMARY_EMAIL

See Also:

Constant Field Values

SECONDARY_EMAIL

public static final String SECONDARY_EMAIL

See Also:

Constant Field Values

ADDRESS_BOOK

public static final String ADDRESS_BOOK

See Also:

Constant Field Values

MULTI_ROLL

public static final String MULTI_ROLL

See Also:

Constant Field Values

DIE_MANAGER

public static final String DIE_MANAGER

See Also:

Constant Field Values

DESC

public static final String DESC

See Also:

Constant Field Values

DFLT_NSIDES

public static final String DFLT_NSIDES

See Also:

Constant Field Values

DFLT_NDICE

public static final String DFLT_NDICE

See Also:

Constant Field Values

Constructor Details

DieManager

public DieManager()

Method Details

setSemailValues

public void setSemailValues()

getNames

public String[] getNames()

getDescriptions

public String[] getDescriptions()

getServerForName

public DieServer getServerForName(String name)

getServerFromDescription

public DieServer getServerFromDescription(String de)

getServer

public DieServer getServer()

getServerDescription

public String getServerDescription()

getServerName

public String getServerName()

getDfltNDice

public int getDfltNDice()

getDfltNSides

public int getDfltNSides()

getMultiRoll

public MultiRoll getMultiRoll(int nDice,
int nSides)

roll

public void roll(int nDice,
int nSides,
int plus,
boolean reportTotal,
String description,
FormattedString format)

addDieButton

public void addDieButton(InternetDiceButton d)

removeDieButton

public void removeDieButton(InternetDiceButton d)

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:

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

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

Specified by:

getAttributeTypes in interface AutoConfigurable

Specified by:

getAttributeTypes in class AbstractConfigurable

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:

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

setAttribute

public void setAttribute(String key,
Object value)

Description copied from class: AbstractBuildable

Sets a buildFile (XML) attribute value for this component. The key parameter will be one of those listed in AbstractBuildable.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractBuildable.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

Specified by:

setAttribute in class AbstractBuildable

Parameters:

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

value - If the value parameter is a String, it will be the value returned by AbstractBuildable.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 interface: AutoConfigurable

Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element

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 AbstractBuildable.getAttributeNames()

Returns:

a String representation of the attribute with the given name. When initializing a module, this String value will be passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object).

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

getHelpFile

public HelpFile getHelpFile()

Returns:

a HelpFilte describing how to use and configure this component

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Description copied from interface: Configurable

Return 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 Configuration Window.

addTo

public void addTo(Buildable parent)

Description copied from interface: Buildable

Adds this component to its parent. In order to make Buildable objects extensible, the child is reponsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.

getConfigureTypeName

public static String getConfigureTypeName()

setSecondaryEmail

public void setSecondaryEmail(String email)