Package com.inductiveautomation.ignition.client.model

Class ClientLocalizationManager

java.lang.Object
com.inductiveautomation.ignition.client.model.ClientLocalizationManager
All Implemented Interfaces:
TranslationPackage, Serializable
Direct Known Subclasses:
ClientLocalizationManagerImpl, DesignerLocalizationManager
public abstract class ClientLocalizationManager extends Object implements TranslationPackage
See Also:

  • Field Details

  • Constructor Details

    • ClientLocalizationManager

      protected ClientLocalizationManager()

  • Method Details

    • get

      public static <T extends ClientLocalizationManager> T get()

    • set

      protected static void set(ClientLocalizationManager mgr)

    • addPropertyChangeListener

      public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)

    • removePropertyChangeListener

      public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)

    • fireProperty

      protected void fireProperty(String name)

    • isTranslationEnabled

      public abstract boolean isTranslationEnabled()

    • getAvailableLocales

      public abstract Collection<Locale> getAvailableLocales()
      Specified by:
      getAvailableLocales in interface TranslationPackage
      Returns:
      the locales for which translations are available. This will include the base locale.

    • get

      public abstract String get(Locale locale, String key)
      Specified by:
      get in interface TranslationPackage
      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 abstract String getString(String key)

    • getStrict

      public abstract String getStrict(String key)

    • getStrict

      public abstract String getStrict(Locale locale, String key)
      Specified by:
      getStrict in interface TranslationPackage
      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 abstract String getStringForBundleKey(String bundlekey)

    • getTranslationsFor

      public abstract TranslationMap getTranslationsFor(String key)
      Specified by:
      getTranslationsFor in interface TranslationPackage
      Returns:
      a map of all of the translations available for a given key.

    • getCurrentLocale

      public abstract Locale getCurrentLocale()

    • setCurrentLocale

      public abstract void setCurrentLocale(Locale locale)

    • getPreviewLocale

      public abstract Locale getPreviewLocale()

    • addLocaleListener

      public abstract void addLocaleListener(LocaleListener listener)

    • removeLocaleListener

      public abstract void removeLocaleListener(LocaleListener listener)

    • resetLocale

      public abstract void resetLocale()
      Resets the current locale to the base locale. *