keyboard accelerators

[nikiroo-utils.git] / src / jexer / event / TKeypressEvent.java

diff --git a/src/jexer/event/TKeypressEvent.java b/src/jexer/event/TKeypressEvent.java
index 4f54df907ba16e62649a98df25cdca3269d66b37..bf8a51afe09ce4ec7f723a202c4dfcd12f9684e3 100644 (file)
--- a/src/jexer/event/TKeypressEvent.java
+++ b/src/jexer/event/TKeypressEvent.java
@@ -1,16 +1,11 @@
 /**
  * Jexer - Java Text User Interface
  *
- * Version: $Id$
- *
- * Author: Kevin Lamonte, <a href="mailto:kevin.lamonte@gmail.com">kevin.lamonte@gmail.com</a>
- *
  * License: LGPLv3 or later
  *
- * Copyright: 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.
+ * 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) 2015  Kevin Lamonte
  *
@@ -29,6 +24,9 @@
  * http://www.gnu.org/licenses/, or write to the Free Software
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  * 02110-1301 USA
+ *
+ * @author Kevin Lamonte [kevin.lamonte@gmail.com]
+ * @version 1
  */
 package jexer.event;
 
@@ -37,34 +35,108 @@ import jexer.TKeypress;
 /**
  * This class encapsulates a keyboard input event.
  */
-public class TKeypressEvent extends TInputEvent {
+public final class TKeypressEvent extends TInputEvent {
+
+    /**
+     * Keystroke received.
+     */
+    private TKeypress key;
+
+    /**
+     * Get keystroke.
+     *
+     * @return keystroke
+     */
+    public TKeypress getKey() {
+        return key;
+    }
 
     /**
-     * Keystroke received
+     * Public contructor.
+     *
+     * @param key the TKeypress received
      */
-    public TKeypress key;
+    public TKeypressEvent(final TKeypress key) {
+        this.key = key;
+    }
 
     /**
-     * Public contructor
+     * Public constructor.
+     *
+     * @param isKey is true, this is a function key
+     * @param fnKey the function key code (only valid if isKey is true)
+     * @param ch the character (only valid if fnKey is false)
+     * @param alt if true, ALT was pressed with this keystroke
+     * @param ctrl if true, CTRL was pressed with this keystroke
+     * @param shift if true, SHIFT was pressed with this keystroke
      */
-    public TKeypressEvent() {
-       key = new TKeypress(false, 0, ' ', false, false, false);
+    public TKeypressEvent(final boolean isKey, final int fnKey, final char ch,
+        final boolean alt, final boolean ctrl, final boolean shift) {
+
+        this.key = new TKeypress(isKey, fnKey, ch, alt, ctrl, shift);
     }
 
     /**
-     * Public contructor
+     * Public constructor.
      *
      * @param key the TKeypress received
+     * @param alt if true, ALT was pressed with this keystroke
+     * @param ctrl if true, CTRL was pressed with this keystroke
+     * @param shift if true, SHIFT was pressed with this keystroke
      */
-    public TKeypressEvent(TKeypress key) {
-       this.key = key;
+    public TKeypressEvent(final TKeypress key,
+        final boolean alt, final boolean ctrl, final boolean shift) {
+
+        this.key = new TKeypress(key.getIsKey(), key.getFnKey(), key.getCh(),
+            alt, ctrl, shift);
+    }
+
+    /**
+     * Comparison check.  All fields must match to return true.
+     *
+     * @param rhs another TKeypressEvent or TKeypress instance
+     * @return true if all fields are equal
+     */
+    @Override
+    public boolean equals(final Object rhs) {
+        if (!(rhs instanceof TKeypressEvent)
+            && !(rhs instanceof TKeypress)
+        ) {
+            return false;
+        }
+
+        if (rhs instanceof TKeypressEvent) {
+            TKeypressEvent that = (TKeypressEvent) rhs;
+            return (key.equals(that.key)
+                && (getTime().equals(that.getTime())));
+        }
+
+        TKeypress that = (TKeypress) rhs;
+        return (key.equals(that));
+    }
+
+    /**
+     * Hashcode uses all fields in equals().
+     *
+     * @return the hash
+     */
+    @Override
+    public int hashCode() {
+        int A = 13;
+        int B = 23;
+        int hash = A;
+        hash = (B * hash) + getTime().hashCode();
+        hash = (B * hash) + key.hashCode();
+        return hash;
     }
 
     /**
-     * Make human-readable description of this event
+     * Make human-readable description of this TKeypressEvent.
+     *
+     * @return displayable String
      */
     @Override
     public String toString() {
-       return String.format("Keypress: %s", key.toString());
+        return String.format("Keypress: %s", key.toString());
     }
 }