oracle.stellent.ridc.i18n.locale

Class LocaleMessage

java.lang.Object

oracle.stellent.ridc.i18n.locale.BaseLocaleMessage

oracle.stellent.ridc.i18n.locale.LocaleMessage

@Concealed
public class LocaleMessage
extends BaseLocaleMessage

Constructor Summary

Constructors

Constructor and Description
LocaleMessage(String bundle, String key) Constructor
LocaleMessage(String bundle, String key, Object[] parameters) Constructor

Method Summary

Modifier and Type	Method and Description
char	getMnemonicCharacter() Returns the mnemonic character.
int	getMnemonicCharacterIndex() Deprecated. Caution, this can cause exceptions if used in conjunction with getWithoutMnemonic() and Japanese!
String	getText() Returns the text associated with this message, stripping the 'non-printing' Mnemonic character (the '&'), but leaving the rest of the text.
String	getText(Locale locale) Returns the text associated with this message, stripping the 'non-printing' Mnemonic character (the '&'), but leaving the rest of the text.
String	getWithoutMnemonic() SPECIAL USE ONLY, Use getText() instead.
String	toString()

Methods inherited from class oracle.stellent.ridc.i18n.locale.BaseLocaleMessage

getBundle, getKey, getParameters, setBundle, setKey, setParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

LocaleMessage

public LocaleMessage(String bundle,
                     String key,
                     Object[] parameters)

Constructor

Parameters:

key - the message key

parameters - the parameters

LocaleMessage

public LocaleMessage(String bundle,
                     String key)

Constructor

Parameters:

key - the message key

Method Detail

toString

public String toString()

Overrides:

toString in class BaseLocaleMessage

See Also:

Object.toString()

getText

public String getText()

Returns the text associated with this message, stripping the 'non-printing' Mnemonic character (the '&'), but leaving the rest of the text. This is the primary method of getting the text for a menu, label, button, etc. This will leave the (V) on the end of Japanese text indicating that the letter V is the mnemonic.

Returns:

The text of the message as a String, with the non-printing mnemonic stripped, but otherwise the message intact.

getText

public String getText(Locale locale)

Returns the text associated with this message, stripping the 'non-printing' Mnemonic character (the '&'), but leaving the rest of the text. This is the primary method of getting the text for a menu, label, button, etc. This will leave the (V) on the end of Japanese text indicating that the letter V is the mnemonic.

Parameters:

locale - the locale to use rather that the default locale

Returns:

The text of the message as a String, with the non-printing mnemonic stripped, but otherwise the message intact.

getWithoutMnemonic

public String getWithoutMnemonic()

SPECIAL USE ONLY, Use getText() instead. Returns the text of associated with this message without the mnemonic character. This will strip the '&' but will also strip the (V) mnemonic hint in Japanese strings. This is only useful if you are printing out to a log or some other place where you can't use the mnemonics to access the button because it is pure text.

Returns:

string containing message without mnemonic character.

getMnemonicCharacter

public char getMnemonicCharacter()

Returns the mnemonic character.

Returns:

the mnemonic character.

getMnemonicCharacterIndex

public int getMnemonicCharacterIndex()

Deprecated. Caution, this can cause exceptions if used in conjunction with getWithoutMnemonic() and Japanese!

Returns the index of the mnemonic character.

Returns:

the mnemonic character's index.