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]
32 import java
.io
.InputStream
;
33 import java
.io
.IOException
;
34 import java
.io
.OutputStream
;
35 import java
.io
.PrintWriter
;
36 import java
.io
.Reader
;
37 import java
.io
.UnsupportedEncodingException
;
38 import java
.text
.MessageFormat
;
39 import java
.util
.ArrayList
;
40 import java
.util
.Collections
;
41 import java
.util
.Date
;
42 import java
.util
.HashMap
;
43 import java
.util
.LinkedList
;
44 import java
.util
.List
;
46 import java
.util
.ResourceBundle
;
48 import jexer
.bits
.Cell
;
49 import jexer
.bits
.CellAttributes
;
50 import jexer
.bits
.ColorTheme
;
51 import jexer
.bits
.StringUtils
;
52 import jexer
.event
.TCommandEvent
;
53 import jexer
.event
.TInputEvent
;
54 import jexer
.event
.TKeypressEvent
;
55 import jexer
.event
.TMenuEvent
;
56 import jexer
.event
.TMouseEvent
;
57 import jexer
.event
.TResizeEvent
;
58 import jexer
.backend
.Backend
;
59 import jexer
.backend
.MultiBackend
;
60 import jexer
.backend
.Screen
;
61 import jexer
.backend
.SwingBackend
;
62 import jexer
.backend
.ECMA48Backend
;
63 import jexer
.backend
.TWindowBackend
;
64 import jexer
.menu
.TMenu
;
65 import jexer
.menu
.TMenuItem
;
66 import jexer
.menu
.TSubMenu
;
67 import static jexer
.TCommand
.*;
68 import static jexer
.TKeypress
.*;
71 * TApplication is the main driver class for a full Text User Interface
72 * application. It manages windows, provides a menu bar and status bar, and
73 * processes events received from the user.
75 public class TApplication
implements Runnable
{
80 private static final ResourceBundle i18n
= ResourceBundle
.getBundle(TApplication
.class.getName());
82 // ------------------------------------------------------------------------
83 // Constants --------------------------------------------------------------
84 // ------------------------------------------------------------------------
87 * If true, emit thread stuff to System.err.
89 private static final boolean debugThreads
= false;
92 * If true, emit events being processed to System.err.
94 private static final boolean debugEvents
= false;
97 * If true, do "smart placement" on new windows that are not specified to
100 private static final boolean smartWindowPlacement
= true;
103 * Two backend types are available.
105 public static enum BackendType
{
112 * An ECMA48 / ANSI X3.64 / XTERM style terminal.
117 * Synonym for ECMA48.
122 // ------------------------------------------------------------------------
123 // Variables --------------------------------------------------------------
124 // ------------------------------------------------------------------------
127 * The primary event handler thread.
129 private volatile WidgetEventHandler primaryEventHandler
;
132 * The secondary event handler thread.
134 private volatile WidgetEventHandler secondaryEventHandler
;
137 * The screen handler thread.
139 private volatile ScreenHandler screenHandler
;
142 * The widget receiving events from the secondary event handler thread.
144 private volatile TWidget secondaryEventReceiver
;
147 * Access to the physical screen, keyboard, and mouse.
149 private Backend backend
;
152 * Actual mouse coordinate X.
157 * Actual mouse coordinate Y.
162 * Old version of mouse coordinate X.
164 private int oldMouseX
;
167 * Old version mouse coordinate Y.
169 private int oldMouseY
;
172 * Old drawn version of mouse coordinate X.
174 private int oldDrawnMouseX
;
177 * Old drawn version mouse coordinate Y.
179 private int oldDrawnMouseY
;
182 * Old drawn version mouse cell.
184 private Cell oldDrawnMouseCell
= new Cell();
187 * The last mouse up click time, used to determine if this is a mouse
190 private long lastMouseUpTime
;
193 * The amount of millis between mouse up events to assume a double-click.
195 private long doubleClickTime
= 250;
198 * Event queue that is filled by run().
200 private List
<TInputEvent
> fillEventQueue
;
203 * Event queue that will be drained by either primary or secondary
206 private List
<TInputEvent
> drainEventQueue
;
209 * Top-level menus in this application.
211 private List
<TMenu
> menus
;
214 * Stack of activated sub-menus in this application.
216 private List
<TMenu
> subMenus
;
219 * The currently active menu.
221 private TMenu activeMenu
= null;
224 * Active keyboard accelerators.
226 private Map
<TKeypress
, TMenuItem
> accelerators
;
231 private List
<TMenuItem
> menuItems
;
234 * Windows and widgets pull colors from this ColorTheme.
236 private ColorTheme theme
;
239 * The top-level windows (but not menus).
241 private List
<TWindow
> windows
;
244 * The currently acive window.
246 private TWindow activeWindow
= null;
249 * Timers that are being ticked.
251 private List
<TTimer
> timers
;
254 * When true, the application has been started.
256 private volatile boolean started
= false;
259 * When true, exit the application.
261 private volatile boolean quit
= false;
264 * When true, repaint the entire screen.
266 private volatile boolean repaint
= true;
269 * Y coordinate of the top edge of the desktop. For now this is a
270 * constant. Someday it would be nice to have a multi-line menu or
273 private int desktopTop
= 1;
276 * Y coordinate of the bottom edge of the desktop.
278 private int desktopBottom
;
281 * An optional TDesktop background window that is drawn underneath
284 private TDesktop desktop
;
287 * If true, focus follows mouse: windows automatically raised if the
288 * mouse passes over them.
290 private boolean focusFollowsMouse
= false;
293 * If true, display a text-based mouse cursor.
295 private boolean textMouse
= true;
298 * If true, hide the mouse after typing a keystroke.
300 private boolean hideMouseWhenTyping
= false;
303 * If true, the mouse should not be displayed because a keystroke was
306 private boolean typingHidMouse
= false;
309 * If true, hide the status bar.
311 private boolean hideStatusBar
= false;
314 * If true, hide the menu bar.
316 private boolean hideMenuBar
= false;
319 * The list of commands to run before the next I/O check.
321 private List
<Runnable
> invokeLaters
= new LinkedList
<Runnable
>();
324 * The last time the screen was resized.
326 private long screenResizeTime
= 0;
329 * WidgetEventHandler is the main event consumer loop. There are at most
330 * two such threads in existence: the primary for normal case and a
331 * secondary that is used for TMessageBox, TInputBox, and similar.
333 private class WidgetEventHandler
implements Runnable
{
335 * The main application.
337 private TApplication application
;
340 * Whether or not this WidgetEventHandler is the primary or secondary
343 private boolean primary
= true;
346 * Public constructor.
348 * @param application the main application
349 * @param primary if true, this is the primary event handler thread
351 public WidgetEventHandler(final TApplication application
,
352 final boolean primary
) {
354 this.application
= application
;
355 this.primary
= primary
;
362 // Wrap everything in a try, so that if we go belly up we can let
363 // the user have their terminal back.
366 } catch (Throwable t
) {
367 this.application
.restoreConsole();
369 this.application
.exit();
376 private void runImpl() {
377 boolean first
= true;
380 while (!application
.quit
) {
382 // Wait until application notifies me
383 while (!application
.quit
) {
385 synchronized (application
.drainEventQueue
) {
386 if (application
.drainEventQueue
.size() > 0) {
395 timeout
= application
.getSleepTime(1000);
399 // A timer needs to fire, break out.
404 System
.err
.printf("%d %s %s %s sleep %d millis\n",
405 System
.currentTimeMillis(), this,
406 primary ?
"primary" : "secondary",
407 Thread
.currentThread(), timeout
);
410 synchronized (this) {
415 System
.err
.printf("%d %s %s %s AWAKE\n",
416 System
.currentTimeMillis(), this,
417 primary ?
"primary" : "secondary",
418 Thread
.currentThread());
422 && (application
.secondaryEventReceiver
== null)
424 // Secondary thread, emergency exit. If we got
425 // here then something went wrong with the
426 // handoff between yield() and closeWindow().
427 synchronized (application
.primaryEventHandler
) {
428 application
.primaryEventHandler
.notify();
430 application
.secondaryEventHandler
= null;
431 throw new RuntimeException("secondary exited " +
435 } catch (InterruptedException e
) {
438 } // while (!application.quit)
440 // Pull all events off the queue
442 TInputEvent event
= null;
443 synchronized (application
.drainEventQueue
) {
444 if (application
.drainEventQueue
.size() == 0) {
447 event
= application
.drainEventQueue
.remove(0);
450 // We will have an event to process, so repaint the
451 // screen at the end.
452 application
.repaint
= true;
455 primaryHandleEvent(event
);
457 secondaryHandleEvent(event
);
460 && (application
.secondaryEventReceiver
== null)
462 // Secondary thread, time to exit.
464 // Eliminate my reference so that wakeEventHandler()
465 // resumes working on the primary.
466 application
.secondaryEventHandler
= null;
468 // We are ready to exit, wake up the primary thread.
469 // Remember that it is currently sleeping inside its
470 // primaryHandleEvent().
471 synchronized (application
.primaryEventHandler
) {
472 application
.primaryEventHandler
.notify();
481 // Fire timers, update screen.
483 application
.finishEventProcessing();
486 } // while (true) (main runnable loop)
491 * ScreenHandler pushes screen updates to the physical device.
493 private class ScreenHandler
implements Runnable
{
495 * The main application.
497 private TApplication application
;
502 private boolean dirty
= false;
505 * Public constructor.
507 * @param application the main application
509 public ScreenHandler(final TApplication application
) {
510 this.application
= application
;
514 * The screen update loop.
517 // Wrap everything in a try, so that if we go belly up we can let
518 // the user have their terminal back.
521 } catch (Throwable t
) {
522 this.application
.restoreConsole();
524 this.application
.exit();
531 private void runImpl() {
534 while (!application
.quit
) {
536 // Wait until application notifies me
537 while (!application
.quit
) {
539 synchronized (this) {
545 // Always check within 50 milliseconds.
548 } catch (InterruptedException e
) {
551 } // while (!application.quit)
553 // Flush the screen contents
555 System
.err
.printf("%d %s backend.flushScreen()\n",
556 System
.currentTimeMillis(), Thread
.currentThread());
558 synchronized (getScreen()) {
559 backend
.flushScreen();
561 } // while (true) (main runnable loop)
563 // Shutdown the user I/O thread(s)
568 * Set the dirty flag.
570 public void setDirty() {
571 synchronized (this) {
578 // ------------------------------------------------------------------------
579 // Constructors -----------------------------------------------------------
580 // ------------------------------------------------------------------------
583 * Public constructor.
585 * @param backendType BackendType.XTERM, BackendType.ECMA48 or
587 * @param windowWidth the number of text columns to start with
588 * @param windowHeight the number of text rows to start with
589 * @param fontSize the size in points
590 * @throws UnsupportedEncodingException if an exception is thrown when
591 * creating the InputStreamReader
593 public TApplication(final BackendType backendType
, final int windowWidth
,
594 final int windowHeight
, final int fontSize
)
595 throws UnsupportedEncodingException
{
597 switch (backendType
) {
599 backend
= new SwingBackend(this, windowWidth
, windowHeight
,
605 backend
= new ECMA48Backend(this, null, null, windowWidth
,
606 windowHeight
, fontSize
);
609 throw new IllegalArgumentException("Invalid backend type: "
616 * Public constructor.
618 * @param backendType BackendType.XTERM, BackendType.ECMA48 or
620 * @throws UnsupportedEncodingException if an exception is thrown when
621 * creating the InputStreamReader
623 public TApplication(final BackendType backendType
)
624 throws UnsupportedEncodingException
{
626 switch (backendType
) {
628 // The default SwingBackend is 80x25, 20 pt font. If you want to
629 // change that, you can pass the extra arguments to the
630 // SwingBackend constructor here. For example, if you wanted
631 // 90x30, 16 pt font:
633 // backend = new SwingBackend(this, 90, 30, 16);
634 backend
= new SwingBackend(this);
639 backend
= new ECMA48Backend(this, null, null);
642 throw new IllegalArgumentException("Invalid backend type: "
649 * Public constructor. The backend type will be BackendType.ECMA48.
651 * @param input an InputStream connected to the remote user, or null for
652 * System.in. If System.in is used, then on non-Windows systems it will
653 * be put in raw mode; shutdown() will (blindly!) put System.in in cooked
654 * mode. input is always converted to a Reader with UTF-8 encoding.
655 * @param output an OutputStream connected to the remote user, or null
656 * for System.out. output is always converted to a Writer with UTF-8
658 * @throws UnsupportedEncodingException if an exception is thrown when
659 * creating the InputStreamReader
661 public TApplication(final InputStream input
,
662 final OutputStream output
) throws UnsupportedEncodingException
{
664 backend
= new ECMA48Backend(this, input
, output
);
669 * Public constructor. The backend type will be BackendType.ECMA48.
671 * @param input the InputStream underlying 'reader'. Its available()
672 * method is used to determine if reader.read() will block or not.
673 * @param reader a Reader connected to the remote user.
674 * @param writer a PrintWriter connected to the remote user.
675 * @param setRawMode if true, set System.in into raw mode with stty.
676 * This should in general not be used. It is here solely for Demo3,
677 * which uses System.in.
678 * @throws IllegalArgumentException if input, reader, or writer are null.
680 public TApplication(final InputStream input
, final Reader reader
,
681 final PrintWriter writer
, final boolean setRawMode
) {
683 backend
= new ECMA48Backend(this, input
, reader
, writer
, setRawMode
);
688 * Public constructor. The backend type will be BackendType.ECMA48.
690 * @param input the InputStream underlying 'reader'. Its available()
691 * method is used to determine if reader.read() will block or not.
692 * @param reader a Reader connected to the remote user.
693 * @param writer a PrintWriter connected to the remote user.
694 * @throws IllegalArgumentException if input, reader, or writer are null.
696 public TApplication(final InputStream input
, final Reader reader
,
697 final PrintWriter writer
) {
699 this(input
, reader
, writer
, false);
703 * Public constructor. This hook enables use with new non-Jexer
706 * @param backend a Backend that is already ready to go.
708 public TApplication(final Backend backend
) {
709 this.backend
= backend
;
710 backend
.setListener(this);
715 * Finish construction once the backend is set.
717 private void TApplicationImpl() {
718 // Text block mouse option
719 if (System
.getProperty("jexer.textMouse", "true").equals("false")) {
723 // Hide mouse when typing option
724 if (System
.getProperty("jexer.hideMouseWhenTyping",
725 "false").equals("true")) {
727 hideMouseWhenTyping
= true;
730 // Hide status bar option
731 if (System
.getProperty("jexer.hideStatusBar",
732 "false").equals("true")) {
733 hideStatusBar
= true;
736 // Hide menu bar option
737 if (System
.getProperty("jexer.hideMenuBar", "false").equals("true")) {
741 theme
= new ColorTheme();
742 desktopTop
= (hideMenuBar ?
0 : 1);
743 desktopBottom
= getScreen().getHeight() - 1 + (hideStatusBar ?
1 : 0);
744 fillEventQueue
= new LinkedList
<TInputEvent
>();
745 drainEventQueue
= new LinkedList
<TInputEvent
>();
746 windows
= new LinkedList
<TWindow
>();
747 menus
= new ArrayList
<TMenu
>();
748 subMenus
= new ArrayList
<TMenu
>();
749 timers
= new LinkedList
<TTimer
>();
750 accelerators
= new HashMap
<TKeypress
, TMenuItem
>();
751 menuItems
= new LinkedList
<TMenuItem
>();
752 desktop
= new TDesktop(this);
754 // Special case: the Swing backend needs to have a timer to drive its
756 if ((backend
instanceof SwingBackend
)
757 || (backend
instanceof MultiBackend
)
759 // Default to 500 millis, unless a SwingBackend has its own
762 if (backend
instanceof SwingBackend
) {
763 millis
= ((SwingBackend
) backend
).getBlinkMillis();
766 addTimer(millis
, true,
769 TApplication
.this.doRepaint();
778 // ------------------------------------------------------------------------
779 // Runnable ---------------------------------------------------------------
780 // ------------------------------------------------------------------------
783 * Run this application until it exits.
786 // System.err.println("*** TApplication.run() begins ***");
788 // Start the screen updater thread
789 screenHandler
= new ScreenHandler(this);
790 (new Thread(screenHandler
)).start();
792 // Start the main consumer thread
793 primaryEventHandler
= new WidgetEventHandler(this, true);
794 (new Thread(primaryEventHandler
)).start();
799 synchronized (this) {
800 boolean doWait
= false;
802 if (!backend
.hasEvents()) {
803 synchronized (fillEventQueue
) {
804 if (fillEventQueue
.size() == 0) {
811 // No I/O to dispatch, so wait until the backend
815 System
.err
.println(System
.currentTimeMillis() +
816 " " + Thread
.currentThread() + " MAIN sleep");
822 System
.err
.println(System
.currentTimeMillis() +
823 " " + Thread
.currentThread() + " MAIN AWAKE");
825 } catch (InterruptedException e
) {
826 // I'm awake and don't care why, let's see what's
827 // going on out there.
831 } // synchronized (this)
833 synchronized (fillEventQueue
) {
834 // Pull any pending I/O events
835 backend
.getEvents(fillEventQueue
);
837 // Dispatch each event to the appropriate handler, one at a
840 TInputEvent event
= null;
841 if (fillEventQueue
.size() == 0) {
844 event
= fillEventQueue
.remove(0);
845 metaHandleEvent(event
);
849 // Wake a consumer thread if we have any pending events.
850 if (drainEventQueue
.size() > 0) {
856 // Shutdown the event consumer threads
857 if (secondaryEventHandler
!= null) {
858 synchronized (secondaryEventHandler
) {
859 secondaryEventHandler
.notify();
862 if (primaryEventHandler
!= null) {
863 synchronized (primaryEventHandler
) {
864 primaryEventHandler
.notify();
868 // Close all the windows. This gives them an opportunity to release
872 // Close the desktop.
873 if (desktop
!= null) {
877 // Give the overarching application an opportunity to release
881 // System.err.println("*** TApplication.run() exits ***");
884 // ------------------------------------------------------------------------
885 // Event handlers ---------------------------------------------------------
886 // ------------------------------------------------------------------------
889 * Method that TApplication subclasses can override to handle menu or
890 * posted command events.
892 * @param command command event
893 * @return if true, this event was consumed
895 protected boolean onCommand(final TCommandEvent command
) {
896 // Default: handle cmExit
897 if (command
.equals(cmExit
)) {
898 if (messageBox(i18n
.getString("exitDialogTitle"),
899 i18n
.getString("exitDialogText"),
900 TMessageBox
.Type
.YESNO
).isYes()) {
907 if (command
.equals(cmShell
)) {
908 openTerminal(0, 0, TWindow
.RESIZABLE
);
912 if (command
.equals(cmTile
)) {
916 if (command
.equals(cmCascade
)) {
920 if (command
.equals(cmCloseAll
)) {
925 if (command
.equals(cmMenu
) && (hideMenuBar
== false)) {
926 if (!modalWindowActive() && (activeMenu
== null)) {
927 if (menus
.size() > 0) {
928 menus
.get(0).setActive(true);
929 activeMenu
= menus
.get(0);
939 * Method that TApplication subclasses can override to handle menu
942 * @param menu menu event
943 * @return if true, this event was consumed
945 protected boolean onMenu(final TMenuEvent menu
) {
947 // Default: handle MID_EXIT
948 if (menu
.getId() == TMenu
.MID_EXIT
) {
949 if (messageBox(i18n
.getString("exitDialogTitle"),
950 i18n
.getString("exitDialogText"),
951 TMessageBox
.Type
.YESNO
).isYes()) {
958 if (menu
.getId() == TMenu
.MID_SHELL
) {
959 openTerminal(0, 0, TWindow
.RESIZABLE
);
963 if (menu
.getId() == TMenu
.MID_TILE
) {
967 if (menu
.getId() == TMenu
.MID_CASCADE
) {
971 if (menu
.getId() == TMenu
.MID_CLOSE_ALL
) {
975 if (menu
.getId() == TMenu
.MID_ABOUT
) {
979 if (menu
.getId() == TMenu
.MID_REPAINT
) {
980 getScreen().clearPhysical();
984 if (menu
.getId() == TMenu
.MID_VIEW_IMAGE
) {
988 if (menu
.getId() == TMenu
.MID_SCREEN_OPTIONS
) {
989 new TFontChooserWindow(this);
996 * Method that TApplication subclasses can override to handle keystrokes.
998 * @param keypress keystroke event
999 * @return if true, this event was consumed
1001 protected boolean onKeypress(final TKeypressEvent keypress
) {
1002 // Default: only menu shortcuts
1004 // Process Alt-F, Alt-E, etc. menu shortcut keys
1005 if (!keypress
.getKey().isFnKey()
1006 && keypress
.getKey().isAlt()
1007 && !keypress
.getKey().isCtrl()
1008 && (activeMenu
== null)
1009 && !modalWindowActive()
1010 && (hideMenuBar
== false)
1013 assert (subMenus
.size() == 0);
1015 for (TMenu menu
: menus
) {
1016 if (Character
.toLowerCase(menu
.getMnemonic().getShortcut())
1017 == Character
.toLowerCase(keypress
.getKey().getChar())
1020 menu
.setActive(true);
1030 * Process background events, and update the screen.
1032 private void finishEventProcessing() {
1034 System
.err
.printf(System
.currentTimeMillis() + " " +
1035 Thread
.currentThread() + " finishEventProcessing()\n");
1038 // Process timers and call doIdle()'s
1041 // Update the screen
1042 synchronized (getScreen()) {
1046 // Wake up the screen repainter
1047 wakeScreenHandler();
1050 System
.err
.printf(System
.currentTimeMillis() + " " +
1051 Thread
.currentThread() + " finishEventProcessing() END\n");
1056 * Peek at certain application-level events, add to eventQueue, and wake
1057 * up the consuming Thread.
1059 * @param event the input event to consume
1061 private void metaHandleEvent(final TInputEvent event
) {
1064 System
.err
.printf(String
.format("metaHandleEvents event: %s\n",
1065 event
)); System
.err
.flush();
1069 // Do no more processing if the application is already trying
1074 // Special application-wide events -------------------------------
1077 if (event
instanceof TCommandEvent
) {
1078 TCommandEvent command
= (TCommandEvent
) event
;
1079 if (command
.equals(cmAbort
)) {
1085 synchronized (drainEventQueue
) {
1087 if (event
instanceof TResizeEvent
) {
1088 TResizeEvent resize
= (TResizeEvent
) event
;
1089 synchronized (getScreen()) {
1090 if ((System
.currentTimeMillis() - screenResizeTime
>= 15)
1091 || (resize
.getWidth() < getScreen().getWidth())
1092 || (resize
.getHeight() < getScreen().getHeight())
1094 getScreen().setDimensions(resize
.getWidth(),
1095 resize
.getHeight());
1096 screenResizeTime
= System
.currentTimeMillis();
1098 desktopBottom
= getScreen().getHeight() - 1;
1099 if (hideStatusBar
) {
1107 if (desktop
!= null) {
1108 desktop
.setDimensions(0, desktopTop
, resize
.getWidth(),
1109 (desktopBottom
- desktopTop
));
1110 desktop
.onResize(resize
);
1113 // Change menu edges if needed.
1116 // We are dirty, redraw the screen.
1120 System.err.println("New screen: " + resize.getWidth() +
1121 " x " + resize.getHeight());
1126 // Put into the main queue
1127 drainEventQueue
.add(event
);
1132 * Dispatch one event to the appropriate widget or application-level
1133 * event handler. This is the primary event handler, it has the normal
1134 * application-wide event handling.
1136 * @param event the input event to consume
1137 * @see #secondaryHandleEvent(TInputEvent event)
1139 private void primaryHandleEvent(final TInputEvent event
) {
1142 System
.err
.printf("%s primaryHandleEvent: %s\n",
1143 Thread
.currentThread(), event
);
1145 TMouseEvent doubleClick
= null;
1147 // Special application-wide events -----------------------------------
1149 if (event
instanceof TKeypressEvent
) {
1150 if (hideMouseWhenTyping
) {
1151 typingHidMouse
= true;
1155 // Peek at the mouse position
1156 if (event
instanceof TMouseEvent
) {
1157 typingHidMouse
= false;
1159 TMouseEvent mouse
= (TMouseEvent
) event
;
1160 if ((mouseX
!= mouse
.getX()) || (mouseY
!= mouse
.getY())) {
1163 mouseX
= mouse
.getX();
1164 mouseY
= mouse
.getY();
1166 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
1167 && (!mouse
.isMouseWheelUp())
1168 && (!mouse
.isMouseWheelDown())
1170 if ((mouse
.getTime().getTime() - lastMouseUpTime
) <
1173 // This is a double-click.
1174 doubleClick
= new TMouseEvent(TMouseEvent
.Type
.
1176 mouse
.getX(), mouse
.getY(),
1177 mouse
.getAbsoluteX(), mouse
.getAbsoluteY(),
1178 mouse
.isMouse1(), mouse
.isMouse2(),
1180 mouse
.isMouseWheelUp(), mouse
.isMouseWheelDown());
1183 // The first click of a potential double-click.
1184 lastMouseUpTime
= mouse
.getTime().getTime();
1189 // See if we need to switch focus to another window or the menu
1190 checkSwitchFocus((TMouseEvent
) event
);
1193 // Handle menu events
1194 if ((activeMenu
!= null) && !(event
instanceof TCommandEvent
)) {
1195 TMenu menu
= activeMenu
;
1197 if (event
instanceof TMouseEvent
) {
1198 TMouseEvent mouse
= (TMouseEvent
) event
;
1200 while (subMenus
.size() > 0) {
1201 TMenu subMenu
= subMenus
.get(subMenus
.size() - 1);
1202 if (subMenu
.mouseWouldHit(mouse
)) {
1205 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_MOTION
)
1206 && (!mouse
.isMouse1())
1207 && (!mouse
.isMouse2())
1208 && (!mouse
.isMouse3())
1209 && (!mouse
.isMouseWheelUp())
1210 && (!mouse
.isMouseWheelDown())
1214 // We navigated away from a sub-menu, so close it
1218 // Convert the mouse relative x/y to menu coordinates
1219 assert (mouse
.getX() == mouse
.getAbsoluteX());
1220 assert (mouse
.getY() == mouse
.getAbsoluteY());
1221 if (subMenus
.size() > 0) {
1222 menu
= subMenus
.get(subMenus
.size() - 1);
1224 mouse
.setX(mouse
.getX() - menu
.getX());
1225 mouse
.setY(mouse
.getY() - menu
.getY());
1227 menu
.handleEvent(event
);
1231 if (event
instanceof TKeypressEvent
) {
1232 TKeypressEvent keypress
= (TKeypressEvent
) event
;
1234 // See if this key matches an accelerator, and is not being
1235 // shortcutted by the active window, and if so dispatch the menu
1237 boolean windowWillShortcut
= false;
1238 if (activeWindow
!= null) {
1239 assert (activeWindow
.isShown());
1240 if (activeWindow
.isShortcutKeypress(keypress
.getKey())) {
1241 // We do not process this key, it will be passed to the
1243 windowWillShortcut
= true;
1247 if (!windowWillShortcut
&& !modalWindowActive()) {
1248 TKeypress keypressLowercase
= keypress
.getKey().toLowerCase();
1249 TMenuItem item
= null;
1250 synchronized (accelerators
) {
1251 item
= accelerators
.get(keypressLowercase
);
1254 if (item
.isEnabled()) {
1255 // Let the menu item dispatch
1261 // Handle the keypress
1262 if (onKeypress(keypress
)) {
1268 if (event
instanceof TCommandEvent
) {
1269 if (onCommand((TCommandEvent
) event
)) {
1274 if (event
instanceof TMenuEvent
) {
1275 if (onMenu((TMenuEvent
) event
)) {
1280 // Dispatch events to the active window -------------------------------
1281 boolean dispatchToDesktop
= true;
1282 TWindow window
= activeWindow
;
1283 if (window
!= null) {
1284 assert (window
.isActive());
1285 assert (window
.isShown());
1286 if (event
instanceof TMouseEvent
) {
1287 TMouseEvent mouse
= (TMouseEvent
) event
;
1288 // Convert the mouse relative x/y to window coordinates
1289 assert (mouse
.getX() == mouse
.getAbsoluteX());
1290 assert (mouse
.getY() == mouse
.getAbsoluteY());
1291 mouse
.setX(mouse
.getX() - window
.getX());
1292 mouse
.setY(mouse
.getY() - window
.getY());
1294 if (doubleClick
!= null) {
1295 doubleClick
.setX(doubleClick
.getX() - window
.getX());
1296 doubleClick
.setY(doubleClick
.getY() - window
.getY());
1299 if (window
.mouseWouldHit(mouse
)) {
1300 dispatchToDesktop
= false;
1302 } else if (event
instanceof TKeypressEvent
) {
1303 dispatchToDesktop
= false;
1304 } else if (event
instanceof TMenuEvent
) {
1305 dispatchToDesktop
= false;
1309 System
.err
.printf("TApplication dispatch event: %s\n",
1312 window
.handleEvent(event
);
1313 if (doubleClick
!= null) {
1314 window
.handleEvent(doubleClick
);
1317 if (dispatchToDesktop
) {
1318 // This event is fair game for the desktop to process.
1319 if (desktop
!= null) {
1320 desktop
.handleEvent(event
);
1321 if (doubleClick
!= null) {
1322 desktop
.handleEvent(doubleClick
);
1329 * Dispatch one event to the appropriate widget or application-level
1330 * event handler. This is the secondary event handler used by certain
1331 * special dialogs (currently TMessageBox and TFileOpenBox).
1333 * @param event the input event to consume
1334 * @see #primaryHandleEvent(TInputEvent event)
1336 private void secondaryHandleEvent(final TInputEvent event
) {
1337 TMouseEvent doubleClick
= null;
1340 System
.err
.printf("%s secondaryHandleEvent: %s\n",
1341 Thread
.currentThread(), event
);
1344 // Peek at the mouse position
1345 if (event
instanceof TMouseEvent
) {
1346 typingHidMouse
= false;
1348 TMouseEvent mouse
= (TMouseEvent
) event
;
1349 if ((mouseX
!= mouse
.getX()) || (mouseY
!= mouse
.getY())) {
1352 mouseX
= mouse
.getX();
1353 mouseY
= mouse
.getY();
1355 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
1356 && (!mouse
.isMouseWheelUp())
1357 && (!mouse
.isMouseWheelDown())
1359 if ((mouse
.getTime().getTime() - lastMouseUpTime
) <
1362 // This is a double-click.
1363 doubleClick
= new TMouseEvent(TMouseEvent
.Type
.
1365 mouse
.getX(), mouse
.getY(),
1366 mouse
.getAbsoluteX(), mouse
.getAbsoluteY(),
1367 mouse
.isMouse1(), mouse
.isMouse2(),
1369 mouse
.isMouseWheelUp(), mouse
.isMouseWheelDown());
1372 // The first click of a potential double-click.
1373 lastMouseUpTime
= mouse
.getTime().getTime();
1379 secondaryEventReceiver
.handleEvent(event
);
1380 // Note that it is possible for secondaryEventReceiver to be null
1381 // now, because its handleEvent() might have finished out on the
1382 // secondary thread. So put any extra processing inside a null
1384 if (secondaryEventReceiver
!= null) {
1385 if (doubleClick
!= null) {
1386 secondaryEventReceiver
.handleEvent(doubleClick
);
1392 * Enable a widget to override the primary event thread.
1394 * @param widget widget that will receive events
1396 public final void enableSecondaryEventReceiver(final TWidget widget
) {
1398 System
.err
.println(System
.currentTimeMillis() +
1399 " enableSecondaryEventReceiver()");
1402 assert (secondaryEventReceiver
== null);
1403 assert (secondaryEventHandler
== null);
1404 assert ((widget
instanceof TMessageBox
)
1405 || (widget
instanceof TFileOpenBox
));
1406 secondaryEventReceiver
= widget
;
1407 secondaryEventHandler
= new WidgetEventHandler(this, false);
1409 (new Thread(secondaryEventHandler
)).start();
1413 * Yield to the secondary thread.
1415 public final void yield() {
1417 System
.err
.printf(System
.currentTimeMillis() + " " +
1418 Thread
.currentThread() + " yield()\n");
1421 assert (secondaryEventReceiver
!= null);
1423 while (secondaryEventReceiver
!= null) {
1424 synchronized (primaryEventHandler
) {
1426 primaryEventHandler
.wait();
1427 } catch (InterruptedException e
) {
1435 * Do stuff when there is no user input.
1437 private void doIdle() {
1439 System
.err
.printf(System
.currentTimeMillis() + " " +
1440 Thread
.currentThread() + " doIdle()\n");
1443 synchronized (timers
) {
1446 System
.err
.printf(System
.currentTimeMillis() + " " +
1447 Thread
.currentThread() + " doIdle() 2\n");
1450 // Run any timers that have timed out
1451 Date now
= new Date();
1452 List
<TTimer
> keepTimers
= new LinkedList
<TTimer
>();
1453 for (TTimer timer
: timers
) {
1454 if (timer
.getNextTick().getTime() <= now
.getTime()) {
1455 // Something might change, so repaint the screen.
1458 if (timer
.recurring
) {
1459 keepTimers
.add(timer
);
1462 keepTimers
.add(timer
);
1466 timers
.addAll(keepTimers
);
1470 for (TWindow window
: windows
) {
1473 if (desktop
!= null) {
1477 // Run any invokeLaters
1478 synchronized (invokeLaters
) {
1479 for (Runnable invoke
: invokeLaters
) {
1482 invokeLaters
.clear();
1488 * Wake the sleeping active event handler.
1490 private void wakeEventHandler() {
1495 if (secondaryEventHandler
!= null) {
1496 synchronized (secondaryEventHandler
) {
1497 secondaryEventHandler
.notify();
1500 assert (primaryEventHandler
!= null);
1501 synchronized (primaryEventHandler
) {
1502 primaryEventHandler
.notify();
1508 * Wake the sleeping screen handler.
1510 private void wakeScreenHandler() {
1515 synchronized (screenHandler
) {
1516 screenHandler
.notify();
1520 // ------------------------------------------------------------------------
1521 // TApplication -----------------------------------------------------------
1522 // ------------------------------------------------------------------------
1525 * Place a command on the run queue, and run it before the next round of
1528 * @param command the command to run later
1530 public void invokeLater(final Runnable command
) {
1531 synchronized (invokeLaters
) {
1532 invokeLaters
.add(command
);
1538 * Restore the console to sane defaults. This is meant to be used for
1539 * improper exits (e.g. a caught exception in main()), and should not be
1540 * necessary for normal program termination.
1542 public void restoreConsole() {
1543 if (backend
!= null) {
1544 if (backend
instanceof ECMA48Backend
) {
1553 * @return the Backend
1555 public final Backend
getBackend() {
1562 * @return the Screen
1564 public final Screen
getScreen() {
1565 if (backend
instanceof TWindowBackend
) {
1566 // We are being rendered to a TWindow. We can't use its
1567 // getScreen() method because that is how it is rendering to a
1568 // hardware backend somewhere. Instead use its getOtherScreen()
1570 return ((TWindowBackend
) backend
).getOtherScreen();
1572 return backend
.getScreen();
1577 * Get the color theme.
1581 public final ColorTheme
getTheme() {
1586 * Repaint the screen on the next update.
1588 public void doRepaint() {
1594 * Get Y coordinate of the top edge of the desktop.
1596 * @return Y coordinate of the top edge of the desktop
1598 public final int getDesktopTop() {
1603 * Get Y coordinate of the bottom edge of the desktop.
1605 * @return Y coordinate of the bottom edge of the desktop
1607 public final int getDesktopBottom() {
1608 return desktopBottom
;
1612 * Set the TDesktop instance.
1614 * @param desktop a TDesktop instance, or null to remove the one that is
1617 public final void setDesktop(final TDesktop desktop
) {
1618 if (this.desktop
!= null) {
1619 this.desktop
.onPreClose();
1620 this.desktop
.onUnfocus();
1621 this.desktop
.onClose();
1623 this.desktop
= desktop
;
1627 * Get the TDesktop instance.
1629 * @return the desktop, or null if it is not set
1631 public final TDesktop
getDesktop() {
1636 * Get the current active window.
1638 * @return the active window, or null if it is not set
1640 public final TWindow
getActiveWindow() {
1641 return activeWindow
;
1645 * Get a (shallow) copy of the window list.
1647 * @return a copy of the list of windows for this application
1649 public final List
<TWindow
> getAllWindows() {
1650 List
<TWindow
> result
= new ArrayList
<TWindow
>();
1651 result
.addAll(windows
);
1656 * Get focusFollowsMouse flag.
1658 * @return true if focus follows mouse: windows automatically raised if
1659 * the mouse passes over them
1661 public boolean getFocusFollowsMouse() {
1662 return focusFollowsMouse
;
1666 * Set focusFollowsMouse flag.
1668 * @param focusFollowsMouse if true, focus follows mouse: windows
1669 * automatically raised if the mouse passes over them
1671 public void setFocusFollowsMouse(final boolean focusFollowsMouse
) {
1672 this.focusFollowsMouse
= focusFollowsMouse
;
1676 * Display the about dialog.
1678 protected void showAboutDialog() {
1679 String version
= getClass().getPackage().getImplementationVersion();
1680 if (version
== null) {
1681 // This is Java 9+, use a hardcoded string here.
1684 messageBox(i18n
.getString("aboutDialogTitle"),
1685 MessageFormat
.format(i18n
.getString("aboutDialogText"), version
),
1686 TMessageBox
.Type
.OK
);
1690 * Handle the Tool | Open image menu item.
1692 private void openImage() {
1694 List
<String
> filters
= new ArrayList
<String
>();
1695 filters
.add("^.*\\.[Jj][Pp][Gg]$");
1696 filters
.add("^.*\\.[Jj][Pp][Ee][Gg]$");
1697 filters
.add("^.*\\.[Pp][Nn][Gg]$");
1698 filters
.add("^.*\\.[Gg][Ii][Ff]$");
1699 filters
.add("^.*\\.[Bb][Mm][Pp]$");
1700 String filename
= fileOpenBox(".", TFileOpenBox
.Type
.OPEN
, filters
);
1701 if (filename
!= null) {
1702 new TImageWindow(this, new File(filename
));
1704 } catch (IOException e
) {
1705 // Show this exception to the user.
1706 new TExceptionDialog(this, e
);
1711 * Check if application is still running.
1713 * @return true if the application is running
1715 public final boolean isRunning() {
1722 // ------------------------------------------------------------------------
1723 // Screen refresh loop ----------------------------------------------------
1724 // ------------------------------------------------------------------------
1727 * Invert the cell color at a position. This is used to track the mouse.
1729 * @param x column position
1730 * @param y row position
1732 private void invertCell(final int x
, final int y
) {
1733 invertCell(x
, y
, false);
1737 * Invert the cell color at a position. This is used to track the mouse.
1739 * @param x column position
1740 * @param y row position
1741 * @param onlyThisCell if true, only invert this cell
1743 private void invertCell(final int x
, final int y
,
1744 final boolean onlyThisCell
) {
1747 System
.err
.printf("%d %s invertCell() %d %d\n",
1748 System
.currentTimeMillis(), Thread
.currentThread(), x
, y
);
1750 if (activeWindow
!= null) {
1751 System
.err
.println("activeWindow.hasHiddenMouse() " +
1752 activeWindow
.hasHiddenMouse());
1756 // If this cell is on top of a visible window that has requested a
1757 // hidden mouse, bail out.
1758 if ((activeWindow
!= null) && (activeMenu
== null)) {
1759 if ((activeWindow
.hasHiddenMouse() == true)
1760 && (x
> activeWindow
.getX())
1761 && (x
< activeWindow
.getX() + activeWindow
.getWidth() - 1)
1762 && (y
> activeWindow
.getY())
1763 && (y
< activeWindow
.getY() + activeWindow
.getHeight() - 1)
1769 Cell cell
= getScreen().getCharXY(x
, y
);
1770 if (cell
.isImage()) {
1773 if (cell
.getForeColorRGB() < 0) {
1774 cell
.setForeColor(cell
.getForeColor().invert());
1776 cell
.setForeColorRGB(cell
.getForeColorRGB() ^
0x00ffffff);
1778 if (cell
.getBackColorRGB() < 0) {
1779 cell
.setBackColor(cell
.getBackColor().invert());
1781 cell
.setBackColorRGB(cell
.getBackColorRGB() ^
0x00ffffff);
1783 getScreen().putCharXY(x
, y
, cell
);
1784 if ((onlyThisCell
== true) || (cell
.getWidth() == Cell
.Width
.SINGLE
)) {
1788 // This cell is one half of a fullwidth glyph. Invert the other
1790 if (cell
.getWidth() == Cell
.Width
.LEFT
) {
1791 if (x
< getScreen().getWidth() - 1) {
1792 Cell rightHalf
= getScreen().getCharXY(x
+ 1, y
);
1793 if (rightHalf
.getWidth() == Cell
.Width
.RIGHT
) {
1794 invertCell(x
+ 1, y
, true);
1799 if (cell
.getWidth() == Cell
.Width
.RIGHT
) {
1801 Cell leftHalf
= getScreen().getCharXY(x
- 1, y
);
1802 if (leftHalf
.getWidth() == Cell
.Width
.LEFT
) {
1803 invertCell(x
- 1, y
, true);
1812 private void drawAll() {
1813 boolean menuIsActive
= false;
1816 System
.err
.printf("%d %s drawAll() enter\n",
1817 System
.currentTimeMillis(), Thread
.currentThread());
1820 // I don't think this does anything useful anymore...
1823 System
.err
.printf("%d %s drawAll() !repaint\n",
1824 System
.currentTimeMillis(), Thread
.currentThread());
1826 if ((oldDrawnMouseX
!= mouseX
) || (oldDrawnMouseY
!= mouseY
)) {
1828 System
.err
.printf("%d %s drawAll() !repaint MOUSE\n",
1829 System
.currentTimeMillis(), Thread
.currentThread());
1832 // The only thing that has happened is the mouse moved.
1834 // Redraw the old cell at that position, and save the cell at
1835 // the new mouse position.
1837 System
.err
.printf("%d %s restoreImage() %d %d\n",
1838 System
.currentTimeMillis(), Thread
.currentThread(),
1839 oldDrawnMouseX
, oldDrawnMouseY
);
1841 oldDrawnMouseCell
.restoreImage();
1842 getScreen().putCharXY(oldDrawnMouseX
, oldDrawnMouseY
,
1844 oldDrawnMouseCell
= getScreen().getCharXY(mouseX
, mouseY
);
1845 if (backend
instanceof ECMA48Backend
) {
1846 // Special case: the entire row containing the mouse has
1847 // to be re-drawn if it has any image data, AND any rows
1849 if (oldDrawnMouseY
!= mouseY
) {
1850 for (int i
= oldDrawnMouseY
; ;) {
1851 getScreen().unsetImageRow(i
);
1855 if (oldDrawnMouseY
< mouseY
) {
1862 getScreen().unsetImageRow(mouseY
);
1866 if ((textMouse
== true) && (typingHidMouse
== false)) {
1867 // Draw mouse at the new position.
1868 invertCell(mouseX
, mouseY
);
1871 oldDrawnMouseX
= mouseX
;
1872 oldDrawnMouseY
= mouseY
;
1874 if (getScreen().isDirty()) {
1875 screenHandler
.setDirty();
1881 System
.err
.printf("%d %s drawAll() REDRAW\n",
1882 System
.currentTimeMillis(), Thread
.currentThread());
1885 // If true, the cursor is not visible
1886 boolean cursor
= false;
1888 // Start with a clean screen
1889 getScreen().clear();
1892 if (desktop
!= null) {
1893 desktop
.drawChildren();
1896 // Draw each window in reverse Z order
1897 List
<TWindow
> sorted
= new ArrayList
<TWindow
>(windows
);
1898 Collections
.sort(sorted
);
1899 TWindow topLevel
= null;
1900 if (sorted
.size() > 0) {
1901 topLevel
= sorted
.get(0);
1903 Collections
.reverse(sorted
);
1904 for (TWindow window
: sorted
) {
1905 if (window
.isShown()) {
1906 window
.drawChildren();
1910 if (hideMenuBar
== false) {
1912 // Draw the blank menubar line - reset the screen clipping first
1913 // so it won't trim it out.
1914 getScreen().resetClipping();
1915 getScreen().hLineXY(0, 0, getScreen().getWidth(), ' ',
1916 theme
.getColor("tmenu"));
1917 // Now draw the menus.
1919 for (TMenu menu
: menus
) {
1920 CellAttributes menuColor
;
1921 CellAttributes menuMnemonicColor
;
1922 if (menu
.isActive()) {
1923 menuIsActive
= true;
1924 menuColor
= theme
.getColor("tmenu.highlighted");
1925 menuMnemonicColor
= theme
.getColor("tmenu.mnemonic.highlighted");
1928 menuColor
= theme
.getColor("tmenu");
1929 menuMnemonicColor
= theme
.getColor("tmenu.mnemonic");
1931 // Draw the menu title
1932 getScreen().hLineXY(x
, 0,
1933 StringUtils
.width(menu
.getTitle()) + 2, ' ', menuColor
);
1934 getScreen().putStringXY(x
+ 1, 0, menu
.getTitle(), menuColor
);
1935 // Draw the highlight character
1936 getScreen().putCharXY(x
+ 1 +
1937 menu
.getMnemonic().getScreenShortcutIdx(),
1938 0, menu
.getMnemonic().getShortcut(), menuMnemonicColor
);
1940 if (menu
.isActive()) {
1941 ((TWindow
) menu
).drawChildren();
1942 // Reset the screen clipping so we can draw the next
1944 getScreen().resetClipping();
1946 x
+= StringUtils
.width(menu
.getTitle()) + 2;
1949 for (TMenu menu
: subMenus
) {
1950 // Reset the screen clipping so we can draw the next
1952 getScreen().resetClipping();
1953 ((TWindow
) menu
).drawChildren();
1956 getScreen().resetClipping();
1958 if (hideStatusBar
== false) {
1959 // Draw the status bar of the top-level window
1960 TStatusBar statusBar
= null;
1961 if (topLevel
!= null) {
1962 statusBar
= topLevel
.getStatusBar();
1964 if (statusBar
!= null) {
1965 getScreen().resetClipping();
1966 statusBar
.setWidth(getScreen().getWidth());
1967 statusBar
.setY(getScreen().getHeight() - topLevel
.getY());
1970 CellAttributes barColor
= new CellAttributes();
1971 barColor
.setTo(getTheme().getColor("tstatusbar.text"));
1972 getScreen().hLineXY(0, desktopBottom
, getScreen().getWidth(),
1977 // Draw the mouse pointer
1979 System
.err
.printf("%d %s restoreImage() %d %d\n",
1980 System
.currentTimeMillis(), Thread
.currentThread(),
1981 oldDrawnMouseX
, oldDrawnMouseY
);
1983 oldDrawnMouseCell
= getScreen().getCharXY(mouseX
, mouseY
);
1984 if (backend
instanceof ECMA48Backend
) {
1985 // Special case: the entire row containing the mouse has to be
1986 // re-drawn if it has any image data, AND any rows in between.
1987 if (oldDrawnMouseY
!= mouseY
) {
1988 for (int i
= oldDrawnMouseY
; ;) {
1989 getScreen().unsetImageRow(i
);
1993 if (oldDrawnMouseY
< mouseY
) {
2000 getScreen().unsetImageRow(mouseY
);
2003 if ((textMouse
== true) && (typingHidMouse
== false)) {
2004 invertCell(mouseX
, mouseY
);
2006 oldDrawnMouseX
= mouseX
;
2007 oldDrawnMouseY
= mouseY
;
2009 // Place the cursor if it is visible
2010 if (!menuIsActive
) {
2012 int visibleWindowCount
= 0;
2013 for (TWindow window
: sorted
) {
2014 if (window
.isShown()) {
2015 visibleWindowCount
++;
2018 if (visibleWindowCount
== 0) {
2019 // No windows are visible, only the desktop. Allow it to
2021 if (desktop
!= null) {
2022 sorted
.add(desktop
);
2026 TWidget activeWidget
= null;
2027 if (sorted
.size() > 0) {
2028 activeWidget
= sorted
.get(sorted
.size() - 1).getActiveChild();
2029 int cursorClipTop
= desktopTop
;
2030 int cursorClipBottom
= desktopBottom
;
2031 if (activeWidget
.isCursorVisible()) {
2032 if ((activeWidget
.getCursorAbsoluteY() <= cursorClipBottom
)
2033 && (activeWidget
.getCursorAbsoluteY() >= cursorClipTop
)
2035 getScreen().putCursor(true,
2036 activeWidget
.getCursorAbsoluteX(),
2037 activeWidget
.getCursorAbsoluteY());
2040 // Turn off the cursor. Also place it at 0,0.
2041 getScreen().putCursor(false, 0, 0);
2050 getScreen().hideCursor();
2053 if (getScreen().isDirty()) {
2054 screenHandler
.setDirty();
2060 * Force this application to exit.
2062 public void exit() {
2064 synchronized (this) {
2070 * Subclasses can use this hook to cleanup resources. Called as the last
2071 * step of TApplication.run().
2073 public void onExit() {
2074 // Default does nothing.
2077 // ------------------------------------------------------------------------
2078 // TWindow management -----------------------------------------------------
2079 // ------------------------------------------------------------------------
2082 * Return the total number of windows.
2084 * @return the total number of windows
2086 public final int windowCount() {
2087 return windows
.size();
2091 * Return the number of windows that are showing.
2093 * @return the number of windows that are showing on screen
2095 public final int shownWindowCount() {
2097 for (TWindow w
: windows
) {
2106 * Return the number of windows that are hidden.
2108 * @return the number of windows that are hidden
2110 public final int hiddenWindowCount() {
2112 for (TWindow w
: windows
) {
2121 * Check if a window instance is in this application's window list.
2123 * @param window window to look for
2124 * @return true if this window is in the list
2126 public final boolean hasWindow(final TWindow window
) {
2127 if (windows
.size() == 0) {
2130 for (TWindow w
: windows
) {
2132 assert (window
.getApplication() == this);
2140 * Activate a window: bring it to the top and have it receive events.
2142 * @param window the window to become the new active window
2144 public void activateWindow(final TWindow window
) {
2145 if (hasWindow(window
) == false) {
2147 * Someone has a handle to a window I don't have. Ignore this
2153 // Whatever window might be moving/dragging, stop it now.
2154 for (TWindow w
: windows
) {
2155 if (w
.inMovements()) {
2160 assert (windows
.size() > 0);
2162 if (window
.isHidden()) {
2163 // Unhiding will also activate.
2167 assert (window
.isShown());
2169 if (windows
.size() == 1) {
2170 assert (window
== windows
.get(0));
2171 if (activeWindow
== null) {
2172 activeWindow
= window
;
2174 activeWindow
.setActive(true);
2175 activeWindow
.onFocus();
2178 assert (window
.isActive());
2179 assert (activeWindow
== window
);
2183 if (activeWindow
== window
) {
2184 assert (window
.isActive());
2186 // Window is already active, do nothing.
2190 assert (!window
.isActive());
2191 if (activeWindow
!= null) {
2192 // TODO: see if this assertion is really necessary.
2193 // assert (activeWindow.getZ() == 0);
2195 activeWindow
.setActive(false);
2197 // Increment every window Z that is on top of window
2198 for (TWindow w
: windows
) {
2202 if (w
.getZ() < window
.getZ()) {
2203 w
.setZ(w
.getZ() + 1);
2207 // Unset activeWindow now before unfocus, so that a window
2208 // lifecycle change inside onUnfocus() doesn't call
2209 // switchWindow() and lead to a stack overflow.
2210 TWindow oldActiveWindow
= activeWindow
;
2211 activeWindow
= null;
2212 oldActiveWindow
.onUnfocus();
2214 activeWindow
= window
;
2215 activeWindow
.setZ(0);
2216 activeWindow
.setActive(true);
2217 activeWindow
.onFocus();
2224 * @param window the window to hide
2226 public void hideWindow(final TWindow window
) {
2227 if (hasWindow(window
) == false) {
2229 * Someone has a handle to a window I don't have. Ignore this
2235 // Whatever window might be moving/dragging, stop it now.
2236 for (TWindow w
: windows
) {
2237 if (w
.inMovements()) {
2242 assert (windows
.size() > 0);
2244 if (!window
.hidden
) {
2245 if (window
== activeWindow
) {
2246 if (shownWindowCount() > 1) {
2249 activeWindow
= null;
2250 window
.setActive(false);
2254 window
.hidden
= true;
2262 * @param window the window to show
2264 public void showWindow(final TWindow window
) {
2265 if (hasWindow(window
) == false) {
2267 * Someone has a handle to a window I don't have. Ignore this
2273 // Whatever window might be moving/dragging, stop it now.
2274 for (TWindow w
: windows
) {
2275 if (w
.inMovements()) {
2280 assert (windows
.size() > 0);
2282 if (window
.hidden
) {
2283 window
.hidden
= false;
2285 activateWindow(window
);
2290 * Close window. Note that the window's destructor is NOT called by this
2291 * method, instead the GC is assumed to do the cleanup.
2293 * @param window the window to remove
2295 public final void closeWindow(final TWindow window
) {
2296 if (hasWindow(window
) == false) {
2298 * Someone has a handle to a window I don't have. Ignore this
2304 // Let window know that it is about to be closed, while it is still
2305 // visible on screen.
2306 window
.onPreClose();
2308 synchronized (windows
) {
2309 // Whatever window might be moving/dragging, stop it now.
2310 for (TWindow w
: windows
) {
2311 if (w
.inMovements()) {
2316 int z
= window
.getZ();
2319 windows
.remove(window
);
2320 Collections
.sort(windows
);
2321 activeWindow
= null;
2323 boolean foundNextWindow
= false;
2325 for (TWindow w
: windows
) {
2329 // Do not activate a hidden window.
2334 if (foundNextWindow
== false) {
2335 foundNextWindow
= true;
2338 assert (activeWindow
== null);
2350 // Perform window cleanup
2353 // Check if we are closing a TMessageBox or similar
2354 if (secondaryEventReceiver
!= null) {
2355 assert (secondaryEventHandler
!= null);
2357 // Do not send events to the secondaryEventReceiver anymore, the
2358 // window is closed.
2359 secondaryEventReceiver
= null;
2361 // Wake the secondary thread, it will wake the primary as it
2363 synchronized (secondaryEventHandler
) {
2364 secondaryEventHandler
.notify();
2368 // Permit desktop to be active if it is the only thing left.
2369 if (desktop
!= null) {
2370 if (windows
.size() == 0) {
2371 desktop
.setActive(true);
2377 * Switch to the next window.
2379 * @param forward if true, then switch to the next window in the list,
2380 * otherwise switch to the previous window in the list
2382 public final void switchWindow(final boolean forward
) {
2383 // Only switch if there are multiple visible windows
2384 if (shownWindowCount() < 2) {
2387 assert (activeWindow
!= null);
2389 synchronized (windows
) {
2390 // Whatever window might be moving/dragging, stop it now.
2391 for (TWindow w
: windows
) {
2392 if (w
.inMovements()) {
2397 // Swap z/active between active window and the next in the list
2398 int activeWindowI
= -1;
2399 for (int i
= 0; i
< windows
.size(); i
++) {
2400 if (windows
.get(i
) == activeWindow
) {
2401 assert (activeWindow
.isActive());
2405 assert (!windows
.get(0).isActive());
2408 assert (activeWindowI
>= 0);
2410 // Do not switch if a window is modal
2411 if (activeWindow
.isModal()) {
2415 int nextWindowI
= activeWindowI
;
2419 nextWindowI
%= windows
.size();
2422 if (nextWindowI
< 0) {
2423 nextWindowI
= windows
.size() - 1;
2427 if (windows
.get(nextWindowI
).isShown()) {
2428 activateWindow(windows
.get(nextWindowI
));
2432 } // synchronized (windows)
2437 * Add a window to my window list and make it active. Note package
2440 * @param window new window to add
2442 final void addWindowToApplication(final TWindow window
) {
2444 // Do not add menu windows to the window list.
2445 if (window
instanceof TMenu
) {
2449 // Do not add the desktop to the window list.
2450 if (window
instanceof TDesktop
) {
2454 synchronized (windows
) {
2455 if (windows
.contains(window
)) {
2456 throw new IllegalArgumentException("Window " + window
+
2457 " is already in window list");
2460 // Whatever window might be moving/dragging, stop it now.
2461 for (TWindow w
: windows
) {
2462 if (w
.inMovements()) {
2467 // Do not allow a modal window to spawn a non-modal window. If a
2468 // modal window is active, then this window will become modal
2470 if (modalWindowActive()) {
2471 window
.flags
|= TWindow
.MODAL
;
2472 window
.flags
|= TWindow
.CENTERED
;
2473 window
.hidden
= false;
2475 if (window
.isShown()) {
2476 for (TWindow w
: windows
) {
2481 w
.setZ(w
.getZ() + 1);
2484 windows
.add(window
);
2485 if (window
.isShown()) {
2486 activeWindow
= window
;
2487 activeWindow
.setZ(0);
2488 activeWindow
.setActive(true);
2489 activeWindow
.onFocus();
2492 if (((window
.flags
& TWindow
.CENTERED
) == 0)
2493 && ((window
.flags
& TWindow
.ABSOLUTEXY
) == 0)
2494 && (smartWindowPlacement
== true)
2495 && (!(window
instanceof TDesktop
))
2498 doSmartPlacement(window
);
2502 // Desktop cannot be active over any other window.
2503 if (desktop
!= null) {
2504 desktop
.setActive(false);
2509 * Check if there is a system-modal window on top.
2511 * @return true if the active window is modal
2513 private boolean modalWindowActive() {
2514 if (windows
.size() == 0) {
2518 for (TWindow w
: windows
) {
2528 * Check if there is a window with overridden menu flag on top.
2530 * @return true if the active window is overriding the menu
2532 private boolean overrideMenuWindowActive() {
2533 if (activeWindow
!= null) {
2534 if (activeWindow
.hasOverriddenMenu()) {
2543 * Close all open windows.
2545 private void closeAllWindows() {
2546 // Don't do anything if we are in the menu
2547 if (activeMenu
!= null) {
2550 while (windows
.size() > 0) {
2551 closeWindow(windows
.get(0));
2556 * Re-layout the open windows as non-overlapping tiles. This produces
2557 * almost the same results as Turbo Pascal 7.0's IDE.
2559 private void tileWindows() {
2560 synchronized (windows
) {
2561 // Don't do anything if we are in the menu
2562 if (activeMenu
!= null) {
2565 int z
= windows
.size();
2571 a
= (int)(Math
.sqrt(z
));
2575 if (((a
* b
) + c
) == z
) {
2583 int newWidth
= (getScreen().getWidth() / a
);
2584 int newHeight1
= ((getScreen().getHeight() - 1) / b
);
2585 int newHeight2
= ((getScreen().getHeight() - 1) / (b
+ c
));
2587 List
<TWindow
> sorted
= new ArrayList
<TWindow
>(windows
);
2588 Collections
.sort(sorted
);
2589 Collections
.reverse(sorted
);
2590 for (int i
= 0; i
< sorted
.size(); i
++) {
2591 int logicalX
= i
/ b
;
2592 int logicalY
= i
% b
;
2593 if (i
>= ((a
- 1) * b
)) {
2595 logicalY
= i
- ((a
- 1) * b
);
2598 TWindow w
= sorted
.get(i
);
2599 int oldWidth
= w
.getWidth();
2600 int oldHeight
= w
.getHeight();
2602 w
.setX(logicalX
* newWidth
);
2603 w
.setWidth(newWidth
);
2604 if (i
>= ((a
- 1) * b
)) {
2605 w
.setY((logicalY
* newHeight2
) + 1);
2606 w
.setHeight(newHeight2
);
2608 w
.setY((logicalY
* newHeight1
) + 1);
2609 w
.setHeight(newHeight1
);
2611 if ((w
.getWidth() != oldWidth
)
2612 || (w
.getHeight() != oldHeight
)
2614 w
.onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
,
2615 w
.getWidth(), w
.getHeight()));
2622 * Re-layout the open windows as overlapping cascaded windows.
2624 private void cascadeWindows() {
2625 synchronized (windows
) {
2626 // Don't do anything if we are in the menu
2627 if (activeMenu
!= null) {
2632 List
<TWindow
> sorted
= new ArrayList
<TWindow
>(windows
);
2633 Collections
.sort(sorted
);
2634 Collections
.reverse(sorted
);
2635 for (TWindow window
: sorted
) {
2640 if (x
> getScreen().getWidth()) {
2643 if (y
>= getScreen().getHeight()) {
2651 * Place a window to minimize its overlap with other windows.
2653 * @param window the window to place
2655 public final void doSmartPlacement(final TWindow window
) {
2656 // This is a pretty dumb algorithm, but seems to work. The hardest
2657 // part is computing these "overlap" values seeking a minimum average
2660 int yMin
= desktopTop
;
2661 int xMax
= getScreen().getWidth() - window
.getWidth() + 1;
2662 int yMax
= desktopBottom
- window
.getHeight() + 1;
2670 if ((xMin
== xMax
) && (yMin
== yMax
)) {
2671 // No work to do, bail out.
2675 // Compute the overlap matrix without the new window.
2676 int width
= getScreen().getWidth();
2677 int height
= getScreen().getHeight();
2678 int overlapMatrix
[][] = new int[width
][height
];
2679 for (TWindow w
: windows
) {
2683 for (int x
= w
.getX(); x
< w
.getX() + w
.getWidth(); x
++) {
2690 for (int y
= w
.getY(); y
< w
.getY() + w
.getHeight(); y
++) {
2697 overlapMatrix
[x
][y
]++;
2702 long oldOverlapTotal
= 0;
2703 long oldOverlapN
= 0;
2704 for (int x
= 0; x
< width
; x
++) {
2705 for (int y
= 0; y
< height
; y
++) {
2706 oldOverlapTotal
+= overlapMatrix
[x
][y
];
2707 if (overlapMatrix
[x
][y
] > 0) {
2714 double oldOverlapAvg
= (double) oldOverlapTotal
/ (double) oldOverlapN
;
2715 boolean first
= true;
2716 int windowX
= window
.getX();
2717 int windowY
= window
.getY();
2719 // For each possible (x, y) position for the new window, compute a
2720 // new overlap matrix.
2721 for (int x
= xMin
; x
< xMax
; x
++) {
2722 for (int y
= yMin
; y
< yMax
; y
++) {
2724 // Start with the matrix minus this window.
2725 int newMatrix
[][] = new int[width
][height
];
2726 for (int mx
= 0; mx
< width
; mx
++) {
2727 for (int my
= 0; my
< height
; my
++) {
2728 newMatrix
[mx
][my
] = overlapMatrix
[mx
][my
];
2732 // Add this window's values to the new overlap matrix.
2733 long newOverlapTotal
= 0;
2734 long newOverlapN
= 0;
2735 // Start by adding each new cell.
2736 for (int wx
= x
; wx
< x
+ window
.getWidth(); wx
++) {
2740 for (int wy
= y
; wy
< y
+ window
.getHeight(); wy
++) {
2744 newMatrix
[wx
][wy
]++;
2747 // Now figure out the new value for total coverage.
2748 for (int mx
= 0; mx
< width
; mx
++) {
2749 for (int my
= 0; my
< height
; my
++) {
2750 newOverlapTotal
+= newMatrix
[x
][y
];
2751 if (newMatrix
[mx
][my
] > 0) {
2756 double newOverlapAvg
= (double) newOverlapTotal
/ (double) newOverlapN
;
2759 // First time: just record what we got.
2760 oldOverlapAvg
= newOverlapAvg
;
2763 // All other times: pick a new best (x, y) and save the
2765 if (newOverlapAvg
< oldOverlapAvg
) {
2768 oldOverlapAvg
= newOverlapAvg
;
2772 } // for (int x = xMin; x < xMax; x++)
2774 } // for (int y = yMin; y < yMax; y++)
2776 // Finally, set the window's new coordinates.
2777 window
.setX(windowX
);
2778 window
.setY(windowY
);
2781 // ------------------------------------------------------------------------
2782 // TMenu management -------------------------------------------------------
2783 // ------------------------------------------------------------------------
2786 * Check if a mouse event would hit either the active menu or any open
2789 * @param mouse mouse event
2790 * @return true if the mouse would hit the active menu or an open
2793 private boolean mouseOnMenu(final TMouseEvent mouse
) {
2794 assert (activeMenu
!= null);
2795 List
<TMenu
> menus
= new ArrayList
<TMenu
>(subMenus
);
2796 Collections
.reverse(menus
);
2797 for (TMenu menu
: menus
) {
2798 if (menu
.mouseWouldHit(mouse
)) {
2802 return activeMenu
.mouseWouldHit(mouse
);
2806 * See if we need to switch window or activate the menu based on
2809 * @param mouse mouse event
2811 private void checkSwitchFocus(final TMouseEvent mouse
) {
2813 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
2814 && (activeMenu
!= null)
2815 && (mouse
.getAbsoluteY() != 0)
2816 && (!mouseOnMenu(mouse
))
2818 // They clicked outside the active menu, turn it off
2819 activeMenu
.setActive(false);
2821 for (TMenu menu
: subMenus
) {
2822 menu
.setActive(false);
2828 // See if they hit the menu bar
2829 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
2830 && (mouse
.isMouse1())
2831 && (!modalWindowActive())
2832 && (!overrideMenuWindowActive())
2833 && (mouse
.getAbsoluteY() == 0)
2834 && (hideMenuBar
== false)
2837 for (TMenu menu
: subMenus
) {
2838 menu
.setActive(false);
2842 // They selected the menu, go activate it
2843 for (TMenu menu
: menus
) {
2844 if ((mouse
.getAbsoluteX() >= menu
.getTitleX())
2845 && (mouse
.getAbsoluteX() < menu
.getTitleX()
2846 + StringUtils
.width(menu
.getTitle()) + 2)
2848 menu
.setActive(true);
2851 menu
.setActive(false);
2857 // See if they hit the menu bar
2858 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_MOTION
)
2859 && (mouse
.isMouse1())
2860 && (activeMenu
!= null)
2861 && (mouse
.getAbsoluteY() == 0)
2862 && (hideMenuBar
== false)
2865 TMenu oldMenu
= activeMenu
;
2866 for (TMenu menu
: subMenus
) {
2867 menu
.setActive(false);
2871 // See if we should switch menus
2872 for (TMenu menu
: menus
) {
2873 if ((mouse
.getAbsoluteX() >= menu
.getTitleX())
2874 && (mouse
.getAbsoluteX() < menu
.getTitleX()
2875 + StringUtils
.width(menu
.getTitle()) + 2)
2877 menu
.setActive(true);
2881 if (oldMenu
!= activeMenu
) {
2882 // They switched menus
2883 oldMenu
.setActive(false);
2888 // If a menu is still active, don't switch windows
2889 if (activeMenu
!= null) {
2893 // Only switch if there are multiple windows
2894 if (windows
.size() < 2) {
2898 if (((focusFollowsMouse
== true)
2899 && (mouse
.getType() == TMouseEvent
.Type
.MOUSE_MOTION
))
2900 || (mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
2902 synchronized (windows
) {
2903 Collections
.sort(windows
);
2904 if (windows
.get(0).isModal()) {
2905 // Modal windows don't switch
2909 for (TWindow window
: windows
) {
2910 assert (!window
.isModal());
2912 if (window
.isHidden()) {
2913 assert (!window
.isActive());
2917 if (window
.mouseWouldHit(mouse
)) {
2918 if (window
== windows
.get(0)) {
2919 // Clicked on the same window, nothing to do
2920 assert (window
.isActive());
2924 // We will be switching to another window
2925 assert (windows
.get(0).isActive());
2926 assert (windows
.get(0) == activeWindow
);
2927 assert (!window
.isActive());
2928 if (activeWindow
!= null) {
2929 activeWindow
.onUnfocus();
2930 activeWindow
.setActive(false);
2931 activeWindow
.setZ(window
.getZ());
2933 activeWindow
= window
;
2935 window
.setActive(true);
2942 // Clicked on the background, nothing to do
2946 // Nothing to do: this isn't a mouse up, or focus isn't following
2952 * Turn off the menu.
2954 public final void closeMenu() {
2955 if (activeMenu
!= null) {
2956 activeMenu
.setActive(false);
2958 for (TMenu menu
: subMenus
) {
2959 menu
.setActive(false);
2966 * Get a (shallow) copy of the menu list.
2968 * @return a copy of the menu list
2970 public final List
<TMenu
> getAllMenus() {
2971 return new ArrayList
<TMenu
>(menus
);
2975 * Add a top-level menu to the list.
2977 * @param menu the menu to add
2978 * @throws IllegalArgumentException if the menu is already used in
2979 * another TApplication
2981 public final void addMenu(final TMenu menu
) {
2982 if ((menu
.getApplication() != null)
2983 && (menu
.getApplication() != this)
2985 throw new IllegalArgumentException("Menu " + menu
+ " is already " +
2986 "part of application " + menu
.getApplication());
2994 * Remove a top-level menu from the list.
2996 * @param menu the menu to remove
2997 * @throws IllegalArgumentException if the menu is already used in
2998 * another TApplication
3000 public final void removeMenu(final TMenu menu
) {
3001 if ((menu
.getApplication() != null)
3002 && (menu
.getApplication() != this)
3004 throw new IllegalArgumentException("Menu " + menu
+ " is already " +
3005 "part of application " + menu
.getApplication());
3013 * Turn off a sub-menu.
3015 public final void closeSubMenu() {
3016 assert (activeMenu
!= null);
3017 TMenu item
= subMenus
.get(subMenus
.size() - 1);
3018 assert (item
!= null);
3019 item
.setActive(false);
3020 subMenus
.remove(subMenus
.size() - 1);
3024 * Switch to the next menu.
3026 * @param forward if true, then switch to the next menu in the list,
3027 * otherwise switch to the previous menu in the list
3029 public final void switchMenu(final boolean forward
) {
3030 assert (activeMenu
!= null);
3031 assert (hideMenuBar
== false);
3033 for (TMenu menu
: subMenus
) {
3034 menu
.setActive(false);
3038 for (int i
= 0; i
< menus
.size(); i
++) {
3039 if (activeMenu
== menus
.get(i
)) {
3041 if (i
< menus
.size() - 1) {
3050 i
= menus
.size() - 1;
3053 activeMenu
.setActive(false);
3054 activeMenu
= menus
.get(i
);
3055 activeMenu
.setActive(true);
3062 * Add a menu item to the global list. If it has a keyboard accelerator,
3063 * that will be added the global hash.
3065 * @param item the menu item
3067 public final void addMenuItem(final TMenuItem item
) {
3068 menuItems
.add(item
);
3070 TKeypress key
= item
.getKey();
3072 synchronized (accelerators
) {
3073 assert (accelerators
.get(key
) == null);
3074 accelerators
.put(key
.toLowerCase(), item
);
3080 * Disable one menu item.
3082 * @param id the menu item ID
3084 public final void disableMenuItem(final int id
) {
3085 for (TMenuItem item
: menuItems
) {
3086 if (item
.getId() == id
) {
3087 item
.setEnabled(false);
3093 * Disable the range of menu items with ID's between lower and upper,
3096 * @param lower the lowest menu item ID
3097 * @param upper the highest menu item ID
3099 public final void disableMenuItems(final int lower
, final int upper
) {
3100 for (TMenuItem item
: menuItems
) {
3101 if ((item
.getId() >= lower
) && (item
.getId() <= upper
)) {
3102 item
.setEnabled(false);
3103 item
.getParent().activate(0);
3109 * Enable one menu item.
3111 * @param id the menu item ID
3113 public final void enableMenuItem(final int id
) {
3114 for (TMenuItem item
: menuItems
) {
3115 if (item
.getId() == id
) {
3116 item
.setEnabled(true);
3117 item
.getParent().activate(0);
3123 * Enable the range of menu items with ID's between lower and upper,
3126 * @param lower the lowest menu item ID
3127 * @param upper the highest menu item ID
3129 public final void enableMenuItems(final int lower
, final int upper
) {
3130 for (TMenuItem item
: menuItems
) {
3131 if ((item
.getId() >= lower
) && (item
.getId() <= upper
)) {
3132 item
.setEnabled(true);
3133 item
.getParent().activate(0);
3139 * Get the menu item associated with this ID.
3141 * @param id the menu item ID
3142 * @return the menu item, or null if not found
3144 public final TMenuItem
getMenuItem(final int id
) {
3145 for (TMenuItem item
: menuItems
) {
3146 if (item
.getId() == id
) {
3154 * Recompute menu x positions based on their title length.
3156 public final void recomputeMenuX() {
3158 for (TMenu menu
: menus
) {
3161 x
+= StringUtils
.width(menu
.getTitle()) + 2;
3163 // Don't let the menu window exceed the screen width
3164 int rightEdge
= menu
.getX() + menu
.getWidth();
3165 if (rightEdge
> getScreen().getWidth()) {
3166 menu
.setX(getScreen().getWidth() - menu
.getWidth());
3172 * Post an event to process.
3174 * @param event new event to add to the queue
3176 public final void postEvent(final TInputEvent event
) {
3177 synchronized (this) {
3178 synchronized (fillEventQueue
) {
3179 fillEventQueue
.add(event
);
3182 System
.err
.println(System
.currentTimeMillis() + " " +
3183 Thread
.currentThread() + " postEvent() wake up main");
3190 * Post an event to process and turn off the menu.
3192 * @param event new event to add to the queue
3194 public final void postMenuEvent(final TInputEvent event
) {
3195 synchronized (this) {
3196 synchronized (fillEventQueue
) {
3197 fillEventQueue
.add(event
);
3200 System
.err
.println(System
.currentTimeMillis() + " " +
3201 Thread
.currentThread() + " postMenuEvent() wake up main");
3209 * Add a sub-menu to the list of open sub-menus.
3211 * @param menu sub-menu
3213 public final void addSubMenu(final TMenu menu
) {
3218 * Convenience function to add a top-level menu.
3220 * @param title menu title
3221 * @return the new menu
3223 public final TMenu
addMenu(final String title
) {
3226 TMenu menu
= new TMenu(this, x
, y
, title
);
3233 * Convenience function to add a default tools (hamburger) menu.
3235 * @return the new menu
3237 public final TMenu
addToolMenu() {
3238 TMenu toolMenu
= addMenu(i18n
.getString("toolMenuTitle"));
3239 toolMenu
.addDefaultItem(TMenu
.MID_REPAINT
);
3240 toolMenu
.addDefaultItem(TMenu
.MID_VIEW_IMAGE
);
3241 toolMenu
.addDefaultItem(TMenu
.MID_SCREEN_OPTIONS
);
3242 TStatusBar toolStatusBar
= toolMenu
.newStatusBar(i18n
.
3243 getString("toolMenuStatus"));
3244 toolStatusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
3249 * Convenience function to add a default "File" menu.
3251 * @return the new menu
3253 public final TMenu
addFileMenu() {
3254 TMenu fileMenu
= addMenu(i18n
.getString("fileMenuTitle"));
3255 fileMenu
.addDefaultItem(TMenu
.MID_SHELL
);
3256 fileMenu
.addSeparator();
3257 fileMenu
.addDefaultItem(TMenu
.MID_EXIT
);
3258 TStatusBar statusBar
= fileMenu
.newStatusBar(i18n
.
3259 getString("fileMenuStatus"));
3260 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
3265 * Convenience function to add a default "Edit" menu.
3267 * @return the new menu
3269 public final TMenu
addEditMenu() {
3270 TMenu editMenu
= addMenu(i18n
.getString("editMenuTitle"));
3271 editMenu
.addDefaultItem(TMenu
.MID_CUT
);
3272 editMenu
.addDefaultItem(TMenu
.MID_COPY
);
3273 editMenu
.addDefaultItem(TMenu
.MID_PASTE
);
3274 editMenu
.addDefaultItem(TMenu
.MID_CLEAR
);
3275 TStatusBar statusBar
= editMenu
.newStatusBar(i18n
.
3276 getString("editMenuStatus"));
3277 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
3282 * Convenience function to add a default "Window" menu.
3284 * @return the new menu
3286 public final TMenu
addWindowMenu() {
3287 TMenu windowMenu
= addMenu(i18n
.getString("windowMenuTitle"));
3288 windowMenu
.addDefaultItem(TMenu
.MID_TILE
);
3289 windowMenu
.addDefaultItem(TMenu
.MID_CASCADE
);
3290 windowMenu
.addDefaultItem(TMenu
.MID_CLOSE_ALL
);
3291 windowMenu
.addSeparator();
3292 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_MOVE
);
3293 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_ZOOM
);
3294 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_NEXT
);
3295 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_PREVIOUS
);
3296 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_CLOSE
);
3297 TStatusBar statusBar
= windowMenu
.newStatusBar(i18n
.
3298 getString("windowMenuStatus"));
3299 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
3304 * Convenience function to add a default "Help" menu.
3306 * @return the new menu
3308 public final TMenu
addHelpMenu() {
3309 TMenu helpMenu
= addMenu(i18n
.getString("helpMenuTitle"));
3310 helpMenu
.addDefaultItem(TMenu
.MID_HELP_CONTENTS
);
3311 helpMenu
.addDefaultItem(TMenu
.MID_HELP_INDEX
);
3312 helpMenu
.addDefaultItem(TMenu
.MID_HELP_SEARCH
);
3313 helpMenu
.addDefaultItem(TMenu
.MID_HELP_PREVIOUS
);
3314 helpMenu
.addDefaultItem(TMenu
.MID_HELP_HELP
);
3315 helpMenu
.addDefaultItem(TMenu
.MID_HELP_ACTIVE_FILE
);
3316 helpMenu
.addSeparator();
3317 helpMenu
.addDefaultItem(TMenu
.MID_ABOUT
);
3318 TStatusBar statusBar
= helpMenu
.newStatusBar(i18n
.
3319 getString("helpMenuStatus"));
3320 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
3325 * Convenience function to add a default "Table" menu.
3327 * @return the new menu
3329 public final TMenu
addTableMenu() {
3330 TMenu tableMenu
= addMenu(i18n
.getString("tableMenuTitle"));
3331 tableMenu
.addDefaultItem(TMenu
.MID_TABLE_RENAME_COLUMN
, false);
3332 tableMenu
.addDefaultItem(TMenu
.MID_TABLE_RENAME_ROW
, false);
3333 tableMenu
.addSeparator();
3335 TSubMenu viewMenu
= tableMenu
.addSubMenu(i18n
.
3336 getString("tableSubMenuView"));
3337 viewMenu
.addDefaultItem(TMenu
.MID_TABLE_VIEW_ROW_LABELS
, false);
3338 viewMenu
.addDefaultItem(TMenu
.MID_TABLE_VIEW_COLUMN_LABELS
, false);
3339 viewMenu
.addDefaultItem(TMenu
.MID_TABLE_VIEW_HIGHLIGHT_ROW
, false);
3340 viewMenu
.addDefaultItem(TMenu
.MID_TABLE_VIEW_HIGHLIGHT_COLUMN
, false);
3342 TSubMenu borderMenu
= tableMenu
.addSubMenu(i18n
.
3343 getString("tableSubMenuBorders"));
3344 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_NONE
, false);
3345 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_ALL
, false);
3346 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_CELL_NONE
, false);
3347 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_CELL_ALL
, false);
3348 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_RIGHT
, false);
3349 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_LEFT
, false);
3350 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_TOP
, false);
3351 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_BOTTOM
, false);
3352 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_DOUBLE_BOTTOM
, false);
3353 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_THICK_BOTTOM
, false);
3354 TSubMenu deleteMenu
= tableMenu
.addSubMenu(i18n
.
3355 getString("tableSubMenuDelete"));
3356 deleteMenu
.addDefaultItem(TMenu
.MID_TABLE_DELETE_LEFT
, false);
3357 deleteMenu
.addDefaultItem(TMenu
.MID_TABLE_DELETE_UP
, false);
3358 deleteMenu
.addDefaultItem(TMenu
.MID_TABLE_DELETE_ROW
, false);
3359 deleteMenu
.addDefaultItem(TMenu
.MID_TABLE_DELETE_COLUMN
, false);
3360 TSubMenu insertMenu
= tableMenu
.addSubMenu(i18n
.
3361 getString("tableSubMenuInsert"));
3362 insertMenu
.addDefaultItem(TMenu
.MID_TABLE_INSERT_LEFT
, false);
3363 insertMenu
.addDefaultItem(TMenu
.MID_TABLE_INSERT_RIGHT
, false);
3364 insertMenu
.addDefaultItem(TMenu
.MID_TABLE_INSERT_ABOVE
, false);
3365 insertMenu
.addDefaultItem(TMenu
.MID_TABLE_INSERT_BELOW
, false);
3366 TSubMenu columnMenu
= tableMenu
.addSubMenu(i18n
.
3367 getString("tableSubMenuColumn"));
3368 columnMenu
.addDefaultItem(TMenu
.MID_TABLE_COLUMN_NARROW
, false);
3369 columnMenu
.addDefaultItem(TMenu
.MID_TABLE_COLUMN_WIDEN
, false);
3370 TSubMenu fileMenu
= tableMenu
.addSubMenu(i18n
.
3371 getString("tableSubMenuFile"));
3372 fileMenu
.addDefaultItem(TMenu
.MID_TABLE_FILE_OPEN_CSV
, false);
3373 fileMenu
.addDefaultItem(TMenu
.MID_TABLE_FILE_SAVE_CSV
, false);
3374 fileMenu
.addDefaultItem(TMenu
.MID_TABLE_FILE_SAVE_TEXT
, false);
3376 TStatusBar statusBar
= tableMenu
.newStatusBar(i18n
.
3377 getString("tableMenuStatus"));
3378 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
3382 // ------------------------------------------------------------------------
3383 // TTimer management ------------------------------------------------------
3384 // ------------------------------------------------------------------------
3387 * Get the amount of time I can sleep before missing a Timer tick.
3389 * @param timeout = initial (maximum) timeout in millis
3390 * @return number of milliseconds between now and the next timer event
3392 private long getSleepTime(final long timeout
) {
3393 Date now
= new Date();
3394 long nowTime
= now
.getTime();
3395 long sleepTime
= timeout
;
3397 synchronized (timers
) {
3398 for (TTimer timer
: timers
) {
3399 long nextTickTime
= timer
.getNextTick().getTime();
3400 if (nextTickTime
< nowTime
) {
3404 long timeDifference
= nextTickTime
- nowTime
;
3405 if (timeDifference
< sleepTime
) {
3406 sleepTime
= timeDifference
;
3411 assert (sleepTime
>= 0);
3412 assert (sleepTime
<= timeout
);
3417 * Convenience function to add a timer.
3419 * @param duration number of milliseconds to wait between ticks
3420 * @param recurring if true, re-schedule this timer after every tick
3421 * @param action function to call when button is pressed
3424 public final TTimer
addTimer(final long duration
, final boolean recurring
,
3425 final TAction action
) {
3427 TTimer timer
= new TTimer(duration
, recurring
, action
);
3428 synchronized (timers
) {
3435 * Convenience function to remove a timer.
3437 * @param timer timer to remove
3439 public final void removeTimer(final TTimer timer
) {
3440 synchronized (timers
) {
3441 timers
.remove(timer
);
3445 // ------------------------------------------------------------------------
3446 // Other TWindow constructors ---------------------------------------------
3447 // ------------------------------------------------------------------------
3450 * Convenience function to spawn a message box.
3452 * @param title window title, will be centered along the top border
3453 * @param caption message to display. Use embedded newlines to get a
3455 * @return the new message box
3457 public final TMessageBox
messageBox(final String title
,
3458 final String caption
) {
3460 return new TMessageBox(this, title
, caption
, TMessageBox
.Type
.OK
);
3464 * Convenience function to spawn a message box.
3466 * @param title window title, will be centered along the top border
3467 * @param caption message to display. Use embedded newlines to get a
3469 * @param type one of the TMessageBox.Type constants. Default is
3471 * @return the new message box
3473 public final TMessageBox
messageBox(final String title
,
3474 final String caption
, final TMessageBox
.Type type
) {
3476 return new TMessageBox(this, title
, caption
, type
);
3480 * Convenience function to spawn an input box.
3482 * @param title window title, will be centered along the top border
3483 * @param caption message to display. Use embedded newlines to get a
3485 * @return the new input box
3487 public final TInputBox
inputBox(final String title
, final String caption
) {
3489 return new TInputBox(this, title
, caption
);
3493 * Convenience function to spawn an input box.
3495 * @param title window title, will be centered along the top border
3496 * @param caption message to display. Use embedded newlines to get a
3498 * @param text initial text to seed the field with
3499 * @return the new input box
3501 public final TInputBox
inputBox(final String title
, final String caption
,
3502 final String text
) {
3504 return new TInputBox(this, title
, caption
, text
);
3508 * Convenience function to spawn an input box.
3510 * @param title window title, will be centered along the top border
3511 * @param caption message to display. Use embedded newlines to get a
3513 * @param text initial text to seed the field with
3514 * @param type one of the Type constants. Default is Type.OK.
3515 * @return the new input box
3517 public final TInputBox
inputBox(final String title
, final String caption
,
3518 final String text
, final TInputBox
.Type type
) {
3520 return new TInputBox(this, title
, caption
, text
, type
);
3524 * Convenience function to open a terminal window.
3526 * @param x column relative to parent
3527 * @param y row relative to parent
3528 * @return the terminal new window
3530 public final TTerminalWindow
openTerminal(final int x
, final int y
) {
3531 return openTerminal(x
, y
, TWindow
.RESIZABLE
);
3535 * Convenience function to open a terminal window.
3537 * @param x column relative to parent
3538 * @param y row relative to parent
3539 * @param closeOnExit if true, close the window when the command exits
3540 * @return the terminal new window
3542 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3543 final boolean closeOnExit
) {
3545 return openTerminal(x
, y
, TWindow
.RESIZABLE
, closeOnExit
);
3549 * Convenience function to open a terminal window.
3551 * @param x column relative to parent
3552 * @param y row relative to parent
3553 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3554 * @return the terminal new window
3556 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3559 return new TTerminalWindow(this, x
, y
, flags
);
3563 * Convenience function to open a terminal window.
3565 * @param x column relative to parent
3566 * @param y row relative to parent
3567 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3568 * @param closeOnExit if true, close the window when the command exits
3569 * @return the terminal new window
3571 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3572 final int flags
, final boolean closeOnExit
) {
3574 return new TTerminalWindow(this, x
, y
, flags
, closeOnExit
);
3578 * Convenience function to open a terminal window and execute a custom
3579 * command line inside it.
3581 * @param x column relative to parent
3582 * @param y row relative to parent
3583 * @param commandLine the command line to execute
3584 * @return the terminal new window
3586 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3587 final String commandLine
) {
3589 return openTerminal(x
, y
, TWindow
.RESIZABLE
, commandLine
);
3593 * Convenience function to open a terminal window and execute a custom
3594 * command line inside it.
3596 * @param x column relative to parent
3597 * @param y row relative to parent
3598 * @param commandLine the command line to execute
3599 * @param closeOnExit if true, close the window when the command exits
3600 * @return the terminal new window
3602 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3603 final String commandLine
, final boolean closeOnExit
) {
3605 return openTerminal(x
, y
, TWindow
.RESIZABLE
, commandLine
, closeOnExit
);
3609 * Convenience function to open a terminal window and execute a custom
3610 * command line inside it.
3612 * @param x column relative to parent
3613 * @param y row relative to parent
3614 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3615 * @param command the command line to execute
3616 * @return the terminal new window
3618 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3619 final int flags
, final String
[] command
) {
3621 return new TTerminalWindow(this, x
, y
, flags
, command
);
3625 * Convenience function to open a terminal window and execute a custom
3626 * command line inside it.
3628 * @param x column relative to parent
3629 * @param y row relative to parent
3630 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3631 * @param command the command line to execute
3632 * @param closeOnExit if true, close the window when the command exits
3633 * @return the terminal new window
3635 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3636 final int flags
, final String
[] command
, final boolean closeOnExit
) {
3638 return new TTerminalWindow(this, x
, y
, flags
, command
, closeOnExit
);
3642 * Convenience function to open a terminal window and execute a custom
3643 * command line inside it.
3645 * @param x column relative to parent
3646 * @param y row relative to parent
3647 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3648 * @param commandLine the command line to execute
3649 * @return the terminal new window
3651 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3652 final int flags
, final String commandLine
) {
3654 return new TTerminalWindow(this, x
, y
, flags
, commandLine
.split("\\s+"));
3658 * Convenience function to open a terminal window and execute a custom
3659 * command line inside it.
3661 * @param x column relative to parent
3662 * @param y row relative to parent
3663 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3664 * @param commandLine the command line to execute
3665 * @param closeOnExit if true, close the window when the command exits
3666 * @return the terminal new window
3668 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3669 final int flags
, final String commandLine
, final boolean closeOnExit
) {
3671 return new TTerminalWindow(this, x
, y
, flags
, commandLine
.split("\\s+"),
3676 * Convenience function to spawn an file open box.
3678 * @param path path of selected file
3679 * @return the result of the new file open box
3680 * @throws IOException if java.io operation throws
3682 public final String
fileOpenBox(final String path
) throws IOException
{
3684 TFileOpenBox box
= new TFileOpenBox(this, path
, TFileOpenBox
.Type
.OPEN
);
3685 return box
.getFilename();
3689 * Convenience function to spawn an file open box.
3691 * @param path path of selected file
3692 * @param type one of the Type constants
3693 * @return the result of the new file open box
3694 * @throws IOException if java.io operation throws
3696 public final String
fileOpenBox(final String path
,
3697 final TFileOpenBox
.Type type
) throws IOException
{
3699 TFileOpenBox box
= new TFileOpenBox(this, path
, type
);
3700 return box
.getFilename();
3704 * Convenience function to spawn a file open box.
3706 * @param path path of selected file
3707 * @param type one of the Type constants
3708 * @param filter a string that files must match to be displayed
3709 * @return the result of the new file open box
3710 * @throws IOException of a java.io operation throws
3712 public final String
fileOpenBox(final String path
,
3713 final TFileOpenBox
.Type type
, final String filter
) throws IOException
{
3715 ArrayList
<String
> filters
= new ArrayList
<String
>();
3716 filters
.add(filter
);
3718 TFileOpenBox box
= new TFileOpenBox(this, path
, type
, filters
);
3719 return box
.getFilename();
3723 * Convenience function to spawn a file open box.
3725 * @param path path of selected file
3726 * @param type one of the Type constants
3727 * @param filters a list of strings that files must match to be displayed
3728 * @return the result of the new file open box
3729 * @throws IOException of a java.io operation throws
3731 public final String
fileOpenBox(final String path
,
3732 final TFileOpenBox
.Type type
,
3733 final List
<String
> filters
) throws IOException
{
3735 TFileOpenBox box
= new TFileOpenBox(this, path
, type
, filters
);
3736 return box
.getFilename();
3740 * Convenience function to create a new window and make it active.
3741 * Window will be located at (0, 0).
3743 * @param title window title, will be centered along the top border
3744 * @param width width of window
3745 * @param height height of window
3746 * @return the new window
3748 public final TWindow
addWindow(final String title
, final int width
,
3751 TWindow window
= new TWindow(this, title
, 0, 0, width
, height
);
3756 * Convenience function to create a new window and make it active.
3757 * Window will be located at (0, 0).
3759 * @param title window title, will be centered along the top border
3760 * @param width width of window
3761 * @param height height of window
3762 * @param flags bitmask of RESIZABLE, CENTERED, or MODAL
3763 * @return the new window
3765 public final TWindow
addWindow(final String title
,
3766 final int width
, final int height
, final int flags
) {
3768 TWindow window
= new TWindow(this, title
, 0, 0, width
, height
, flags
);
3773 * Convenience function to create a new window and make it active.
3775 * @param title window title, will be centered along the top border
3776 * @param x column relative to parent
3777 * @param y row relative to parent
3778 * @param width width of window
3779 * @param height height of window
3780 * @return the new window
3782 public final TWindow
addWindow(final String title
,
3783 final int x
, final int y
, final int width
, final int height
) {
3785 TWindow window
= new TWindow(this, title
, x
, y
, width
, height
);
3790 * Convenience function to create a new window and make it active.
3792 * @param title window title, will be centered along the top border
3793 * @param x column relative to parent
3794 * @param y row relative to parent
3795 * @param width width of window
3796 * @param height height of window
3797 * @param flags mask of RESIZABLE, CENTERED, or MODAL
3798 * @return the new window
3800 public final TWindow
addWindow(final String title
,
3801 final int x
, final int y
, final int width
, final int height
,
3804 TWindow window
= new TWindow(this, title
, x
, y
, width
, height
, flags
);