slightly better navigation
[fanfix.git] / src / jexer / bits / MnemonicString.java
CommitLineData
daa4106c 1/*
df8de03f
KL
2 * Jexer - Java Text User Interface
3 *
e16dda65 4 * The MIT License (MIT)
df8de03f 5 *
a69ed767 6 * Copyright (C) 2019 Kevin Lamonte
df8de03f 7 *
e16dda65
KL
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
df8de03f 14 *
e16dda65
KL
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
df8de03f 17 *
e16dda65
KL
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 * DEALINGS IN THE SOFTWARE.
7b5261bc
KL
25 *
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
27 * @version 1
df8de03f
KL
28 */
29package jexer.bits;
30
31/**
43ad7b6c
KL
32 * MnemonicString is used to render a string like "&File" into a
33 * highlighted 'F' and the rest of 'ile'. To insert a literal '&', use
34 * two '&&' characters, e.g. "&File && Stuff" would be
35 * "File & Stuff" with the first 'F' highlighted.
df8de03f 36 */
051e2913 37public class MnemonicString {
df8de03f 38
d36057df
KL
39 // ------------------------------------------------------------------------
40 // Variables --------------------------------------------------------------
41 // ------------------------------------------------------------------------
42
df8de03f 43 /**
7b5261bc 44 * Keyboard shortcut to activate this item.
df8de03f 45 */
7b5261bc 46 private char shortcut;
df8de03f
KL
47
48 /**
7b5261bc 49 * Location of the highlighted character.
df8de03f 50 */
7b5261bc 51 private int shortcutIdx = -1;
df8de03f
KL
52
53 /**
7b5261bc 54 * The raw (uncolored) string.
df8de03f 55 */
7b5261bc 56 private String rawLabel;
df8de03f 57
d36057df
KL
58 // ------------------------------------------------------------------------
59 // Constructors -----------------------------------------------------------
60 // ------------------------------------------------------------------------
329fd62e 61
df8de03f 62 /**
7b5261bc 63 * Public constructor.
df8de03f
KL
64 *
65 * @param label widget label or title. Label must contain a keyboard
43ad7b6c 66 * shortcut, denoted by prefixing a letter with "&", e.g. "&File"
df8de03f 67 */
7b5261bc 68 public MnemonicString(final String label) {
df8de03f 69
7b5261bc
KL
70 // Setup the menu shortcut
71 String newLabel = "";
72 boolean foundAmp = false;
73 boolean foundShortcut = false;
74 int scanShortcutIdx = 0;
75 for (int i = 0; i < label.length(); i++) {
76 char c = label.charAt(i);
77 if (c == '&') {
78 if (foundAmp) {
79 newLabel += '&';
80 scanShortcutIdx++;
81 } else {
82 foundAmp = true;
83 }
84 } else {
85 newLabel += c;
86 if (foundAmp) {
87 if (!foundShortcut) {
88 shortcut = c;
89 foundAmp = false;
90 foundShortcut = true;
91 shortcutIdx = scanShortcutIdx;
92 }
93 } else {
94 scanShortcutIdx++;
95 }
96 }
97 }
98 this.rawLabel = newLabel;
df8de03f 99 }
d36057df
KL
100
101 // ------------------------------------------------------------------------
102 // MnemonicString ---------------------------------------------------------
103 // ------------------------------------------------------------------------
104
105 /**
106 * Get the keyboard shortcut character.
107 *
108 * @return the highlighted character
109 */
110 public char getShortcut() {
111 return shortcut;
112 }
113
114 /**
115 * Get location of the highlighted character.
116 *
117 * @return location of the highlighted character
118 */
119 public int getShortcutIdx() {
120 return shortcutIdx;
121 }
122
123 /**
124 * Get the raw (uncolored) string.
125 *
126 * @return the raw (uncolored) string
127 */
128 public String getRawLabel() {
129 return rawLabel;
130 }
131
df8de03f 132}