use a .summary file
[fanfix.git] / src / jexer / TCheckBox.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 static jexer.TKeypress.kbEnter;
32 import static jexer.TKeypress.kbEsc;
33 import static jexer.TKeypress.kbSpace;
34 import jexer.bits.CellAttributes;
35 import jexer.bits.GraphicsChars;
36 import jexer.bits.MnemonicString;
37 import jexer.bits.StringUtils;
38 import jexer.event.TKeypressEvent;
39 import jexer.event.TMouseEvent;
40
41 /**
42 * TCheckBox implements an on/off checkbox.
43 */
44 public class TCheckBox extends TWidget {
45
46 // ------------------------------------------------------------------------
47 // Variables --------------------------------------------------------------
48 // ------------------------------------------------------------------------
49
50 /**
51 * CheckBox state, true means checked.
52 */
53 private boolean checked = false;
54
55 /**
56 * The shortcut and checkbox label.
57 */
58 private MnemonicString mnemonic;
59
60 /**
61 * If true, use the window's background color.
62 */
63 private boolean useWindowBackground = false;
64
65 // ------------------------------------------------------------------------
66 // Constructors -----------------------------------------------------------
67 // ------------------------------------------------------------------------
68
69 /**
70 * Public constructor.
71 *
72 * @param parent parent widget
73 * @param x column relative to parent
74 * @param y row relative to parent
75 * @param label label to display next to (right of) the checkbox
76 * @param checked initial check state
77 */
78 public TCheckBox(final TWidget parent, final int x, final int y,
79 final String label, final boolean checked) {
80
81 // Set parent and window
82 super(parent, x, y, StringUtils.width(label) + 4, 1);
83
84 mnemonic = new MnemonicString(label);
85 this.checked = checked;
86
87 setCursorVisible(true);
88 setCursorX(1);
89 }
90
91 // ------------------------------------------------------------------------
92 // Event handlers ---------------------------------------------------------
93 // ------------------------------------------------------------------------
94
95 /**
96 * Returns true if the mouse is currently on the checkbox.
97 *
98 * @param mouse mouse event
99 * @return true if the mouse is currently on the checkbox
100 */
101 private boolean mouseOnCheckBox(final TMouseEvent mouse) {
102 if ((mouse.getY() == 0)
103 && (mouse.getX() >= 0)
104 && (mouse.getX() <= 2)
105 ) {
106 return true;
107 }
108 return false;
109 }
110
111 /**
112 * Handle mouse checkbox presses.
113 *
114 * @param mouse mouse button down event
115 */
116 @Override
117 public void onMouseDown(final TMouseEvent mouse) {
118 if ((mouseOnCheckBox(mouse)) && (mouse.isMouse1())) {
119 // Switch state
120 checked = !checked;
121 }
122 }
123
124 /**
125 * Handle keystrokes.
126 *
127 * @param keypress keystroke event
128 */
129 @Override
130 public void onKeypress(final TKeypressEvent keypress) {
131 if (keypress.equals(kbSpace)
132 || keypress.equals(kbEnter)
133 ) {
134 checked = !checked;
135 return;
136 }
137
138 if (keypress.equals(kbEsc)) {
139 checked = false;
140 return;
141 }
142
143 // Pass to parent for the things we don't care about.
144 super.onKeypress(keypress);
145 }
146
147 // ------------------------------------------------------------------------
148 // TWidget ----------------------------------------------------------------
149 // ------------------------------------------------------------------------
150
151 /**
152 * Draw a checkbox with label.
153 */
154 @Override
155 public void draw() {
156 CellAttributes checkboxColor;
157 CellAttributes mnemonicColor;
158
159 if (isAbsoluteActive()) {
160 checkboxColor = getTheme().getColor("tcheckbox.active");
161 mnemonicColor = getTheme().getColor("tcheckbox.mnemonic.highlighted");
162 } else {
163 checkboxColor = getTheme().getColor("tcheckbox.inactive");
164 mnemonicColor = getTheme().getColor("tcheckbox.mnemonic");
165 }
166 if (useWindowBackground) {
167 CellAttributes background = getWindow().getBackground();
168 checkboxColor.setBackColor(background.getBackColor());
169 }
170
171 putCharXY(0, 0, '[', checkboxColor);
172 if (checked) {
173 putCharXY(1, 0, GraphicsChars.CHECK, checkboxColor);
174 } else {
175 putCharXY(1, 0, ' ', checkboxColor);
176 }
177 putCharXY(2, 0, ']', checkboxColor);
178 putStringXY(4, 0, mnemonic.getRawLabel(), checkboxColor);
179 if (mnemonic.getScreenShortcutIdx() >= 0) {
180 putCharXY(4 + mnemonic.getScreenShortcutIdx(), 0,
181 mnemonic.getShortcut(), mnemonicColor);
182 }
183 }
184
185 // ------------------------------------------------------------------------
186 // TCheckBox --------------------------------------------------------------
187 // ------------------------------------------------------------------------
188
189 /**
190 * Get checked value.
191 *
192 * @return if true, this is checked
193 */
194 public boolean isChecked() {
195 return checked;
196 }
197
198 /**
199 * Set checked value.
200 *
201 * @param checked new checked value.
202 */
203 public void setChecked(final boolean checked) {
204 this.checked = checked;
205 }
206
207 /**
208 * Get the mnemonic string for this checkbox.
209 *
210 * @return mnemonic string
211 */
212 public MnemonicString getMnemonic() {
213 return mnemonic;
214 }
215
216 }