2 * Jexer - Java Text User Interface
4 * The MIT License (MIT)
6 * Copyright (C) 2019 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
{
54 // ------------------------------------------------------------------------
55 // Constructors -----------------------------------------------------------
56 // ------------------------------------------------------------------------
61 * @param parent parent application
63 public TDesktop(final TApplication parent
) {
64 super(parent
, "", 0, 0, parent
.getScreen().getWidth(),
65 parent
.getDesktopBottom() - parent
.getDesktopTop());
70 // ------------------------------------------------------------------------
71 // TWindow ----------------------------------------------------------------
72 // ------------------------------------------------------------------------
75 * The default TDesktop draws a hatch character across everything.
79 CellAttributes background
= getTheme().getColor("tdesktop.background");
80 putAll(GraphicsChars
.HATCH
, background
);
84 * Hide window. This is a NOP for TDesktop.
87 public final void hide() {}
90 * Show window. This is a NOP for TDesktop.
93 public final void show() {}
96 * Called by hide(). This is a NOP for TDesktop.
99 public final void onHide() {}
102 * Called by show(). This is a NOP for TDesktop.
105 public final void onShow() {}
108 * Returns true if the mouse is currently on the close button.
110 * @return true if mouse is currently on the close button
113 protected final boolean mouseOnClose() {
118 * Returns true if the mouse is currently on the maximize/restore button.
120 * @return true if the mouse is currently on the maximize/restore button
123 protected final boolean mouseOnMaximize() {
128 * Returns true if the mouse is currently on the resizable lower right
131 * @return true if the mouse is currently on the resizable lower right
135 protected final boolean mouseOnResize() {
140 * Handle mouse button presses.
142 * @param mouse mouse button event
145 public void onMouseDown(final TMouseEvent mouse
) {
149 for (TWidget widget
: getChildren()) {
150 if (widget
.mouseWouldHit(mouse
)) {
151 // Dispatch to this child, also activate it
154 // Set x and y relative to the child's coordinates
155 mouse
.setX(mouse
.getAbsoluteX() - widget
.getAbsoluteX());
156 mouse
.setY(mouse
.getAbsoluteY() - widget
.getAbsoluteY());
157 widget
.handleEvent(mouse
);
164 * Handle mouse button releases.
166 * @param mouse mouse button release event
169 public void onMouseUp(final TMouseEvent mouse
) {
173 for (TWidget widget
: getChildren()) {
174 if (widget
.mouseWouldHit(mouse
)) {
175 // Dispatch to this child, also activate it
178 // Set x and y relative to the child's coordinates
179 mouse
.setX(mouse
.getAbsoluteX() - widget
.getAbsoluteX());
180 mouse
.setY(mouse
.getAbsoluteY() - widget
.getAbsoluteY());
181 widget
.handleEvent(mouse
);
188 * Handle mouse movements.
190 * @param mouse mouse motion event
193 public void onMouseMotion(final TMouseEvent mouse
) {
196 // Default: do nothing, pass to children instead
197 super.onMouseMotion(mouse
);
203 * @param keypress keystroke event
206 public void onKeypress(final TKeypressEvent keypress
) {
207 // Default: do nothing, pass to children instead
208 super.onKeypress(keypress
);
212 * Handle posted menu events.
214 * @param menu menu event
217 public void onMenu(final TMenuEvent menu
) {
218 // Default: do nothing, pass to children instead