src/jexer/TRadioButton.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;
  30
  31 import jexer.bits.CellAttributes;
  32 import jexer.bits.GraphicsChars;
  33 import jexer.bits.MnemonicString;
  34 import jexer.bits.StringUtils;
  35 import jexer.event.TKeypressEvent;
  36 import jexer.event.TMouseEvent;
  37 import static jexer.TKeypress.*;
  38
  39 /**
  40  * TRadioButton implements a selectable radio button.
  41  *
  42  * If the user clicks or presses space on this button, it is selected.
  43  *
  44  * If the user presses escape on this button, it is unselected.
  45  */
  46 public class TRadioButton extends TWidget {
  47
  48     // ------------------------------------------------------------------------
  49     // Variables --------------------------------------------------------------
  50     // ------------------------------------------------------------------------
  51
  52     /**
  53      * RadioButton state, true means selected.
  54      */
  55     private boolean selected = false;
  56
  57     /**
  58      * The shortcut and radio button label.
  59      */
  60     private MnemonicString mnemonic;
  61
  62     /**
  63      * ID for this radio button.  Buttons start counting at 1 in the
  64      * RadioGroup.
  65      */
  66     private int id;
  67
  68     // ------------------------------------------------------------------------
  69     // Constructors -----------------------------------------------------------
  70     // ------------------------------------------------------------------------
  71
  72     /**
  73      * Public constructor.
  74      *
  75      * @param parent parent widget
  76      * @param x column relative to parent
  77      * @param y row relative to parent
  78      * @param label label to display next to (right of) the radiobutton
  79      * @param id ID for this radio button
  80      */
  81     public TRadioButton(final TRadioGroup parent, final int x, final int y,
  82         final String label, final int id) {
  83
  84         // Set parent and window
  85         super(parent, x, y, StringUtils.width(label) + 4, 1);
  86
  87         mnemonic = new MnemonicString(label);
  88         this.id = id;
  89
  90         setCursorVisible(true);
  91         setCursorX(1);
  92     }
  93
  94     // ------------------------------------------------------------------------
  95     // Event handlers ---------------------------------------------------------
  96     // ------------------------------------------------------------------------
  97
  98     /**
  99      * Returns true if the mouse is currently on the radio button.
 100      *
 101      * @param mouse mouse event
 102      * @return if true the mouse is currently on the radio button
 103      */
 104     private boolean mouseOnRadioButton(final TMouseEvent mouse) {
 105         if ((mouse.getY() == 0)
 106             && (mouse.getX() >= 0)
 107             && (mouse.getX() <= 2)
 108         ) {
 109             return true;
 110         }
 111         return false;
 112     }
 113
 114     /**
 115      * Handle mouse button presses.
 116      *
 117      * @param mouse mouse button press event
 118      */
 119     @Override
 120     public void onMouseDown(final TMouseEvent mouse) {
 121         if ((mouseOnRadioButton(mouse)) && (mouse.isMouse1())) {
 122             // Switch state
 123             selected = true;
 124             ((TRadioGroup) getParent()).setSelected(this);
 125         }
 126     }
 127
 128     /**
 129      * Handle keystrokes.
 130      *
 131      * @param keypress keystroke event
 132      */
 133     @Override
 134     public void onKeypress(final TKeypressEvent keypress) {
 135
 136         if (keypress.equals(kbSpace)) {
 137             selected = true;
 138             ((TRadioGroup) getParent()).setSelected(this);
 139             return;
 140         }
 141
 142         if (keypress.equals(kbEsc)) {
 143             TRadioGroup parent = (TRadioGroup) getParent();
 144             if (parent.requiresSelection == false) {
 145                 selected = false;
 146                 parent.setSelected(0);
 147             }
 148             return;
 149         }
 150
 151         // Pass to parent for the things we don't care about.
 152         super.onKeypress(keypress);
 153     }
 154
 155     // ------------------------------------------------------------------------
 156     // TWidget ----------------------------------------------------------------
 157     // ------------------------------------------------------------------------
 158
 159     /**
 160      * Override TWidget's width: we can only set width at construction time.
 161      *
 162      * @param width new widget width (ignored)
 163      */
 164     @Override
 165     public void setWidth(final int width) {
 166         // Do nothing
 167     }
 168
 169     /**
 170      * Override TWidget's height: we can only set height at construction
 171      * time.
 172      *
 173      * @param height new widget height (ignored)
 174      */
 175     @Override
 176     public void setHeight(final int height) {
 177         // Do nothing
 178     }
 179
 180     /**
 181      * Draw a radio button with label.
 182      */
 183     @Override
 184     public void draw() {
 185         CellAttributes radioButtonColor;
 186         CellAttributes mnemonicColor;
 187
 188         if (isAbsoluteActive()) {
 189             radioButtonColor = getTheme().getColor("tradiobutton.active");
 190             mnemonicColor = getTheme().getColor("tradiobutton.mnemonic.highlighted");
 191         } else {
 192             radioButtonColor = getTheme().getColor("tradiobutton.inactive");
 193             mnemonicColor = getTheme().getColor("tradiobutton.mnemonic");
 194         }
 195
 196         putCharXY(0, 0, '(', radioButtonColor);
 197         if (selected) {
 198             putCharXY(1, 0, GraphicsChars.CP437[0x07], radioButtonColor);
 199         } else {
 200             putCharXY(1, 0, ' ', radioButtonColor);
 201         }
 202         putCharXY(2, 0, ')', radioButtonColor);
 203         putStringXY(4, 0, mnemonic.getRawLabel(), radioButtonColor);
 204         if (mnemonic.getScreenShortcutIdx() >= 0) {
 205             putCharXY(4 + mnemonic.getScreenShortcutIdx(), 0,
 206                 mnemonic.getShortcut(), mnemonicColor);
 207         }
 208     }
 209
 210     // ------------------------------------------------------------------------
 211     // TRadioButton -----------------------------------------------------------
 212     // ------------------------------------------------------------------------
 213
 214     /**
 215      * Get RadioButton state, true means selected.
 216      *
 217      * @return if true then this is the one button in the group that is
 218      * selected
 219      */
 220     public boolean isSelected() {
 221         return selected;
 222     }
 223
 224     /**
 225      * Set RadioButton state, true means selected.  Note package private
 226      * access.
 227      *
 228      * @param selected if true then this is the one button in the group that
 229      * is selected
 230      */
 231     void setSelected(final boolean selected) {
 232         this.selected = selected;
 233     }
 234
 235     /**
 236      * Get ID for this radio button.  Buttons start counting at 1 in the
 237      * RadioGroup.
 238      *
 239      * @return the ID
 240      */
 241     public int getId() {
 242         return id;
 243     }
 244
 245     /**
 246      * Get the mnemonic string for this button.
 247      *
 248      * @return mnemonic string
 249      */
 250     public MnemonicString getMnemonic() {
 251         return mnemonic;
 252     }
 253
 254 }