Package org.jdesktop.swingx.renderer

Class LocalizableStringValue

java.lang.Object
org.jdesktop.swingx.renderer.LocalizableStringValue
All Implemented Interfaces:
Serializable, StringValue
public class LocalizableStringValue extends Object implements StringValue
A StringValue which looks up localized String representations for objects.
See Also:

  • Constructor Details

    • LocalizableStringValue

      public LocalizableStringValue(Map<Object,String> lookup)
      Instantiates a LocaleStringValue which looks up localized String representations for items in the map using the JComponent defaultLocale.
      Parameters:
      lookup - a map containing Entries of objects and a string key to look up its string representation in the UIManager

    • LocalizableStringValue

      public LocalizableStringValue(Map<Object,String> lookup, Locale locale)
      Instantiates a LocaleStringValue which looks up localized String representations for items in the map using the given Locale.
      Parameters:
      lookup - a map containing Entries of objects and a string key to look up its string representation in the UIManager
      locale - the locale to lookup the localized strings, may be null to denote using JComponent.defaultLocale

    • LocalizableStringValue

      public LocalizableStringValue(Map<Object,String> lookup, String prefix)
      Instantiates a LocaleStringValue which looks up localized String representations for items in the map using the JComponent defaultLocale.
      Parameters:
      lookup - a map containing Entries of objects and a string key to look up its string representation in the UIManager
      prefix - a common prefix for all string keys in the map, may be null to denote that the keys should be use as are

    • LocalizableStringValue

      public LocalizableStringValue(Map<Object,String> lookup, String prefix, Locale locale)
      Instantiates a LocaleStringValue which looks up localized String representations for items in the map using the given Locale.
      Parameters:
      lookup - a map containing Entries of objects and a string key to look up its string representation in the UIManager
      prefix - a common prefix for all string keys in the map, may be null to denote that the keys should be use as are
      locale - the locale to lookup the localized strings, may be null to denote using JComponent.defaultLocale

  • Method Details

    • getString

      public String getString(Object value)
      Returns a string representation of the given value.

      PENDING JW: forgot - why not null return guaranteed?

      Implemented to lookup the value's localized string representation, if contained in the lookup map. Returns the fallback if not contained.

      Specified by:
      getString in interface StringValue
      Parameters:
      value - the object to present as a string
      Returns:
      a string representation of the given value, guaranteed to be not null

    • getKey

      protected String getKey(Object value)
      Returns the key for the given value. The prefix is prepended to the key if both are available. May be null if not available.
      Parameters:
      value - the value to find the key for
      Returns:
      the key or null if not available.

    • getFallbackString

      protected String getFallbackString(Object value)
      Returns the fallback string representation. This method is called when a localized value isn't available be found.

      This implementation returns toString.

      Parameters:
      value - the object to return a string representation for.
      Returns:
      a string representation for the value

    • getLocalizedString

      protected String getLocalizedString(String key)
      Returns the localized value for the given key or null if not found.

      This implementation queries the UIManagerExt.

      Parameters:
      key - the key to search a value for
      Returns:
      the localized value for the given key or null if not available.

    • setLocale

      public final void setLocale(Locale locale)
      Sets the Locale to use for lookup of localized string representation.
      Parameters:
      locale - the locale to lookup the localized strings, may be null to denote using Locale's default.

    • getLocale

      public Locale getLocale()
      Returns the Locale to use for lookup, guaranteed to be not null. If the initial setting had been null, returns current Locale's default.
      Returns:
      the Locale used for lookup.