com.luciad.lucy.util.language

LuciadLightspeedClass TLcyLang

java.lang.Object

com.luciad.lucy.util.language.TLcyLang

public class TLcyLang
extends java.lang.Object

Internationalization

This class takes care of the internationalization capabilities of Lucy. Translations files are searched by trying to find the file lucy/DefaultResources (e.g. lucy/DefaultResources_nl.properties)

The language is set (to Java) by using the -Duser.language=.. system property. Lucy supports three languages:

• English (-Duser.language=en or any other unknown abbreviation)
• Dutch (-Duser.language=nl)
• French (-Duser.language=fr)

Other languages can simply be added by translating the DefaultResourceBundle to other languages.

To translate a string into the target language, use TLcyLang.getString(aKey). Lucy uses the message in English as the key. This means if no translations are available, Lucy is in English.

Adding bundles

When developing your own application which needs internationalization support, it is easiest to define your own resource bundles, so that you keep your own translations separate from the ones that ship with Lucy. You can do so be registering your additional bundles, for example like this:

   ResourceBundle bundle = ResourceBundle.getBundle("myApp.TranslationBundle");
   TLcyLang.registerResourceBundle("arbitraryID", bundle);
 

When requesting a translation, and the language is set to French for example, these files are checked, in this order:

• myApp/TranslationBundle_fr.properties
• lucy/DefaultResources_fr.properties

The file names are interpreted relative to the classpath.

See Also:

getString(java.lang.String)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AIRCRAFT
static java.lang.String	ANNEX
static java.lang.String	APP_TITLE
static java.lang.String	APPLY
static java.lang.String	AUTO_CENTER
static java.lang.String	AUTO_FIT
static java.lang.String	AUTO_RESIZE
static java.lang.String	AUTO_SELECT
static java.lang.String	BACKGROUND
static java.lang.String	BASE
static java.lang.String	CAN_NOT_ADD_ELEMENT
static java.lang.String	CANCEL
static java.lang.String	CLOSE
static java.lang.String	COLORS
static java.lang.String	CONFIDENTIAL
static java.lang.String	CONTROLS
static java.lang.String	DATA
static java.lang.String	DELETE
static java.lang.String	EDIT
static java.lang.String	EDIT_CURRENT
static java.lang.String	EXIT
static java.lang.String	FILE
static java.lang.String	INITIALIZING
static java.lang.String	LASTCLICK
static java.lang.String	LOAD
static java.lang.String	MAKE_OVERVIEW
static java.lang.String	MAP
static java.lang.String	MAX_CPU_USAGE
static java.lang.String	MIN1
static java.lang.String	MIN10
static java.lang.String	MIN2
static java.lang.String	MIN30
static java.lang.String	MIN5
static java.lang.String	MISSION_ID
static java.lang.String	NEW
static java.lang.String	NEW_MAP
static java.lang.String	NOT_VALID_CLASSIFICATION
static java.lang.String	NR_AIRCRAFT
static java.lang.String	OBJ
static java.lang.String	OK
static java.lang.String	OPEN
static java.lang.String	OVERVIEW
static java.lang.String	PACKAGE
static java.lang.String	POINTLIST_ERROR
static java.lang.String	POINTLIST_ERROR_MESSAGE
static java.lang.String	PREVIEW_LAYER_NAME
static java.lang.String	PREVIEWER
static java.lang.String	PROJECTION
static java.lang.String	REMOVE_FROM
static java.lang.String	RESET
static java.lang.String	RESTRICTED
static java.lang.String	ROLE
static java.lang.String	SAVE
static java.lang.String	SAVE_AS
static java.lang.String	SEC1
static java.lang.String	SEC10
static java.lang.String	SEC2
static java.lang.String	SEC30
static java.lang.String	SEC5
static java.lang.String	SECRET
static java.lang.String	SHOW
static java.lang.String	SHOW_ALL_ON
static java.lang.String	SHOW_SELECTED_ON
static java.lang.String	SPEED
static java.lang.String	TARGET
static java.lang.String	TIME_FACTOR
static java.lang.String	TIME_RANGE
static java.lang.String	TOT
static java.lang.String	TOTE
static java.lang.String	UNCLASSIFIED
static java.lang.String	UNIT
static java.lang.String	UPDATE_POLYLINE
static java.lang.String	WARNING

Constructor Summary

Constructors

Constructor and Description
TLcyLang()

Method Summary

Modifier and Type	Method and Description
static java.util.ResourceBundle	getDefaultResourceBundle() Returns the default resource bundle.
static java.util.ResourceBundle	getResourceBundle(java.lang.String aResourceBundleID) Returns the resource bundle associated with the given ID, or null if there is none.
static java.lang.String	getString(java.lang.String aKey) Returns the internationalized string corresponding to the specified key, by trying all registered resource bundles.
static java.lang.String	getString(java.lang.String aResourceBundleID, java.lang.String aKey) Returns the internationalized string corresponding to the specified key from the resource bundle that is associated with the specified identifier.
static ILcdStringTranslator	getStringTranslator() Returns an ILcdStringTranslator that translates strings similar to getString.
static ILcdStringTranslator	getStringTranslator(java.lang.String aResourceBundleID) Returns an ILcdStringTranslator that translates strings similar to getString
static boolean	isClassTraceOn() Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
static java.util.ResourceBundle	registerResourceBundle(java.lang.String aResourceBundleID, java.util.ResourceBundle aResourceBundle) Registers a resource bundle using a specified ID.
static void	setClassTraceOn(boolean aClassTraceOn) Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
static java.util.ResourceBundle	setDefaultResourceBundle(java.util.ResourceBundle aResourceBundle) Sets the default resource bundle to a specified resource bundle
static java.util.ResourceBundle	unregisterResourceBundle(java.lang.String aResourceBundleID) Unregisters the resource bundle that is associated with a specified ID.

Methods inherited from class java.lang.Object

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

Field Detail

NEW_MAP

public static final java.lang.String NEW_MAP

See Also:

Constant Field Values

LASTCLICK

public static final java.lang.String LASTCLICK

See Also:

Constant Field Values

FILE

public static final java.lang.String FILE

See Also:

Constant Field Values

NEW

public static final java.lang.String NEW

See Also:

Constant Field Values

OPEN

public static final java.lang.String OPEN

See Also:

Constant Field Values

LOAD

public static final java.lang.String LOAD

See Also:

Constant Field Values

SAVE

public static final java.lang.String SAVE

See Also:

Constant Field Values

SAVE_AS

public static final java.lang.String SAVE_AS

See Also:

Constant Field Values

CLOSE

public static final java.lang.String CLOSE

See Also:

Constant Field Values

DELETE

public static final java.lang.String DELETE

See Also:

Constant Field Values

EXIT

public static final java.lang.String EXIT

See Also:

Constant Field Values

OK

public static final java.lang.String OK

See Also:

Constant Field Values

CANCEL

public static final java.lang.String CANCEL

See Also:

Constant Field Values

APPLY

public static final java.lang.String APPLY

See Also:

Constant Field Values

MAP

public static final java.lang.String MAP

See Also:

Constant Field Values

PROJECTION

public static final java.lang.String PROJECTION

See Also:

Constant Field Values

EDIT

public static final java.lang.String EDIT

See Also:

Constant Field Values

COLORS

public static final java.lang.String COLORS

See Also:

Constant Field Values

BACKGROUND

public static final java.lang.String BACKGROUND

See Also:

Constant Field Values

CONTROLS

public static final java.lang.String CONTROLS

See Also:

Constant Field Values

EDIT_CURRENT

public static final java.lang.String EDIT_CURRENT

See Also:

Constant Field Values

SHOW

public static final java.lang.String SHOW

See Also:

Constant Field Values

WARNING

public static final java.lang.String WARNING

See Also:

Constant Field Values

SHOW_ALL_ON

public static final java.lang.String SHOW_ALL_ON

See Also:

Constant Field Values

SHOW_SELECTED_ON

public static final java.lang.String SHOW_SELECTED_ON

See Also:

Constant Field Values

REMOVE_FROM

public static final java.lang.String REMOVE_FROM

See Also:

Constant Field Values

RESET

public static final java.lang.String RESET

See Also:

Constant Field Values

TOTE

public static final java.lang.String TOTE

See Also:

Constant Field Values

MAX_CPU_USAGE

public static final java.lang.String MAX_CPU_USAGE

See Also:

Constant Field Values

TIME_RANGE

public static final java.lang.String TIME_RANGE

See Also:

Constant Field Values

TIME_FACTOR

public static final java.lang.String TIME_FACTOR

See Also:

Constant Field Values

UNCLASSIFIED

public static final java.lang.String UNCLASSIFIED

See Also:

Constant Field Values

RESTRICTED

public static final java.lang.String RESTRICTED

See Also:

Constant Field Values

CONFIDENTIAL

public static final java.lang.String CONFIDENTIAL

See Also:

Constant Field Values

SECRET

public static final java.lang.String SECRET

See Also:

Constant Field Values

NOT_VALID_CLASSIFICATION

public static final java.lang.String NOT_VALID_CLASSIFICATION

See Also:

Constant Field Values

CAN_NOT_ADD_ELEMENT

public static final java.lang.String CAN_NOT_ADD_ELEMENT

See Also:

Constant Field Values

SEC1

public static final java.lang.String SEC1

See Also:

Constant Field Values

SEC2

public static final java.lang.String SEC2

See Also:

Constant Field Values

SEC5

public static final java.lang.String SEC5

See Also:

Constant Field Values

SEC10

public static final java.lang.String SEC10

See Also:

Constant Field Values

SEC30

public static final java.lang.String SEC30

See Also:

Constant Field Values

MIN1

public static final java.lang.String MIN1

See Also:

Constant Field Values

MIN2

public static final java.lang.String MIN2

See Also:

Constant Field Values

MIN5

public static final java.lang.String MIN5

See Also:

Constant Field Values

MIN10

public static final java.lang.String MIN10

See Also:

Constant Field Values

MIN30

public static final java.lang.String MIN30

See Also:

Constant Field Values

PREVIEWER

public static final java.lang.String PREVIEWER

See Also:

Constant Field Values

PREVIEW_LAYER_NAME

public static final java.lang.String PREVIEW_LAYER_NAME

See Also:

Constant Field Values

MISSION_ID

public static final java.lang.String MISSION_ID

See Also:

Constant Field Values

ROLE

public static final java.lang.String ROLE

See Also:

Constant Field Values

TARGET

public static final java.lang.String TARGET

See Also:

Constant Field Values

UNIT

public static final java.lang.String UNIT

See Also:

Constant Field Values

BASE

public static final java.lang.String BASE

See Also:

Constant Field Values

AIRCRAFT

public static final java.lang.String AIRCRAFT

See Also:

Constant Field Values

NR_AIRCRAFT

public static final java.lang.String NR_AIRCRAFT

See Also:

Constant Field Values

SPEED

public static final java.lang.String SPEED

See Also:

Constant Field Values

TOT

public static final java.lang.String TOT

See Also:

Constant Field Values

OBJ

public static final java.lang.String OBJ

See Also:

Constant Field Values

PACKAGE

public static final java.lang.String PACKAGE

See Also:

Constant Field Values

ANNEX

public static final java.lang.String ANNEX

See Also:

Constant Field Values

OVERVIEW

public static final java.lang.String OVERVIEW

See Also:

Constant Field Values

MAKE_OVERVIEW

public static final java.lang.String MAKE_OVERVIEW

See Also:

Constant Field Values

INITIALIZING

public static final java.lang.String INITIALIZING

See Also:

Constant Field Values

APP_TITLE

public static final java.lang.String APP_TITLE

See Also:

Constant Field Values

DATA

public static final java.lang.String DATA

See Also:

Constant Field Values

AUTO_CENTER

public static final java.lang.String AUTO_CENTER

See Also:

Constant Field Values

AUTO_FIT

public static final java.lang.String AUTO_FIT

See Also:

Constant Field Values

AUTO_RESIZE

public static final java.lang.String AUTO_RESIZE

See Also:

Constant Field Values

AUTO_SELECT

public static final java.lang.String AUTO_SELECT

See Also:

Constant Field Values

UPDATE_POLYLINE

public static final java.lang.String UPDATE_POLYLINE

See Also:

Constant Field Values

POINTLIST_ERROR

public static final java.lang.String POINTLIST_ERROR

See Also:

Constant Field Values

POINTLIST_ERROR_MESSAGE

public static final java.lang.String POINTLIST_ERROR_MESSAGE

See Also:

Constant Field Values

Constructor Detail

TLcyLang

public TLcyLang()

Method Detail

getDefaultResourceBundle

public static final java.util.ResourceBundle getDefaultResourceBundle()

Returns the default resource bundle.

Returns:

the default resource bundle if it is loaded; null otherwise

See Also:

setDefaultResourceBundle(java.util.ResourceBundle)

setDefaultResourceBundle

public static final java.util.ResourceBundle setDefaultResourceBundle(java.util.ResourceBundle aResourceBundle)

Sets the default resource bundle to a specified resource bundle

Returns:

the previous default resource bundle if it existed; null otherwise

See Also:

getDefaultResourceBundle()

isClassTraceOn

@Deprecated
public static boolean isClassTraceOn()

Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Returns true if tracing is enabled for this class.

Returns:

true if tracing is enabled for this class, false otherwise.

setClassTraceOn

@Deprecated
public static void setClassTraceOn(boolean aClassTraceOn)

Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Enables tracing for all instances of this class. If the argument is true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.

Parameters:

aClassTraceOn - if true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.

getStringTranslator

public static ILcdStringTranslator getStringTranslator()

Returns an ILcdStringTranslator that translates strings similar to getString.

Returns:

An ILcdStringTranslator instance.

See Also:

getString(String)

getStringTranslator

public static ILcdStringTranslator getStringTranslator(java.lang.String aResourceBundleID)

Returns an ILcdStringTranslator that translates strings similar to getString

Parameters:

aResourceBundleID - the identifier for the resource bundle in which to search.

Returns:

An ILcdStringTranslator instance.

See Also:

getString(String, String)

getString

public static java.lang.String getString(java.lang.String aKey)

Returns the internationalized string corresponding to the specified key, by trying all registered resource bundles. More recently registered bundles take precedence over others. The default bundle is tried last. If no string was available for the specified key, the key itself is returned.

Parameters:

aKey - the key for which to get the internationalized string

Returns:

the internationalized string if it is available in any of the registered resource bundles; the key itself otherwise

getString

public static java.lang.String getString(java.lang.String aResourceBundleID,
                                         java.lang.String aKey)

Returns the internationalized string corresponding to the specified key from the resource bundle that is associated with the specified identifier. If no resource bundle is registered with this identifier, this method will try to find a string in the default resource bundle. If this also fails, the key itself is returned.

Parameters:

aResourceBundleID - the identifier for the resource bundle in which to search

aKey - the key for which to get the internationalized string

Returns:

the internationalized string if it is available; the key itself otherwise

See Also:

registerResourceBundle(java.lang.String, java.util.ResourceBundle)

registerResourceBundle

public static final java.util.ResourceBundle registerResourceBundle(java.lang.String aResourceBundleID,
                                                                    java.util.ResourceBundle aResourceBundle)

Registers a resource bundle using a specified ID. This ID can be used later on to retrieve strings specifically from this resource bundle, using the getString(String, String) method.

Parameters:

aResourceBundleID - the identifier for the resource bundle

aResourceBundle - the resource bundle to register

Returns:

the previous resource bundle that was registered using the specified key if there was one; null otherwise

Throws:

java.lang.IllegalArgumentException - if the key or the resource bundle is null

See Also:

unregisterResourceBundle(java.lang.String)

unregisterResourceBundle

public static final java.util.ResourceBundle unregisterResourceBundle(java.lang.String aResourceBundleID)

Unregisters the resource bundle that is associated with a specified ID.

Parameters:

aResourceBundleID - the identifier for the resource bundle to remove

Returns:

the resource bundle that was registered using the specified key if there was one; null otherwise

Throws:

java.lang.IllegalArgumentException - if the key is null

See Also:

registerResourceBundle(java.lang.String, java.util.ResourceBundle)

getResourceBundle

public static final java.util.ResourceBundle getResourceBundle(java.lang.String aResourceBundleID)

Returns the resource bundle associated with the given ID, or null if there is none.

Parameters:

aResourceBundleID - the bundle ID

Returns:

the resource bundle associated with the given ID, or null if there is none.