src/jexer/bits/MnemonicString.java

   1 /*
   2  * Jexer - Java Text User Interface
   3  *
   4  * The MIT License (MIT)
   5  *
   6  * Copyright (C) 2019 Kevin Lamonte
   7  *
   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:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  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.
  25  *
  26  * @author Kevin Lamonte [kevin.lamonte@gmail.com]
  27  * @version 1
  28  */
  29 package jexer.bits;
  30
  31 /**
  32  * MnemonicString is used to render a string like "&amp;File" into a
  33  * highlighted 'F' and the rest of 'ile'.  To insert a literal '&amp;', use
  34  * two '&amp;&amp;' characters, e.g. "&amp;File &amp;&amp; Stuff" would be
  35  * "File &amp; Stuff" with the first 'F' highlighted.
  36  */
  37 public class MnemonicString {
  38
  39     // ------------------------------------------------------------------------
  40     // Variables --------------------------------------------------------------
  41     // ------------------------------------------------------------------------
  42
  43     /**
  44      * Keyboard shortcut to activate this item.
  45      */
  46     private char shortcut;
  47
  48     /**
  49      * Location of the highlighted character.
  50      */
  51     private int shortcutIdx = -1;
  52
  53     /**
  54      * The raw (uncolored) string.
  55      */
  56     private String rawLabel;
  57
  58     // ------------------------------------------------------------------------
  59     // Constructors -----------------------------------------------------------
  60     // ------------------------------------------------------------------------
  61
  62     /**
  63      * Public constructor.
  64      *
  65      * @param label widget label or title.  Label must contain a keyboard
  66      * shortcut, denoted by prefixing a letter with "&amp;", e.g. "&amp;File"
  67      */
  68     public MnemonicString(final String label) {
  69
  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;
  99     }
 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
 132 }