2 * Jexer - Java Text User Interface
4 * The MIT License (MIT)
6 * Copyright (C) 2017 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]
31 import jexer
.bits
.CellAttributes
;
32 import jexer
.bits
.GraphicsChars
;
33 import jexer
.event
.TKeypressEvent
;
34 import jexer
.event
.TMenuEvent
;
35 import jexer
.event
.TMouseEvent
;
38 * TDesktop is a special-class window that is drawn underneath everything
39 * else. Like a TWindow, it can contain widgets and perform "background"
40 * processing via onIdle(). But unlike a TWindow, it cannot be hidden,
44 * Events are passed to TDesktop as follows:
46 * <li>Mouse events are seen if they do not cover any other windows.</li>
47 * <li>Keypress events are seen if no other windows are open.</li>
48 * <li>Menu events are seen if no other windows are open.</li>
49 * <li>Command events are seen if no other windows are open.</li>
52 public class TDesktop
extends TWindow
{
57 * @param parent parent application
59 public TDesktop(final TApplication parent
) {
61 super(parent
, "", 0, 0, parent
.getScreen().getWidth(),
62 parent
.getScreen().getHeight() - 1);
68 * The default TDesktop draws a hatch character across everything.
72 CellAttributes background
= getTheme().getColor("tdesktop.background");
73 putAll(GraphicsChars
.HATCH
, background
);
77 * Hide window. This is a NOP for TDesktop.
80 public final void hide() {}
83 * Show window. This is a NOP for TDesktop.
86 public final void show() {}
89 * Called by hide(). This is a NOP for TDesktop.
92 public final void onHide() {}
95 * Called by show(). This is a NOP for TDesktop.
98 public final void onShow() {}
101 * Returns true if the mouse is currently on the close button.
103 * @return true if mouse is currently on the close button
106 protected final boolean mouseOnClose() {
111 * Returns true if the mouse is currently on the maximize/restore button.
113 * @return true if the mouse is currently on the maximize/restore button
116 protected final boolean mouseOnMaximize() {
121 * Returns true if the mouse is currently on the resizable lower right
124 * @return true if the mouse is currently on the resizable lower right
128 protected final boolean mouseOnResize() {
133 * Handle mouse button presses.
135 * @param mouse mouse button event
138 public void onMouseDown(final TMouseEvent mouse
) {
142 for (TWidget widget
: getChildren()) {
143 if (widget
.mouseWouldHit(mouse
)) {
144 // Dispatch to this child, also activate it
147 // Set x and y relative to the child's coordinates
148 mouse
.setX(mouse
.getAbsoluteX() - widget
.getAbsoluteX());
149 mouse
.setY(mouse
.getAbsoluteY() - widget
.getAbsoluteY());
150 widget
.handleEvent(mouse
);
157 * Handle mouse button releases.
159 * @param mouse mouse button release event
162 public void onMouseUp(final TMouseEvent mouse
) {
166 for (TWidget widget
: getChildren()) {
167 if (widget
.mouseWouldHit(mouse
)) {
168 // Dispatch to this child, also activate it
171 // Set x and y relative to the child's coordinates
172 mouse
.setX(mouse
.getAbsoluteX() - widget
.getAbsoluteX());
173 mouse
.setY(mouse
.getAbsoluteY() - widget
.getAbsoluteY());
174 widget
.handleEvent(mouse
);
181 * Handle mouse movements.
183 * @param mouse mouse motion event
186 public void onMouseMotion(final TMouseEvent mouse
) {
189 // Default: do nothing, pass to children instead
190 super.onMouseMotion(mouse
);
196 * @param keypress keystroke event
199 public void onKeypress(final TKeypressEvent keypress
) {
200 // Default: do nothing, pass to children instead
201 super.onKeypress(keypress
);
205 * Handle posted menu events.
207 * @param menu menu event
210 public void onMenu(final TMenuEvent menu
) {
211 // Default: do nothing, pass to children instead