-/**
+/*
* Jexer - Java Text User Interface
*
- * Version: $Id$
- *
- * Author: Kevin Lamonte, <a href="mailto:kevin.lamonte@gmail.com">kevin.lamonte@gmail.com</a>
- *
- * License: LGPLv3 or later
+ * The MIT License (MIT)
*
- * Copyright: This module is licensed under the GNU Lesser General
- * Public License Version 3. Please see the file "COPYING" in this
- * directory for more information about the GNU Lesser General Public
- * License Version 3.
+ * Copyright (C) 2019 Kevin Lamonte
*
- * Copyright (C) 2015 Kevin Lamonte
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
*
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public License
- * as published by the Free Software Foundation; either version 3 of
- * the License, or (at your option) any later version.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
*
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * General Public License for more details.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
*
- * You should have received a copy of the GNU Lesser General Public
- * License along with this program; if not, see
- * http://www.gnu.org/licenses/, or write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
- * 02110-1301 USA
+ * @author Kevin Lamonte [kevin.lamonte@gmail.com]
+ * @version 1
*/
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 class MnemonicString {
+ // ------------------------------------------------------------------------
+ // Variables --------------------------------------------------------------
+ // ------------------------------------------------------------------------
+
/**
- * Keyboard shortcut to activate this item
+ * Keyboard shortcut to activate this item.
*/
- public char shortcut;
+ private int shortcut;
/**
- * Location of the highlighted character
+ * Location of the highlighted character.
*/
- public int shortcutIdx = -1;
+ private int shortcutIdx = -1;
/**
- * The raw (uncolored) string
+ * Screen location of the highlighted character (number of text cells
+ * required to display from the beginning to shortcutIdx).
*/
- public String rawLabel;
+ private int screenShortcutIdx = -1;
/**
- * Public constructor
+ * The raw (uncolored) string.
+ */
+ private String 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(String label) {
-
- // Setup the menu shortcut
- String newLabel = "";
- boolean foundAmp = false;
- boolean foundShortcut = false;
- int shortcutIdx = 0;
- for (int i = 0; i < label.length(); i++) {
- char c = label.charAt(i);
- if (c == '&') {
- if (foundAmp == true) {
- newLabel += '&';
- shortcutIdx++;
- } else {
- foundAmp = true;
- }
- } else {
- newLabel += c;
- if (foundAmp == true) {
- if (foundShortcut == false) {
- shortcut = c;
- foundAmp = false;
- foundShortcut = true;
- this.shortcutIdx = shortcutIdx;
- }
- } else {
- shortcutIdx++;
- }
- }
- }
- this.rawLabel = newLabel;
+ public MnemonicString(final String label) {
+
+ // Setup the menu shortcut
+ StringBuilder newLabel = new StringBuilder();
+ boolean foundAmp = false;
+ boolean foundShortcut = false;
+ int scanShortcutIdx = 0;
+ int scanScreenShortcutIdx = 0;
+ for (int i = 0; i < label.length();) {
+ int c = label.codePointAt(i);
+ i += Character.charCount(c);
+
+ if (c == '&') {
+ if (foundAmp) {
+ newLabel.append('&');
+ scanShortcutIdx++;
+ scanScreenShortcutIdx++;
+ } else {
+ foundAmp = true;
+ }
+ } else {
+ newLabel.append(Character.toChars(c));
+ if (foundAmp) {
+ if (!foundShortcut) {
+ shortcut = c;
+ foundAmp = false;
+ foundShortcut = true;
+ shortcutIdx = scanShortcutIdx;
+ screenShortcutIdx = scanScreenShortcutIdx;
+ }
+ } else {
+ scanShortcutIdx++;
+ scanScreenShortcutIdx += StringUtils.width(c);
+ }
+ }
+ }
+ this.rawLabel = newLabel.toString();
+ }
+
+ // ------------------------------------------------------------------------
+ // MnemonicString ---------------------------------------------------------
+ // ------------------------------------------------------------------------
+
+ /**
+ * Get the keyboard shortcut character.
+ *
+ * @return the highlighted character
+ */
+ public int getShortcut() {
+ return shortcut;
}
-}
+ /**
+ * Get location of the highlighted character.
+ *
+ * @return location of the highlighted character
+ */
+ public int getShortcutIdx() {
+ return shortcutIdx;
+ }
+
+ /**
+ * Get the screen location of the highlighted character.
+ *
+ * @return the number of text cells required to display from the
+ * beginning of the label to shortcutIdx
+ */
+ public int getScreenShortcutIdx() {
+ return screenShortcutIdx;
+ }
+
+ /**
+ * Get the raw (uncolored) string.
+ *
+ * @return the raw (uncolored) string
+ */
+ public String getRawLabel() {
+ return rawLabel;
+ }
+
+}