2 * Jexer - Java Text User Interface
4 * The MIT License (MIT)
6 * Copyright (C) 2019 Kevin Lamonte
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
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.
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
31 import jexer
.bits
.CellAttributes
;
32 import jexer
.bits
.Color
;
33 import jexer
.bits
.GraphicsChars
;
34 import jexer
.bits
.MnemonicString
;
35 import jexer
.event
.TKeypressEvent
;
36 import jexer
.event
.TMouseEvent
;
37 import static jexer
.TKeypress
.kbEnter
;
38 import static jexer
.TKeypress
.kbSpace
;
41 * TButton implements a simple button. To make the button do something, pass
42 * a TAction class to its constructor.
46 public class TButton
extends TWidget
{
48 // ------------------------------------------------------------------------
49 // Variables --------------------------------------------------------------
50 // ------------------------------------------------------------------------
53 * The shortcut and button text.
55 private MnemonicString mnemonic
;
58 * Remember mouse state.
60 private TMouseEvent mouse
;
63 * True when the button is being pressed and held down.
65 private boolean inButtonPress
= false;
68 * The action to perform when the button is clicked.
70 private TAction action
;
73 * The background color used for the button "shadow", or null for "no
76 private CellAttributes shadowColor
;
78 // ------------------------------------------------------------------------
79 // Constructors -----------------------------------------------------------
80 // ------------------------------------------------------------------------
83 * Private constructor.
85 * @param parent parent widget
86 * @param text label on the button
87 * @param x column relative to parent
88 * @param y row relative to parent
90 private TButton(final TWidget parent
, final String text
,
91 final int x
, final int y
) {
93 // Set parent and window
96 mnemonic
= new MnemonicString(text
);
101 setWidth(mnemonic
.getRawLabel().length() + 3);
103 shadowColor
= new CellAttributes();
104 shadowColor
.setTo(getWindow().getBackground());
105 shadowColor
.setForeColor(Color
.BLACK
);
106 shadowColor
.setBold(false);
110 * Public constructor.
112 * @param parent parent widget
113 * @param text label on the button
114 * @param x column relative to parent
115 * @param y row relative to parent
116 * @param action to call when button is pressed
118 public TButton(final TWidget parent
, final String text
,
119 final int x
, final int y
, final TAction action
) {
121 this(parent
, text
, x
, y
);
122 this.action
= action
;
125 // ------------------------------------------------------------------------
126 // Event handlers ---------------------------------------------------------
127 // ------------------------------------------------------------------------
130 * Returns true if the mouse is currently on the button.
132 * @return if true the mouse is currently on the button
134 private boolean mouseOnButton() {
135 int rightEdge
= getWidth() - 1;
140 && (mouse
.getY() == 0)
141 && (mouse
.getX() >= 0)
142 && (mouse
.getX() < rightEdge
)
150 * Handle mouse button presses.
152 * @param mouse mouse button event
155 public void onMouseDown(final TMouseEvent mouse
) {
158 if ((mouseOnButton()) && (mouse
.isMouse1())) {
159 // Begin button press
160 inButtonPress
= true;
165 * Handle mouse button releases.
167 * @param mouse mouse button release event
170 public void onMouseUp(final TMouseEvent mouse
) {
173 if (inButtonPress
&& mouse
.isMouse1()) {
174 // Dispatch the event
181 * Handle mouse movements.
183 * @param mouse mouse motion event
186 public void onMouseMotion(final TMouseEvent mouse
) {
189 if (!mouseOnButton()) {
190 inButtonPress
= false;
197 * @param keypress keystroke event
200 public void onKeypress(final TKeypressEvent keypress
) {
201 if (keypress
.equals(kbEnter
)
202 || keypress
.equals(kbSpace
)
209 // Pass to parent for the things we don't care about.
210 super.onKeypress(keypress
);
213 // ------------------------------------------------------------------------
214 // TWidget ----------------------------------------------------------------
215 // ------------------------------------------------------------------------
218 * Draw a button with a shadow.
222 CellAttributes buttonColor
;
223 CellAttributes menuMnemonicColor
;
226 buttonColor
= getTheme().getColor("tbutton.disabled");
227 menuMnemonicColor
= getTheme().getColor("tbutton.disabled");
228 } else if (isAbsoluteActive()) {
229 buttonColor
= getTheme().getColor("tbutton.active");
230 menuMnemonicColor
= getTheme().getColor("tbutton.mnemonic.highlighted");
232 buttonColor
= getTheme().getColor("tbutton.inactive");
233 menuMnemonicColor
= getTheme().getColor("tbutton.mnemonic");
237 putCharXY(1, 0, ' ', buttonColor
);
238 putStringXY(2, 0, mnemonic
.getRawLabel(), buttonColor
);
239 putCharXY(getWidth() - 1, 0, ' ', buttonColor
);
241 putCharXY(0, 0, ' ', buttonColor
);
242 putStringXY(1, 0, mnemonic
.getRawLabel(), buttonColor
);
243 putCharXY(getWidth() - 2, 0, ' ', buttonColor
);
245 if (shadowColor
!= null) {
246 putCharXY(getWidth() - 1, 0,
247 GraphicsChars
.CP437
[0xDC], shadowColor
);
248 hLineXY(1, 1, getWidth() - 1,
249 GraphicsChars
.CP437
[0xDF], shadowColor
);
252 if (mnemonic
.getShortcutIdx() >= 0) {
254 putCharXY(2 + mnemonic
.getShortcutIdx(), 0,
255 mnemonic
.getShortcut(), menuMnemonicColor
);
257 putCharXY(1 + mnemonic
.getShortcutIdx(), 0,
258 mnemonic
.getShortcut(), menuMnemonicColor
);
263 // ------------------------------------------------------------------------
264 // TButton ----------------------------------------------------------------
265 // ------------------------------------------------------------------------
268 * Get the mnemonic string for this button.
270 * @return mnemonic string
272 public MnemonicString
getMnemonic() {
277 * Act as though the button was pressed. This is useful for other UI
278 * elements to get the same action as if the user clicked the button.
280 public void dispatch() {
281 if (action
!= null) {
283 inButtonPress
= false;
288 * Set the background color used for the button "shadow". If null, no
289 * shadow will be drawn.
291 * @param color the new background color, or null for no shadow
293 public void setShadowColor(final CellAttributes color
) {
295 shadowColor
= new CellAttributes();
296 shadowColor
.setTo(color
);
297 shadowColor
.setForeColor(Color
.BLACK
);
298 shadowColor
.setBold(false);