Package velox.gui.utils.localization.translatable

Class TranslatableText

java.lang.Object

velox.gui.utils.localization.translatable.TranslatableText

All Implemented Interfaces:

TranslatableComponent

public class TranslatableText
extends Object
implements TranslatableComponent

You can use this class instead of LocalizedBundle.getString(String key, Map args) if the given text can be used on several locales at the same time.

This class support chainging with other TranslatableComponent classes when they passed as arguments
For a convenient use, extend this class with you own add-on specific class with a constructor that will call super constructor with a specific bundleName and classLoader (to not pass the bundleName and classLoader explicitly every time you create a new instance of TranslatableText)

See Also:

• DemoStrategies see velox.api.layer1.simpledemo.localization.LocalizedAlertDemoTranslatableText class for an example

Constructor Summary

Constructors

Constructor	Description
TranslatableText(String key, String bundleName, ClassLoader classLoader, boolean throwException)	Get locale specific text by given key, without arguments
TranslatableText(String key, Map<String,Object> args, String bundleName, ClassLoader classLoader, boolean throwException)	Get locale specific text by given key, and insert given arguments

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getKey()
int	hashCode()
String	toLocalizedString(com.ibm.icu.util.ULocale locale)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface velox.gui.utils.localization.translatable.TranslatableComponent

toDefaultString, toLocalizedString

Constructor Details

TranslatableText

public TranslatableText(String key,
 Map<String,Object> args,
 String bundleName,
 ClassLoader classLoader,
 boolean throwException)

Get locale specific text by given key, and insert given arguments

Parameters:

key - translation key

args - named arguments that should inserted in text

bundleName - in which key is located

classLoader - with which your classes were loaded from the jar

throwException - if true we throw an exception if the key is not found in the given bundleName, otherwise return the key as is

TranslatableText

public TranslatableText(String key,
 String bundleName,
 ClassLoader classLoader,
 boolean throwException)

Get locale specific text by given key, without arguments

Parameters:

key - translation key

bundleName - in which key is located

classLoader - with which your classes were loaded from the jar

throwException - if true we throw an exception if the key is not found in the given bundleName, otherwise return the key as is

Method Details

getKey

public String getKey()

Returns:

translationKey

toLocalizedString

public String toLocalizedString(com.ibm.icu.util.ULocale locale)

Specified by:

toLocalizedString in interface TranslatableComponent

Parameters:

locale -

Returns:

localized string in specific locale

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object