TLcyLang (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.lucy.util.language.TLcyLang

```
public class TLcyLang
extends 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 String`	`AIRCRAFT`
`static String`	`ANNEX`
`static String`	`APP_TITLE`
`static String`	`APPLY`
`static String`	`AUTO_CENTER`
`static String`	`AUTO_FIT`
`static String`	`AUTO_RESIZE`
`static String`	`AUTO_SELECT`
`static String`	`BACKGROUND`
`static String`	`BASE`
`static String`	`CAN_NOT_ADD_ELEMENT`
`static String`	`CANCEL`
`static String`	`CLOSE`
`static String`	`COLORS`
`static String`	`CONFIDENTIAL`
`static String`	`CONTROLS`
`static String`	`DATA`
`static String`	`DELETE`
`static String`	`EDIT`
`static String`	`EDIT_CURRENT`
`static String`	`EXIT`
`static String`	`FILE`
`static String`	`INITIALIZING`
`static String`	`LASTCLICK`
`static String`	`LOAD`
`static String`	`MAKE_OVERVIEW`
`static String`	`MAP`
`static String`	`MAX_CPU_USAGE`
`static String`	`MIN1`
`static String`	`MIN10`
`static String`	`MIN2`
`static String`	`MIN30`
`static String`	`MIN5`
`static String`	`MISSION_ID`
`static String`	`NEW`
`static String`	`NEW_MAP`
`static String`	`NOT_VALID_CLASSIFICATION`
`static String`	`NR_AIRCRAFT`
`static String`	`OBJ`
`static String`	`OK`
`static String`	`OPEN`
`static String`	`OVERVIEW`
`static String`	`PACKAGE`
`static String`	`POINTLIST_ERROR`
`static String`	`POINTLIST_ERROR_MESSAGE`
`static String`	`PREVIEW_LAYER_NAME`
`static String`	`PREVIEWER`
`static String`	`PROJECTION`
`static String`	`REMOVE_FROM`
`static String`	`RESET`
`static String`	`RESTRICTED`
`static String`	`ROLE`
`static String`	`SAVE`
`static String`	`SAVE_AS`
`static String`	`SEC1`
`static String`	`SEC10`
`static String`	`SEC2`
`static String`	`SEC30`
`static String`	`SEC5`
`static String`	`SECRET`
`static String`	`SHOW`
`static String`	`SHOW_ALL_ON`
`static String`	`SHOW_SELECTED_ON`
`static String`	`SPEED`
`static String`	`TARGET`
`static String`	`TIME_FACTOR`
`static String`	`TIME_RANGE`
`static String`	`TOT`
`static String`	`TOTE`
`static String`	`UNCLASSIFIED`
`static String`	`UNIT`
`static String`	`UPDATE_POLYLINE`
`static String`	`WARNING`

Constructor Summary

Constructors
Constructor and Description

TLcyLang()

Constructors
Constructor and Description
`TLcyLang()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static ResourceBundle`	`getDefaultResourceBundle()` Returns the default resource bundle.
`static ResourceBundle`	`getResourceBundle(String aResourceBundleID)` Returns the resource bundle associated with the given ID, or `null` if there is none.
`static String`	`getString(String aKey)` Returns the internationalized string corresponding to the specified key, by trying all registered resource bundles.
`static String`	`getString(String aResourceBundleID, 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(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 ResourceBundle`	`registerResourceBundle(String aResourceBundleID, 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 ResourceBundle`	`setDefaultResourceBundle(ResourceBundle aResourceBundle)` Sets the default resource bundle to a specified resource bundle
`static ResourceBundle`	`unregisterResourceBundle(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 String NEW_MAP
```
    See Also:
    
    Constant Field Values
  - LASTCLICK
```
public static final String LASTCLICK
```
    See Also:
    
    Constant Field Values
  - FILE
```
public static final String FILE
```
    See Also:
    
    Constant Field Values
  - NEW
```
public static final String NEW
```
    See Also:
    
    Constant Field Values
  - OPEN
```
public static final String OPEN
```
    See Also:
    
    Constant Field Values
  - LOAD
```
public static final String LOAD
```
    See Also:
    
    Constant Field Values
  - SAVE
```
public static final String SAVE
```
    See Also:
    
    Constant Field Values
  - SAVE_AS
```
public static final String SAVE_AS
```
    See Also:
    
    Constant Field Values
  - CLOSE
```
public static final String CLOSE
```
    See Also:
    
    Constant Field Values
  - DELETE
```
public static final String DELETE
```
    See Also:
    
    Constant Field Values
  - EXIT
```
public static final String EXIT
```
    See Also:
    
    Constant Field Values
  - OK
```
public static final String OK
```
    See Also:
    
    Constant Field Values
  - CANCEL
```
public static final String CANCEL
```
    See Also:
    
    Constant Field Values
  - APPLY
```
public static final String APPLY
```
    See Also:
    
    Constant Field Values
  - MAP
```
public static final String MAP
```
    See Also:
    
    Constant Field Values
  - PROJECTION
```
public static final String PROJECTION
```
    See Also:
    
    Constant Field Values
  - EDIT
```
public static final String EDIT
```
    See Also:
    
    Constant Field Values
  - COLORS
```
public static final String COLORS
```
    See Also:
    
    Constant Field Values
  - BACKGROUND
```
public static final String BACKGROUND
```
    See Also:
    
    Constant Field Values
  - CONTROLS
```
public static final String CONTROLS
```
    See Also:
    
    Constant Field Values
  - EDIT_CURRENT
```
public static final String EDIT_CURRENT
```
    See Also:
    
    Constant Field Values
  - SHOW
```
public static final String SHOW
```
    See Also:
    
    Constant Field Values
  - WARNING
```
public static final String WARNING
```
    See Also:
    
    Constant Field Values
  - SHOW_ALL_ON
```
public static final String SHOW_ALL_ON
```
    See Also:
    
    Constant Field Values
  - SHOW_SELECTED_ON
```
public static final String SHOW_SELECTED_ON
```
    See Also:
    
    Constant Field Values
  - REMOVE_FROM
```
public static final String REMOVE_FROM
```
    See Also:
    
    Constant Field Values
  - RESET
```
public static final String RESET
```
    See Also:
    
    Constant Field Values
  - TOTE
```
public static final String TOTE
```
    See Also:
    
    Constant Field Values
  - MAX_CPU_USAGE
```
public static final String MAX_CPU_USAGE
```
    See Also:
    
    Constant Field Values
  - TIME_RANGE
```
public static final String TIME_RANGE
```
    See Also:
    
    Constant Field Values
  - TIME_FACTOR
```
public static final String TIME_FACTOR
```
    See Also:
    
    Constant Field Values
  - UNCLASSIFIED
```
public static final String UNCLASSIFIED
```
    See Also:
    
    Constant Field Values
  - RESTRICTED
```
public static final String RESTRICTED
```
    See Also:
    
    Constant Field Values
  - CONFIDENTIAL
```
public static final String CONFIDENTIAL
```
    See Also:
    
    Constant Field Values
  - SECRET
```
public static final String SECRET
```
    See Also:
    
    Constant Field Values
  - NOT_VALID_CLASSIFICATION
```
public static final String NOT_VALID_CLASSIFICATION
```
    See Also:
    
    Constant Field Values
  - CAN_NOT_ADD_ELEMENT
```
public static final String CAN_NOT_ADD_ELEMENT
```
    See Also:
    
    Constant Field Values
  - SEC1
```
public static final String SEC1
```
    See Also:
    
    Constant Field Values
  - SEC2
```
public static final String SEC2
```
    See Also:
    
    Constant Field Values
  - SEC5
```
public static final String SEC5
```
    See Also:
    
    Constant Field Values
  - SEC10
```
public static final String SEC10
```
    See Also:
    
    Constant Field Values
  - SEC30
```
public static final String SEC30
```
    See Also:
    
    Constant Field Values
  - MIN1
```
public static final String MIN1
```
    See Also:
    
    Constant Field Values
  - MIN2
```
public static final String MIN2
```
    See Also:
    
    Constant Field Values
  - MIN5
```
public static final String MIN5
```
    See Also:
    
    Constant Field Values
  - MIN10
```
public static final String MIN10
```
    See Also:
    
    Constant Field Values
  - MIN30
```
public static final String MIN30
```
    See Also:
    
    Constant Field Values
  - PREVIEWER
```
public static final String PREVIEWER
```
    See Also:
    
    Constant Field Values
  - PREVIEW_LAYER_NAME
```
public static final String PREVIEW_LAYER_NAME
```
    See Also:
    
    Constant Field Values
  - MISSION_ID
```
public static final String MISSION_ID
```
    See Also:
    
    Constant Field Values
  - ROLE
```
public static final String ROLE
```
    See Also:
    
    Constant Field Values
  - TARGET
```
public static final String TARGET
```
    See Also:
    
    Constant Field Values
  - UNIT
```
public static final String UNIT
```
    See Also:
    
    Constant Field Values
  - BASE
```
public static final String BASE
```
    See Also:
    
    Constant Field Values
  - AIRCRAFT
```
public static final String AIRCRAFT
```
    See Also:
    
    Constant Field Values
  - NR_AIRCRAFT
```
public static final String NR_AIRCRAFT
```
    See Also:
    
    Constant Field Values
  - SPEED
```
public static final String SPEED
```
    See Also:
    
    Constant Field Values
  - TOT
```
public static final String TOT
```
    See Also:
    
    Constant Field Values
  - OBJ
```
public static final String OBJ
```
    See Also:
    
    Constant Field Values
  - PACKAGE
```
public static final String PACKAGE
```
    See Also:
    
    Constant Field Values
  - ANNEX
```
public static final String ANNEX
```
    See Also:
    
    Constant Field Values
  - OVERVIEW
```
public static final String OVERVIEW
```
    See Also:
    
    Constant Field Values
  - MAKE_OVERVIEW
```
public static final String MAKE_OVERVIEW
```
    See Also:
    
    Constant Field Values
  - INITIALIZING
```
public static final String INITIALIZING
```
    See Also:
    
    Constant Field Values
  - APP_TITLE
```
public static final String APP_TITLE
```
    See Also:
    
    Constant Field Values
  - DATA
```
public static final String DATA
```
    See Also:
    
    Constant Field Values
  - AUTO_CENTER
```
public static final String AUTO_CENTER
```
    See Also:
    
    Constant Field Values
  - AUTO_FIT
```
public static final String AUTO_FIT
```
    See Also:
    
    Constant Field Values
  - AUTO_RESIZE
```
public static final String AUTO_RESIZE
```
    See Also:
    
    Constant Field Values
  - AUTO_SELECT
```
public static final String AUTO_SELECT
```
    See Also:
    
    Constant Field Values
  - UPDATE_POLYLINE
```
public static final String UPDATE_POLYLINE
```
    See Also:
    
    Constant Field Values
  - POINTLIST_ERROR
```
public static final String POINTLIST_ERROR
```
    See Also:
    
    Constant Field Values
  - POINTLIST_ERROR_MESSAGE
```
public static final String POINTLIST_ERROR_MESSAGE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TLcyLang
```
public TLcyLang()
```
- Method Detail
  - getDefaultResourceBundle
```
public static final 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 ResourceBundle setDefaultResourceBundle(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(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 String getString(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 String getString(String aResourceBundleID,
                               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 ResourceBundle registerResourceBundle(String aResourceBundleID,
                                                          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:
    
    IllegalArgumentException - if the key or the resource bundle is null
    
    See Also:
    
    unregisterResourceBundle(java.lang.String)
  - unregisterResourceBundle
```
public static final ResourceBundle unregisterResourceBundle(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:
    
    IllegalArgumentException - if the key is null
    
    See Also:
    
    registerResourceBundle(java.lang.String, java.util.ResourceBundle)
  - getResourceBundle
```
public static final ResourceBundle getResourceBundle(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.

LuciadLightspeedClass TLcyLang

Internationalization

Adding bundles

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NEW_MAP

LASTCLICK

FILE

NEW

OPEN

LOAD

SAVE

SAVE_AS

CLOSE

DELETE

EXIT

OK

CANCEL

APPLY

MAP

PROJECTION

EDIT

COLORS

BACKGROUND

CONTROLS

EDIT_CURRENT

SHOW

WARNING

SHOW_ALL_ON

SHOW_SELECTED_ON

REMOVE_FROM

RESET

TOTE

MAX_CPU_USAGE

TIME_RANGE

TIME_FACTOR

UNCLASSIFIED

RESTRICTED

CONFIDENTIAL

SECRET

NOT_VALID_CLASSIFICATION

CAN_NOT_ADD_ELEMENT

SEC1

SEC2

SEC5

SEC10

SEC30

MIN1

MIN2

MIN5

MIN10

MIN30

PREVIEWER

PREVIEW_LAYER_NAME

MISSION_ID

ROLE

TARGET

UNIT

BASE

AIRCRAFT

NR_AIRCRAFT

SPEED

TOT

OBJ

PACKAGE

ANNEX

OVERVIEW

MAKE_OVERVIEW

INITIALIZING

APP_TITLE

DATA

AUTO_CENTER

AUTO_FIT

AUTO_RESIZE

AUTO_SELECT

UPDATE_POLYLINE

POINTLIST_ERROR