2 * Jexer - Java Text User Interface
4 * The MIT License (MIT)
6 * Copyright (C) 2016 Kevin Lamonte
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 * DEALINGS IN THE SOFTWARE.
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
32 * This class encapsulates a user command event. User commands can be
33 * generated by menu actions, keyboard accelerators, and other UI elements.
34 * Commands can operate on both the application and individual widgets.
36 public class TCommand
{
39 * Immediately abort the application (e.g. remote side closed
42 public static final int ABORT
= 1;
47 public static final int OPEN
= 2;
52 public static final int EXIT
= 3;
55 * Spawn OS shell window.
57 public static final int SHELL
= 4;
60 * Cut selected text and copy to the clipboard.
62 public static final int CUT
= 5;
65 * Copy selected text to clipboard.
67 public static final int COPY
= 6;
70 * Paste from clipboard.
72 public static final int PASTE
= 7;
75 * Clear selected text without copying it to the clipboard.
77 public static final int CLEAR
= 8;
82 public static final int TILE
= 9;
87 public static final int CASCADE
= 10;
92 public static final int CLOSE_ALL
= 11;
95 * Move (move/resize) window.
97 public static final int WINDOW_MOVE
= 12;
100 * Zoom (maximize/restore) window.
102 public static final int WINDOW_ZOOM
= 13;
105 * Next window (like Alt-TAB).
107 public static final int WINDOW_NEXT
= 14;
110 * Previous window (like Shift-Alt-TAB).
112 public static final int WINDOW_PREVIOUS
= 15;
117 public static final int WINDOW_CLOSE
= 16;
122 public static final int HELP
= 20;
125 * Type of command, one of EXIT, CASCADE, etc.
130 * Protected constructor. Subclasses can be used to define new commands.
132 * @param type the Type of command, one of EXIT, CASCADE, etc.
134 protected TCommand(final int type
) {
139 * Make human-readable description of this TCommand.
141 * @return displayable String
144 public final String
toString() {
145 return String
.format("%s", type
);
149 * Comparison check. All fields must match to return true.
151 * @param rhs another TCommand instance
152 * @return true if all fields are equal
155 public final boolean equals(final Object rhs
) {
156 if (!(rhs
instanceof TCommand
)) {
160 TCommand that
= (TCommand
) rhs
;
161 return (type
== that
.type
);
165 * Hashcode uses all fields in equals().
170 public int hashCode() {
174 public static final TCommand cmAbort
= new TCommand(ABORT
);
175 public static final TCommand cmExit
= new TCommand(EXIT
);
176 public static final TCommand cmQuit
= new TCommand(EXIT
);
177 public static final TCommand cmOpen
= new TCommand(OPEN
);
178 public static final TCommand cmShell
= new TCommand(SHELL
);
179 public static final TCommand cmCut
= new TCommand(CUT
);
180 public static final TCommand cmCopy
= new TCommand(COPY
);
181 public static final TCommand cmPaste
= new TCommand(PASTE
);
182 public static final TCommand cmClear
= new TCommand(CLEAR
);
183 public static final TCommand cmTile
= new TCommand(TILE
);
184 public static final TCommand cmCascade
= new TCommand(CASCADE
);
185 public static final TCommand cmCloseAll
= new TCommand(CLOSE_ALL
);
186 public static final TCommand cmWindowMove
= new TCommand(WINDOW_MOVE
);
187 public static final TCommand cmWindowZoom
= new TCommand(WINDOW_ZOOM
);
188 public static final TCommand cmWindowNext
= new TCommand(WINDOW_NEXT
);
189 public static final TCommand cmWindowPrevious
= new TCommand(WINDOW_PREVIOUS
);
190 public static final TCommand cmWindowClose
= new TCommand(WINDOW_CLOSE
);
191 public static final TCommand cmHelp
= new TCommand(HELP
);