Package VASSAL.build.module

Class GlobalOptions

java.lang.Object

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.GlobalOptions

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable

public class GlobalOptions
extends AbstractConfigurable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GlobalOptions.PlayerIdFormatConfig
static class	GlobalOptions.Prompt
static class	GlobalOptions.PromptOnOff

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALWAYS
static String	AUTO_REPORT
static String	BUG_10295
static String	CENTER_ON_MOVE
static String	CHATTER_HTML_SUPPORT
static String	CLASSIC_MFD
static String	DRAG_THRESHOLD
static boolean	FORCE_MAC_LEGACY
static String	INITIAL_HEAP
static String	MAC_LEGACY
static String	MARK_MOVED
static String	MAXIMUM_HEAP
static String	NEVER
static String	NON_OWNER_UNMASKABLE
static String	PLAYER_ID
static String	PLAYER_ID_ALT
static String	PLAYER_ID_FORMAT
static String	PLAYER_NAME
static String	PLAYER_NAME_ALT
static String	PLAYER_SIDE
static String	PLAYER_SIDE_ALT
static String	PROMPT
static String	PROMPT_STRING
static String	SINGLE_WINDOW

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

Method Summary

Modifier and Type	Method	Description
void	addOption(Configurer option)	Components may use GlobalOptions to store generic global attributes.
void	addTo(Buildable parent)	Adds this component to its parent.
boolean	autoReportEnabled()
void	build(Element e)	Build this component by getting all XML attributes of the XML element and calling AbstractBuildable.setAttribute(java.lang.String, java.lang.Object) with the String value of the attribute
boolean	centerOnOpponentsMove()
boolean	chatterHTMLSupport()
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
Element	getBuildElement(Document doc)
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
static String	getConfigureTypeName()
int	getDragThreshold()
HelpFile	getHelpFile()
static GlobalOptions	getInstance()
String	getPlayerId()
List<String>	getPropertyNames()	Implement PropertyNameSource - Expose our preference names
boolean	isAveragedScaling()	Deprecated, for removal: This API element is subject to removal in a future version. No replacement
boolean	isMarkMoveEnabled()
boolean	isUseClassicMoveFixedDistance()
boolean	isUseSingleWindow()
void	removeFrom(Buildable parent)	Remove this component from its parent
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
void	setPrefMacLegacy(boolean b)
void	setUseClassicMoveFixedDistance(boolean b)

Methods inherited from class VASSAL.build.AbstractConfigurable

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

Methods inherited from class VASSAL.build.AbstractBuildable

getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getComponents, getComponentsOf, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NON_OWNER_UNMASKABLE

public static final String NON_OWNER_UNMASKABLE

See Also:

Constant Field Values

PROMPT_STRING

public static final String PROMPT_STRING

See Also:

Constant Field Values

CENTER_ON_MOVE

public static final String CENTER_ON_MOVE

See Also:

Constant Field Values

MARK_MOVED

public static final String MARK_MOVED

See Also:

Constant Field Values

AUTO_REPORT

public static final String AUTO_REPORT

See Also:

Constant Field Values

CHATTER_HTML_SUPPORT

public static final String CHATTER_HTML_SUPPORT

See Also:

Constant Field Values

ALWAYS

public static final String ALWAYS

See Also:

Constant Field Values

NEVER

public static final String NEVER

See Also:

Constant Field Values

PROMPT

public static final String PROMPT

See Also:

Constant Field Values

SINGLE_WINDOW

public static final String SINGLE_WINDOW

See Also:

Constant Field Values

MAXIMUM_HEAP

public static final String MAXIMUM_HEAP

See Also:

Constant Field Values

INITIAL_HEAP

public static final String INITIAL_HEAP

See Also:

Constant Field Values

BUG_10295

public static final String BUG_10295

See Also:

Constant Field Values

CLASSIC_MFD

public static final String CLASSIC_MFD

See Also:

Constant Field Values

DRAG_THRESHOLD

public static final String DRAG_THRESHOLD

See Also:

Constant Field Values

MAC_LEGACY

public static final String MAC_LEGACY

See Also:

Constant Field Values

PLAYER_NAME

public static final String PLAYER_NAME

See Also:

Constant Field Values

PLAYER_NAME_ALT

public static final String PLAYER_NAME_ALT

See Also:

Constant Field Values

PLAYER_SIDE

public static final String PLAYER_SIDE

See Also:

Constant Field Values

PLAYER_SIDE_ALT

public static final String PLAYER_SIDE_ALT

See Also:

Constant Field Values

PLAYER_ID

public static final String PLAYER_ID

See Also:

Constant Field Values

PLAYER_ID_ALT

public static final String PLAYER_ID_ALT

See Also:

Constant Field Values

PLAYER_ID_FORMAT

public static final String PLAYER_ID_FORMAT

See Also:

Constant Field Values

FORCE_MAC_LEGACY

public static final boolean FORCE_MAC_LEGACY

See Also:

Constant Field Values

Constructor Details

GlobalOptions

public GlobalOptions()

Method Details

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.

getInstance

public static GlobalOptions getInstance()

isUseSingleWindow

public boolean isUseSingleWindow()

isUseClassicMoveFixedDistance

public boolean isUseClassicMoveFixedDistance()

setUseClassicMoveFixedDistance

public void setUseClassicMoveFixedDistance(boolean b)

isAveragedScaling

@Deprecated(since="2020-08-06",
            forRemoval=true)
public boolean isAveragedScaling()

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

No replacement

setPrefMacLegacy

public void setPrefMacLegacy(boolean b)

getConfigureTypeName

public static String getConfigureTypeName()

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.

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

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

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

addOption

public void addOption(Configurer option)

Components may use GlobalOptions to store generic global attributes. This method registers the given key as an attribute of the GlobalOptions with the given type.

build

public void build(Element e)

Description copied from class: AbstractBuildable

Build this component by getting all XML attributes of the XML element and calling AbstractBuildable.setAttribute(java.lang.String, java.lang.Object) with the String value of the attribute

Specified by:

build in interface Buildable

Overrides:

build in class AbstractBuildable

Parameters:

e - the XML element containing the object data

getBuildElement

public Element getBuildElement(Document doc)

Specified by:

getBuildElement in interface Buildable

Overrides:

getBuildElement in class AbstractBuildable

Returns:

an XML element from which this component can be built

getConfigurer

public Configurer getConfigurer()

Description copied from class: AbstractConfigurable

The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer

Specified by:

getConfigurer in interface Configurable

Overrides:

getConfigurer in class AbstractConfigurable

Returns:

Configurer for this component

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

getHelpFile

public HelpFile getHelpFile()

Returns:

a HelpFilte describing how to use and configure this component

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

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

autoReportEnabled

public boolean autoReportEnabled()

centerOnOpponentsMove

public boolean centerOnOpponentsMove()

chatterHTMLSupport

public boolean chatterHTMLSupport()

isMarkMoveEnabled

public boolean isMarkMoveEnabled()

getDragThreshold

public int getDragThreshold()

getPlayerId

public String getPlayerId()

getPropertyNames

public List<String> getPropertyNames()

Implement PropertyNameSource - Expose our preference names

Specified by:

getPropertyNames in interface PropertyNameSource

Overrides:

getPropertyNames in class AbstractBuildable

Returns:

Default implementation of PropertyNameSource - No properties exposed