package jexer.bits;
/**
- * MnemonicString is used to render a string like "&File" into a highlighted
- * 'F' and the rest of 'ile'. To insert a literal '&', use two '&&'
- * characters, e.g. "&File && Stuff" would be "File & Stuff" with the first
- * 'F' highlighted.
+ * MnemonicString is used to render a string like "&File" into a
+ * highlighted 'F' and the rest of 'ile'. To insert a literal '&', use
+ * two '&&' characters, e.g. "&File && Stuff" would be
+ * "File & Stuff" with the first 'F' highlighted.
*/
-public final class MnemonicString {
+public class MnemonicString {
+
+ // ------------------------------------------------------------------------
+ // Variables --------------------------------------------------------------
+ // ------------------------------------------------------------------------
/**
* Keyboard shortcut to activate this item.
*/
private char shortcut;
- /**
- * Get the keyboard shortcut character.
- *
- * @return the highlighted character
- */
- public char getShortcut() {
- return shortcut;
- }
-
/**
* Location of the highlighted character.
*/
private int shortcutIdx = -1;
- /**
- * Get location of the highlighted character.
- *
- * @return location of the highlighted character
- */
- public int getShortcutIdx() {
- return shortcutIdx;
- }
-
/**
* The raw (uncolored) string.
*/
private String rawLabel;
- /**
- * Get the raw (uncolored) string.
- *
- * @return the raw (uncolored) string
- */
- public String getRawLabel() {
- return rawLabel;
- }
+ // ------------------------------------------------------------------------
+ // Constructors -----------------------------------------------------------
+ // ------------------------------------------------------------------------
/**
* Public constructor.
*
* @param label widget label or title. Label must contain a keyboard
- * shortcut, denoted by prefixing a letter with "&", e.g. "&File"
+ * shortcut, denoted by prefixing a letter with "&", e.g. "&File"
*/
public MnemonicString(final String label) {
}
this.rawLabel = newLabel;
}
+
+ // ------------------------------------------------------------------------
+ // MnemonicString ---------------------------------------------------------
+ // ------------------------------------------------------------------------
+
+ /**
+ * Get the keyboard shortcut character.
+ *
+ * @return the highlighted character
+ */
+ public char getShortcut() {
+ return shortcut;
+ }
+
+ /**
+ * Get location of the highlighted character.
+ *
+ * @return location of the highlighted character
+ */
+ public int getShortcutIdx() {
+ return shortcutIdx;
+ }
+
+ /**
+ * Get the raw (uncolored) string.
+ *
+ * @return the raw (uncolored) string
+ */
+ public String getRawLabel() {
+ return rawLabel;
+ }
+
}