MutableTranslationPackage

All Superinterfaces:: Serializable, TranslationPackage

All Known Implementing Classes:: BasicTranslationPackage, DelegateTranslationPackage, DesignerLocalizationManager, TranslationPackageDiff, TranslationWorkspacePanel.FilteredTranslationPackage

public interface MutableTranslationPackage extends TranslationPackage

Method Summary

Modifier and Type

Method

Description

void

addTerm(String key)

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.

void

ensureLocaleExists(Locale locale)

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

boolean

removeKey(String key)

Removes the specific key, and any translations.

void

removeLocale(Locale locale)

void

removeTranslation(String key, Locale locale)

Removes a translation for a specified key and locale.

Methods inherited from interface com.inductiveautomation.ignition.common.i18n.translation.TranslationPackage
createDiff, get, getAllTranslations, getAvailableKeys, getAvailableLocales, getBaseLocale, getKeyHashRule, getStrict, getTranslationsFor, isDefined, isDefined

Method Details
- addTerm
  
  void addTerm(String key)
  
  Ensures that the specified key is in the translation package.
- addTranslation
  
  void addTranslation(String key, Locale locale, String value)
  
  Sets a translation for the specified key and locale.
- removeTranslation
  
  void removeTranslation(String key, Locale locale)
  
  Removes a translation for a specified key and locale. Used when someone had a translation and blanks it out.
- addTranslations
  
  void addTranslations(String key, TranslationMap translations)
  
  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.
- removeKey
  
  boolean removeKey(String key)
  
  Removes the specific key, and any translations.
  
  Returns:
  
  true if key was present
- ensureLocaleExists
  
  void ensureLocaleExists(Locale locale)
  
  Verifies that the locale is present, adding it if necessary.
- removeLocale
  
  void removeLocale(Locale locale)