Class VassalTranslation

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.i18n.Translation

VASSAL.i18n.VassalTranslation

All Implemented Interfaces:

Comparable<Translation>, AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget

public class VassalTranslation
extends Translation

Utility class to allow translation of VASSAL using the Component Translation mechanism.

Author:

Brent Easton

Nested Class Summary

Nested classes/interfaces inherited from class Translation

Translation.LocalePrompt

Modifier and Type	Class	Description
static class	Translation.LocalePrompt

Nested classes/interfaces inherited from interface AutoConfigurable

AutoConfigurable.Util

Modifier and Type	Interface	Description
static class	AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
protected String[]	allKeys
protected Properties	baseValues

Fields inherited from class Translation

dirty, locale, LOCALE, localProperties

Modifier and Type	Field	Description
protected boolean	dirty
protected Locale	locale
static final String	LOCALE
protected Properties	localProperties

Fields inherited from class AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Modifier and Type	Field	Description
protected PropertyChangeSupport	changeSupport
protected Configurer	config
protected String	localizedName
protected ComponentI18nData	myI18nData
protected String	name

Fields inherited from class AbstractBuildable

buildComponents, validator

Modifier and Type	Field	Description
protected List<Buildable>	buildComponents
protected ValidityChecker	validator

Fields inherited from interface Configurable

NAME_PROPERTY

Modifier and Type	Field	Description
static final String	NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
VassalTranslation()

Method Summary

Modifier and Type	Method	Description
void	clearProperties()
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 attributes of this object.
String	getAttributeValueString(String key)	Called by the Buildable.getBuildElement(Document) method to write the attributes into an XML element
protected String	getDescription()
protected String	getI18nPrefix()
protected void	initkeys()
protected void	loadProperties(InputStream in)
void	saveProperties(File file, Locale locale)

Methods inherited from class Translation

addTo, compareTo, equals, getAllowableConfigureComponents, getBundle, getBundleFileName, getBundleName, getConfigureName, getHelpFile, getLanguageCode, getLocale, getProperties, isDirty, loadProperties, reloadProperties, removeFrom, saveProperties, setAttribute, setProperty, translate

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Adds this component to its parent.
int	compareTo(Translation o)
boolean	equals(Object obj)
Class<?>[]	getAllowableConfigureComponents()
protected VassalResourceBundle	getBundle()
String	getBundleFileName()	Build the bundle file name
String	getBundleName()	Build the bundle name
String	getConfigureName()	ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.
HelpFile	getHelpFile()
String	getLanguageCode()
Locale	getLocale()
Properties	getProperties()	Return the properties map for this translation.
boolean	isDirty()	Return true if this translation has unsaved modifications
protected void	loadProperties()	Load properties from the bundle file in the module/extension
void	reloadProperties()	Reload the properties from the module/extension
void	removeFrom(Buildable parent)	Remove this component from its parent
protected void	saveProperties()	Save the properties back to the module/extension
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
void	setProperty(String key, String value)	Set a property into our property map. i.e. an attribute has been translated
String	translate(String key)	Return the translation for the supplied key

Methods inherited from class AbstractConfigurable

add, addPropertyChangeListener, getAttributeVisibility, getConfigureComponents, getConfigurer, getExpressionList, getFormattedStringList, getI18nData, getLocalizedConfigureName, getMenuTextList, getNamedKeyStrokeList, getPropertyList, getTypeName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Modifier and Type	Method	Description
void	add(Buildable b)	Set the owning translatable of this component
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener.
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
Configurable[]	getConfigureComponents()
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
List<String>	getExpressionList()	SearchTarget
List<String>	getFormattedStringList()	SearchTarget
ComponentI18nData	getI18nData()
String	getLocalizedConfigureName()
List<String>	getMenuTextList()	SearchTarget
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
List<String>	getPropertyList()	SearchTarget
String	getTypeName()	Returns the name of the configurable type for display purposes.
void	remove(Buildable b)	Remove a Buildable object from this object
void	removePropertyChangeListener(PropertyChangeListener l)
protected void	setAllAttributesUntranslatable()	Sets all attributes untranslatable.
protected void	setAttributeTranslatable(String attr, boolean b)	Over-ride the default attribute translatability.
void	setConfigureName(String s)	Sets the name and fires a PropertyChangeEvent

Methods inherited from class AbstractBuildable

addImageNamesRecursively, build, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, getPropertyNames, setAncestor, validate

Modifier and Type	Method	Description
void	addImageNamesRecursively(Collection<String> s)	Adds all images used by this component AND any subcomponents to the collection
void	build(Element e)	Build this component by getting all XML attributes of the XML element and calling AbstractBuildable.setAttribute(String, Object) with the String value of the attribute
String	buildString()
<T> List<T>	getAllDescendantComponentsOf(Class<T> target)	Recursively descend the build tree and return a List of all components that are instances of the given class
Buildable	getAncestor()
List<Buildable>	getBuildables()
Enumeration<Buildable>	getBuildComponents()	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getBuildables() instead.
Element	getBuildElement(Document doc)
<T> Enumeration<T>	getComponents(Class<T> target)	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getComponentsOf(Class) instead.
<T> List<T>	getComponentsOf(Class<T> target)
Buildable	getNonFolderAncestor()
List<String>	getPropertyNames()	Override this method to provide a list of properties to be exposed for use by expressions in the module.
void	setAncestor(Buildable ancestor)
void	validate(Buildable target, ValidationReport report)

Methods inherited from class AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	Classes extending AbstractImageFinder should override this method in order to add the names of any image files they use to the collection.
SortedSet<String>	getAllImageNames()
SortedSet<String>	getLocalImageNames()

Methods inherited from class Object

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

Methods inherited from interface Auditable

getComponentName, getComponentTypeName

Modifier and Type	Method	Description
default String	getComponentName()	Return the name of the trait or Component an Auditable is
default String	getComponentTypeName()	Return a description of the Type of trait or Component an Auditable is

Methods inherited from interface Buildable

isMandatory, isMovable, isUnique

Modifier and Type	Method	Description
default boolean	isMandatory()	Is this component a reqired component within its parent?
default boolean	isMovable()	Is this component allowed to be moved around the Configure Tree?
default boolean	isUnique()	Does this component need to be unique within it's parent?

Field Details

allKeys

protected String[] allKeys

baseValues

protected Properties baseValues

Constructor Details

VassalTranslation

public VassalTranslation()

Method Details

getI18nPrefix

protected String getI18nPrefix()

Overrides:

getI18nPrefix in class AbstractConfigurable

Returns:

Generate a standard prefix for i18n keys for attributes of this component - Classname.attributeName

getDescription

protected String getDescription()

Overrides:

getDescription in class Translation

clearProperties

public void clearProperties()

getAttributeValueString

public String getAttributeValueString(String key)

Description copied from interface: AutoConfigurable

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

Specified by:

getAttributeValueString in interface AutoConfigurable

Specified by:

getAttributeValueString in interface Translatable

Overrides:

getAttributeValueString in class Translation

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractBuildable.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 AbstractBuildable.setAttribute(String, Object). It is also frequently used for checking the current value of an attribute.

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

Overrides:

getAttributeDescriptions in class Translation

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

Overrides:

getAttributeNames in class Translation

Returns:

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

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from interface: AutoConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, File, Color, and KeyStroke

Specified by:

getAttributeTypes in interface AutoConfigurable

Overrides:

getAttributeTypes in class Translation

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

initkeys

protected void initkeys()

saveProperties

public void saveProperties(File file,
 Locale locale)
                    throws IOException

Throws:

IOException

loadProperties

protected void loadProperties(InputStream in)
                       throws IOException

Throws:

IOException