VASSAL.build.module
Class DieManager

java.lang.Object
  |
  +--VASSAL.build.AbstractBuildable
        |
        +--VASSAL.build.AbstractConfigurable
              |
              +--VASSAL.build.module.DieManager

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable

public class DieManager

extends AbstractConfigurable

Author:

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

Inner Class Summary

static class	DieManager.DieServer Base DieServer Class Does most of the work.
static class	DieManager.RollSet Describes a set of DieRolls

Inner classes inherited from class VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

static java.lang.String	DESC
static java.lang.String	DFLT_NDICE
static java.lang.String	DFLT_NSIDES
static java.lang.String	DICE_SERVER
static java.lang.String	DIE_MANAGER
static java.lang.String	MULTI_ROLL
static java.lang.String	PRIMARY_EMAIL
static java.lang.String	ROLL_MARKER
static java.lang.String	SECONDARY_EMAIL
static java.lang.String	SERVER_PW
static java.lang.String	USE_EMAIL
static java.lang.String	USE_INTERNET_DICE

Fields inherited from class VASSAL.build.AbstractConfigurable

changeSupport, config, name

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

DieManager()

Method Summary

void	addDieButton(InternetDiceButton d)
void	addTo(Buildable parent) Adds this component to its parent.
java.lang.Class[]	getAllowableConfigureComponents() Return a list of valid sub-component Classes.
java.lang.String[]	getAttributeDescriptions() Return an array of Strings describing the attributes of this object.
java.lang.String[]	getAttributeNames()
java.lang.Class[]	getAttributeTypes() Return the Class for the attributes of this object.
java.lang.String	getAttributeValueString(java.lang.String key) Called by the AbstractBuildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
static java.lang.String	getConfigureTypeName()
java.lang.String[]	getDescriptions()
int	getDfltNDice()
int	getDfltNSides()
HelpFile	getHelpFile()
MultiRoll	getMultiRoll()
java.lang.String[]	getNames()
DieManager.DieServer	getServer()
java.lang.String	getServerDescription()
DieManager.DieServer	getServerForName(java.lang.String name)
DieManager.DieServer	getServerFromDescription(java.lang.String de)
java.lang.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, java.lang.String description)
void	setAttribute(java.lang.String key, java.lang.Object value) Called by the AbstractBuildable.build(org.w3c.dom.Element) method, where value is the String value read by the XML attribute.

Methods inherited from class VASSAL.build.AbstractConfigurable

addPropertyChangeListener, getAttributeVisibility, getConfigureComponents, getConfigureName, getConfigurer, remove, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

add, build, getBuildComponents, getBuildElement, getComponents

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

add, build, getBuildElement

Field Detail

USE_INTERNET_DICE

public static final java.lang.String USE_INTERNET_DICE

DICE_SERVER

public static final java.lang.String DICE_SERVER

SERVER_PW

public static final java.lang.String SERVER_PW

USE_EMAIL

public static final java.lang.String USE_EMAIL

PRIMARY_EMAIL

public static final java.lang.String PRIMARY_EMAIL

SECONDARY_EMAIL

public static final java.lang.String SECONDARY_EMAIL

MULTI_ROLL

public static final java.lang.String MULTI_ROLL

DIE_MANAGER

public static final java.lang.String DIE_MANAGER

ROLL_MARKER

public static final java.lang.String ROLL_MARKER

DESC

public static final java.lang.String DESC

DFLT_NSIDES

public static final java.lang.String DFLT_NSIDES

DFLT_NDICE

public static final java.lang.String DFLT_NDICE

Constructor Detail

DieManager

public DieManager()

Method Detail

getNames

public java.lang.String[] getNames()

getDescriptions

public java.lang.String[] getDescriptions()

getServerForName

public DieManager.DieServer getServerForName(java.lang.String name)

getServerFromDescription

public DieManager.DieServer getServerFromDescription(java.lang.String de)

getServer

public DieManager.DieServer getServer()

getServerDescription

public java.lang.String getServerDescription()

getServerName

public java.lang.String getServerName()

getDfltNDice

public int getDfltNDice()

getDfltNSides

public int getDfltNSides()

getMultiRoll

public MultiRoll getMultiRoll()

roll

public void roll(int nDice,
                 int nSides,
                 int plus,
                 boolean reportTotal,
                 java.lang.String description)

addDieButton

public void addDieButton(InternetDiceButton d)

removeDieButton

public void removeDieButton(InternetDiceButton d)

getAttributeDescriptions

public java.lang.String[] getAttributeDescriptions()

Description copied from class: AbstractConfigurable

Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()

Overrides:

getAttributeDescriptions in class AbstractConfigurable

getAttributeTypes

public java.lang.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()

Overrides:

getAttributeTypes in class AbstractConfigurable

getAttributeNames

public java.lang.String[] getAttributeNames()

Overrides:

getAttributeNames in class AbstractBuildable

Following copied from interface: VASSAL.build.AutoConfigurable

Returns:

an array of Strings giving all attributes of this Buildable component that will be written to/read from an XML element

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.Object value)

Description copied from interface: AutoConfigurable

Called by the Buildable.build(org.w3c.dom.Element) method, where value is the String value read by the XML attribute. Can also be called with Object value to set the attribute.

Overrides:

setAttribute in class AbstractBuildable

Following copied from class: VASSAL.build.AbstractBuildable

Parameters:

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

getAttributeValueString

public java.lang.String getAttributeValueString(java.lang.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

Overrides:

getAttributeValueString in class AbstractBuildable

Following copied from class: VASSAL.build.AbstractBuildable

Parameters:

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

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

getHelpFile

public HelpFile getHelpFile()

Following copied from interface: VASSAL.build.Configurable

Returns:

a HelpFilte describing how to use and configure this component

getAllowableConfigureComponents

public java.lang.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 java.lang.String getConfigureTypeName()