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(),
1181 mouse
.isAlt(), mouse
.isCtrl(), mouse
.isShift());
1184 // The first click of a potential double-click.
1185 lastMouseUpTime
= mouse
.getTime().getTime();
1190 // See if we need to switch focus to another window or the menu
1191 checkSwitchFocus((TMouseEvent
) event
);
1194 // Handle menu events
1195 if ((activeMenu
!= null) && !(event
instanceof TCommandEvent
)) {
1196 TMenu menu
= activeMenu
;
1198 if (event
instanceof TMouseEvent
) {
1199 TMouseEvent mouse
= (TMouseEvent
) event
;
1201 while (subMenus
.size() > 0) {
1202 TMenu subMenu
= subMenus
.get(subMenus
.size() - 1);
1203 if (subMenu
.mouseWouldHit(mouse
)) {
1206 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_MOTION
)
1207 && (!mouse
.isMouse1())
1208 && (!mouse
.isMouse2())
1209 && (!mouse
.isMouse3())
1210 && (!mouse
.isMouseWheelUp())
1211 && (!mouse
.isMouseWheelDown())
1215 // We navigated away from a sub-menu, so close it
1219 // Convert the mouse relative x/y to menu coordinates
1220 assert (mouse
.getX() == mouse
.getAbsoluteX());
1221 assert (mouse
.getY() == mouse
.getAbsoluteY());
1222 if (subMenus
.size() > 0) {
1223 menu
= subMenus
.get(subMenus
.size() - 1);
1225 mouse
.setX(mouse
.getX() - menu
.getX());
1226 mouse
.setY(mouse
.getY() - menu
.getY());
1228 menu
.handleEvent(event
);
1232 if (event
instanceof TKeypressEvent
) {
1233 TKeypressEvent keypress
= (TKeypressEvent
) event
;
1235 // See if this key matches an accelerator, and is not being
1236 // shortcutted by the active window, and if so dispatch the menu
1238 boolean windowWillShortcut
= false;
1239 if (activeWindow
!= null) {
1240 assert (activeWindow
.isShown());
1241 if (activeWindow
.isShortcutKeypress(keypress
.getKey())) {
1242 // We do not process this key, it will be passed to the
1244 windowWillShortcut
= true;
1248 if (!windowWillShortcut
&& !modalWindowActive()) {
1249 TKeypress keypressLowercase
= keypress
.getKey().toLowerCase();
1250 TMenuItem item
= null;
1251 synchronized (accelerators
) {
1252 item
= accelerators
.get(keypressLowercase
);
1255 if (item
.isEnabled()) {
1256 // Let the menu item dispatch
1262 // Handle the keypress
1263 if (onKeypress(keypress
)) {
1269 if (event
instanceof TCommandEvent
) {
1270 if (onCommand((TCommandEvent
) event
)) {
1275 if (event
instanceof TMenuEvent
) {
1276 if (onMenu((TMenuEvent
) event
)) {
1281 // Dispatch events to the active window -------------------------------
1282 boolean dispatchToDesktop
= true;
1283 TWindow window
= activeWindow
;
1284 if (window
!= null) {
1285 assert (window
.isActive());
1286 assert (window
.isShown());
1287 if (event
instanceof TMouseEvent
) {
1288 TMouseEvent mouse
= (TMouseEvent
) event
;
1289 // Convert the mouse relative x/y to window coordinates
1290 assert (mouse
.getX() == mouse
.getAbsoluteX());
1291 assert (mouse
.getY() == mouse
.getAbsoluteY());
1292 mouse
.setX(mouse
.getX() - window
.getX());
1293 mouse
.setY(mouse
.getY() - window
.getY());
1295 if (doubleClick
!= null) {
1296 doubleClick
.setX(doubleClick
.getX() - window
.getX());
1297 doubleClick
.setY(doubleClick
.getY() - window
.getY());
1300 if (window
.mouseWouldHit(mouse
)) {
1301 dispatchToDesktop
= false;
1303 } else if (event
instanceof TKeypressEvent
) {
1304 dispatchToDesktop
= false;
1305 } else if (event
instanceof TMenuEvent
) {
1306 dispatchToDesktop
= false;
1310 System
.err
.printf("TApplication dispatch event: %s\n",
1313 window
.handleEvent(event
);
1314 if (doubleClick
!= null) {
1315 window
.handleEvent(doubleClick
);
1318 if (dispatchToDesktop
) {
1319 // This event is fair game for the desktop to process.
1320 if (desktop
!= null) {
1321 desktop
.handleEvent(event
);
1322 if (doubleClick
!= null) {
1323 desktop
.handleEvent(doubleClick
);
1330 * Dispatch one event to the appropriate widget or application-level
1331 * event handler. This is the secondary event handler used by certain
1332 * special dialogs (currently TMessageBox and TFileOpenBox).
1334 * @param event the input event to consume
1335 * @see #primaryHandleEvent(TInputEvent event)
1337 private void secondaryHandleEvent(final TInputEvent event
) {
1338 TMouseEvent doubleClick
= null;
1341 System
.err
.printf("%s secondaryHandleEvent: %s\n",
1342 Thread
.currentThread(), event
);
1345 // Peek at the mouse position
1346 if (event
instanceof TMouseEvent
) {
1347 typingHidMouse
= false;
1349 TMouseEvent mouse
= (TMouseEvent
) event
;
1350 if ((mouseX
!= mouse
.getX()) || (mouseY
!= mouse
.getY())) {
1353 mouseX
= mouse
.getX();
1354 mouseY
= mouse
.getY();
1356 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
1357 && (!mouse
.isMouseWheelUp())
1358 && (!mouse
.isMouseWheelDown())
1360 if ((mouse
.getTime().getTime() - lastMouseUpTime
) <
1363 // This is a double-click.
1364 doubleClick
= new TMouseEvent(TMouseEvent
.Type
.
1366 mouse
.getX(), mouse
.getY(),
1367 mouse
.getAbsoluteX(), mouse
.getAbsoluteY(),
1368 mouse
.isMouse1(), mouse
.isMouse2(),
1370 mouse
.isMouseWheelUp(), mouse
.isMouseWheelDown(),
1371 mouse
.isAlt(), mouse
.isCtrl(), mouse
.isShift());
1374 // The first click of a potential double-click.
1375 lastMouseUpTime
= mouse
.getTime().getTime();
1381 secondaryEventReceiver
.handleEvent(event
);
1382 // Note that it is possible for secondaryEventReceiver to be null
1383 // now, because its handleEvent() might have finished out on the
1384 // secondary thread. So put any extra processing inside a null
1386 if (secondaryEventReceiver
!= null) {
1387 if (doubleClick
!= null) {
1388 secondaryEventReceiver
.handleEvent(doubleClick
);
1394 * Enable a widget to override the primary event thread.
1396 * @param widget widget that will receive events
1398 public final void enableSecondaryEventReceiver(final TWidget widget
) {
1400 System
.err
.println(System
.currentTimeMillis() +
1401 " enableSecondaryEventReceiver()");
1404 assert (secondaryEventReceiver
== null);
1405 assert (secondaryEventHandler
== null);
1406 assert ((widget
instanceof TMessageBox
)
1407 || (widget
instanceof TFileOpenBox
));
1408 secondaryEventReceiver
= widget
;
1409 secondaryEventHandler
= new WidgetEventHandler(this, false);
1411 (new Thread(secondaryEventHandler
)).start();
1415 * Yield to the secondary thread.
1417 public final void yield() {
1419 System
.err
.printf(System
.currentTimeMillis() + " " +
1420 Thread
.currentThread() + " yield()\n");
1423 assert (secondaryEventReceiver
!= null);
1425 while (secondaryEventReceiver
!= null) {
1426 synchronized (primaryEventHandler
) {
1428 primaryEventHandler
.wait();
1429 } catch (InterruptedException e
) {
1437 * Do stuff when there is no user input.
1439 private void doIdle() {
1441 System
.err
.printf(System
.currentTimeMillis() + " " +
1442 Thread
.currentThread() + " doIdle()\n");
1445 synchronized (timers
) {
1448 System
.err
.printf(System
.currentTimeMillis() + " " +
1449 Thread
.currentThread() + " doIdle() 2\n");
1452 // Run any timers that have timed out
1453 Date now
= new Date();
1454 List
<TTimer
> keepTimers
= new LinkedList
<TTimer
>();
1455 for (TTimer timer
: timers
) {
1456 if (timer
.getNextTick().getTime() <= now
.getTime()) {
1457 // Something might change, so repaint the screen.
1460 if (timer
.recurring
) {
1461 keepTimers
.add(timer
);
1464 keepTimers
.add(timer
);
1468 timers
.addAll(keepTimers
);
1472 for (TWindow window
: windows
) {
1475 if (desktop
!= null) {
1479 // Run any invokeLaters
1480 synchronized (invokeLaters
) {
1481 for (Runnable invoke
: invokeLaters
) {
1484 invokeLaters
.clear();
1490 * Wake the sleeping active event handler.
1492 private void wakeEventHandler() {
1497 if (secondaryEventHandler
!= null) {
1498 synchronized (secondaryEventHandler
) {
1499 secondaryEventHandler
.notify();
1502 assert (primaryEventHandler
!= null);
1503 synchronized (primaryEventHandler
) {
1504 primaryEventHandler
.notify();
1510 * Wake the sleeping screen handler.
1512 private void wakeScreenHandler() {
1517 synchronized (screenHandler
) {
1518 screenHandler
.notify();
1522 // ------------------------------------------------------------------------
1523 // TApplication -----------------------------------------------------------
1524 // ------------------------------------------------------------------------
1527 * Place a command on the run queue, and run it before the next round of
1530 * @param command the command to run later
1532 public void invokeLater(final Runnable command
) {
1533 synchronized (invokeLaters
) {
1534 invokeLaters
.add(command
);
1540 * Restore the console to sane defaults. This is meant to be used for
1541 * improper exits (e.g. a caught exception in main()), and should not be
1542 * necessary for normal program termination.
1544 public void restoreConsole() {
1545 if (backend
!= null) {
1546 if (backend
instanceof ECMA48Backend
) {
1555 * @return the Backend
1557 public final Backend
getBackend() {
1564 * @return the Screen
1566 public final Screen
getScreen() {
1567 if (backend
instanceof TWindowBackend
) {
1568 // We are being rendered to a TWindow. We can't use its
1569 // getScreen() method because that is how it is rendering to a
1570 // hardware backend somewhere. Instead use its getOtherScreen()
1572 return ((TWindowBackend
) backend
).getOtherScreen();
1574 return backend
.getScreen();
1579 * Get the color theme.
1583 public final ColorTheme
getTheme() {
1588 * Repaint the screen on the next update.
1590 public void doRepaint() {
1596 * Get Y coordinate of the top edge of the desktop.
1598 * @return Y coordinate of the top edge of the desktop
1600 public final int getDesktopTop() {
1605 * Get Y coordinate of the bottom edge of the desktop.
1607 * @return Y coordinate of the bottom edge of the desktop
1609 public final int getDesktopBottom() {
1610 return desktopBottom
;
1614 * Set the TDesktop instance.
1616 * @param desktop a TDesktop instance, or null to remove the one that is
1619 public final void setDesktop(final TDesktop desktop
) {
1620 if (this.desktop
!= null) {
1621 this.desktop
.onPreClose();
1622 this.desktop
.onUnfocus();
1623 this.desktop
.onClose();
1625 this.desktop
= desktop
;
1629 * Get the TDesktop instance.
1631 * @return the desktop, or null if it is not set
1633 public final TDesktop
getDesktop() {
1638 * Get the current active window.
1640 * @return the active window, or null if it is not set
1642 public final TWindow
getActiveWindow() {
1643 return activeWindow
;
1647 * Get a (shallow) copy of the window list.
1649 * @return a copy of the list of windows for this application
1651 public final List
<TWindow
> getAllWindows() {
1652 List
<TWindow
> result
= new ArrayList
<TWindow
>();
1653 result
.addAll(windows
);
1658 * Get focusFollowsMouse flag.
1660 * @return true if focus follows mouse: windows automatically raised if
1661 * the mouse passes over them
1663 public boolean getFocusFollowsMouse() {
1664 return focusFollowsMouse
;
1668 * Set focusFollowsMouse flag.
1670 * @param focusFollowsMouse if true, focus follows mouse: windows
1671 * automatically raised if the mouse passes over them
1673 public void setFocusFollowsMouse(final boolean focusFollowsMouse
) {
1674 this.focusFollowsMouse
= focusFollowsMouse
;
1678 * Display the about dialog.
1680 protected void showAboutDialog() {
1681 String version
= getClass().getPackage().getImplementationVersion();
1682 if (version
== null) {
1683 // This is Java 9+, use a hardcoded string here.
1686 messageBox(i18n
.getString("aboutDialogTitle"),
1687 MessageFormat
.format(i18n
.getString("aboutDialogText"), version
),
1688 TMessageBox
.Type
.OK
);
1692 * Handle the Tool | Open image menu item.
1694 private void openImage() {
1696 List
<String
> filters
= new ArrayList
<String
>();
1697 filters
.add("^.*\\.[Jj][Pp][Gg]$");
1698 filters
.add("^.*\\.[Jj][Pp][Ee][Gg]$");
1699 filters
.add("^.*\\.[Pp][Nn][Gg]$");
1700 filters
.add("^.*\\.[Gg][Ii][Ff]$");
1701 filters
.add("^.*\\.[Bb][Mm][Pp]$");
1702 String filename
= fileOpenBox(".", TFileOpenBox
.Type
.OPEN
, filters
);
1703 if (filename
!= null) {
1704 new TImageWindow(this, new File(filename
));
1706 } catch (IOException e
) {
1707 // Show this exception to the user.
1708 new TExceptionDialog(this, e
);
1713 * Check if application is still running.
1715 * @return true if the application is running
1717 public final boolean isRunning() {
1724 // ------------------------------------------------------------------------
1725 // Screen refresh loop ----------------------------------------------------
1726 // ------------------------------------------------------------------------
1729 * Invert the cell color at a position. This is used to track the mouse.
1731 * @param x column position
1732 * @param y row position
1734 private void invertCell(final int x
, final int y
) {
1735 invertCell(x
, y
, false);
1739 * Invert the cell color at a position. This is used to track the mouse.
1741 * @param x column position
1742 * @param y row position
1743 * @param onlyThisCell if true, only invert this cell
1745 private void invertCell(final int x
, final int y
,
1746 final boolean onlyThisCell
) {
1749 System
.err
.printf("%d %s invertCell() %d %d\n",
1750 System
.currentTimeMillis(), Thread
.currentThread(), x
, y
);
1752 if (activeWindow
!= null) {
1753 System
.err
.println("activeWindow.hasHiddenMouse() " +
1754 activeWindow
.hasHiddenMouse());
1758 // If this cell is on top of a visible window that has requested a
1759 // hidden mouse, bail out.
1760 if ((activeWindow
!= null) && (activeMenu
== null)) {
1761 if ((activeWindow
.hasHiddenMouse() == true)
1762 && (x
> activeWindow
.getX())
1763 && (x
< activeWindow
.getX() + activeWindow
.getWidth() - 1)
1764 && (y
> activeWindow
.getY())
1765 && (y
< activeWindow
.getY() + activeWindow
.getHeight() - 1)
1771 // If this cell is on top of the desktop, and the desktop has
1772 // requested a hidden mouse, bail out.
1773 if ((desktop
!= null) && (activeWindow
== null) && (activeMenu
== null)) {
1774 if ((desktop
.hasHiddenMouse() == true)
1775 && (x
> desktop
.getX())
1776 && (x
< desktop
.getX() + desktop
.getWidth() - 1)
1777 && (y
> desktop
.getY())
1778 && (y
< desktop
.getY() + desktop
.getHeight() - 1)
1784 Cell cell
= getScreen().getCharXY(x
, y
);
1785 if (cell
.isImage()) {
1788 if (cell
.getForeColorRGB() < 0) {
1789 cell
.setForeColor(cell
.getForeColor().invert());
1791 cell
.setForeColorRGB(cell
.getForeColorRGB() ^
0x00ffffff);
1793 if (cell
.getBackColorRGB() < 0) {
1794 cell
.setBackColor(cell
.getBackColor().invert());
1796 cell
.setBackColorRGB(cell
.getBackColorRGB() ^
0x00ffffff);
1798 getScreen().putCharXY(x
, y
, cell
);
1799 if ((onlyThisCell
== true) || (cell
.getWidth() == Cell
.Width
.SINGLE
)) {
1803 // This cell is one half of a fullwidth glyph. Invert the other
1805 if (cell
.getWidth() == Cell
.Width
.LEFT
) {
1806 if (x
< getScreen().getWidth() - 1) {
1807 Cell rightHalf
= getScreen().getCharXY(x
+ 1, y
);
1808 if (rightHalf
.getWidth() == Cell
.Width
.RIGHT
) {
1809 invertCell(x
+ 1, y
, true);
1814 if (cell
.getWidth() == Cell
.Width
.RIGHT
) {
1816 Cell leftHalf
= getScreen().getCharXY(x
- 1, y
);
1817 if (leftHalf
.getWidth() == Cell
.Width
.LEFT
) {
1818 invertCell(x
- 1, y
, true);
1827 private void drawAll() {
1828 boolean menuIsActive
= false;
1831 System
.err
.printf("%d %s drawAll() enter\n",
1832 System
.currentTimeMillis(), Thread
.currentThread());
1835 // I don't think this does anything useful anymore...
1838 System
.err
.printf("%d %s drawAll() !repaint\n",
1839 System
.currentTimeMillis(), Thread
.currentThread());
1841 if ((oldDrawnMouseX
!= mouseX
) || (oldDrawnMouseY
!= mouseY
)) {
1843 System
.err
.printf("%d %s drawAll() !repaint MOUSE\n",
1844 System
.currentTimeMillis(), Thread
.currentThread());
1847 // The only thing that has happened is the mouse moved.
1849 // Redraw the old cell at that position, and save the cell at
1850 // the new mouse position.
1852 System
.err
.printf("%d %s restoreImage() %d %d\n",
1853 System
.currentTimeMillis(), Thread
.currentThread(),
1854 oldDrawnMouseX
, oldDrawnMouseY
);
1856 oldDrawnMouseCell
.restoreImage();
1857 getScreen().putCharXY(oldDrawnMouseX
, oldDrawnMouseY
,
1859 oldDrawnMouseCell
= getScreen().getCharXY(mouseX
, mouseY
);
1860 if (backend
instanceof ECMA48Backend
) {
1861 // Special case: the entire row containing the mouse has
1862 // to be re-drawn if it has any image data, AND any rows
1864 if (oldDrawnMouseY
!= mouseY
) {
1865 for (int i
= oldDrawnMouseY
; ;) {
1866 getScreen().unsetImageRow(i
);
1870 if (oldDrawnMouseY
< mouseY
) {
1877 getScreen().unsetImageRow(mouseY
);
1881 if ((textMouse
== true) && (typingHidMouse
== false)) {
1882 // Draw mouse at the new position.
1883 invertCell(mouseX
, mouseY
);
1886 oldDrawnMouseX
= mouseX
;
1887 oldDrawnMouseY
= mouseY
;
1889 if (getScreen().isDirty()) {
1890 screenHandler
.setDirty();
1896 System
.err
.printf("%d %s drawAll() REDRAW\n",
1897 System
.currentTimeMillis(), Thread
.currentThread());
1900 // If true, the cursor is not visible
1901 boolean cursor
= false;
1903 // Start with a clean screen
1904 getScreen().clear();
1907 if (desktop
!= null) {
1908 desktop
.drawChildren();
1911 // Draw each window in reverse Z order
1912 List
<TWindow
> sorted
= new ArrayList
<TWindow
>(windows
);
1913 Collections
.sort(sorted
);
1914 TWindow topLevel
= null;
1915 if (sorted
.size() > 0) {
1916 topLevel
= sorted
.get(0);
1918 Collections
.reverse(sorted
);
1919 for (TWindow window
: sorted
) {
1920 if (window
.isShown()) {
1921 window
.drawChildren();
1925 if (hideMenuBar
== false) {
1927 // Draw the blank menubar line - reset the screen clipping first
1928 // so it won't trim it out.
1929 getScreen().resetClipping();
1930 getScreen().hLineXY(0, 0, getScreen().getWidth(), ' ',
1931 theme
.getColor("tmenu"));
1932 // Now draw the menus.
1934 for (TMenu menu
: menus
) {
1935 CellAttributes menuColor
;
1936 CellAttributes menuMnemonicColor
;
1937 if (menu
.isActive()) {
1938 menuIsActive
= true;
1939 menuColor
= theme
.getColor("tmenu.highlighted");
1940 menuMnemonicColor
= theme
.getColor("tmenu.mnemonic.highlighted");
1943 menuColor
= theme
.getColor("tmenu");
1944 menuMnemonicColor
= theme
.getColor("tmenu.mnemonic");
1946 // Draw the menu title
1947 getScreen().hLineXY(x
, 0,
1948 StringUtils
.width(menu
.getTitle()) + 2, ' ', menuColor
);
1949 getScreen().putStringXY(x
+ 1, 0, menu
.getTitle(), menuColor
);
1950 // Draw the highlight character
1951 getScreen().putCharXY(x
+ 1 +
1952 menu
.getMnemonic().getScreenShortcutIdx(),
1953 0, menu
.getMnemonic().getShortcut(), menuMnemonicColor
);
1955 if (menu
.isActive()) {
1956 ((TWindow
) menu
).drawChildren();
1957 // Reset the screen clipping so we can draw the next
1959 getScreen().resetClipping();
1961 x
+= StringUtils
.width(menu
.getTitle()) + 2;
1964 for (TMenu menu
: subMenus
) {
1965 // Reset the screen clipping so we can draw the next
1967 getScreen().resetClipping();
1968 ((TWindow
) menu
).drawChildren();
1971 getScreen().resetClipping();
1973 if (hideStatusBar
== false) {
1974 // Draw the status bar of the top-level window
1975 TStatusBar statusBar
= null;
1976 if (topLevel
!= null) {
1977 statusBar
= topLevel
.getStatusBar();
1979 if (statusBar
!= null) {
1980 getScreen().resetClipping();
1981 statusBar
.setWidth(getScreen().getWidth());
1982 statusBar
.setY(getScreen().getHeight() - topLevel
.getY());
1985 CellAttributes barColor
= new CellAttributes();
1986 barColor
.setTo(getTheme().getColor("tstatusbar.text"));
1987 getScreen().hLineXY(0, desktopBottom
, getScreen().getWidth(),
1992 // Draw the mouse pointer
1994 System
.err
.printf("%d %s restoreImage() %d %d\n",
1995 System
.currentTimeMillis(), Thread
.currentThread(),
1996 oldDrawnMouseX
, oldDrawnMouseY
);
1998 oldDrawnMouseCell
= getScreen().getCharXY(mouseX
, mouseY
);
1999 if (backend
instanceof ECMA48Backend
) {
2000 // Special case: the entire row containing the mouse has to be
2001 // re-drawn if it has any image data, AND any rows in between.
2002 if (oldDrawnMouseY
!= mouseY
) {
2003 for (int i
= oldDrawnMouseY
; ;) {
2004 getScreen().unsetImageRow(i
);
2008 if (oldDrawnMouseY
< mouseY
) {
2015 getScreen().unsetImageRow(mouseY
);
2018 if ((textMouse
== true) && (typingHidMouse
== false)) {
2019 invertCell(mouseX
, mouseY
);
2021 oldDrawnMouseX
= mouseX
;
2022 oldDrawnMouseY
= mouseY
;
2024 // Place the cursor if it is visible
2025 if (!menuIsActive
) {
2027 int visibleWindowCount
= 0;
2028 for (TWindow window
: sorted
) {
2029 if (window
.isShown()) {
2030 visibleWindowCount
++;
2033 if (visibleWindowCount
== 0) {
2034 // No windows are visible, only the desktop. Allow it to
2036 if (desktop
!= null) {
2037 sorted
.add(desktop
);
2041 TWidget activeWidget
= null;
2042 if (sorted
.size() > 0) {
2043 activeWidget
= sorted
.get(sorted
.size() - 1).getActiveChild();
2044 int cursorClipTop
= desktopTop
;
2045 int cursorClipBottom
= desktopBottom
;
2046 if (activeWidget
.isCursorVisible()) {
2047 if ((activeWidget
.getCursorAbsoluteY() <= cursorClipBottom
)
2048 && (activeWidget
.getCursorAbsoluteY() >= cursorClipTop
)
2050 getScreen().putCursor(true,
2051 activeWidget
.getCursorAbsoluteX(),
2052 activeWidget
.getCursorAbsoluteY());
2055 // Turn off the cursor. Also place it at 0,0.
2056 getScreen().putCursor(false, 0, 0);
2065 getScreen().hideCursor();
2068 if (getScreen().isDirty()) {
2069 screenHandler
.setDirty();
2075 * Force this application to exit.
2077 public void exit() {
2079 synchronized (this) {
2085 * Subclasses can use this hook to cleanup resources. Called as the last
2086 * step of TApplication.run().
2088 public void onExit() {
2089 // Default does nothing.
2092 // ------------------------------------------------------------------------
2093 // TWindow management -----------------------------------------------------
2094 // ------------------------------------------------------------------------
2097 * Return the total number of windows.
2099 * @return the total number of windows
2101 public final int windowCount() {
2102 return windows
.size();
2106 * Return the number of windows that are showing.
2108 * @return the number of windows that are showing on screen
2110 public final int shownWindowCount() {
2112 for (TWindow w
: windows
) {
2121 * Return the number of windows that are hidden.
2123 * @return the number of windows that are hidden
2125 public final int hiddenWindowCount() {
2127 for (TWindow w
: windows
) {
2136 * Check if a window instance is in this application's window list.
2138 * @param window window to look for
2139 * @return true if this window is in the list
2141 public final boolean hasWindow(final TWindow window
) {
2142 if (windows
.size() == 0) {
2145 for (TWindow w
: windows
) {
2147 assert (window
.getApplication() == this);
2155 * Activate a window: bring it to the top and have it receive events.
2157 * @param window the window to become the new active window
2159 public void activateWindow(final TWindow window
) {
2160 if (hasWindow(window
) == false) {
2162 * Someone has a handle to a window I don't have. Ignore this
2168 // Whatever window might be moving/dragging, stop it now.
2169 for (TWindow w
: windows
) {
2170 if (w
.inMovements()) {
2175 assert (windows
.size() > 0);
2177 if (window
.isHidden()) {
2178 // Unhiding will also activate.
2182 assert (window
.isShown());
2184 if (windows
.size() == 1) {
2185 assert (window
== windows
.get(0));
2186 if (activeWindow
== null) {
2187 activeWindow
= window
;
2189 activeWindow
.setActive(true);
2190 activeWindow
.onFocus();
2193 assert (window
.isActive());
2194 assert (activeWindow
== window
);
2198 if (activeWindow
== window
) {
2199 assert (window
.isActive());
2201 // Window is already active, do nothing.
2205 assert (!window
.isActive());
2206 if (activeWindow
!= null) {
2207 activeWindow
.setActive(false);
2209 // Increment every window Z that is on top of window
2210 for (TWindow w
: windows
) {
2214 if (w
.getZ() < window
.getZ()) {
2215 w
.setZ(w
.getZ() + 1);
2219 // Unset activeWindow now before unfocus, so that a window
2220 // lifecycle change inside onUnfocus() doesn't call
2221 // switchWindow() and lead to a stack overflow.
2222 TWindow oldActiveWindow
= activeWindow
;
2223 activeWindow
= null;
2224 oldActiveWindow
.onUnfocus();
2226 activeWindow
= window
;
2227 activeWindow
.setZ(0);
2228 activeWindow
.setActive(true);
2229 activeWindow
.onFocus();
2236 * @param window the window to hide
2238 public void hideWindow(final TWindow window
) {
2239 if (hasWindow(window
) == false) {
2241 * Someone has a handle to a window I don't have. Ignore this
2247 // Whatever window might be moving/dragging, stop it now.
2248 for (TWindow w
: windows
) {
2249 if (w
.inMovements()) {
2254 assert (windows
.size() > 0);
2256 if (!window
.hidden
) {
2257 if (window
== activeWindow
) {
2258 if (shownWindowCount() > 1) {
2261 activeWindow
= null;
2262 window
.setActive(false);
2266 window
.hidden
= true;
2274 * @param window the window to show
2276 public void showWindow(final TWindow window
) {
2277 if (hasWindow(window
) == false) {
2279 * Someone has a handle to a window I don't have. Ignore this
2285 // Whatever window might be moving/dragging, stop it now.
2286 for (TWindow w
: windows
) {
2287 if (w
.inMovements()) {
2292 assert (windows
.size() > 0);
2294 if (window
.hidden
) {
2295 window
.hidden
= false;
2297 activateWindow(window
);
2302 * Close window. Note that the window's destructor is NOT called by this
2303 * method, instead the GC is assumed to do the cleanup.
2305 * @param window the window to remove
2307 public final void closeWindow(final TWindow window
) {
2308 if (hasWindow(window
) == false) {
2310 * Someone has a handle to a window I don't have. Ignore this
2316 // Let window know that it is about to be closed, while it is still
2317 // visible on screen.
2318 window
.onPreClose();
2320 synchronized (windows
) {
2321 // Whatever window might be moving/dragging, stop it now.
2322 for (TWindow w
: windows
) {
2323 if (w
.inMovements()) {
2328 int z
= window
.getZ();
2331 windows
.remove(window
);
2332 Collections
.sort(windows
);
2333 activeWindow
= null;
2335 boolean foundNextWindow
= false;
2337 for (TWindow w
: windows
) {
2341 // Do not activate a hidden window.
2346 if (foundNextWindow
== false) {
2347 foundNextWindow
= true;
2350 assert (activeWindow
== null);
2362 // Perform window cleanup
2365 // Check if we are closing a TMessageBox or similar
2366 if (secondaryEventReceiver
!= null) {
2367 assert (secondaryEventHandler
!= null);
2369 // Do not send events to the secondaryEventReceiver anymore, the
2370 // window is closed.
2371 secondaryEventReceiver
= null;
2373 // Wake the secondary thread, it will wake the primary as it
2375 synchronized (secondaryEventHandler
) {
2376 secondaryEventHandler
.notify();
2380 // Permit desktop to be active if it is the only thing left.
2381 if (desktop
!= null) {
2382 if (windows
.size() == 0) {
2383 desktop
.setActive(true);
2389 * Switch to the next window.
2391 * @param forward if true, then switch to the next window in the list,
2392 * otherwise switch to the previous window in the list
2394 public final void switchWindow(final boolean forward
) {
2395 // Only switch if there are multiple visible windows
2396 if (shownWindowCount() < 2) {
2399 assert (activeWindow
!= null);
2401 synchronized (windows
) {
2402 // Whatever window might be moving/dragging, stop it now.
2403 for (TWindow w
: windows
) {
2404 if (w
.inMovements()) {
2409 // Swap z/active between active window and the next in the list
2410 int activeWindowI
= -1;
2411 for (int i
= 0; i
< windows
.size(); i
++) {
2412 if (windows
.get(i
) == activeWindow
) {
2413 assert (activeWindow
.isActive());
2417 assert (!windows
.get(0).isActive());
2420 assert (activeWindowI
>= 0);
2422 // Do not switch if a window is modal
2423 if (activeWindow
.isModal()) {
2427 int nextWindowI
= activeWindowI
;
2431 nextWindowI
%= windows
.size();
2434 if (nextWindowI
< 0) {
2435 nextWindowI
= windows
.size() - 1;
2439 if (windows
.get(nextWindowI
).isShown()) {
2440 activateWindow(windows
.get(nextWindowI
));
2444 } // synchronized (windows)
2449 * Add a window to my window list and make it active. Note package
2452 * @param window new window to add
2454 final void addWindowToApplication(final TWindow window
) {
2456 // Do not add menu windows to the window list.
2457 if (window
instanceof TMenu
) {
2461 // Do not add the desktop to the window list.
2462 if (window
instanceof TDesktop
) {
2466 synchronized (windows
) {
2467 if (windows
.contains(window
)) {
2468 throw new IllegalArgumentException("Window " + window
+
2469 " is already in window list");
2472 // Whatever window might be moving/dragging, stop it now.
2473 for (TWindow w
: windows
) {
2474 if (w
.inMovements()) {
2479 // Do not allow a modal window to spawn a non-modal window. If a
2480 // modal window is active, then this window will become modal
2482 if (modalWindowActive()) {
2483 window
.flags
|= TWindow
.MODAL
;
2484 window
.flags
|= TWindow
.CENTERED
;
2485 window
.hidden
= false;
2487 if (window
.isShown()) {
2488 for (TWindow w
: windows
) {
2493 w
.setZ(w
.getZ() + 1);
2496 windows
.add(window
);
2497 if (window
.isShown()) {
2498 activeWindow
= window
;
2499 activeWindow
.setZ(0);
2500 activeWindow
.setActive(true);
2501 activeWindow
.onFocus();
2504 if (((window
.flags
& TWindow
.CENTERED
) == 0)
2505 && ((window
.flags
& TWindow
.ABSOLUTEXY
) == 0)
2506 && (smartWindowPlacement
== true)
2507 && (!(window
instanceof TDesktop
))
2510 doSmartPlacement(window
);
2514 // Desktop cannot be active over any other window.
2515 if (desktop
!= null) {
2516 desktop
.setActive(false);
2521 * Check if there is a system-modal window on top.
2523 * @return true if the active window is modal
2525 private boolean modalWindowActive() {
2526 if (windows
.size() == 0) {
2530 for (TWindow w
: windows
) {
2540 * Check if there is a window with overridden menu flag on top.
2542 * @return true if the active window is overriding the menu
2544 private boolean overrideMenuWindowActive() {
2545 if (activeWindow
!= null) {
2546 if (activeWindow
.hasOverriddenMenu()) {
2555 * Close all open windows.
2557 private void closeAllWindows() {
2558 // Don't do anything if we are in the menu
2559 if (activeMenu
!= null) {
2562 while (windows
.size() > 0) {
2563 closeWindow(windows
.get(0));
2568 * Re-layout the open windows as non-overlapping tiles. This produces
2569 * almost the same results as Turbo Pascal 7.0's IDE.
2571 private void tileWindows() {
2572 synchronized (windows
) {
2573 // Don't do anything if we are in the menu
2574 if (activeMenu
!= null) {
2577 int z
= windows
.size();
2583 a
= (int)(Math
.sqrt(z
));
2587 if (((a
* b
) + c
) == z
) {
2595 int newWidth
= (getScreen().getWidth() / a
);
2596 int newHeight1
= ((getScreen().getHeight() - 1) / b
);
2597 int newHeight2
= ((getScreen().getHeight() - 1) / (b
+ c
));
2599 List
<TWindow
> sorted
= new ArrayList
<TWindow
>(windows
);
2600 Collections
.sort(sorted
);
2601 Collections
.reverse(sorted
);
2602 for (int i
= 0; i
< sorted
.size(); i
++) {
2603 int logicalX
= i
/ b
;
2604 int logicalY
= i
% b
;
2605 if (i
>= ((a
- 1) * b
)) {
2607 logicalY
= i
- ((a
- 1) * b
);
2610 TWindow w
= sorted
.get(i
);
2611 int oldWidth
= w
.getWidth();
2612 int oldHeight
= w
.getHeight();
2614 w
.setX(logicalX
* newWidth
);
2615 w
.setWidth(newWidth
);
2616 if (i
>= ((a
- 1) * b
)) {
2617 w
.setY((logicalY
* newHeight2
) + 1);
2618 w
.setHeight(newHeight2
);
2620 w
.setY((logicalY
* newHeight1
) + 1);
2621 w
.setHeight(newHeight1
);
2623 if ((w
.getWidth() != oldWidth
)
2624 || (w
.getHeight() != oldHeight
)
2626 w
.onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
,
2627 w
.getWidth(), w
.getHeight()));
2634 * Re-layout the open windows as overlapping cascaded windows.
2636 private void cascadeWindows() {
2637 synchronized (windows
) {
2638 // Don't do anything if we are in the menu
2639 if (activeMenu
!= null) {
2644 List
<TWindow
> sorted
= new ArrayList
<TWindow
>(windows
);
2645 Collections
.sort(sorted
);
2646 Collections
.reverse(sorted
);
2647 for (TWindow window
: sorted
) {
2652 if (x
> getScreen().getWidth()) {
2655 if (y
>= getScreen().getHeight()) {
2663 * Place a window to minimize its overlap with other windows.
2665 * @param window the window to place
2667 public final void doSmartPlacement(final TWindow window
) {
2668 // This is a pretty dumb algorithm, but seems to work. The hardest
2669 // part is computing these "overlap" values seeking a minimum average
2672 int yMin
= desktopTop
;
2673 int xMax
= getScreen().getWidth() - window
.getWidth() + 1;
2674 int yMax
= desktopBottom
- window
.getHeight() + 1;
2682 if ((xMin
== xMax
) && (yMin
== yMax
)) {
2683 // No work to do, bail out.
2687 // Compute the overlap matrix without the new window.
2688 int width
= getScreen().getWidth();
2689 int height
= getScreen().getHeight();
2690 int overlapMatrix
[][] = new int[width
][height
];
2691 for (TWindow w
: windows
) {
2695 for (int x
= w
.getX(); x
< w
.getX() + w
.getWidth(); x
++) {
2702 for (int y
= w
.getY(); y
< w
.getY() + w
.getHeight(); y
++) {
2709 overlapMatrix
[x
][y
]++;
2714 long oldOverlapTotal
= 0;
2715 long oldOverlapN
= 0;
2716 for (int x
= 0; x
< width
; x
++) {
2717 for (int y
= 0; y
< height
; y
++) {
2718 oldOverlapTotal
+= overlapMatrix
[x
][y
];
2719 if (overlapMatrix
[x
][y
] > 0) {
2726 double oldOverlapAvg
= (double) oldOverlapTotal
/ (double) oldOverlapN
;
2727 boolean first
= true;
2728 int windowX
= window
.getX();
2729 int windowY
= window
.getY();
2731 // For each possible (x, y) position for the new window, compute a
2732 // new overlap matrix.
2733 for (int x
= xMin
; x
< xMax
; x
++) {
2734 for (int y
= yMin
; y
< yMax
; y
++) {
2736 // Start with the matrix minus this window.
2737 int newMatrix
[][] = new int[width
][height
];
2738 for (int mx
= 0; mx
< width
; mx
++) {
2739 for (int my
= 0; my
< height
; my
++) {
2740 newMatrix
[mx
][my
] = overlapMatrix
[mx
][my
];
2744 // Add this window's values to the new overlap matrix.
2745 long newOverlapTotal
= 0;
2746 long newOverlapN
= 0;
2747 // Start by adding each new cell.
2748 for (int wx
= x
; wx
< x
+ window
.getWidth(); wx
++) {
2752 for (int wy
= y
; wy
< y
+ window
.getHeight(); wy
++) {
2756 newMatrix
[wx
][wy
]++;
2759 // Now figure out the new value for total coverage.
2760 for (int mx
= 0; mx
< width
; mx
++) {
2761 for (int my
= 0; my
< height
; my
++) {
2762 newOverlapTotal
+= newMatrix
[x
][y
];
2763 if (newMatrix
[mx
][my
] > 0) {
2768 double newOverlapAvg
= (double) newOverlapTotal
/ (double) newOverlapN
;
2771 // First time: just record what we got.
2772 oldOverlapAvg
= newOverlapAvg
;
2775 // All other times: pick a new best (x, y) and save the
2777 if (newOverlapAvg
< oldOverlapAvg
) {
2780 oldOverlapAvg
= newOverlapAvg
;
2784 } // for (int x = xMin; x < xMax; x++)
2786 } // for (int y = yMin; y < yMax; y++)
2788 // Finally, set the window's new coordinates.
2789 window
.setX(windowX
);
2790 window
.setY(windowY
);
2793 // ------------------------------------------------------------------------
2794 // TMenu management -------------------------------------------------------
2795 // ------------------------------------------------------------------------
2798 * Check if a mouse event would hit either the active menu or any open
2801 * @param mouse mouse event
2802 * @return true if the mouse would hit the active menu or an open
2805 private boolean mouseOnMenu(final TMouseEvent mouse
) {
2806 assert (activeMenu
!= null);
2807 List
<TMenu
> menus
= new ArrayList
<TMenu
>(subMenus
);
2808 Collections
.reverse(menus
);
2809 for (TMenu menu
: menus
) {
2810 if (menu
.mouseWouldHit(mouse
)) {
2814 return activeMenu
.mouseWouldHit(mouse
);
2818 * See if we need to switch window or activate the menu based on
2821 * @param mouse mouse event
2823 private void checkSwitchFocus(final TMouseEvent mouse
) {
2825 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
2826 && (activeMenu
!= null)
2827 && (mouse
.getAbsoluteY() != 0)
2828 && (!mouseOnMenu(mouse
))
2830 // They clicked outside the active menu, turn it off
2831 activeMenu
.setActive(false);
2833 for (TMenu menu
: subMenus
) {
2834 menu
.setActive(false);
2840 // See if they hit the menu bar
2841 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
2842 && (mouse
.isMouse1())
2843 && (!modalWindowActive())
2844 && (!overrideMenuWindowActive())
2845 && (mouse
.getAbsoluteY() == 0)
2846 && (hideMenuBar
== false)
2849 for (TMenu menu
: subMenus
) {
2850 menu
.setActive(false);
2854 // They selected the menu, go activate it
2855 for (TMenu menu
: menus
) {
2856 if ((mouse
.getAbsoluteX() >= menu
.getTitleX())
2857 && (mouse
.getAbsoluteX() < menu
.getTitleX()
2858 + StringUtils
.width(menu
.getTitle()) + 2)
2860 menu
.setActive(true);
2863 menu
.setActive(false);
2869 // See if they hit the menu bar
2870 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_MOTION
)
2871 && (mouse
.isMouse1())
2872 && (activeMenu
!= null)
2873 && (mouse
.getAbsoluteY() == 0)
2874 && (hideMenuBar
== false)
2877 TMenu oldMenu
= activeMenu
;
2878 for (TMenu menu
: subMenus
) {
2879 menu
.setActive(false);
2883 // See if we should switch menus
2884 for (TMenu menu
: menus
) {
2885 if ((mouse
.getAbsoluteX() >= menu
.getTitleX())
2886 && (mouse
.getAbsoluteX() < menu
.getTitleX()
2887 + StringUtils
.width(menu
.getTitle()) + 2)
2889 menu
.setActive(true);
2893 if (oldMenu
!= activeMenu
) {
2894 // They switched menus
2895 oldMenu
.setActive(false);
2900 // If a menu is still active, don't switch windows
2901 if (activeMenu
!= null) {
2905 // Only switch if there are multiple windows
2906 if (windows
.size() < 2) {
2910 if (((focusFollowsMouse
== true)
2911 && (mouse
.getType() == TMouseEvent
.Type
.MOUSE_MOTION
))
2912 || (mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
2914 synchronized (windows
) {
2915 Collections
.sort(windows
);
2916 if (windows
.get(0).isModal()) {
2917 // Modal windows don't switch
2921 for (TWindow window
: windows
) {
2922 assert (!window
.isModal());
2924 if (window
.isHidden()) {
2925 assert (!window
.isActive());
2929 if (window
.mouseWouldHit(mouse
)) {
2930 if (window
== windows
.get(0)) {
2931 // Clicked on the same window, nothing to do
2932 assert (window
.isActive());
2936 // We will be switching to another window
2937 assert (windows
.get(0).isActive());
2938 assert (windows
.get(0) == activeWindow
);
2939 assert (!window
.isActive());
2940 if (activeWindow
!= null) {
2941 activeWindow
.onUnfocus();
2942 activeWindow
.setActive(false);
2943 activeWindow
.setZ(window
.getZ());
2945 activeWindow
= window
;
2947 window
.setActive(true);
2954 // Clicked on the background, nothing to do
2958 // Nothing to do: this isn't a mouse up, or focus isn't following
2964 * Turn off the menu.
2966 public final void closeMenu() {
2967 if (activeMenu
!= null) {
2968 activeMenu
.setActive(false);
2970 for (TMenu menu
: subMenus
) {
2971 menu
.setActive(false);
2978 * Get a (shallow) copy of the menu list.
2980 * @return a copy of the menu list
2982 public final List
<TMenu
> getAllMenus() {
2983 return new ArrayList
<TMenu
>(menus
);
2987 * Add a top-level menu to the list.
2989 * @param menu the menu to add
2990 * @throws IllegalArgumentException if the menu is already used in
2991 * another TApplication
2993 public final void addMenu(final TMenu menu
) {
2994 if ((menu
.getApplication() != null)
2995 && (menu
.getApplication() != this)
2997 throw new IllegalArgumentException("Menu " + menu
+ " is already " +
2998 "part of application " + menu
.getApplication());
3006 * Remove a top-level menu from the list.
3008 * @param menu the menu to remove
3009 * @throws IllegalArgumentException if the menu is already used in
3010 * another TApplication
3012 public final void removeMenu(final TMenu menu
) {
3013 if ((menu
.getApplication() != null)
3014 && (menu
.getApplication() != this)
3016 throw new IllegalArgumentException("Menu " + menu
+ " is already " +
3017 "part of application " + menu
.getApplication());
3025 * Turn off a sub-menu.
3027 public final void closeSubMenu() {
3028 assert (activeMenu
!= null);
3029 TMenu item
= subMenus
.get(subMenus
.size() - 1);
3030 assert (item
!= null);
3031 item
.setActive(false);
3032 subMenus
.remove(subMenus
.size() - 1);
3036 * Switch to the next menu.
3038 * @param forward if true, then switch to the next menu in the list,
3039 * otherwise switch to the previous menu in the list
3041 public final void switchMenu(final boolean forward
) {
3042 assert (activeMenu
!= null);
3043 assert (hideMenuBar
== false);
3045 for (TMenu menu
: subMenus
) {
3046 menu
.setActive(false);
3050 for (int i
= 0; i
< menus
.size(); i
++) {
3051 if (activeMenu
== menus
.get(i
)) {
3053 if (i
< menus
.size() - 1) {
3062 i
= menus
.size() - 1;
3065 activeMenu
.setActive(false);
3066 activeMenu
= menus
.get(i
);
3067 activeMenu
.setActive(true);
3074 * Add a menu item to the global list. If it has a keyboard accelerator,
3075 * that will be added the global hash.
3077 * @param item the menu item
3079 public final void addMenuItem(final TMenuItem item
) {
3080 menuItems
.add(item
);
3082 TKeypress key
= item
.getKey();
3084 synchronized (accelerators
) {
3085 assert (accelerators
.get(key
) == null);
3086 accelerators
.put(key
.toLowerCase(), item
);
3092 * Disable one menu item.
3094 * @param id the menu item ID
3096 public final void disableMenuItem(final int id
) {
3097 for (TMenuItem item
: menuItems
) {
3098 if (item
.getId() == id
) {
3099 item
.setEnabled(false);
3105 * Disable the range of menu items with ID's between lower and upper,
3108 * @param lower the lowest menu item ID
3109 * @param upper the highest menu item ID
3111 public final void disableMenuItems(final int lower
, final int upper
) {
3112 for (TMenuItem item
: menuItems
) {
3113 if ((item
.getId() >= lower
) && (item
.getId() <= upper
)) {
3114 item
.setEnabled(false);
3115 item
.getParent().activate(0);
3121 * Enable one menu item.
3123 * @param id the menu item ID
3125 public final void enableMenuItem(final int id
) {
3126 for (TMenuItem item
: menuItems
) {
3127 if (item
.getId() == id
) {
3128 item
.setEnabled(true);
3129 item
.getParent().activate(0);
3135 * Enable the range of menu items with ID's between lower and upper,
3138 * @param lower the lowest menu item ID
3139 * @param upper the highest menu item ID
3141 public final void enableMenuItems(final int lower
, final int upper
) {
3142 for (TMenuItem item
: menuItems
) {
3143 if ((item
.getId() >= lower
) && (item
.getId() <= upper
)) {
3144 item
.setEnabled(true);
3145 item
.getParent().activate(0);
3151 * Get the menu item associated with this ID.
3153 * @param id the menu item ID
3154 * @return the menu item, or null if not found
3156 public final TMenuItem
getMenuItem(final int id
) {
3157 for (TMenuItem item
: menuItems
) {
3158 if (item
.getId() == id
) {
3166 * Recompute menu x positions based on their title length.
3168 public final void recomputeMenuX() {
3170 for (TMenu menu
: menus
) {
3173 x
+= StringUtils
.width(menu
.getTitle()) + 2;
3175 // Don't let the menu window exceed the screen width
3176 int rightEdge
= menu
.getX() + menu
.getWidth();
3177 if (rightEdge
> getScreen().getWidth()) {
3178 menu
.setX(getScreen().getWidth() - menu
.getWidth());
3184 * Post an event to process.
3186 * @param event new event to add to the queue
3188 public final void postEvent(final TInputEvent event
) {
3189 synchronized (this) {
3190 synchronized (fillEventQueue
) {
3191 fillEventQueue
.add(event
);
3194 System
.err
.println(System
.currentTimeMillis() + " " +
3195 Thread
.currentThread() + " postEvent() wake up main");
3202 * Post an event to process and turn off the menu.
3204 * @param event new event to add to the queue
3206 public final void postMenuEvent(final TInputEvent event
) {
3207 synchronized (this) {
3208 synchronized (fillEventQueue
) {
3209 fillEventQueue
.add(event
);
3212 System
.err
.println(System
.currentTimeMillis() + " " +
3213 Thread
.currentThread() + " postMenuEvent() wake up main");
3221 * Add a sub-menu to the list of open sub-menus.
3223 * @param menu sub-menu
3225 public final void addSubMenu(final TMenu menu
) {
3230 * Convenience function to add a top-level menu.
3232 * @param title menu title
3233 * @return the new menu
3235 public final TMenu
addMenu(final String title
) {
3238 TMenu menu
= new TMenu(this, x
, y
, title
);
3245 * Convenience function to add a default tools (hamburger) menu.
3247 * @return the new menu
3249 public final TMenu
addToolMenu() {
3250 TMenu toolMenu
= addMenu(i18n
.getString("toolMenuTitle"));
3251 toolMenu
.addDefaultItem(TMenu
.MID_REPAINT
);
3252 toolMenu
.addDefaultItem(TMenu
.MID_VIEW_IMAGE
);
3253 toolMenu
.addDefaultItem(TMenu
.MID_SCREEN_OPTIONS
);
3254 TStatusBar toolStatusBar
= toolMenu
.newStatusBar(i18n
.
3255 getString("toolMenuStatus"));
3256 toolStatusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
3261 * Convenience function to add a default "File" menu.
3263 * @return the new menu
3265 public final TMenu
addFileMenu() {
3266 TMenu fileMenu
= addMenu(i18n
.getString("fileMenuTitle"));
3267 fileMenu
.addDefaultItem(TMenu
.MID_SHELL
);
3268 fileMenu
.addSeparator();
3269 fileMenu
.addDefaultItem(TMenu
.MID_EXIT
);
3270 TStatusBar statusBar
= fileMenu
.newStatusBar(i18n
.
3271 getString("fileMenuStatus"));
3272 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
3277 * Convenience function to add a default "Edit" menu.
3279 * @return the new menu
3281 public final TMenu
addEditMenu() {
3282 TMenu editMenu
= addMenu(i18n
.getString("editMenuTitle"));
3283 editMenu
.addDefaultItem(TMenu
.MID_CUT
);
3284 editMenu
.addDefaultItem(TMenu
.MID_COPY
);
3285 editMenu
.addDefaultItem(TMenu
.MID_PASTE
);
3286 editMenu
.addDefaultItem(TMenu
.MID_CLEAR
);
3287 TStatusBar statusBar
= editMenu
.newStatusBar(i18n
.
3288 getString("editMenuStatus"));
3289 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
3294 * Convenience function to add a default "Window" menu.
3296 * @return the new menu
3298 public final TMenu
addWindowMenu() {
3299 TMenu windowMenu
= addMenu(i18n
.getString("windowMenuTitle"));
3300 windowMenu
.addDefaultItem(TMenu
.MID_TILE
);
3301 windowMenu
.addDefaultItem(TMenu
.MID_CASCADE
);
3302 windowMenu
.addDefaultItem(TMenu
.MID_CLOSE_ALL
);
3303 windowMenu
.addSeparator();
3304 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_MOVE
);
3305 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_ZOOM
);
3306 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_NEXT
);
3307 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_PREVIOUS
);
3308 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_CLOSE
);
3309 TStatusBar statusBar
= windowMenu
.newStatusBar(i18n
.
3310 getString("windowMenuStatus"));
3311 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
3316 * Convenience function to add a default "Help" menu.
3318 * @return the new menu
3320 public final TMenu
addHelpMenu() {
3321 TMenu helpMenu
= addMenu(i18n
.getString("helpMenuTitle"));
3322 helpMenu
.addDefaultItem(TMenu
.MID_HELP_CONTENTS
);
3323 helpMenu
.addDefaultItem(TMenu
.MID_HELP_INDEX
);
3324 helpMenu
.addDefaultItem(TMenu
.MID_HELP_SEARCH
);
3325 helpMenu
.addDefaultItem(TMenu
.MID_HELP_PREVIOUS
);
3326 helpMenu
.addDefaultItem(TMenu
.MID_HELP_HELP
);
3327 helpMenu
.addDefaultItem(TMenu
.MID_HELP_ACTIVE_FILE
);
3328 helpMenu
.addSeparator();
3329 helpMenu
.addDefaultItem(TMenu
.MID_ABOUT
);
3330 TStatusBar statusBar
= helpMenu
.newStatusBar(i18n
.
3331 getString("helpMenuStatus"));
3332 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
3337 * Convenience function to add a default "Table" menu.
3339 * @return the new menu
3341 public final TMenu
addTableMenu() {
3342 TMenu tableMenu
= addMenu(i18n
.getString("tableMenuTitle"));
3343 tableMenu
.addDefaultItem(TMenu
.MID_TABLE_RENAME_COLUMN
, false);
3344 tableMenu
.addDefaultItem(TMenu
.MID_TABLE_RENAME_ROW
, false);
3345 tableMenu
.addSeparator();
3347 TSubMenu viewMenu
= tableMenu
.addSubMenu(i18n
.
3348 getString("tableSubMenuView"));
3349 viewMenu
.addDefaultItem(TMenu
.MID_TABLE_VIEW_ROW_LABELS
, false);
3350 viewMenu
.addDefaultItem(TMenu
.MID_TABLE_VIEW_COLUMN_LABELS
, false);
3351 viewMenu
.addDefaultItem(TMenu
.MID_TABLE_VIEW_HIGHLIGHT_ROW
, false);
3352 viewMenu
.addDefaultItem(TMenu
.MID_TABLE_VIEW_HIGHLIGHT_COLUMN
, false);
3354 TSubMenu borderMenu
= tableMenu
.addSubMenu(i18n
.
3355 getString("tableSubMenuBorders"));
3356 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_NONE
, false);
3357 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_ALL
, false);
3358 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_CELL_NONE
, false);
3359 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_CELL_ALL
, false);
3360 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_RIGHT
, false);
3361 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_LEFT
, false);
3362 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_TOP
, false);
3363 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_BOTTOM
, false);
3364 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_DOUBLE_BOTTOM
, false);
3365 borderMenu
.addDefaultItem(TMenu
.MID_TABLE_BORDER_THICK_BOTTOM
, false);
3366 TSubMenu deleteMenu
= tableMenu
.addSubMenu(i18n
.
3367 getString("tableSubMenuDelete"));
3368 deleteMenu
.addDefaultItem(TMenu
.MID_TABLE_DELETE_LEFT
, false);
3369 deleteMenu
.addDefaultItem(TMenu
.MID_TABLE_DELETE_UP
, false);
3370 deleteMenu
.addDefaultItem(TMenu
.MID_TABLE_DELETE_ROW
, false);
3371 deleteMenu
.addDefaultItem(TMenu
.MID_TABLE_DELETE_COLUMN
, false);
3372 TSubMenu insertMenu
= tableMenu
.addSubMenu(i18n
.
3373 getString("tableSubMenuInsert"));
3374 insertMenu
.addDefaultItem(TMenu
.MID_TABLE_INSERT_LEFT
, false);
3375 insertMenu
.addDefaultItem(TMenu
.MID_TABLE_INSERT_RIGHT
, false);
3376 insertMenu
.addDefaultItem(TMenu
.MID_TABLE_INSERT_ABOVE
, false);
3377 insertMenu
.addDefaultItem(TMenu
.MID_TABLE_INSERT_BELOW
, false);
3378 TSubMenu columnMenu
= tableMenu
.addSubMenu(i18n
.
3379 getString("tableSubMenuColumn"));
3380 columnMenu
.addDefaultItem(TMenu
.MID_TABLE_COLUMN_NARROW
, false);
3381 columnMenu
.addDefaultItem(TMenu
.MID_TABLE_COLUMN_WIDEN
, false);
3382 TSubMenu fileMenu
= tableMenu
.addSubMenu(i18n
.
3383 getString("tableSubMenuFile"));
3384 fileMenu
.addDefaultItem(TMenu
.MID_TABLE_FILE_OPEN_CSV
, false);
3385 fileMenu
.addDefaultItem(TMenu
.MID_TABLE_FILE_SAVE_CSV
, false);
3386 fileMenu
.addDefaultItem(TMenu
.MID_TABLE_FILE_SAVE_TEXT
, false);
3388 TStatusBar statusBar
= tableMenu
.newStatusBar(i18n
.
3389 getString("tableMenuStatus"));
3390 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
3394 // ------------------------------------------------------------------------
3395 // TTimer management ------------------------------------------------------
3396 // ------------------------------------------------------------------------
3399 * Get the amount of time I can sleep before missing a Timer tick.
3401 * @param timeout = initial (maximum) timeout in millis
3402 * @return number of milliseconds between now and the next timer event
3404 private long getSleepTime(final long timeout
) {
3405 Date now
= new Date();
3406 long nowTime
= now
.getTime();
3407 long sleepTime
= timeout
;
3409 synchronized (timers
) {
3410 for (TTimer timer
: timers
) {
3411 long nextTickTime
= timer
.getNextTick().getTime();
3412 if (nextTickTime
< nowTime
) {
3416 long timeDifference
= nextTickTime
- nowTime
;
3417 if (timeDifference
< sleepTime
) {
3418 sleepTime
= timeDifference
;
3423 assert (sleepTime
>= 0);
3424 assert (sleepTime
<= timeout
);
3429 * Convenience function to add a timer.
3431 * @param duration number of milliseconds to wait between ticks
3432 * @param recurring if true, re-schedule this timer after every tick
3433 * @param action function to call when button is pressed
3436 public final TTimer
addTimer(final long duration
, final boolean recurring
,
3437 final TAction action
) {
3439 TTimer timer
= new TTimer(duration
, recurring
, action
);
3440 synchronized (timers
) {
3447 * Convenience function to remove a timer.
3449 * @param timer timer to remove
3451 public final void removeTimer(final TTimer timer
) {
3452 synchronized (timers
) {
3453 timers
.remove(timer
);
3457 // ------------------------------------------------------------------------
3458 // Other TWindow constructors ---------------------------------------------
3459 // ------------------------------------------------------------------------
3462 * Convenience function to spawn a message box.
3464 * @param title window title, will be centered along the top border
3465 * @param caption message to display. Use embedded newlines to get a
3467 * @return the new message box
3469 public final TMessageBox
messageBox(final String title
,
3470 final String caption
) {
3472 return new TMessageBox(this, title
, caption
, TMessageBox
.Type
.OK
);
3476 * Convenience function to spawn a message box.
3478 * @param title window title, will be centered along the top border
3479 * @param caption message to display. Use embedded newlines to get a
3481 * @param type one of the TMessageBox.Type constants. Default is
3483 * @return the new message box
3485 public final TMessageBox
messageBox(final String title
,
3486 final String caption
, final TMessageBox
.Type type
) {
3488 return new TMessageBox(this, title
, caption
, type
);
3492 * Convenience function to spawn an input box.
3494 * @param title window title, will be centered along the top border
3495 * @param caption message to display. Use embedded newlines to get a
3497 * @return the new input box
3499 public final TInputBox
inputBox(final String title
, final String caption
) {
3501 return new TInputBox(this, title
, caption
);
3505 * Convenience function to spawn an input box.
3507 * @param title window title, will be centered along the top border
3508 * @param caption message to display. Use embedded newlines to get a
3510 * @param text initial text to seed the field with
3511 * @return the new input box
3513 public final TInputBox
inputBox(final String title
, final String caption
,
3514 final String text
) {
3516 return new TInputBox(this, title
, caption
, text
);
3520 * Convenience function to spawn an input box.
3522 * @param title window title, will be centered along the top border
3523 * @param caption message to display. Use embedded newlines to get a
3525 * @param text initial text to seed the field with
3526 * @param type one of the Type constants. Default is Type.OK.
3527 * @return the new input box
3529 public final TInputBox
inputBox(final String title
, final String caption
,
3530 final String text
, final TInputBox
.Type type
) {
3532 return new TInputBox(this, title
, caption
, text
, type
);
3536 * Convenience function to open a terminal window.
3538 * @param x column relative to parent
3539 * @param y row relative to parent
3540 * @return the terminal new window
3542 public final TTerminalWindow
openTerminal(final int x
, final int y
) {
3543 return openTerminal(x
, y
, TWindow
.RESIZABLE
);
3547 * Convenience function to open a terminal window.
3549 * @param x column relative to parent
3550 * @param y row relative to parent
3551 * @param closeOnExit if true, close the window when the command exits
3552 * @return the terminal new window
3554 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3555 final boolean closeOnExit
) {
3557 return openTerminal(x
, y
, TWindow
.RESIZABLE
, closeOnExit
);
3561 * Convenience function to open a terminal window.
3563 * @param x column relative to parent
3564 * @param y row relative to parent
3565 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3566 * @return the terminal new window
3568 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3571 return new TTerminalWindow(this, x
, y
, flags
);
3575 * Convenience function to open a terminal window.
3577 * @param x column relative to parent
3578 * @param y row relative to parent
3579 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3580 * @param closeOnExit if true, close the window when the command exits
3581 * @return the terminal new window
3583 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3584 final int flags
, final boolean closeOnExit
) {
3586 return new TTerminalWindow(this, x
, y
, flags
, closeOnExit
);
3590 * Convenience function to open a terminal window and execute a custom
3591 * command line inside it.
3593 * @param x column relative to parent
3594 * @param y row relative to parent
3595 * @param commandLine the command line to execute
3596 * @return the terminal new window
3598 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3599 final String commandLine
) {
3601 return openTerminal(x
, y
, TWindow
.RESIZABLE
, commandLine
);
3605 * Convenience function to open a terminal window and execute a custom
3606 * command line inside it.
3608 * @param x column relative to parent
3609 * @param y row relative to parent
3610 * @param commandLine the command line to execute
3611 * @param closeOnExit if true, close the window when the command exits
3612 * @return the terminal new window
3614 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3615 final String commandLine
, final boolean closeOnExit
) {
3617 return openTerminal(x
, y
, TWindow
.RESIZABLE
, commandLine
, closeOnExit
);
3621 * Convenience function to open a terminal window and execute a custom
3622 * command line inside it.
3624 * @param x column relative to parent
3625 * @param y row relative to parent
3626 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3627 * @param command the command line to execute
3628 * @return the terminal new window
3630 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3631 final int flags
, final String
[] command
) {
3633 return new TTerminalWindow(this, x
, y
, flags
, command
);
3637 * Convenience function to open a terminal window and execute a custom
3638 * command line inside it.
3640 * @param x column relative to parent
3641 * @param y row relative to parent
3642 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3643 * @param command the command line to execute
3644 * @param closeOnExit if true, close the window when the command exits
3645 * @return the terminal new window
3647 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3648 final int flags
, final String
[] command
, final boolean closeOnExit
) {
3650 return new TTerminalWindow(this, x
, y
, flags
, command
, closeOnExit
);
3654 * Convenience function to open a terminal window and execute a custom
3655 * command line inside it.
3657 * @param x column relative to parent
3658 * @param y row relative to parent
3659 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3660 * @param commandLine the command line to execute
3661 * @return the terminal new window
3663 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3664 final int flags
, final String commandLine
) {
3666 return new TTerminalWindow(this, x
, y
, flags
, commandLine
.split("\\s+"));
3670 * Convenience function to open a terminal window and execute a custom
3671 * command line inside it.
3673 * @param x column relative to parent
3674 * @param y row relative to parent
3675 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3676 * @param commandLine the command line to execute
3677 * @param closeOnExit if true, close the window when the command exits
3678 * @return the terminal new window
3680 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3681 final int flags
, final String commandLine
, final boolean closeOnExit
) {
3683 return new TTerminalWindow(this, x
, y
, flags
, commandLine
.split("\\s+"),
3688 * Convenience function to spawn an file open box.
3690 * @param path path of selected file
3691 * @return the result of the new file open box
3692 * @throws IOException if java.io operation throws
3694 public final String
fileOpenBox(final String path
) throws IOException
{
3696 TFileOpenBox box
= new TFileOpenBox(this, path
, TFileOpenBox
.Type
.OPEN
);
3697 return box
.getFilename();
3701 * Convenience function to spawn an file open box.
3703 * @param path path of selected file
3704 * @param type one of the Type constants
3705 * @return the result of the new file open box
3706 * @throws IOException if java.io operation throws
3708 public final String
fileOpenBox(final String path
,
3709 final TFileOpenBox
.Type type
) throws IOException
{
3711 TFileOpenBox box
= new TFileOpenBox(this, path
, type
);
3712 return box
.getFilename();
3716 * Convenience function to spawn a file open box.
3718 * @param path path of selected file
3719 * @param type one of the Type constants
3720 * @param filter a string that files must match to be displayed
3721 * @return the result of the new file open box
3722 * @throws IOException of a java.io operation throws
3724 public final String
fileOpenBox(final String path
,
3725 final TFileOpenBox
.Type type
, final String filter
) throws IOException
{
3727 ArrayList
<String
> filters
= new ArrayList
<String
>();
3728 filters
.add(filter
);
3730 TFileOpenBox box
= new TFileOpenBox(this, path
, type
, filters
);
3731 return box
.getFilename();
3735 * Convenience function to spawn a file open box.
3737 * @param path path of selected file
3738 * @param type one of the Type constants
3739 * @param filters a list of strings that files must match to be displayed
3740 * @return the result of the new file open box
3741 * @throws IOException of a java.io operation throws
3743 public final String
fileOpenBox(final String path
,
3744 final TFileOpenBox
.Type type
,
3745 final List
<String
> filters
) throws IOException
{
3747 TFileOpenBox box
= new TFileOpenBox(this, path
, type
, filters
);
3748 return box
.getFilename();
3752 * Convenience function to create a new window and make it active.
3753 * Window will be located at (0, 0).
3755 * @param title window title, will be centered along the top border
3756 * @param width width of window
3757 * @param height height of window
3758 * @return the new window
3760 public final TWindow
addWindow(final String title
, final int width
,
3763 TWindow window
= new TWindow(this, title
, 0, 0, width
, height
);
3768 * Convenience function to create a new window and make it active.
3769 * Window will be located at (0, 0).
3771 * @param title window title, will be centered along the top border
3772 * @param width width of window
3773 * @param height height of window
3774 * @param flags bitmask of RESIZABLE, CENTERED, or MODAL
3775 * @return the new window
3777 public final TWindow
addWindow(final String title
,
3778 final int width
, final int height
, final int flags
) {
3780 TWindow window
= new TWindow(this, title
, 0, 0, width
, height
, flags
);
3785 * Convenience function to create a new window and make it active.
3787 * @param title window title, will be centered along the top border
3788 * @param x column relative to parent
3789 * @param y row relative to parent
3790 * @param width width of window
3791 * @param height height of window
3792 * @return the new window
3794 public final TWindow
addWindow(final String title
,
3795 final int x
, final int y
, final int width
, final int height
) {
3797 TWindow window
= new TWindow(this, title
, x
, y
, width
, height
);
3802 * Convenience function to create a new window and make it active.
3804 * @param title window title, will be centered along the top border
3805 * @param x column relative to parent
3806 * @param y row relative to parent
3807 * @param width width of window
3808 * @param height height of window
3809 * @param flags mask of RESIZABLE, CENTERED, or MODAL
3810 * @return the new window
3812 public final TWindow
addWindow(final String title
,
3813 final int x
, final int y
, final int width
, final int height
,
3816 TWindow window
= new TWindow(this, title
, x
, y
, width
, height
, flags
);