Module org.apache.wicket.core
Package org.apache.wicket

Class Localizer

java.lang.Object
org.apache.wicket.Localizer
public class Localizer extends Object
A utility class that encapsulates all of the localization related functionality in a way that it can be accessed by all areas of the framework in a consistent way. A singleton instance of this class is available via the Application object.

You may register additional IStringResourceLoader to extend or replace Wickets default search strategy for the properties. E.g. string resource loaders which load the properties from a database. There should be hardly any need to extend Localizer.

Author:
Chris Turner, Juergen Donnerstag
See Also:

  • Constructor Details

    • Localizer

      public Localizer()
      Create the utils instance class backed by the configuration information contained within the supplied application object.

  • Method Details

    • get

      public static Localizer get()
      Returns:
      Same as Application.get().getResourceSettings().getLocalizer()

    • clearCache

      public final void clearCache()
      Clear all cache entries by instantiating a new cache object
      See Also:

    • getString

      public String getString(String key, Component component) throws MissingResourceException
      Parameters:
      key - The key to obtain the resource for
      component - The component to get the resource for
      Returns:
      The string resource
      Throws:
      MissingResourceException - If resource not found and configuration dictates that exception should be thrown
      See Also:

    • getString

      public String getString(String key, Component component, IModel<?> model) throws MissingResourceException
      Parameters:
      key - The key to obtain the resource for
      component - The component to get the resource for
      model - The model to use for property substitutions in the strings (optional)
      Returns:
      The string resource
      Throws:
      MissingResourceException - If resource not found and configuration dictates that exception should be thrown
      See Also:

    • getString

      public String getString(String key, Component component, String defaultValue) throws MissingResourceException
      Parameters:
      key - The key to obtain the resource for
      component - The component to get the resource for
      defaultValue - The default value (optional)
      Returns:
      The string resource
      Throws:
      MissingResourceException - If resource not found and configuration dictates that exception should be thrown
      See Also:

    • getString

      public String getString(String key, Component component, IModel<?> model, String defaultValue) throws MissingResourceException
      Parameters:
      key - The key to obtain the resource for
      component - The component to get the resource for
      model - The model to use for property substitutions in the strings (optional)
      defaultValue - The default value (optional)
      Returns:
      The string resource
      Throws:
      MissingResourceException - If resource not found and configuration dictates that exception should be thrown
      See Also:

    • getString

      public String getString(String key, Component component, IModel<?> model, Locale locale, String style, String defaultValue) throws MissingResourceException
      Get the localized string using all of the supplied parameters. This method is left public to allow developers full control over string resource loading. However, it is recommended that one of the other convenience methods in the class are used as they handle all of the work related to obtaining the current user locale and style information.
      Parameters:
      key - The key to obtain the resource for
      component - The component to get the resource for (optional)
      model - The model to use for substitutions in the strings (optional)
      locale - If != null, it'll supersede the component's locale
      style - If != null, it'll supersede the component's style
      defaultValue - The default value (optional)
      Returns:
      The string resource
      Throws:
      MissingResourceException - If resource not found and configuration dictates that exception should be thrown

    • getString

      public String getString(String key, Component component, IModel<?> model, Locale locale, String style, IModel<String> defaultValue) throws MissingResourceException
      Get the localized string using all of the supplied parameters. This method is left public to allow developers full control over string resource loading. However, it is recommended that one of the other convenience methods in the class are used as they handle all of the work related to obtaining the current user locale and style information.
      Parameters:
      key - The key to obtain the resource for
      component - The component to get the resource for (optional)
      model - The model to use for substitutions in the strings (optional)
      locale - If != null, it'll supersede the component's locale
      style - If != null, it'll supersede the component's style
      defaultValue - The default value (optional)
      Returns:
      The string resource
      Throws:
      MissingResourceException - If resource not found and configuration dictates that exception should be thrown

    • getStringIgnoreSettings

      public String getStringIgnoreSettings(String key, Component component, IModel<?> model, String defaultValue)
      Parameters:
      key - The key to obtain the resource for
      component - The component to get the resource for (optional)
      model - The model to use for substitutions in the strings (optional)
      defaultValue - The default value (optional)
      Returns:
      The string resource
      See Also:

    • getStringIgnoreSettings

      public String getStringIgnoreSettings(String key, Component component, IModel<?> model, Locale locale, String style, String defaultValue)
      This is similar to getString(String, Component, IModel, String) except that the resource settings are ignored. This allows to to code something like 
       String option = getLocalizer().getStringIgnoreSettings(getId() + ".null", this, "");
 if (Strings.isEmpty(option))
 {
        option = getLocalizer().getString("null", this, CHOOSE_ONE);
 }
      Parameters:
      key - The key to obtain the resource for
      component - The component to get the resource for (optional)
      model - The model to use for substitutions in the strings (optional)
      locale - If != null, it'll supersede the component's locale
      style - If != null, it'll supersede the component's style
      defaultValue - The default value (optional)
      Returns:
      The string resource

    • getStringResourceLoaders

      protected List<IStringResourceLoader> getStringResourceLoaders()
      In case you want to provide your own list of string resource loaders
      Returns:
      List of string resource loaders

    • putIntoCache

      protected void putIntoCache(String cacheKey, String string)
      Put the value into the cache and associate it with the cache key
      Parameters:
      cacheKey -
      string -

    • getFromCache

      protected String getFromCache(String cacheKey)
      Get the value associated with the key from the cache.
      Parameters:
      cacheKey -
      Returns:
      The value of the key

    • getCacheKey

      protected String getCacheKey(String key, Component component, Locale locale, String style, String variation)
      Gets the cache key
      Parameters:
      key -
      component -
      locale - Guaranteed to be != null
      style -
      variation -
      Returns:
      The value of the key

    • substitutePropertyExpressions

      public String substitutePropertyExpressions(Component component, String string, IModel<?> model)
      Helper method to handle property variable substitution in strings.
      Parameters:
      component - The component requesting a model value or null
      string - The string to substitute into
      model - The model
      Returns:
      The resulting string

    • setEnableCache

      public final void setEnableCache(boolean value)
      By default the cache is enabled. Disabling the cache will disable it and clear the cache. This can be handy for example in development mode.
      Parameters:
      value -

    • newCache

      protected Map<String,String> newCache()
      Create a new cache, override this method if you want a different map to store the cache keys, for example a map that hold only the last X number of elements.. By default it uses the ConcurrentHashMap
      Returns:
      cache