LICENSE CHANGED TO MIT
[nikiroo-utils.git] / src / jexer / TButton.java
index 24ee94c1abb9c0ff942ddeb90ef1a2c232cc356c..748fe247c035b5dccf22acc913271fb0dbc30b10 100644 (file)
@@ -1,29 +1,27 @@
-/**
+/*
  * 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) 2016 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
@@ -51,6 +49,15 @@ public final class TButton extends TWidget {
      */
     private MnemonicString mnemonic;
 
+    /**
+     * Get the mnemonic string for this button.
+     *
+     * @return mnemonic string
+     */
+    public MnemonicString getMnemonic() {
+        return mnemonic;
+    }
+
     /**
      * Remember mouse state.
      */
@@ -66,6 +73,16 @@ public final class TButton extends TWidget {
      */
     private TAction action;
 
+    /**
+     * 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();
+        }
+    }
+
     /**
      * Private constructor.
      *
@@ -136,10 +153,10 @@ public final class TButton extends TWidget {
         shadowColor.setForeColor(Color.BLACK);
         shadowColor.setBold(false);
 
-        if (!getEnabled()) {
+        if (!isEnabled()) {
             buttonColor = getTheme().getColor("tbutton.disabled");
             menuMnemonicColor = getTheme().getColor("tbutton.disabled");
-        } else if (getAbsoluteActive()) {
+        } else if (isAbsoluteActive()) {
             buttonColor = getTheme().getColor("tbutton.active");
             menuMnemonicColor = getTheme().getColor("tbutton.mnemonic.highlighted");
         } else {
@@ -149,11 +166,11 @@ public final class TButton extends TWidget {
 
         if (inButtonPress) {
             getScreen().putCharXY(1, 0, ' ', buttonColor);
-            getScreen().putStrXY(2, 0, mnemonic.getRawLabel(), buttonColor);
+            getScreen().putStringXY(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().putStringXY(1, 0, mnemonic.getRawLabel(), buttonColor);
             getScreen().putCharXY(getWidth() - 2, 0, ' ', buttonColor);
 
             getScreen().putCharXY(getWidth() - 1, 0,
@@ -182,7 +199,7 @@ public final class TButton extends TWidget {
     public void onMouseDown(final TMouseEvent mouse) {
         this.mouse = mouse;
 
-        if ((mouseOnButton()) && (mouse.getMouse1())) {
+        if ((mouseOnButton()) && (mouse.isMouse1())) {
             // Begin button press
             inButtonPress = true;
         }
@@ -197,7 +214,7 @@ public final class TButton extends TWidget {
     public void onMouseUp(final TMouseEvent mouse) {
         this.mouse = mouse;
 
-        if (inButtonPress && mouse.getMouse1()) {
+        if (inButtonPress && mouse.isMouse1()) {
             inButtonPress = false;
             // Dispatch the event
             if (action != null) {