LICENSE CHANGED TO MIT

[nikiroo-utils.git] / src / jexer / menu / TMenuItem.java

diff --git a/src/jexer/menu/TMenuItem.java b/src/jexer/menu/TMenuItem.java
index ce57cc24e2c1095acefecb966c8e8ec440ac278e..ec2afb232718ca8d4c565e114a20b37a3d4d95c3 100644 (file)
--- a/src/jexer/menu/TMenuItem.java
+++ b/src/jexer/menu/TMenuItem.java
@@ -1,29 +1,27 @@
 /*
  * Jexer - Java Text User Interface
  *
- * License: LGPLv3 or later
+ * The MIT License (MIT)
  *
- * 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.
+ * Copyright (C) 2016 Kevin Lamonte
  *
- *     Copyright (C) 2015  Kevin Lamonte
+ * 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 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.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
  *
- * 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.
- *
- * 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
@@ -56,6 +54,15 @@ public class TMenuItem extends TWidget {
      */
     private int id = TMenu.MID_UNUSED;
 
+    /**
+     * Get the menu item ID.
+     *
+     * @return the id
+     */
+    public final int getId() {
+        return id;
+    }
+
     /**
      * When true, this item can be checked or unchecked.
      */
@@ -69,7 +76,7 @@ public class TMenuItem extends TWidget {
     public final void setCheckable(final boolean checkable) {
         this.checkable = checkable;
     }
-    
+
     /**
      * When true, this item is checked.
      */
@@ -80,11 +87,6 @@ public class TMenuItem extends TWidget {
      */
     private TKeypress key;
 
-    /**
-     * When true, a global accelerator can be used to select this item.
-     */
-    private boolean hasKey = false;
-
     /**
      * The title string.  Use '&' to specify a mnemonic, i.e. "&File" will
      * highlight the 'F' and allow 'f' or 'F' to select it.
@@ -100,18 +102,29 @@ public class TMenuItem extends TWidget {
         return mnemonic;
     }
 
+    /**
+     * Get a global accelerator key for this menu item.
+     *
+     * @return global keyboard accelerator, or null if no key is associated
+     * with this item
+     */
+    public final TKeypress getKey() {
+        return key;
+    }
+
     /**
      * Set a global accelerator key for this menu item.
      *
      * @param key global keyboard accelerator
      */
     public final void setKey(final TKeypress key) {
-        hasKey = true;
         this.key = key;
 
-        int newWidth = (label.length() + 4 + key.toString().length() + 2);
-        if (newWidth > getWidth()) {
-            setWidth(newWidth);
+        if (key != null) {
+            int newWidth = (label.length() + 4 + key.toString().length() + 2);
+            if (newWidth > getWidth()) {
+                setWidth(newWidth);
+            }
         }
     }
 
@@ -181,6 +194,7 @@ public class TMenuItem extends TWidget {
      * Returns true if the mouse is currently on the menu item.
      *
      * @param mouse mouse event
+     * @return if true then the mouse is currently on this item
      */
     private boolean mouseOnMenuItem(final TMouseEvent mouse) {
         if ((mouse.getY() == 0)
@@ -219,7 +233,7 @@ public class TMenuItem extends TWidget {
 
         getScreen().hLineXY(1, 0, getWidth() - 2, ' ', menuColor);
         getScreen().putStringXY(2, 0, mnemonic.getRawLabel(), menuColor);
-        if (hasKey) {
+        if (key != null) {
             String keyLabel = key.toString();
             getScreen().putStringXY((getWidth() - keyLabel.length() - 2), 0,
                 keyLabel, menuColor);
@@ -247,21 +261,6 @@ public class TMenuItem extends TWidget {
         }
     }
 
-    /**
-     * Handle mouse button presses.
-     *
-     * @param event mouse button press event
-     */
-    /* TODO: this was commented out in d-tui, why?
-    @Override
-    public void onMouseDown(final TMouseEvent event) {
-        if ((mouseOnMenuItem(event)) && (event.mouse1)) {
-            dispatch();
-            return;
-        }
-    }
-    */
-
     /**
      * Handle mouse button releases.
      *