Package com.intellij.openapi.util.text

Class TextWithMnemonic

java.lang.Object

com.intellij.openapi.util.text.TextWithMnemonic

public final class TextWithMnemonic
extends java.lang.Object

An immutable object which represents a text string with mnemonic character.

Method Summary

Modifier and Type	Method and Description
TextWithMnemonic	append(java.lang.String textToAppend) Appends given text to the current text.
TextWithMnemonic	dropMnemonic() Drops a mnemonic
boolean	equals(java.lang.Object o)
static TextWithMnemonic	fromPlainText(java.lang.String text) Creates a TextWithMnemonic object from a plain text without mnemonic.
int	getMnemonic()
int	getMnemonicIndex()
java.lang.String	getText()
int	hashCode()
boolean	hasMnemonic()
static TextWithMnemonic	parse(java.lang.String text) Parses a text in text-with-mnemonic format.
TextWithMnemonic	replaceFirst(java.lang.String target, java.lang.String replacement) Replaces the first occurrence of given target text with the given replacement text.
TextWithMnemonic	setMnemonicAt(int index) Sets mnemonic at given index
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getText

public java.lang.String getText()

Returns:

plain text without mnemonic

getMnemonic

public int getMnemonic()

Returns:

a mnemonic character (upper-cased) if mnemonic is set; 0 otherwise

getMnemonicIndex

public int getMnemonicIndex()

Returns:

a mnemonic index if it's set; -1 otherwise

hasMnemonic

public boolean hasMnemonic()

Returns:

true if mnemonic is set

dropMnemonic

public TextWithMnemonic dropMnemonic()

Drops a mnemonic

Returns:

a TextWithMnemonic object where mnemonic is not set

setMnemonicAt

public TextWithMnemonic setMnemonicAt(int index)

Sets mnemonic at given index

Parameters:

index - index, must be within the text string.

Returns:

a TextWithMnemonic object with mnemonic set at given index

append

public TextWithMnemonic append(java.lang.String textToAppend)

Appends given text to the current text.

Parameters:

textToAppend - text to append. Appended text is treated as a plain text, without mnemonic, so mnemonic position is unchanged.

Returns:

TextWithMnemonic object which text is the concatenation of this object text and supplied text.

replaceFirst

public TextWithMnemonic replaceFirst(java.lang.String target,
                                     java.lang.String replacement)

Replaces the first occurrence of given target text with the given replacement text.

Parameters:

target - the target text to be replaced

replacement - the replacement text which is treated as a plain text, without mnemonic.

Returns:

TextWithMnemonic object. The resulting mnemonic position could be adjusted if the mnemonic was located after the replacement. If the mnemonic was inside the target text then it's dropped. Returns this object if the target text was not found.

fromPlainText

public static TextWithMnemonic fromPlainText(java.lang.String text)

Creates a TextWithMnemonic object from a plain text without mnemonic.

Parameters:

text - a plain text to create a TextWithMnemonic object from

Returns:

new TextWithMnemonic object which has no mnemonic

parse

public static TextWithMnemonic parse(java.lang.String text)

Parses a text in text-with-mnemonic format. A mnemonic is prepended either with '_', or with '&' or with '\x1B' character. To escape '_' or '&' before the actual mnemonic the character must be duplicated. The characters after the actual mnemonic should not be escaped. E.g. "A__b_c__d" in text-with-mnemonic format will be displayed as "A_bc__d" with mnemonic 'c'.

Parameters:

text - text to parse

Returns:

TextWithMnemonic object which corresponds to the parsed text.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

text in text-with-mnemonic format. Parsing back this text using parse(String) method would create a TextWithMnemonic object which is equal to this.