org.vaadin.spring.i18n

Class I18N

java.lang.Object

org.vaadin.spring.i18n.I18N

public class I18N
extends Object

Helper class for resolving messages in a Vaadin UI. This is effectively a wrapper around ApplicationContext that uses the locale of the current UI to lookup messages. Use it like this:

 @VaadinUI
 public class MyUI extends UI {

     @Autowired I18N i18n;

     ...

     void init() {
         myLabel.setCaption(i18n.get("myLabel.caption"));
     }
 }
 

Please note, that you also need to configure a MessageSource inside your application context that contains all the messages to resolve.

Author:

Petter Holmström (petter@vaadin.com)

Constructor Summary

Constructors

Constructor and Description
I18N(ApplicationContext applicationContext)

Method Summary

Modifier and Type	Method and Description
String	get(String code, Object... arguments) Tries to resolve the specified message for the current locale.
Locale	getLocale() Gets the locale of the current Vaadin UI.
String	getWithDefault(String code, String defaultMessage, Object... arguments) Tries to resolve the specified message for the current locale.
String	getWithLocale(String code, Locale locale, Object... arguments) Tries to resolve the specified message for the given locale.
boolean	isRevertToDefaultBundle() Returns whether I18N will try the default bundle if a message cannot be resolved for the current locale.
void	setRevertToDefaultBundle(boolean revertToDefaultBundle) See isRevertToDefaultBundle().

Methods inherited from class java.lang.Object

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

Constructor Detail

I18N

@Autowired
public I18N(ApplicationContext applicationContext)

Parameters:

applicationContext - the application context to read messages from, never null.

Method Detail

isRevertToDefaultBundle

public boolean isRevertToDefaultBundle()

Returns whether I18N will try the default bundle if a message cannot be resolved for the current locale. By default, this is true.

setRevertToDefaultBundle

public void setRevertToDefaultBundle(boolean revertToDefaultBundle)

See isRevertToDefaultBundle().

get

public String get(String code,
                  Object... arguments)

Tries to resolve the specified message for the current locale.

Parameters:

code - the code to lookup up, such as 'calculator.noRateSet', never null.

arguments - Array of arguments that will be filled in for params within the message (params look like "{0}", "{1,date}", "{2,time}"), or null if none.

Returns:

the resolved message, or the message code prepended with an exclamation mark if the lookup fails.

See Also:

MessageSource.getMessage(String, Object[], java.util.Locale), getLocale()

getWithLocale

public String getWithLocale(String code,
                            Locale locale,
                            Object... arguments)

Tries to resolve the specified message for the given locale.

Parameters:

code - the code to lookup up, such as 'calculator.noRateSet', never null.

arguments - Array of arguments that will be filled in for params within the message (params look like "{0}", "{1,date}", "{2,time}"), or null if none.

locale - The Locale for which it is tried to look up the code. Must not be null

Returns:

the resolved message, or the message code prepended with an exclamation mark if the lookup fails.

Throws:

IllegalArgumentException - if the given Locale is null

See Also:

MessageSource.getMessage(String, Object[], java.util.Locale), Locale

getWithDefault

public String getWithDefault(String code,
                             String defaultMessage,
                             Object... arguments)

Tries to resolve the specified message for the current locale.

Parameters:

code - the code to lookup up, such as 'calculator.noRateSet', never null.

defaultMessage - string to return if the lookup fails, never null.

arguments - Array of arguments that will be filled in for params within the message (params look like "{0}", "{1,date}", "{2,time}"), or null if none.

Returns:

the resolved message, or the defaultMessage if the lookup fails.

See Also:

MessageSource.getMessage(String, Object[], String, java.util.Locale), getLocale()

getLocale

public Locale getLocale()

Gets the locale of the current Vaadin UI. If the locale can not be determinted, the default locale is returned instead.

Returns:

the current locale, never null.

See Also:

AbstractComponent.getLocale(), Locale.getDefault()