|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.alee.managers.language.LanguageManager
public final class LanguageManager
This manager allows you to quickly setup changeable lanugage onto different components and to listen to application-wide language change events. Language could be either loaded from structured xml files or added directly from the application by adding Dictionary type objects into this manager.
Be aware of the fact that all equal key-language pairs will be merged and collected into a global data map. The original list of dictionaries will be preserved and will not be modified, but all translation will be taken from global data map.
Field Summary | |
---|---|
static javax.swing.ImageIcon |
other
Unknown language icon. |
Fields inherited from interface com.alee.managers.language.LanguageConstants |
---|
ARABIC, ENGLISH, FRENCH, GERMAN, POLISH, PORTUGUESE, RUSSIAN, SPANISH |
Constructor Summary | |
---|---|
LanguageManager()
|
Method Summary | |
---|---|
static Dictionary |
addDictionary(java.lang.Class nearClass,
java.lang.String resource)
Adds new language dictionary into LanguageManager. |
static Dictionary |
addDictionary(Dictionary dictionary)
Adds new language dictionary into LanguageManager. |
static Dictionary |
addDictionary(java.io.File file)
Adds new language dictionary into LanguageManager. |
static Dictionary |
addDictionary(java.lang.String path)
Adds new language dictionary into LanguageManager. |
static Dictionary |
addDictionary(java.net.URL url)
Adds new language dictionary into LanguageManager. |
static void |
addLanguageKeyListener(java.lang.String key,
LanguageKeyListener listener)
Adds language key listener. |
static void |
addLanguageListener(java.awt.Component component,
LanguageListener listener)
Adds language listener for the specified component. |
static void |
addLanguageListener(LanguageListener listener)
Adds new language listener. |
static void |
addSupportedLanguage(java.lang.String language)
Adds supported language. |
static void |
addSupportedLanguage(java.lang.String language,
Dictionary dictionary)
Adds supported language and new dictionary. |
static void |
clearDictionaries()
Removes all added dictionaries including WebLaF ones. |
static void |
clearSupportedLanguages()
Clears list of supported languages. |
static java.lang.String |
combineWithContainerKeys(java.awt.Component component,
java.lang.String key)
Returns component language key combined with its containers keys. |
static boolean |
contains(java.lang.String key)
Returns whether specified language key exists or not. |
static java.lang.String |
get(java.awt.Component component,
java.lang.String key)
Returns component translation. |
static java.lang.String |
get(java.lang.String key)
Returns translation for the specified language key. |
static java.lang.String |
get(java.lang.String key,
java.lang.Object... data)
Returns translation for the specified language key. |
static java.lang.String |
getComponentKey(java.awt.Component component)
Returns component language key. |
static java.util.Map<java.awt.Component,LanguageListener> |
getComponentLanguageListeners()
Returns component language listeners. |
static java.lang.String |
getDefaultLanguage()
Returns default language. |
static java.lang.String |
getDefaultLanguageKey()
Returns default language key. |
static TooltipType |
getDefaultTooltipType()
Returns default tooltip type. |
static java.util.List<Dictionary> |
getDictionaries()
Returns all dictionaries added into LanguageManager. |
static Dictionary |
getDictionary(java.lang.String id)
Returns dictionary for the specified ID or null if it was not found. |
static Dictionary |
getGlobalDictionary()
Returns global dictionary that aggregates all added dictionaries. |
static java.lang.String |
getLanguage()
Returns currently used language. |
static java.lang.String |
getLanguageContainerKey(java.awt.Container container)
Returns language container key for the specified container. |
static javax.swing.ImageIcon |
getLanguageIcon(java.lang.String language)
Returns icon for the specified language. |
static java.util.Map<java.lang.String,java.util.List<LanguageKeyListener>> |
getLanguageKeyListeners()
Returns language key listeners. |
static java.util.List<LanguageListener> |
getLanguageListeners()
Returns language listeners. |
static java.lang.String |
getLanguageTitle(java.lang.String language)
Returns language title in that language translation. |
static LanguageUpdater |
getLanguageUpdater(java.awt.Component component)
Returns LanguageUpdater currently used for the specified component. |
static java.util.Locale |
getLocale(java.lang.String language)
Returns Locale for the specified language. |
static java.lang.Character |
getMnemonic(java.awt.Component component,
java.lang.String key)
Returns component mnemonic. |
static java.lang.Character |
getMnemonic(java.lang.String key)
Returns mnemonic for the specified language key. |
static Value |
getNotNullValue(java.awt.Component component,
java.lang.String key)
Returns non-null component language value. |
static Value |
getNotNullValue(java.awt.Component component,
java.lang.String key,
java.lang.String additionalKey)
Returns non-null component language value. |
static Value |
getNotNullValue(java.lang.String key)
Returns non-null value for the specified language key. |
static java.util.List<java.lang.String> |
getSupportedLanguages()
Returns list of currently supported languages. |
static java.util.List<java.lang.String> |
getSupportedLanguages(Dictionary dictionary)
Returns list of languages supported by the specified dictionary. |
static java.util.List<java.lang.String> |
getSupportedLanguages(java.lang.String dictionaryId)
Returns list of languages supported by the dictionary with the specified ID. |
static java.lang.String |
getSystemLanguageKey()
Returns system language key. |
static TooltipLanguageSupport |
getTooltipLanguageSupport()
Returns current tooltip language support. |
static Value |
getValue(java.awt.Component component,
java.lang.String key)
Returns component language value. |
static Value |
getValue(java.awt.Component component,
java.lang.String key,
java.lang.String additionalKey)
Returns component language value. |
static Value |
getValue(java.lang.String key)
Returns value for the specified language key. |
static void |
initialize()
Initializes LanguageManager settings. |
static boolean |
isCurrentLanguage(java.lang.String language)
Returns whether the specified language is currently used or not. |
static boolean |
isDictionaryAdded(Dictionary dictionary)
Returns whether specified dictionary is added or not. |
static boolean |
isDictionaryAdded(java.lang.String id)
Returns whether dictionary with the specified ID is added or not. |
static boolean |
isRegisteredComponent(java.awt.Component component)
Returns whether component is registered for language updates or not. |
static void |
loadDefaultDictionary()
Loads default WebLaF dictionary. |
static Dictionary |
loadDictionary(java.lang.Class nearClass,
java.lang.String resource)
Returns dictionary loaded from the specified location near class. |
static Dictionary |
loadDictionary(java.io.File file)
Returns dictionary loaded from the specified file. |
static Dictionary |
loadDictionary(java.lang.String path)
Returns dictionary loaded from the specified file path. |
static Dictionary |
loadDictionary(java.net.URL url)
Returns dictionary loaded from the specified URL. |
static java.lang.Object[] |
parseData(java.lang.Object... data)
Returns language data transformed into its final form. |
static void |
registerComponent(java.awt.Component component,
java.lang.String key,
java.lang.Object... data)
Registers component for language updates. |
static void |
registerLanguageContainer(java.awt.Container container,
java.lang.String key)
Registers language container key. |
static void |
registerLanguageUpdater(java.awt.Component component,
LanguageUpdater updater)
Registers custom LanguageUpdater for specific component. |
static void |
registerLanguageUpdater(LanguageUpdater updater)
Register custom LanguageUpdater. |
static Dictionary |
removeDictionary(Dictionary dictionary)
Removes dictionary from LanguageManager. |
static Dictionary |
removeDictionary(java.lang.String id)
Removes dictionary from LanguageManager. |
static void |
removeLanguageKeyListener(LanguageKeyListener listener)
Removes language key listener |
static void |
removeLanguageKeyListeners(java.lang.String key)
Removes language key listener. |
static void |
removeLanguageListener(java.awt.Component component)
Removes language listener from the specified component. |
static void |
removeLanguageListener(LanguageListener listener)
Removes language listener. |
static void |
removeSupportedLanguage(java.lang.String language)
Removes supported language. |
static void |
setDefaultLanguage(java.lang.String lang)
Sets default language. |
static void |
setDefaultTooltipType(TooltipType defaultTooltipType)
Sets default tooltip type. |
static void |
setLanguage(java.lang.String language)
Sets currently used language. |
static javax.swing.ImageIcon |
setLanguageIcon(java.lang.String language,
javax.swing.ImageIcon icon)
Sets icon for the specified language. |
static void |
setSupportedLanguages(java.util.Collection<java.lang.String> supportedLanguages)
Sets supported languages. |
static void |
setSupportedLanguages(java.lang.String... supportedLanguages)
Sets supported languages. |
static void |
setTooltipLanguageSupport(TooltipLanguageSupport support)
Sets tooltip language support. |
static void |
switchLanguage()
Switches current language to next language in supported languages list. |
static void |
unregisterComponent(java.awt.Component component)
Unregisters component from language updates. |
static void |
unregisterLanguageContainer(java.awt.Container container)
Unregisters language container key. |
static void |
unregisterLanguageUpdater(java.awt.Component component)
Unregisters component's custom LanguageUpdater. |
static void |
unregisterLanguageUpdater(LanguageUpdater updater)
Unregister custom LanguageUpdater. |
static void |
updateComponent(java.awt.Component component,
java.lang.Object... data)
Forces component language update. |
static void |
updateComponent(java.awt.Component component,
java.lang.String key,
java.lang.Object... data)
Forces component language update. |
static void |
updateComponents()
Forces full language update for all registered components. |
static void |
updateComponents(java.util.List<java.lang.String> keys)
Forces language update for components with the specified keys. |
static void |
updateComponentsTree(java.awt.Component component)
Updates components tree language keys according to their container keys. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final javax.swing.ImageIcon other
Constructor Detail |
---|
public LanguageManager()
Method Detail |
---|
public static void initialize()
public static void loadDefaultDictionary()
public static java.util.List<java.lang.String> getSupportedLanguages()
public static void setSupportedLanguages(java.util.Collection<java.lang.String> supportedLanguages)
supportedLanguages
- collection of supported languagespublic static void setSupportedLanguages(java.lang.String... supportedLanguages)
supportedLanguages
- supported languagespublic static void addSupportedLanguage(java.lang.String language)
language
- new supported languagepublic static void addSupportedLanguage(java.lang.String language, Dictionary dictionary)
language
- new supported languagedictionary
- new dictionarypublic static void removeSupportedLanguage(java.lang.String language)
language
- supported language to removepublic static void clearSupportedLanguages()
public static void registerComponent(java.awt.Component component, java.lang.String key, java.lang.Object... data)
component
- component to registerkey
- component language keydata
- component language dataLanguageUpdater
public static void updateComponentsTree(java.awt.Component component)
component
- component to updatepublic static void unregisterComponent(java.awt.Component component)
component
- component to unregisterpublic static boolean isRegisteredComponent(java.awt.Component component)
component
- component to check
public static java.lang.String getComponentKey(java.awt.Component component)
component
- component to retrieve language key for
public static void registerLanguageUpdater(LanguageUpdater updater)
updater
- new LanguageUpdaterLanguageUpdater
public static void unregisterLanguageUpdater(LanguageUpdater updater)
updater
- LanguageUpdater to unregisterpublic static void registerLanguageUpdater(java.awt.Component component, LanguageUpdater updater)
component
- component to register LanguageUpdater forupdater
- custom LanguageUpdaterpublic static void unregisterLanguageUpdater(java.awt.Component component)
component
- component to unregister custom LanguageUpdater frompublic static LanguageUpdater getLanguageUpdater(java.awt.Component component)
component
- component to retrieve LanguageUpdater for
public static void updateComponents()
public static void updateComponents(java.util.List<java.lang.String> keys)
keys
- language keys of the components to updatepublic static void updateComponent(java.awt.Component component, java.lang.Object... data)
component
- component to updatedata
- component language datapublic static void updateComponent(java.awt.Component component, java.lang.String key, java.lang.Object... data)
component
- component to updatekey
- component language keydata
- component language datapublic static java.lang.Object[] parseData(java.lang.Object... data)
data
- language data to process
public static javax.swing.ImageIcon getLanguageIcon(java.lang.String language)
language
- language to retrieve icon for
public static javax.swing.ImageIcon setLanguageIcon(java.lang.String language, javax.swing.ImageIcon icon)
language
- language to set icon foricon
- language icon
public static java.lang.String getLanguageTitle(java.lang.String language)
language
- language to get title for
public static TooltipLanguageSupport getTooltipLanguageSupport()
TooltipLanguageSupport
,
SwingTooltipLanguageSupport
public static void setTooltipLanguageSupport(TooltipLanguageSupport support)
support
- new tooltip language supportTooltipLanguageSupport
,
SwingTooltipLanguageSupport
public static TooltipType getDefaultTooltipType()
TooltipType
public static void setDefaultTooltipType(TooltipType defaultTooltipType)
defaultTooltipType
- new default tooltip typeTooltipType
public static java.lang.String getDefaultLanguage()
public static void setDefaultLanguage(java.lang.String lang)
lang
- new default languagepublic static java.lang.String getLanguage()
public static boolean isCurrentLanguage(java.lang.String language)
language
- language to check
public static void setLanguage(java.lang.String language)
language
- new languagepublic static void switchLanguage()
public static java.util.Locale getLocale(java.lang.String language)
language
- language to return Locale for
public static Dictionary getGlobalDictionary()
public static java.util.List<Dictionary> getDictionaries()
public static Dictionary loadDictionary(java.lang.Class nearClass, java.lang.String resource)
nearClass
- class near which dictionary XML is locatedresource
- dictionary XML file
public static Dictionary loadDictionary(java.net.URL url)
url
- URL to load dictionary from
public static Dictionary loadDictionary(java.lang.String path)
path
- file path to load dictionary from
public static Dictionary loadDictionary(java.io.File file)
file
- file to load dictionary from
public static Dictionary addDictionary(java.lang.Class nearClass, java.lang.String resource)
nearClass
- class to look near for the dictionary fileresource
- path to dictionary file
public static Dictionary addDictionary(java.net.URL url)
url
- dictionary file url
public static Dictionary addDictionary(java.lang.String path)
path
- path to dictionary file
public static Dictionary addDictionary(java.io.File file)
file
- dictionary file
public static Dictionary addDictionary(Dictionary dictionary)
dictionary
- dictionary to add
public static Dictionary removeDictionary(java.lang.String id)
id
- ID of the dictionary to remove
public static Dictionary removeDictionary(Dictionary dictionary)
dictionary
- dictionary to remove
public static boolean isDictionaryAdded(Dictionary dictionary)
dictionary
- dictionary to look for
public static boolean isDictionaryAdded(java.lang.String id)
id
- ID of the dictionary to look for
public static Dictionary getDictionary(java.lang.String id)
id
- ID of the dictionary to look for
public static void clearDictionaries()
loadDefaultDictionary()
public static java.util.List<java.lang.String> getSupportedLanguages(java.lang.String dictionaryId)
dictionaryId
- dictionary ID
public static java.util.List<java.lang.String> getSupportedLanguages(Dictionary dictionary)
dictionary
- dictionary
public static java.lang.String get(java.lang.String key)
key
- language key to retrieve translation for
public static java.lang.String get(java.lang.String key, java.lang.Object... data)
key
- language key to retrieve translation fordata
- language data
public static java.lang.Character getMnemonic(java.lang.String key)
key
- language key to retrieve mnemonic for
public static Value getValue(java.lang.String key)
key
- language key to retrieve value for
public static Value getNotNullValue(java.lang.String key)
key
- language key to retrieve value for
public static boolean contains(java.lang.String key)
key
- language key to check
public static java.lang.String get(java.awt.Component component, java.lang.String key)
component
- component to retrieve translation forkey
- component language key
public static java.lang.Character getMnemonic(java.awt.Component component, java.lang.String key)
component
- component to retrieve mnemonic forkey
- component language key
public static Value getValue(java.awt.Component component, java.lang.String key)
component
- component to retrieve language value forkey
- component language key
public static Value getNotNullValue(java.awt.Component component, java.lang.String key)
component
- component to retrieve language value forkey
- component language key
public static Value getValue(java.awt.Component component, java.lang.String key, java.lang.String additionalKey)
component
- component to retrieve language value forkey
- component language keyadditionalKey
- additional language key
public static Value getNotNullValue(java.awt.Component component, java.lang.String key, java.lang.String additionalKey)
component
- component to retrieve language value forkey
- component language keyadditionalKey
- additional language key
public static java.lang.String combineWithContainerKeys(java.awt.Component component, java.lang.String key)
component
- component to retrieve language key forkey
- component language key
public static void registerLanguageContainer(java.awt.Container container, java.lang.String key)
container
- container to registerkey
- language container keypublic static void unregisterLanguageContainer(java.awt.Container container)
container
- container to unregisterpublic static java.lang.String getLanguageContainerKey(java.awt.Container container)
container
- container to retrieve language container key for
public static java.lang.String getDefaultLanguageKey()
public static java.lang.String getSystemLanguageKey()
public static java.util.List<LanguageListener> getLanguageListeners()
public static void addLanguageListener(LanguageListener listener)
listener
- new language listenerpublic static void removeLanguageListener(LanguageListener listener)
listener
- language listener to removepublic static java.util.Map<java.awt.Component,LanguageListener> getComponentLanguageListeners()
public static void addLanguageListener(java.awt.Component component, LanguageListener listener)
component
- component to add language listener forlistener
- new language listenerpublic static void removeLanguageListener(java.awt.Component component)
component
- component to remove language listener frompublic static java.util.Map<java.lang.String,java.util.List<LanguageKeyListener>> getLanguageKeyListeners()
public static void addLanguageKeyListener(java.lang.String key, LanguageKeyListener listener)
key
- language key to register listener forlistener
- new language key listenerpublic static void removeLanguageKeyListener(LanguageKeyListener listener)
listener
- language key listener to removepublic static void removeLanguageKeyListeners(java.lang.String key)
key
- language key to remove listeners for
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |