MnemonicUtils (JGoodies Common 1.8 API)

java.lang.Object
- com.jgoodies.common.swing.MnemonicUtils

```
public final class MnemonicUtils
extends Object
```
Configures the text, mnemonic and mnemonic index in Actions, JLabels and AbstractButtons. The term marked text is used for String that contain a marker character that marks both the mnemonic an its index in the resulting plain text.
Marked TextPlain TextMnemonicMnemonic IndexCommentSaveSave0-1No mnemonic&SaveSave'S'0 Save &asSave as'A'5Second 'a' markedLook&FeelLookFeel'F'4& should be quotedLook&&FeelLook&Feel0-1& is quoted&Look&FeelLook&FeelL0Second & needs no quoteLook & FeelLook & Feel0-1Whitespace cannot be markedR&&D D&epartmentR&D Department'E'5First & is quoted<html>a&b</html><html>a<u>b</u></html>'B'-1'b' is underlined<html>R&D D&ep.</html><html>R&D D<u>e</u>p.</html>'B'-1HTML & doesn't mark

Author:

Karsten Lentzsch

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`configure(AbstractButton target, String markedText)` Configures the text, mnemonic and mnemonic index for `target`
`static void`	`configure(Action target, String markedText)` Configures the text, mnemonic and mnemonic index for `target`
`static void`	`configure(JLabel target, String markedText)` Configures the text, mnemonic and mnemonic index for `target`
`static String`	`plainText(String markedText)` Returns the plain text for the given marked text by removin the mnemonic marker and marker quotes - if any.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - configure
```
public static void configure(AbstractButton target,
             String markedText)
```
    Configures the text, mnemonic and mnemonic index for targetmarkedText is "Save &as", the tex will be set to "Save as", the mnemonic is 'a', and th mnemonic index is 5.
    
    Parameters:
    target - the button to be configured
    markedText - the text with optional mnemonic marker
    
    Throws:
    
    NullPointerException - if target is null
  - configure
```
public static void configure(Action target,
             String markedText)
```
    Configures the text, mnemonic and mnemonic index for targetmarkedText is "Save &as", the tex will be set to "Save as", the mnemonic is 'a', and th mnemonic index is 5.
    
    Parameters:
    target - the Action to be configured
    markedText - the text with optional mnemonic marker
    
    Throws:
    
    NullPointerException - if target is null
  - configure
```
public static void configure(JLabel target,
             String markedText)
```
    Configures the text, mnemonic and mnemonic index for targetmarkedText is "Save &as", the tex will be set to "Save as", the mnemonic is 'a', and th mnemonic index is 5.
    
    Parameters:
    target - the label to be configured
    markedText - the text with optional mnemonic marker
    
    Throws:
    
    NullPointerException - if target is null
  - plainText
```
public static String plainText(String markedText)
```
    Returns the plain text for the given marked text by removin the mnemonic marker and marker quotes - if any. If the marked tex is HTML, the plain text has the mnemonic character underlined See the MnemonicUtils class comment for informatio about how to mark a mnemonic and how to quote a marker
    Parameters:
    markedText - the text that may contain a mnemonic marker
    
    Returns:
    the text without mnemonic marker and marker quotes

Class MnemonicUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

configure

configure

configure

plainText