X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fjexer%2FTCommand.java;h=874a29dda7fcf2ceae1d92c622d034fb31fb78e9;hb=HEAD;hp=ce19e2a06233f0e9097aded7b11fdc4ada0b9303;hpb=4328bb42c10743287dad5cf045f059ad109eb540;p=fanfix.git diff --git a/src/jexer/TCommand.java b/src/jexer/TCommand.java index ce19e2a..874a29d 100644 --- a/src/jexer/TCommand.java +++ b/src/jexer/TCommand.java @@ -1,178 +1,227 @@ -/** +/* * 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; /** - * This class encapsulates several kinds of user commands. A user command - * can be generated by a menu action or keyboard accelerator. + * This class encapsulates a user command event. User commands can be + * generated by menu actions, keyboard accelerators, and other UI elements. + * Commands can operate on both the application and individual widgets. */ public class TCommand { - public enum Type { - /** - * Immediately abort the application (e.g. remote side closed - * connection) - */ - ABORT, - - /** - * File open dialog - */ - OPEN, - - /** - * Exit application - */ - EXIT, - - /** - * Spawn OS shell window - */ - SHELL, - - /** - * Cut selected text and copy to the clipboard - */ - CUT, - - /** - * Copy selected text to clipboard - */ - COPY, - - /** - * Paste from clipboard - */ - PASTE, - - /** - * Clear selected text without copying it to the clipboard - */ - CLEAR, - - /** - * Tile windows - */ - TILE, - - /** - * Cascade windows - */ - CASCADE, - - /** - * Close all windows - */ - CLOSE_ALL, - - /** - * Move (move/resize) window - */ - WINDOW_MOVE, - - /** - * Zoom (maximize/restore) window - */ - WINDOW_ZOOM, - - /** - * Next window (like Alt-TAB) - */ - WINDOW_NEXT, - - /** - * Previous window (like Shift-Alt-TAB) - */ - WINDOW_PREVIOUS, - - /** - * Close window - */ - WINDOW_CLOSE, + // ------------------------------------------------------------------------ + // Constants -------------------------------------------------------------- + // ------------------------------------------------------------------------ - } + /** + * Immediately abort the application (e.g. remote side closed + * connection). + */ + public static final int ABORT = 1; + + /** + * File open dialog. + */ + public static final int OPEN = 2; + + /** + * Exit application. + */ + public static final int EXIT = 3; + + /** + * Spawn OS shell window. + */ + public static final int SHELL = 4; + + /** + * Cut selected text and copy to the clipboard. + */ + public static final int CUT = 5; + + /** + * Copy selected text to clipboard. + */ + public static final int COPY = 6; + + /** + * Paste from clipboard. + */ + public static final int PASTE = 7; + + /** + * Clear selected text without copying it to the clipboard. + */ + public static final int CLEAR = 8; + + /** + * Tile windows. + */ + public static final int TILE = 9; + + /** + * Cascade windows. + */ + public static final int CASCADE = 10; + + /** + * Close all windows. + */ + public static final int CLOSE_ALL = 11; + + /** + * Move (move/resize) window. + */ + public static final int WINDOW_MOVE = 12; + + /** + * Zoom (maximize/restore) window. + */ + public static final int WINDOW_ZOOM = 13; + + /** + * Next window (like Alt-TAB). + */ + public static final int WINDOW_NEXT = 14; + + /** + * Previous window (like Shift-Alt-TAB). + */ + public static final int WINDOW_PREVIOUS = 15; + + /** + * Close window. + */ + public static final int WINDOW_CLOSE = 16; + + /** + * Enter help system. + */ + public static final int HELP = 20; + + /** + * Enter first menu. + */ + public static final int MENU = 21; + + /** + * Save file. + */ + public static final int SAVE = 30; + + /** + * Backend disconnected. + */ + public static final int BACKEND_DISCONNECT = 100; + + public static final TCommand cmAbort = new TCommand(ABORT); + public static final TCommand cmExit = new TCommand(EXIT); + public static final TCommand cmQuit = new TCommand(EXIT); + public static final TCommand cmOpen = new TCommand(OPEN); + public static final TCommand cmShell = new TCommand(SHELL); + public static final TCommand cmCut = new TCommand(CUT); + public static final TCommand cmCopy = new TCommand(COPY); + public static final TCommand cmPaste = new TCommand(PASTE); + public static final TCommand cmClear = new TCommand(CLEAR); + public static final TCommand cmTile = new TCommand(TILE); + public static final TCommand cmCascade = new TCommand(CASCADE); + public static final TCommand cmCloseAll = new TCommand(CLOSE_ALL); + public static final TCommand cmWindowMove = new TCommand(WINDOW_MOVE); + public static final TCommand cmWindowZoom = new TCommand(WINDOW_ZOOM); + public static final TCommand cmWindowNext = new TCommand(WINDOW_NEXT); + public static final TCommand cmWindowPrevious = new TCommand(WINDOW_PREVIOUS); + public static final TCommand cmWindowClose = new TCommand(WINDOW_CLOSE); + public static final TCommand cmHelp = new TCommand(HELP); + public static final TCommand cmSave = new TCommand(SAVE); + public static final TCommand cmMenu = new TCommand(MENU); + public static final TCommand cmBackendDisconnect = new TCommand(BACKEND_DISCONNECT); + + // ------------------------------------------------------------------------ + // Variables -------------------------------------------------------------- + // ------------------------------------------------------------------------ /** * Type of command, one of EXIT, CASCADE, etc. */ - public Type type; + private int type; + + // ------------------------------------------------------------------------ + // Constructors ----------------------------------------------------------- + // ------------------------------------------------------------------------ /** - * Public contructor + * Public constructor. * * @param type the Type of command, one of EXIT, CASCADE, etc. */ - public TCommand(Type type) { - this.type = type; + public TCommand(final int type) { + this.type = type; } + // ------------------------------------------------------------------------ + // TCommand --------------------------------------------------------------- + // ------------------------------------------------------------------------ + /** - * Make human-readable description of this event + * Make human-readable description of this TCommand. + * + * @return displayable String */ @Override - public String toString() { - return String.format("%s", type); + public final String toString() { + return String.format("%s", type); } /** - * Comparison. All fields must match to return true. + * Comparison check. All fields must match to return true. + * + * @param rhs another TCommand instance + * @return true if all fields are equal */ @Override - public boolean equals(Object rhs) { - if (!(rhs instanceof TCommand)) { - return false; - } + public final boolean equals(final Object rhs) { + if (!(rhs instanceof TCommand)) { + return false; + } - TCommand that = (TCommand)rhs; - return (type == that.type); + TCommand that = (TCommand) rhs; + return (type == that.type); } - static public final TCommand cmAbort = new TCommand(TCommand.Type.ABORT); - static public final TCommand cmExit = new TCommand(TCommand.Type.EXIT); - static public final TCommand cmQuit = new TCommand(TCommand.Type.EXIT); - static public final TCommand cmOpen = new TCommand(TCommand.Type.OPEN); - static public final TCommand cmShell = new TCommand(TCommand.Type.SHELL); - static public final TCommand cmCut = new TCommand(TCommand.Type.CUT); - static public final TCommand cmCopy = new TCommand(TCommand.Type.COPY); - static public final TCommand cmPaste = new TCommand(TCommand.Type.PASTE); - static public final TCommand cmClear = new TCommand(TCommand.Type.CLEAR); - static public final TCommand cmTile = new TCommand(TCommand.Type.TILE); - static public final TCommand cmCascade = new TCommand(TCommand.Type.CASCADE); - static public final TCommand cmCloseAll = new TCommand(TCommand.Type.CLOSE_ALL); - static public final TCommand cmWindowMove = new TCommand(TCommand.Type.WINDOW_MOVE); - static public final TCommand cmWindowZoom = new TCommand(TCommand.Type.WINDOW_ZOOM); - static public final TCommand cmWindowNext = new TCommand(TCommand.Type.WINDOW_NEXT); - static public final TCommand cmWindowPrevious = new TCommand(TCommand.Type.WINDOW_PREVIOUS); - static public final TCommand cmWindowClose = new TCommand(TCommand.Type.WINDOW_CLOSE); + /** + * Hashcode uses all fields in equals(). + * + * @return the hash + */ + @Override + public int hashCode() { + return type; + } }