se.entra.phantom.client

Class Mnemonic

java.lang.Object

se.entra.phantom.client.Mnemonic

public class Mnemonic
extends Object

This class extracts the mnemonic character from a string. A mnemonic character in the NetPhantom environment is preceded with a tilde (~).

Constructor Summary

Constructors

Constructor and Description
Mnemonic(String s) The constructor extracts the mnemonic character in the text string.

Method Summary

Modifier and Type	Method and Description
char	getMnemonic() Gets the mnemonic character of the string.
int	getMnemonicIndex() Gets the mnemonic index (-1 is no mnemonic).
String	getText() Gets the text without the mnemonic character.
void	setMnemonic(AbstractButton b) Sets the mnemonic for an abstract button.
char	update(AbstractButton b) Assigns mnemonic and text to a button.

Methods inherited from class java.lang.Object

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

Constructor Detail

Mnemonic

public Mnemonic(String s)

The constructor extracts the mnemonic character in the text string. The mnemonic character is the tilde-sign (~).

Method Detail

getMnemonic

public char getMnemonic()

Gets the mnemonic character of the string. Always UPPER CASE.

Returns:

'\x00' if no mnemonic was used in the original string.

getMnemonicIndex

public int getMnemonicIndex()

Gets the mnemonic index (-1 is no mnemonic).

getText

public String getText()

Gets the text without the mnemonic character.

setMnemonic

public void setMnemonic(AbstractButton b)

Sets the mnemonic for an abstract button.

For JDK 1.4 the index will be used, otherwise the character itself.

update

public char update(AbstractButton b)

Assigns mnemonic and text to a button.

Returns:

Mnemonic upper case character or '\x00' if no mnemonic was used in the original string.