com.atlassian.confluence.util.i18n
Class DefaultI18NBean
java.lang.Object
com.atlassian.confluence.util.i18n.DefaultI18NBean
- All Implemented Interfaces:
- I18NBean
public class DefaultI18NBean
- extends java.lang.Object
- implements I18NBean
Responsible for fetching internationalised text given a key.
By default, this will only search the default resource bundle for ConfluenceActionSupport.class
To access i18n keys in resource bundles for other classes: specify these classes in a list (use fully qualified class names)
Field Summary |
static org.apache.log4j.Logger |
log
|
Constructor Summary |
DefaultI18NBean(java.util.Locale locale,
com.atlassian.plugin.PluginAccessor pluginManager)
|
Method Summary |
java.util.ResourceBundle |
getResourceBundle()
|
java.lang.String |
getText(Message message)
Gets the i18n text for the specified message, formatting the message's value and arguments with MessageFormat. |
java.lang.String |
getText(java.lang.String key)
Get the i18n text for a particular key. |
java.lang.String |
getText(java.lang.String key,
java.util.List list)
|
java.lang.String |
getText(java.lang.String key,
java.lang.Object[] args)
Get the i18n text for a particular key, formatted through MessageFormat with the given arguments. |
java.lang.String |
getTextStrict(java.lang.String i18nKey)
Needed for text that should not be marked up (for example, values for the 'accessKey' attribute in an input element) |
boolean |
isI18nHighlightMode()
|
boolean |
isShowKeyMode()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
log
public static final org.apache.log4j.Logger log
DefaultI18NBean
public DefaultI18NBean(java.util.Locale locale,
com.atlassian.plugin.PluginAccessor pluginManager)
getText
public java.lang.String getText(java.lang.String key)
- Get the i18n text for a particular key.
- Specified by:
getText
in interface I18NBean
getText
public java.lang.String getText(java.lang.String key,
java.lang.Object[] args)
- Get the i18n text for a particular key, formatted through MessageFormat with the given arguments. Works
similarly to
ActionSupport.getText(String, java.util.List)
, but the array form is necessary to work well
with Velocity.
- Specified by:
getText
in interface I18NBean
- Parameters:
key
- the key to retrieve the i18n text forargs
- an array of arguments to be passed in to the MessageFormat#format for this text
- Returns:
- the appropriate i18n text, formatted with the supplied arguments
- See Also:
ActionSupport.getText(String, java.util.List)
,
MessageFormat
getText
public java.lang.String getText(java.lang.String key,
java.util.List list)
- Specified by:
getText
in interface I18NBean
getText
public java.lang.String getText(Message message)
- Description copied from interface:
I18NBean
- Gets the i18n text for the specified message, formatting the message's value and arguments with MessageFormat.
- Specified by:
getText
in interface I18NBean
- Parameters:
message
- the message to format, containing an i18n key and arguments
- Returns:
- the formatted message
getTextStrict
public java.lang.String getTextStrict(java.lang.String i18nKey)
- Needed for text that should not be marked up (for example, values for the 'accessKey' attribute in an input element)
- Specified by:
getTextStrict
in interface I18NBean
- Parameters:
i18nKey
-
- Returns:
- text for i18nKey (and excludes markup regardless of settings)
getResourceBundle
public java.util.ResourceBundle getResourceBundle()
- Specified by:
getResourceBundle
in interface I18NBean
isI18nHighlightMode
public boolean isI18nHighlightMode()
- Specified by:
isI18nHighlightMode
in interface I18NBean
isShowKeyMode
public boolean isShowKeyMode()
- Specified by:
isShowKeyMode
in interface I18NBean
Copyright © 2003-2009 Atlassian Pty Ltd. All Rights Reserved.