Class Localization

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.i18n.Language

VASSAL.i18n.Localization

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget

public class Localization
extends Language

Singleton class for managing the translation of a module into other languages

Author:

rodneykinney

Nested Class Summary

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	countryBundle
protected List<Translation>	countryTranslations
protected String	languageBundle
protected List<Translation>	languageTranslations
protected VassalResourceBundle	masterBundle
protected String	moduleBundle
protected List<Translation>	moduleTranslations
protected Set<TranslatableAttribute>	translatableItems	Record attributes as the module is being built for later translation
protected boolean	translationComplete
protected boolean	translationInProgress
protected List<Translation>	translations

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

Method Summary

Modifier and Type	Method	Description
protected void	addBundle(VassalResourceBundle child)
void	addTranslation(Translation t)	Called whenever a Translation is added to a module or extension.
static Localization	getInstance()
Translation	getTranslation(String description)	Return a specified translation
String[]	getTranslationList()	Return a list of translations available for editing.
boolean	isMandatory()	Is this component a reqired component within its parent?
boolean	isTranslationComplete()
boolean	isTranslationInProgress()
boolean	isUnique()	Does this component need to be unique within it's parent?
void	removeTranslation(Translation t)
void	saveTranslatableAttribute(Translatable component, String name, String value)	Record an attribute that may need to be translated.
void	translate()	Translate the module.
String	translate(String key, String defaultValue)	Translate an individual attribute.

Methods inherited from class Language

addTo, contains, getAllowableConfigureComponents, getAttributeDescriptions, getAttributeNames, getAttributeTypes, getAttributeValueString, getConfigureTypeName, getDescription, getHelpFile, removeFrom, setAttribute

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Adds this component to its parent.
boolean	contains(Translation newTranslation)
Class<?>[]	getAllowableConfigureComponents()
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
static String	getConfigureTypeName()
protected String	getDescription()
HelpFile	getHelpFile()
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 AbstractConfigurable

add, addPropertyChangeListener, getAttributeVisibility, getConfigureComponents, getConfigureName, getConfigurer, getExpressionList, getFormattedStringList, getI18nData, getI18nPrefix, 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()
String	getConfigureName()	ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
List<String>	getExpressionList()	SearchTarget
List<String>	getFormattedStringList()	SearchTarget
ComponentI18nData	getI18nData()
protected String	getI18nPrefix()
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, equals, 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

isMovable

Modifier and Type	Method	Description
default boolean	isMovable()	Is this component allowed to be moved around the Configure Tree?

Field Details

moduleBundle

protected String moduleBundle

languageBundle

protected String languageBundle

countryBundle

protected String countryBundle

moduleTranslations

protected List<Translation> moduleTranslations

languageTranslations

protected List<Translation> languageTranslations

countryTranslations

protected List<Translation> countryTranslations

translations

protected List<Translation> translations

masterBundle

protected VassalResourceBundle masterBundle

translatableItems

protected Set<TranslatableAttribute> translatableItems

Record attributes as the module is being built for later translation

translationInProgress

protected boolean translationInProgress

translationComplete

protected boolean translationComplete

Method Details

getInstance

public static Localization getInstance()

getTranslationList

public String[] getTranslationList()

Return a list of translations available for editing.

Returns:

Array of available translations

getTranslation

public Translation getTranslation(String description)

Return a specified translation

Parameters:

description - description

Returns:

Translation object

saveTranslatableAttribute

public void saveTranslatableAttribute(Translatable component,
 String name,
 String value)

Record an attribute that may need to be translated.

Parameters:

component - component to be translated

name - Attribute name to be translated

value - current value of attribute

translate

public void translate()
               throws IOException

Translate the module. The module and all extensions have now been built, so all Translations are available and all attributes that need to be translated have been recorded. There may be multiple translations that match this Locale, merge them in order - Country overrides Language overrides default. NB - You cannot create a default translation (Module.properties) using the VASSAL editor, but a default file can be placed into a module or extension manually.

Throws:

IOException - oops

translate

public String translate(String key,
 String defaultValue)

Translate an individual attribute.

Parameters:

key - Attribute Key

defaultValue - Default value if no translation available

Returns:

translation

addBundle

protected void addBundle(VassalResourceBundle child)

isTranslationInProgress

public boolean isTranslationInProgress()

isTranslationComplete

public boolean isTranslationComplete()

addTranslation

public void addTranslation(Translation t)

Called whenever a Translation is added to a module or extension. Check if the translation matches our locale. If so, add it to the list of translations to use. There may multiple matching translations at Country, Language and Module level from different extensions.

Parameters:

t - Translation

removeTranslation

public void removeTranslation(Translation t)

isMandatory

public boolean isMandatory()

Description copied from interface: Buildable

Is this component a reqired component within its parent?

Specified by:

isMandatory in interface Buildable

Overrides:

isMandatory in class Language

Returns:

true if component is mandatory

isUnique

public boolean isUnique()

Description copied from interface: Buildable

Does this component need to be unique within it's parent?

Specified by:

isUnique in interface Buildable

Overrides:

isUnique in class Language

Returns: