X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fjexer%2Fevent%2FTKeypressEvent.java;h=79b28f29381655022f879ef0eccd0f472d50307d;hb=12b90437b5f22c2ae6e9b9b14c3b62b60f6143e5;hp=4f54df907ba16e62649a98df25cdca3269d66b37;hpb=df8de03f80590dde35f26616db91ad6163007b7e;p=nikiroo-utils.git diff --git a/src/jexer/event/TKeypressEvent.java b/src/jexer/event/TKeypressEvent.java index 4f54df9..79b28f2 100644 --- a/src/jexer/event/TKeypressEvent.java +++ b/src/jexer/event/TKeypressEvent.java @@ -1,34 +1,30 @@ -/** +/* * Jexer - Java Text User Interface * - * Version: $Id$ - * - * Author: Kevin Lamonte, kevin.lamonte@gmail.com - * - * License: LGPLv3 or later + * The MIT License (MIT) * - * 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. + * Copyright (C) 2019 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. + * 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. * - * 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 + * @author Kevin Lamonte [kevin.lamonte@gmail.com] + * @version 1 */ package jexer.event; @@ -39,32 +35,133 @@ import jexer.TKeypress; */ public class TKeypressEvent extends TInputEvent { + // ------------------------------------------------------------------------ + // Variables -------------------------------------------------------------- + // ------------------------------------------------------------------------ + /** - * Keystroke received + * Keystroke received. */ - public TKeypress key; + private TKeypress key; + + // ------------------------------------------------------------------------ + // Constructors ----------------------------------------------------------- + // ------------------------------------------------------------------------ /** - * Public contructor + * Public contructor. + * + * @param key the TKeypress received */ - public TKeypressEvent() { - key = new TKeypress(false, 0, ' ', false, false, false); + 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(final boolean isKey, final int fnKey, final int ch, + final boolean alt, final boolean ctrl, final boolean shift) { + + this.key = new TKeypress(isKey, fnKey, ch, alt, ctrl, shift); + } + + /** + * 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(final TKeypress key, + final boolean alt, final boolean ctrl, final boolean shift) { + + this.key = new TKeypress(key.isFnKey(), key.getKeyCode(), key.getChar(), + alt, ctrl, shift); + } + + // ------------------------------------------------------------------------ + // TInputEvent ------------------------------------------------------------ + // ------------------------------------------------------------------------ + + /** + * 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 */ - public TKeypressEvent(TKeypress key) { - this.key = key; + @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()); } + + // ------------------------------------------------------------------------ + // TKeypressEvent --------------------------------------------------------- + // ------------------------------------------------------------------------ + + /** + * Get keystroke. + * + * @return keystroke + */ + public TKeypress getKey() { + return key; + } + + /** + * Create a duplicate instance. + * + * @return duplicate intance + */ + public TKeypressEvent dup() { + TKeypressEvent keypress = new TKeypressEvent(key.dup()); + return keypress; + } + }