repicea.util

Class REpiceaTranslator

java.lang.Object

repicea.util.REpiceaTranslator

public class REpiceaTranslator
extends java.lang.Object

The REpiceaTranslator class handles the translation to another language.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	REpiceaTranslator.Language
static interface	REpiceaTranslator.TextableEnum

Constructor Summary

Constructors

Constructor and Description
REpiceaTranslator()

Method Summary

Modifier and Type	Method and Description
static REpiceaTranslator.Language	getCurrentLanguage() This method returns the current language of the UIControlManager.
static java.lang.String	getString(REpiceaTranslator.TextableEnum messageID) This method returns the message associated to this messageID Enum instance.
static java.lang.String	getTranslation(REpiceaTranslator.TextableEnum textableEnum, REpiceaTranslator.Language language) This method returns the translation of a particular TextableEnum instance.
static void	setCurrentLanguage(REpiceaTranslator.Language language) This method sets the current language of the UIControlManager.
static void	setString(REpiceaTranslator.TextableEnum element, java.lang.String englishText, java.lang.String frenchText) This method sets the different strings for an element, i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

REpiceaTranslator

public REpiceaTranslator()

Method Detail

setString

public static void setString(REpiceaTranslator.TextableEnum element,
                             java.lang.String englishText,
                             java.lang.String frenchText)

This method sets the different strings for an element, i.e. a control, label or message.

Parameters:

element - the TextableEnum that represents the control, label or message

englishText - a String

frenchText - a String

getString

public static java.lang.String getString(REpiceaTranslator.TextableEnum messageID)

This method returns the message associated to this messageID Enum instance.

Parameters:

messageID - an TextableEnum instance

Returns:

the message or an empty string if the title has not been registered

setCurrentLanguage

public static void setCurrentLanguage(REpiceaTranslator.Language language)

This method sets the current language of the UIControlManager. By default, the current language is set to Language.English.

Parameters:

language - a Language enum variable

getCurrentLanguage

public static REpiceaTranslator.Language getCurrentLanguage()

This method returns the current language of the UIControlManager.

Returns:

a Language enum variable

getTranslation

public static java.lang.String getTranslation(REpiceaTranslator.TextableEnum textableEnum,
                                              REpiceaTranslator.Language language)

This method returns the translation of a particular TextableEnum instance.

Parameters:

textableEnum - a TextableEnum instance

language - a Language instance

Returns:

a String which is empty if the translation does not exist