public class

DefaultI18NBean

extends Object
implements I18NBean
java.lang.Object
   ↳ com.atlassian.confluence.util.i18n.DefaultI18NBean

Class Overview

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)

Summary

[Expand]
Inherited Fields
From interface com.atlassian.confluence.util.i18n.I18NBean
Public Constructors
DefaultI18NBean(Locale locale, PluginAccessor pluginManager)
Public Methods
ResourceBundle getResourceBundle()
String getText(String key)
Get the i18n text for a particular key.
String getText(String key, List list)
String getText(Message message)
Gets the i18n text for the specified message, formatting the message's value and arguments with MessageFormat.
String getText(String key, Object[] args)
Get the i18n text for a particular key, formatted through MessageFormat with the given arguments.
String getTextStrict(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()
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.confluence.util.i18n.I18NBean

Public Constructors

public DefaultI18NBean (Locale locale, PluginAccessor pluginManager)

Public Methods

public ResourceBundle getResourceBundle ()

public String getText (String key)

Get the i18n text for a particular key.

public String getText (String key, List list)

public String getText (Message message)

Gets the i18n text for the specified message, formatting the message's value and arguments with MessageFormat.

Parameters
message the message to format, containing an i18n key and arguments
Returns
  • the formatted message

public String getText (String key, Object[] args)

Get the i18n text for a particular key, formatted through MessageFormat with the given arguments. Works similarly to getText(String, java.util.List), but the array form is necessary to work well with Velocity.

Parameters
key the key to retrieve the i18n text for
args 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

public String getTextStrict (String i18nKey)

Needed for text that should not be marked up (for example, values for the 'accessKey' attribute in an input element)

Parameters
i18nKey the key to retrieve localised text for
Returns
  • text for i18nKey (and excludes markup regardless of settings)

public boolean isI18nHighlightMode ()

public boolean isShowKeyMode ()