An immutable parameter object consisting of the text, mnemonic character and mnemonic character index that may be associated with a labeled component. This class also acts as a factory for creating instances of itself based on a string descriptor that adheres to some simple syntax rules as described in the javadoc for the {@link #valueOf(String)} method.
The syntax used for the label info descriptor is just the text to be displayed by the label with an ampersand (&) optionally inserted before the character that is to be used as a mnemonic for the label.
Example: To create a label with the text {@code My Label} and the capital L as a mnemonic,use the following descriptor:
My &Label
A backslash character (\) can be used to escape ampersand characters that are to be displayed as part of the label's text. For example:
Save \& Run
Only one non-escaped backslash can appear in the label descriptor. Attempting to specify more than one mnemonic character will result in an exception being thrown. TODO finish comment regarding backslash chars in props file Note that for label descriptors provided in properties files, an extra backslash will be required to avoid the single backslash being interpreted as a special character.
@author Keith Donald
@author Peter De Bruycker
@author Kevin Stembridge