com.atlassian.confluence.util.i18n
Interface I18NBean

All Known Implementing Classes:

DefaultI18NBean

public interface I18NBean

Responsible for fetching internationalised text for a given key.

Field Summary

static java.lang.String

DEFAULT_RESOURCE_BUNDLE

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()

Field Detail

DEFAULT_RESOURCE_BUNDLE

static final java.lang.String DEFAULT_RESOURCE_BUNDLE

Method Detail

getText

java.lang.String getText(java.lang.String key)

Get the i18n text for a particular key.

getText

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.

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:

ActionSupport.getText(String, java.util.List), MessageFormat

getText

java.lang.String getText(java.lang.String key,
                         java.util.List list)

getText

java.lang.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

getTextStrict

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)

Parameters:

i18nKey - the key to retrieve localised text for

Returns:

text for i18nKey (and excludes markup regardless of settings)

isI18nHighlightMode

boolean isI18nHighlightMode()

isShowKeyMode

boolean isShowKeyMode()

getResourceBundle

java.util.ResourceBundle getResourceBundle()