org.openmrs.web.filter.util

Class LocalizationTool

java.lang.Object

org.apache.velocity.tools.generic.SafeConfig

org.apache.velocity.tools.generic.LocaleConfig

org.apache.velocity.tools.generic.ResourceTool

org.openmrs.web.filter.util.LocalizationTool

@DefaultKey(value="l10n")
public class LocalizationTool
extends org.apache.velocity.tools.generic.ResourceTool

This class is intended for accessing ResourceBundle and formatting messages therein.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.velocity.tools.generic.ResourceTool

org.apache.velocity.tools.generic.ResourceTool.Key

Field Summary

Fields inherited from class org.apache.velocity.tools.generic.ResourceTool

BUNDLES_KEY

Fields inherited from class org.apache.velocity.tools.generic.LocaleConfig

DEFAULT_LOCALE

Fields inherited from class org.apache.velocity.tools.generic.SafeConfig

LOCK_CONFIG_KEY, OLD_LOCK_CONFIG_KEY, SAFE_MODE_KEY

Constructor Summary

Constructors

Constructor and Description
LocalizationTool()

Method Summary

Modifier and Type	Method and Description
Object	get(Object code, String[] resourceNamePrefixes, Object locale)
protected ResourceBundle	getBundle(String baseName, Object loc) To be able to load resource bundles outside the class path we need to override this method
static ResourceBundle	getDefaultResourceBundle()
void	setLocale(Locale locale) Its need to override base class method to be able to change its locale property outside the class hierarchy

Methods inherited from class org.apache.velocity.tools.generic.ResourceTool

bundle, configure, get, get, get, getDefaultBundle, getDefaultLocale, getKeys, getKeys, getKeys, insert, insert, insert, insert, locale, render, setDefaultBundle, setDefaultLocale, setDeprecationSupportMode

Methods inherited from class org.apache.velocity.tools.generic.LocaleConfig

getLocale

Methods inherited from class org.apache.velocity.tools.generic.SafeConfig

configure, isConfigLocked, isSafeMode, setLockConfig, setSafeMode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocalizationTool

public LocalizationTool()

Method Detail

setLocale

public void setLocale(Locale locale)

Its need to override base class method to be able to change its locale property outside the class hierarchy

Overrides:

setLocale in class org.apache.velocity.tools.generic.LocaleConfig

See Also:

LocaleConfig.setLocale(Locale locale)

getDefaultResourceBundle

public static ResourceBundle getDefaultResourceBundle()

Returns:

the defaultResourceBundle

getBundle

protected ResourceBundle getBundle(String baseName,
                                   Object loc)

To be able to load resource bundles outside the class path we need to override this method

Overrides:

getBundle in class org.apache.velocity.tools.generic.ResourceTool

See Also:

ResourceTool.getBundle(java.lang.String, java.lang.Object)

get

public Object get(Object code,
                  String[] resourceNamePrefixes,
                  Object locale)

Overrides:

get in class org.apache.velocity.tools.generic.ResourceTool

See Also:

ResourceTool.get(java.lang.Object, java.lang.String[], java.lang.Object)