Package com.inductiveautomation.ignition.designer.i18n

Class DesignerLocalizationManager

java.lang.Object

com.inductiveautomation.ignition.client.model.ClientLocalizationManager

com.inductiveautomation.ignition.designer.i18n.DesignerLocalizationManager

All Implemented Interfaces:

MutableTranslationPackage, TranslationPackage, Serializable

public class DesignerLocalizationManager
extends ClientLocalizationManager
implements MutableTranslationPackage

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREVIEW_LOCALE

Fields inherited from class com.inductiveautomation.ignition.client.model.ClientLocalizationManager

_instance, EVENT_AVAILABLE_LOCALES, EVENT_TRANSLATIONS

Method Summary

Modifier and Type	Method	Description
void	addLocaleListener(LocaleListener listener)
void	addTerm(String term)	Ensures that the specified key is in the translation package.
void	addTranslation(String key, Locale locale, String value)	Sets a translation for the specified key and locale.
void	addTranslations(String key, TranslationMap translations)	Sets all of the translations for a specific key.
protected boolean	areLocaleSetsDifferent(Collection<Locale> a, Collection<Locale> b)
boolean	areSettingsDefined(Locale locale)
TranslationPackageDiff	createDiff()
void	ensureLocaleExists(Locale locale)	Verifies that the locale is present, adding it if necessary.
protected void	fireLocaleChanged()
static DesignerLocalizationManager	get()
String	get(Locale locale, String key)
Iterator<Translation>	getAllTranslations()
Collection<String>	getAvailableKeys()
Collection<Locale>	getAvailableLocales()
Locale	getBaseLocale()
Locale	getCurrentLocale()
protected TranslationPackageDiff	getEdit()
KeyHashRule	getKeyHashRule()	The key hash rule dictates how term equivalency is calculated.
Locale	getPreviewLocale()
Collection<RegionalSettings>	getRegionalSettings()
protected RegionalSettingsDiff	getSettingsEdit()
RegionalSettings	getSettingsFor(Locale locale)	Returns the settings for the locale.
protected RegionalSettings	getSettingsFor(Locale locale, boolean strict)
String	getStrict(String key)
String	getStrict(Locale locale, String key)
String	getString(String key)
String	getStringForBundleKey(String bundlekey)
TranslationSettings	getTranslationSettings()
TranslationMap	getTranslationsFor(String key)
protected boolean	hasChanges()
boolean	isDefined(String key)	Returns whether the key is defined in the package.
boolean	isDefined(String key, Locale l)	Returns whether there is a translation defined for the given key in the given locale.
boolean	isTranslationEnabled()
void	modifyRegionalSettings(RegionalSettings settings)
protected void	onEditStateChanged()
protected void	refreshModel()
boolean	removeKey(String key)	Removes the specific key, and any translations.
void	removeLocale(Locale locale)
void	removeLocaleListener(LocaleListener listener)
void	removeTranslation(String key, Locale locale)	Removes a translation for a specified key and locale.
void	resetLocale()	Resets the current locale to the base locale.
protected void	saveChanges()
void	saveTranslationSettings(TranslationSettings settings)
void	setCurrentLocale(Locale locale)
void	setEnabled(boolean value)	Sets whether the localization manager should be used.
protected void	setModel(TranslationPackage value)
void	setPreviewLocale(String localeName)
protected void	setSettings(Collection<RegionalSettings> settings)
void	setup(DesignerContext context)

Methods inherited from class com.inductiveautomation.ignition.client.model.ClientLocalizationManager

addPropertyChangeListener, fireProperty, removePropertyChangeListener, set

Methods inherited from class java.lang.Object

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

Field Details

PREVIEW_LOCALE

public static final String PREVIEW_LOCALE

See Also:

• Constant Field Values

Method Details

get

public static DesignerLocalizationManager get()

isTranslationEnabled

public boolean isTranslationEnabled()

Specified by:

isTranslationEnabled in class ClientLocalizationManager

getAvailableLocales

public Collection<Locale> getAvailableLocales()

Specified by:

getAvailableLocales in interface TranslationPackage

Specified by:

getAvailableLocales in class ClientLocalizationManager

Returns:

the locales for which translations are available. This will include the base locale.

get

public String get(Locale locale,
 String key)

Specified by:

get in interface TranslationPackage

Specified by:

get in class ClientLocalizationManager

key - the key to find a match for, or return value if no value found

Returns:

the translation of the key for the requested locale, or the key, if the translation is not available.

getString

public String getString(String key)

Specified by:

getString in class ClientLocalizationManager

getStrict

public String getStrict(String key)

Specified by:

getStrict in class ClientLocalizationManager

getStrict

public String getStrict(Locale locale,
 String key)

Specified by:

getStrict in interface TranslationPackage

Specified by:

getStrict in class ClientLocalizationManager

Parameters:

locale - the locale to find a value for

key - the key to find a match for

Returns:

the translation, or null if the translation doesn't exist.

getStringForBundleKey

public String getStringForBundleKey(String bundlekey)

Specified by:

getStringForBundleKey in class ClientLocalizationManager

getTranslationsFor

public TranslationMap getTranslationsFor(String key)

Specified by:

getTranslationsFor in interface TranslationPackage

Specified by:

getTranslationsFor in class ClientLocalizationManager

Returns:

a map of all of the translations available for a given key.

getCurrentLocale

public Locale getCurrentLocale()

Specified by:

getCurrentLocale in class ClientLocalizationManager

setCurrentLocale

public void setCurrentLocale(Locale locale)

Specified by:

setCurrentLocale in class ClientLocalizationManager

addLocaleListener

public void addLocaleListener(LocaleListener listener)

Specified by:

addLocaleListener in class ClientLocalizationManager

removeLocaleListener

public void removeLocaleListener(LocaleListener listener)

Specified by:

removeLocaleListener in class ClientLocalizationManager

resetLocale

public void resetLocale()

Description copied from class: ClientLocalizationManager

Resets the current locale to the base locale. *

Specified by:

resetLocale in class ClientLocalizationManager

setEnabled

public void setEnabled(boolean value)

Sets whether the localization manager should be used. If false, returns translations as if the current locale was the default locale. However, doesn't fire events like setting the locale. Used especially to save projects.

setup

public void setup(DesignerContext context)

refreshModel

protected void refreshModel()

setModel

protected void setModel(TranslationPackage value)

setSettings

protected void setSettings(Collection<RegionalSettings> settings)

getEdit

protected TranslationPackageDiff getEdit()

getSettingsEdit

protected RegionalSettingsDiff getSettingsEdit()

hasChanges

protected boolean hasChanges()

addTerm

public void addTerm(String term)

Description copied from interface: MutableTranslationPackage

Ensures that the specified key is in the translation package.

Specified by:

addTerm in interface MutableTranslationPackage

addTranslation

public void addTranslation(String key,
 Locale locale,
 String value)

Description copied from interface: MutableTranslationPackage

Sets a translation for the specified key and locale.

Specified by:

addTranslation in interface MutableTranslationPackage

removeTranslation

public void removeTranslation(String key,
 Locale locale)

Description copied from interface: MutableTranslationPackage

Removes a translation for a specified key and locale. Used when someone had a translation and blanks it out.

Specified by:

removeTranslation in interface MutableTranslationPackage

addTranslations

public void addTranslations(String key,
 TranslationMap translations)

Description copied from interface: MutableTranslationPackage

Sets all of the translations for a specific key. Translation map can be null, in which case the key will simply be registered in the index.

Specified by:

addTranslations in interface MutableTranslationPackage

removeKey

public boolean removeKey(String key)

Description copied from interface: MutableTranslationPackage

Removes the specific key, and any translations.

Specified by:

removeKey in interface MutableTranslationPackage

Returns:

true if key was present

ensureLocaleExists

public void ensureLocaleExists(Locale locale)

Description copied from interface: MutableTranslationPackage

Verifies that the locale is present, adding it if necessary.

Specified by:

ensureLocaleExists in interface MutableTranslationPackage

removeLocale

public void removeLocale(Locale locale)

Specified by:

removeLocale in interface MutableTranslationPackage

getBaseLocale

public Locale getBaseLocale()

Specified by:

getBaseLocale in interface TranslationPackage

Returns:

the "base" locale, the language in which the terms are defined.

getKeyHashRule

public KeyHashRule getKeyHashRule()

Description copied from interface: TranslationPackage

The key hash rule dictates how term equivalency is calculated. Though this field should not be used to look up terms, it's important that derived translation packages use the same rule.

Specified by:

getKeyHashRule in interface TranslationPackage

isDefined

public boolean isDefined(String key)

Description copied from interface: TranslationPackage

Returns whether the key is defined in the package. A key can be defined without any particular translations.

Specified by:

isDefined in interface TranslationPackage

isDefined

public boolean isDefined(String key,
 Locale l)

Description copied from interface: TranslationPackage

Returns whether there is a translation defined for the given key in the given locale.

Specified by:

isDefined in interface TranslationPackage

getAvailableKeys

public Collection<String> getAvailableKeys()

Specified by:

getAvailableKeys in interface TranslationPackage

Returns:

all of the defined keys.

createDiff

public TranslationPackageDiff createDiff()

Specified by:

createDiff in interface TranslationPackage

Returns:

an empty, modifiable diff that respects the same rules as the translation package.

getAllTranslations

public Iterator<Translation> getAllTranslations()

Specified by:

getAllTranslations in interface TranslationPackage

Returns:

an iterator that goes through all of the translations. Does not include defined keys that have no translations.

getSettingsFor

public RegionalSettings getSettingsFor(Locale locale)

Returns the settings for the locale. If necessary, will create default settings to return. Therefore, do not use this to see if settings are defined.

getSettingsFor

protected RegionalSettings getSettingsFor(Locale locale,
 boolean strict)

areSettingsDefined

public boolean areSettingsDefined(Locale locale)

getRegionalSettings

public Collection<RegionalSettings> getRegionalSettings()

modifyRegionalSettings

public void modifyRegionalSettings(RegionalSettings settings)

getTranslationSettings

public TranslationSettings getTranslationSettings()

saveTranslationSettings

public void saveTranslationSettings(TranslationSettings settings)

getPreviewLocale

public Locale getPreviewLocale()

Specified by:

getPreviewLocale in class ClientLocalizationManager

setPreviewLocale

public void setPreviewLocale(String localeName)

fireLocaleChanged

protected void fireLocaleChanged()

onEditStateChanged

protected void onEditStateChanged()

areLocaleSetsDifferent

protected boolean areLocaleSetsDifferent(Collection<Locale> a,
 Collection<Locale> b)

saveChanges

protected void saveChanges()