com.alee.managers.language

Class LanguageManager

java.lang.Object

com.alee.managers.language.LanguageManager

public final class LanguageManager
extends Object

LanguageManager allows you to easily manage application language Dictionarys. Dictionarys could be either loaded from structured xml files or added directly from the code.

Author:

Mikle Garin

See Also:

How to use LanguageManager, Language, Dictionary

Constructor Summary

Constructors

Constructor and Description
LanguageManager()

Method Summary

Modifier and Type	Method and Description
static void	addDictionary(Dictionary dictionary) Adds new Dictionary.
static void	addDictionaryListener(DictionaryListener listener) Adds new DictionaryListener.
static void	addDictionaryListener(JComponent component, DictionaryListener listener) Adds new LanguageListener.
static void	addLanguageListener(JComponent component, LanguageListener listener) Adds new LanguageListener.
static void	addLanguageListener(LanguageListener listener) Adds new LanguageListener.
static void	clearDictionaries() Removes all added dictionaries including WebLaF ones.
List<Locale>	getAllLocales() Returns List of all Locale from all Dictionarys.
static Dictionary	getDictionaries() Returns Dictionary containing all registered Dictionarys.
static Language	getLanguage() Returns currently used Language.
static String	getLanguageTitle(Language language) Returns Language title based on TranslationInformation provided within added Dictionarys.
static Locale	getLocale() Returns currently used Locale.
static String	getLocaleTitle(Locale locale) Returns Locale title based on TranslationInformation provided within added Dictionarys.
static List<Locale>	getSupportedLocales() Returns List of Locales that are supported by all Dictionarys.
static List<Locale>	getSupportedLocales(List<Locale> locales) Returns filtered List of Locales that are supported by all Dictionarys.
static void	initialize() Initializes LanguageManager settings.
static boolean	isCurrentLanguage(Language language) Returns whether the specified Language is currently used or not.
static boolean	isCurrentLocale(Locale locale) Returns whether the specified Locale is currently used or not.
static boolean	isSuportedLanguage(Language language) Returns whether or not specified Language is supported.
static boolean	isSuportedLocale(Locale locale) Returns whether or not specified Locale is supported.
static void	removeDictionary(Dictionary dictionary) Removes existing Dictionary.
static void	removeDictionaryListener(DictionaryListener listener) Removes DictionaryListener.
static void	removeDictionaryListener(JComponent component, DictionaryListener listener) Removes LanguageListener.
static void	removeLanguageListener(JComponent component, LanguageListener listener) Removes LanguageListener.
static void	removeLanguageListener(LanguageListener listener) Removes LanguageListener.
static void	setLanguage(Language language) Sets currently used Language.
static void	setLocale(Locale locale) Sets currently used Locale.

Methods inherited from class java.lang.Object

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

Constructor Detail

LanguageManager

public LanguageManager()

Method Detail

initialize

public static void initialize()

Initializes LanguageManager settings.

getDictionaries

@NotNull
public static Dictionary getDictionaries()

Returns Dictionary containing all registered Dictionarys.

Returns:

Dictionary containing all registered Dictionarys

getLanguageTitle

@NotNull
public static String getLanguageTitle(@NotNull
                                               Language language)

Returns Language title based on TranslationInformation provided within added Dictionarys.

Parameters:

language - Language to get title for

Returns:

Language title based on TranslationInformation provided within added Dictionarys

getLocaleTitle

@NotNull
public static String getLocaleTitle(@NotNull
                                             Locale locale)

Returns Locale title based on TranslationInformation provided within added Dictionarys. If no TranslationInformation can be found for Locale its default methods will be used to generate title.

Parameters:

locale - Locale to get title for

Returns:

Locale title based on TranslationInformation provided within added Dictionarys

getAllLocales

@NotNull
public List<Locale> getAllLocales()

Returns List of all Locale from all Dictionarys.

Returns:

List of all Locale from all Dictionarys

getSupportedLocales

@NotNull
public static List<Locale> getSupportedLocales()

Returns List of Locales that are supported by all Dictionarys. Language codes are used to detect whether or not specific Locale is supported. We can't say that for instance "en_US" Locale is not supported if we have "en" or "en_GB" translation available. Even though it is not strict "supported" case it is much better than having fully distinct translation for each country.

Returns:

List of Locales supported by all Dictionarys

getSupportedLocales

@NotNull
public static List<Locale> getSupportedLocales(@NotNull
                                                        List<Locale> locales)

Returns filtered List of Locales that are supported by all Dictionarys.

Parameters:

locales - List of Locales to filter

Returns:

filtered List of Locales that are supported by all Dictionarys

isSuportedLanguage

public static boolean isSuportedLanguage(@NotNull
                                         Language language)

Returns whether or not specified Language is supported.

Parameters:

language - Language

Returns:

true if specified Language is supported, false otherwise

isSuportedLocale

public static boolean isSuportedLocale(@NotNull
                                       Locale locale)

Returns whether or not specified Locale is supported.

Parameters:

locale - Locale

Returns:

true if specified Locale is supported, false otherwise

addDictionary

public static void addDictionary(@NotNull
                                 Dictionary dictionary)

Adds new Dictionary. This method call may cause a lot of UI updates depending on amount of translations contained. If added dictionary contains records with existing keys they will override previously added ones.

Parameters:

dictionary - dictionary to add

removeDictionary

public static void removeDictionary(@NotNull
                                    Dictionary dictionary)

Removes existing Dictionary. This method call may cause a lot of UI updates depending on amount of translations contained.

Parameters:

dictionary - dictionary to remove

clearDictionaries

public static void clearDictionaries()

Removes all added dictionaries including WebLaF ones. You can always restore WebLaF dictionary by calling loadDefaultDictionary () method in LanguageManager.

getLocale

@NotNull
public static Locale getLocale()

Returns currently used Locale.

Returns:

currently used Locale

isCurrentLocale

public static boolean isCurrentLocale(@NotNull
                                      Locale locale)

Returns whether the specified Locale is currently used or not.

Parameters:

locale - Locale to check

Returns:

true if the specified Locale is currently used, false otherwise

setLocale

public static void setLocale(@NotNull
                             Locale locale)

Sets currently used Locale.

Parameters:

locale - Locale to use

getLanguage

@NotNull
public static Language getLanguage()

Returns currently used Language.

Returns:

currently used Language

isCurrentLanguage

public static boolean isCurrentLanguage(@NotNull
                                        Language language)

Returns whether the specified Language is currently used or not.

Parameters:

language - Language to check

Returns:

true if the specified Language is currently used, false otherwise

setLanguage

public static void setLanguage(@NotNull
                               Language language)

Sets currently used Language.

Parameters:

language - Language to use

addLanguageListener

public static void addLanguageListener(@NotNull
                                       LanguageListener listener)

Adds new LanguageListener.

Parameters:

listener - LanguageListener to add

removeLanguageListener

public static void removeLanguageListener(@NotNull
                                          LanguageListener listener)

Removes LanguageListener.

Parameters:

listener - LanguageListener to remove

addLanguageListener

public static void addLanguageListener(@NotNull
                                       JComponent component,
                                       @NotNull
                                       LanguageListener listener)

Adds new LanguageListener.

Parameters:

component - JComponent to add LanguageListener for

listener - LanguageListener to add

removeLanguageListener

public static void removeLanguageListener(@NotNull
                                          JComponent component,
                                          @NotNull
                                          LanguageListener listener)

Removes LanguageListener.

Parameters:

component - JComponent to remove LanguageListener from

listener - LanguageListener to remove

addDictionaryListener

public static void addDictionaryListener(@NotNull
                                         DictionaryListener listener)

Adds new DictionaryListener.

Parameters:

listener - DictionaryListener to add

removeDictionaryListener

public static void removeDictionaryListener(@NotNull
                                            DictionaryListener listener)

Removes DictionaryListener.

Parameters:

listener - DictionaryListener to remove

addDictionaryListener

public static void addDictionaryListener(@NotNull
                                         JComponent component,
                                         @NotNull
                                         DictionaryListener listener)

Adds new LanguageListener.

Parameters:

component - JComponent to add LanguageListener for

listener - LanguageListener to add

removeDictionaryListener

public static void removeDictionaryListener(@NotNull
                                            JComponent component,
                                            @NotNull
                                            DictionaryListener listener)

Removes LanguageListener.

Parameters:

component - JComponent to remove LanguageListener from

listener - LanguageListener to remove