com.alee.managers.language

Class UILanguageManager

java.lang.Object

com.alee.managers.language.UILanguageManager

public final class UILanguageManager
extends Object

UILanguageManager is an extension over LanguageManager that offers extensive Swing components translation support. UILanguageManager provides various ways of translating components that are registered within this manager and also dynamically updating their translation upon Language or Dictionary changes.

Author:

Mikle Garin

See Also:

How to use LanguageManager, LanguageManager, Language, Dictionary, LanguageUpdater

Constructor Summary

Constructors

Constructor and Description
UILanguageManager()

Method Summary

Modifier and Type	Method and Description
static void	addDictionaryListener(JComponent component, DictionaryListener listener) Adds new DictionaryListener tied to the specified JComponent.
static void	addLanguageListener(JComponent component, LanguageListener listener) Adds new LanguageListener tied to the specified JComponent.
static String	getComponentKey(JComponent component) Returns language key which was used to register specified component.
static String	getInitialText(String key, Object... data) Returns proper initial component text.
static Icon	getLanguageIcon(Language language) Returns Icon for the specified Language.
static LanguageUpdater	getLanguageUpdater(Class<? extends JComponent> clazz) Returns LanguageUpdater currently used for the specified component class.
static LanguageUpdater	getLanguageUpdater(JComponent component) Returns LanguageUpdater currently used for the specified component.
static Icon	getLocaleIcon(Locale locale) Returns Icon for the specified Locale.
static void	initialize() Initializes LanguageManager settings.
static boolean	isCheckComponentsTextForTranslations() Returns whether or not text-containing components should check passed text for translation or not.
static boolean	isRegisteredComponent(JComponent component) Returns whether component is registered for language updates or not.
static void	registerComponent(JComponent component, String key, Object... data) Registers component for language updates.
static void	registerInitialLanguage(LanguageMethods component, String key, Object... data) Registers proper initial component language key.
static void	registerLanguageUpdater(JComponent component, LanguageUpdater updater) Registers custom LanguageUpdater for specific JComponent.
static void	registerLanguageUpdater(LanguageUpdater updater) Register custom LanguageUpdater.
static void	removeDictionaryListener(JComponent component, DictionaryListener listener) Removes DictionaryListener tied to the specified JComponent.
static void	removeDictionaryListeners(JComponent component) Removes all DictionaryListeners tied to the specified JComponent.
static void	removeLanguageListener(JComponent component, LanguageListener listener) Removes LanguageListener tied to the specified JComponent.
static void	removeLanguageListeners(JComponent component) Removes all LanguageListeners tied to the specified JComponent.
static void	setCheckComponentsTextForTranslations(boolean check) Sets whether or not text-containing components should check passed text for translation or not.
static Icon	setLanguageIcon(Language language, Icon icon) Sets Icon for the specified Language.
static Icon	setLocaleIcon(Locale locale, Icon icon) Sets Icon for the specified Locale.
static void	unregisterComponent(JComponent component) Unregisters component from language updates.
static void	unregisterLanguageUpdater(JComponent component) Unregisters JComponent's custom LanguageUpdater.
static void	unregisterLanguageUpdater(LanguageUpdater updater) Unregister custom LanguageUpdater.
static void	updateComponent(JComponent component, Object... data) Forces JComponent language update.
static void	updateComponent(JComponent component, String key, Object... data) Forces JComponent language update.
static void	updateComponents() Forces full language update for all registered components.
static void	updateComponents(Set<String> keys) Forces language update for components with the specified keys.

Methods inherited from class java.lang.Object

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

Constructor Detail

UILanguageManager

public UILanguageManager()

Method Detail

initialize

public static void initialize()

Initializes LanguageManager settings.

isCheckComponentsTextForTranslations

public static boolean isCheckComponentsTextForTranslations()

Returns whether or not text-containing components should check passed text for translation or not.

Returns:

true if text-containing components should check passed text for translation, false otherwise

setCheckComponentsTextForTranslations

public static void setCheckComponentsTextForTranslations(boolean check)

Sets whether or not text-containing components should check passed text for translation or not.

Parameters:

check - whether or not text-containing components should check passed text for translation or not

getLanguageIcon

@NotNull
public static Icon getLanguageIcon(@NotNull
                                            Language language)

Returns Icon for the specified Language. By default there are Icons only for languages supported by WebLaF.

Parameters:

language - language to retrieve Icon for

Returns:

Icon for the specified Language

getLocaleIcon

@NotNull
public static Icon getLocaleIcon(@NotNull
                                          Locale locale)

Returns Icon for the specified Locale. By default there are Icons only for languages supported by WebLaF.

Parameters:

locale - Locale to retrieve Icon for

Returns:

Icon for the specified Locale

setLanguageIcon

@Nullable
public static Icon setLanguageIcon(@NotNull
                                             Language language,
                                             @Nullable
                                             Icon icon)

Sets Icon for the specified Language.

Parameters:

language - Language to set Icon for

icon - Icon

Returns:

Icon previously set for this Language

setLocaleIcon

@Nullable
public static Icon setLocaleIcon(@NotNull
                                           Locale locale,
                                           @Nullable
                                           Icon icon)

Sets Icon for the specified Locale.

Parameters:

locale - Locale to set Icon for

icon - Icon

Returns:

Icon previously set for this Locale

registerLanguageUpdater

public static void registerLanguageUpdater(@NotNull
                                           LanguageUpdater updater)

Register custom LanguageUpdater. Each LanguageUpdater is tied to a certain component class and can perform language updates only for that component type.

Parameters:

updater - new LanguageUpdater

See Also:

LanguageUpdater

unregisterLanguageUpdater

public static void unregisterLanguageUpdater(@NotNull
                                             LanguageUpdater updater)

Unregister custom LanguageUpdater.

Parameters:

updater - LanguageUpdater to unregister

registerLanguageUpdater

public static void registerLanguageUpdater(@NotNull
                                           JComponent component,
                                           @NotNull
                                           LanguageUpdater updater)

Registers custom LanguageUpdater for specific JComponent.

Parameters:

component - JComponent to register LanguageUpdater for

updater - custom LanguageUpdater

unregisterLanguageUpdater

public static void unregisterLanguageUpdater(@NotNull
                                             JComponent component)

Unregisters JComponent's custom LanguageUpdater.

Parameters:

component - JComponent to unregister custom LanguageUpdater from

getLanguageUpdater

@NotNull
public static LanguageUpdater getLanguageUpdater(@NotNull
                                                          JComponent component)

Returns LanguageUpdater currently used for the specified component. This method might return either a custom per-component LanguageUpdater or global LanguageUpdater. In case LanguageUpdater cannot be found for the specified component an exception will be thrown.

Parameters:

component - component to retrieve LanguageUpdater for

Returns:

LanguageUpdater currently used for the specified component

getLanguageUpdater

@NotNull
public static LanguageUpdater getLanguageUpdater(@NotNull
                                                          Class<? extends JComponent> clazz)

Returns LanguageUpdater currently used for the specified component class. In case LanguageUpdater cannot be found for the specified component an exception will be thrown.

Parameters:

clazz - component class to retrieve LanguageUpdater for

Returns:

LanguageUpdater currently used for the specified component class

getInitialText

@Nullable
public static String getInitialText(@Nullable
                                              String key,
                                              @NotNull
                                              Object... data)

Returns proper initial component text.

Parameters:

key - text provided into component constructor

data - language data, may not be passed

Returns:

proper initial component text

registerInitialLanguage

public static void registerInitialLanguage(@NotNull
                                           LanguageMethods component,
                                           @Nullable
                                           String key,
                                           @NotNull
                                           Object... data)

Registers proper initial component language key.

Parameters:

component - translated component

key - text provided into component constructor

data - language data, may not be passed

registerComponent

public static void registerComponent(@NotNull
                                     JComponent component,
                                     @NotNull
                                     String key,
                                     @Nullable
                                     Object... data)

Registers component for language updates. This component language will be automatically updated using existing LanguageUpdater.

Parameters:

component - component to register

key - component language key

data - component language data

See Also:

LanguageUpdater

unregisterComponent

public static void unregisterComponent(@NotNull
                                       JComponent component)

Unregisters component from language updates.

Parameters:

component - component to unregister

isRegisteredComponent

public static boolean isRegisteredComponent(@NotNull
                                            JComponent component)

Returns whether component is registered for language updates or not.

Parameters:

component - component to check

Returns:

true if component is registered for language updates, false otherwise

getComponentKey

@Nullable
public static String getComponentKey(@NotNull
                                               JComponent component)

Returns language key which was used to register specified component.

Parameters:

component - component to retrieve language key for

Returns:

language key which was used to register specified component

updateComponents

public static void updateComponents()

Forces full language update for all registered components.

updateComponents

public static void updateComponents(@NotNull
                                    Set<String> keys)

Forces language update for components with the specified keys.

Parameters:

keys - language keys of the components to update

updateComponent

public static void updateComponent(@NotNull
                                   JComponent component,
                                   @Nullable
                                   Object... data)

Forces JComponent language update.

Parameters:

component - JComponent to update

data - new formatting data

updateComponent

public static void updateComponent(@NotNull
                                   JComponent component,
                                   @NotNull
                                   String key,
                                   @Nullable
                                   Object... data)

Forces JComponent language update.

Parameters:

component - JComponent to update

key - new language key

data - new formatting data

addLanguageListener

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

Adds new LanguageListener tied to the specified JComponent. Unlike LanguageManager.addLanguageListener(LanguageListener) using this method will not store hard references to the LanguageListener outside of the JComponent to avoid any mermory leaks. So if specified JComponent will for instance be destroyed provided LanguageListener will also be destroyed.

Parameters:

component - JComponent to tie LanguageListener to

listener - LanguageListener to add

removeLanguageListener

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

Removes LanguageListener tied to the specified JComponent.

Parameters:

component - JComponent to remove tied LanguageListener from

listener - LanguageListener to remove

removeLanguageListeners

public static void removeLanguageListeners(@NotNull
                                           JComponent component)

Removes all LanguageListeners tied to the specified JComponent.

Parameters:

component - JComponent to remove all tied LanguageListeners from

addDictionaryListener

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

Adds new DictionaryListener tied to the specified JComponent. Unlike LanguageManager.addDictionaryListener(DictionaryListener) using this method will not store hard references to the DictionaryListener outside of the JComponent to avoid any mermory leaks. So if specified JComponent will for instance be destroyed provided DictionaryListener will also be destroyed.

Parameters:

component - JComponent to tie DictionaryListener to

listener - DictionaryListener to add

removeDictionaryListener

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

Removes DictionaryListener tied to the specified JComponent.

Parameters:

component - JComponent to remove tied DictionaryListener from

listener - DictionaryListener to remove

removeDictionaryListeners

public static void removeDictionaryListeners(@NotNull
                                             JComponent component)

Removes all DictionaryListeners tied to the specified JComponent.

Parameters:

component - JComponent to remove all tied DictionaryListeners from