-/**
+/*
* Jexer - Java Text User Interface
*
- * License: LGPLv3 or later
- *
- * 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.
+ * The MIT License (MIT)
*
- * Copyright (C) 2015 Kevin Lamonte
+ * Copyright (C) 2019 Kevin Lamonte
*
- * 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.
+ * 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 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 above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of 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
+ * 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.
*
* @author Kevin Lamonte [kevin.lamonte@gmail.com]
* @version 1
import jexer.bits.Color;
import jexer.bits.GraphicsChars;
import jexer.bits.MnemonicString;
+import jexer.bits.StringUtils;
import jexer.event.TKeypressEvent;
import jexer.event.TMouseEvent;
-import static jexer.TKeypress.*;
+import static jexer.TKeypress.kbEnter;
+import static jexer.TKeypress.kbSpace;
/**
* TButton implements a simple button. To make the button do something, pass
*
* @see TAction#DO()
*/
-public final class TButton extends TWidget {
+public class TButton extends TWidget {
+
+ // ------------------------------------------------------------------------
+ // Variables --------------------------------------------------------------
+ // ------------------------------------------------------------------------
/**
* The shortcut and button text.
*/
private TAction action;
+ /**
+ * The background color used for the button "shadow", or null for "no
+ * shadow".
+ */
+ private CellAttributes shadowColor;
+
+ // ------------------------------------------------------------------------
+ // Constructors -----------------------------------------------------------
+ // ------------------------------------------------------------------------
+
/**
* Private constructor.
*
setX(x);
setY(y);
setHeight(2);
- setWidth(mnemonic.getRawLabel().length() + 3);
+ setWidth(StringUtils.width(mnemonic.getRawLabel()) + 3);
+
+ shadowColor = new CellAttributes();
+ shadowColor.setTo(getWindow().getBackground());
+ shadowColor.setForeColor(Color.BLACK);
+ shadowColor.setBold(false);
}
/**
this.action = action;
}
+ // ------------------------------------------------------------------------
+ // Event handlers ---------------------------------------------------------
+ // ------------------------------------------------------------------------
+
/**
* Returns true if the mouse is currently on the button.
*
return false;
}
- /**
- * Draw a button with a shadow.
- */
- @Override
- public void draw() {
- CellAttributes buttonColor;
- CellAttributes menuMnemonicColor;
- CellAttributes shadowColor = new CellAttributes();
- shadowColor.setTo(getWindow().getBackground());
- shadowColor.setForeColor(Color.BLACK);
- shadowColor.setBold(false);
-
- if (!getEnabled()) {
- buttonColor = getTheme().getColor("tbutton.disabled");
- menuMnemonicColor = getTheme().getColor("tbutton.disabled");
- } else if (getAbsoluteActive()) {
- buttonColor = getTheme().getColor("tbutton.active");
- menuMnemonicColor = getTheme().getColor("tbutton.mnemonic.highlighted");
- } else {
- buttonColor = getTheme().getColor("tbutton.inactive");
- menuMnemonicColor = getTheme().getColor("tbutton.mnemonic");
- }
-
- if (inButtonPress) {
- getScreen().putCharXY(1, 0, ' ', buttonColor);
- getScreen().putStrXY(2, 0, mnemonic.getRawLabel(), buttonColor);
- getScreen().putCharXY(getWidth() - 1, 0, ' ', buttonColor);
- } else {
- getScreen().putCharXY(0, 0, ' ', buttonColor);
- getScreen().putStrXY(1, 0, mnemonic.getRawLabel(), buttonColor);
- getScreen().putCharXY(getWidth() - 2, 0, ' ', buttonColor);
-
- getScreen().putCharXY(getWidth() - 1, 0,
- GraphicsChars.CP437[0xDC], shadowColor);
- getScreen().hLineXY(1, 1, getWidth() - 1,
- GraphicsChars.CP437[0xDF], shadowColor);
- }
- if (mnemonic.getShortcutIdx() >= 0) {
- if (inButtonPress) {
- getScreen().putCharXY(2 + mnemonic.getShortcutIdx(), 0,
- mnemonic.getShortcut(), menuMnemonicColor);
- } else {
- getScreen().putCharXY(1 + mnemonic.getShortcutIdx(), 0,
- mnemonic.getShortcut(), menuMnemonicColor);
- }
-
- }
- }
-
/**
* Handle mouse button presses.
*
public void onMouseDown(final TMouseEvent mouse) {
this.mouse = mouse;
- if ((mouseOnButton()) && (mouse.getMouse1())) {
+ if ((mouseOnButton()) && (mouse.isMouse1())) {
// Begin button press
inButtonPress = true;
}
public void onMouseUp(final TMouseEvent mouse) {
this.mouse = mouse;
- if (inButtonPress && mouse.getMouse1()) {
- inButtonPress = false;
+ if (inButtonPress && mouse.isMouse1()) {
// Dispatch the event
- if (action != null) {
- action.DO();
- }
+ dispatch();
}
}
|| keypress.equals(kbSpace)
) {
// Dispatch
- if (action != null) {
- action.DO();
- }
+ dispatch();
return;
}
super.onKeypress(keypress);
}
+ // ------------------------------------------------------------------------
+ // TWidget ----------------------------------------------------------------
+ // ------------------------------------------------------------------------
+
+ /**
+ * Draw a button with a shadow.
+ */
+ @Override
+ public void draw() {
+ CellAttributes buttonColor;
+ CellAttributes menuMnemonicColor;
+
+ if (!isEnabled()) {
+ buttonColor = getTheme().getColor("tbutton.disabled");
+ menuMnemonicColor = getTheme().getColor("tbutton.disabled");
+ } else if (isAbsoluteActive()) {
+ buttonColor = getTheme().getColor("tbutton.active");
+ menuMnemonicColor = getTheme().getColor("tbutton.mnemonic.highlighted");
+ } else {
+ buttonColor = getTheme().getColor("tbutton.inactive");
+ menuMnemonicColor = getTheme().getColor("tbutton.mnemonic");
+ }
+
+ if (inButtonPress) {
+ putCharXY(1, 0, ' ', buttonColor);
+ putStringXY(2, 0, mnemonic.getRawLabel(), buttonColor);
+ putCharXY(getWidth() - 1, 0, ' ', buttonColor);
+ } else {
+ putCharXY(0, 0, ' ', buttonColor);
+ putStringXY(1, 0, mnemonic.getRawLabel(), buttonColor);
+ putCharXY(getWidth() - 2, 0, ' ', buttonColor);
+
+ if (shadowColor != null) {
+ putCharXY(getWidth() - 1, 0,
+ GraphicsChars.CP437[0xDC], shadowColor);
+ hLineXY(1, 1, getWidth() - 1,
+ GraphicsChars.CP437[0xDF], shadowColor);
+ }
+ }
+ if (mnemonic.getShortcutIdx() >= 0) {
+ if (inButtonPress) {
+ putCharXY(2 + mnemonic.getShortcutIdx(), 0,
+ mnemonic.getShortcut(), menuMnemonicColor);
+ } else {
+ putCharXY(1 + mnemonic.getShortcutIdx(), 0,
+ mnemonic.getShortcut(), menuMnemonicColor);
+ }
+ }
+ }
+
+ // ------------------------------------------------------------------------
+ // TButton ----------------------------------------------------------------
+ // ------------------------------------------------------------------------
+
+ /**
+ * Get the mnemonic string for this button.
+ *
+ * @return mnemonic string
+ */
+ public MnemonicString getMnemonic() {
+ return mnemonic;
+ }
+
+ /**
+ * Act as though the button was pressed. This is useful for other UI
+ * elements to get the same action as if the user clicked the button.
+ */
+ public void dispatch() {
+ if (action != null) {
+ action.DO();
+ inButtonPress = false;
+ }
+ }
+
+ /**
+ * Set the background color used for the button "shadow". If null, no
+ * shadow will be drawn.
+ *
+ * @param color the new background color, or null for no shadow
+ */
+ public void setShadowColor(final CellAttributes color) {
+ if (color != null) {
+ shadowColor = new CellAttributes();
+ shadowColor.setTo(color);
+ shadowColor.setForeColor(Color.BLACK);
+ shadowColor.setBold(false);
+ } else {
+ shadowColor = null;
+ }
+ }
+
}