MutableTranslationPackage

All Superinterfaces:

java.io.Serializable, TranslationPackage

All Known Implementing Classes:

BasicTranslationPackage, DelegateTranslationPackage, DesignerLocalizationManager, TranslationPackageDiff, TranslationWorkspacePanel.FilteredTranslationPackage
```
public interface MutableTranslationPackage
extends TranslationPackage
```

Method Summary

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