Package com.iizix.text

Interface ILocaleString

All Known Subinterfaces:
IAppSessionGyro, IClientSessionGyro
All Known Implementing Classes:
AppSessionGyro, ClientSessionGyro
public interface ILocaleString
Interface implemented to perform localized text string look-up's.
Author:
Christopher Mindus

  • Method Summary

    Modifier and Type
    Method
    Description
    IKStringInfoProvider
    getKStringInfoProvider()
    Retrieves the KStringInfoProvider.
    LocaleInfo
    getLocale()
    Gets the local info class instance.
    default KString
    getLocaleKString(String id)
    Gets the KString of a particular ID from the app's text tables, regardless if the text tables are flagged to also handle LocaleString's.
    KString
    getLocaleKString(String id, boolean system)
    Gets the KString of a particular ID from the app's text tables that are flagged to also handle LocaleString's depending on the flag.

  • Method Details

    • getLocaleKString

      default KString getLocaleKString(String id)
      Gets the KString of a particular ID from the app's text tables, regardless if the text tables are flagged to also handle LocaleString's.
      Parameters:
      id - The text ID.
      Returns:
      The KString for the text ID in current locale, null if not found.

    • getLocaleKString

      KString getLocaleKString(String id, boolean system)
      Gets the KString of a particular ID from the app's text tables that are flagged to also handle LocaleString's depending on the flag.
      Parameters:
      id - The text ID.
      system - Flagged to handle system strings for LocaleString's.
      Returns:
      The KString for the text ID in current locale, null if not found.

    • getLocale

      LocaleInfo getLocale()
      Gets the local info class instance.
      Returns:
      The locale info class instance when the client environment has been set, otherwise the default client locale info instance specified for the server.

    • getKStringInfoProvider

      IKStringInfoProvider getKStringInfoProvider()
      Retrieves the KStringInfoProvider.
      Returns:
      The KString information provider instance, or null for none.