Package VASSAL.build.module.gamepieceimage

Class FontManager

java.lang.Object

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.gamepieceimage.FontManager

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable

public class FontManager
extends AbstractConfigurable

Container for definitions of Generic Color Definitions

Nested Class Summary

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static String[]	ALLOWABLE_FONTS
static String	DEFAULT
static OutlineFont	DEFAULT_FONT
static FontStyle	DEFAULT_STYLE
static String	DIALOG
static String	DIALOG_INPUT
protected Map<String,FontStyle>	fontStyles
protected static FontManager	instance
static String	MONOSPACED
static String	SANS_SERIF
static String	SERIF

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

Method Summary

Modifier and Type	Method	Description
void	add(Buildable b)	Set the owning translatable of this component
void	addTo(Buildable parent)	Adds this component to its parent.
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
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
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
static String	getConfigureTypeName()
static FontManager	getFontManager()
String[]	getFontNames()
protected FontStyle	getFontStyle(String name)
HelpFile	getHelpFile()
void	remove(Buildable b)	Remove a Buildable object from this object
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.

Methods inherited from class VASSAL.build.AbstractConfigurable

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

Methods inherited from class VASSAL.build.AbstractBuildable

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

getBuildElement

Field Details

instance

protected static FontManager instance

fontStyles

protected Map<String,FontStyle> fontStyles

DIALOG

public static final String DIALOG

See Also:

Constant Field Values

SERIF

public static final String SERIF

See Also:

Constant Field Values

SANS_SERIF

public static final String SANS_SERIF

See Also:

Constant Field Values

DIALOG_INPUT

public static final String DIALOG_INPUT

See Also:

Constant Field Values

MONOSPACED

public static final String MONOSPACED

See Also:

Constant Field Values

DEFAULT

public static final String DEFAULT

See Also:

Constant Field Values

DEFAULT_FONT

public static final OutlineFont DEFAULT_FONT

DEFAULT_STYLE

public static final FontStyle DEFAULT_STYLE

ALLOWABLE_FONTS

public static final String[] ALLOWABLE_FONTS

Constructor Details

FontManager

public FontManager()

Method Details

getFontManager

public static FontManager getFontManager()

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

getFontStyle

protected FontStyle getFontStyle(String name)

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

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

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

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

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.

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.

getConfigureTypeName

public static String getConfigureTypeName()

add

public void add(Buildable b)

Description copied from class: AbstractConfigurable

Set the owning translatable of this component

Specified by:

add in interface Buildable

Overrides:

add in class AbstractConfigurable

remove

public void remove(Buildable b)

Description copied from class: AbstractConfigurable

Remove a Buildable object from this object

Specified by:

remove in interface Configurable

Overrides:

remove in class AbstractConfigurable

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

getFontNames

public String[] getFontNames()