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
.event
.TCommandEvent
;
52 import jexer
.event
.TInputEvent
;
53 import jexer
.event
.TKeypressEvent
;
54 import jexer
.event
.TMenuEvent
;
55 import jexer
.event
.TMouseEvent
;
56 import jexer
.event
.TResizeEvent
;
57 import jexer
.backend
.Backend
;
58 import jexer
.backend
.MultiBackend
;
59 import jexer
.backend
.Screen
;
60 import jexer
.backend
.SwingBackend
;
61 import jexer
.backend
.ECMA48Backend
;
62 import jexer
.backend
.TWindowBackend
;
63 import jexer
.menu
.TMenu
;
64 import jexer
.menu
.TMenuItem
;
65 import static jexer
.TCommand
.*;
66 import static jexer
.TKeypress
.*;
69 * TApplication is the main driver class for a full Text User Interface
70 * application. It manages windows, provides a menu bar and status bar, and
71 * processes events received from the user.
73 public class TApplication
implements Runnable
{
78 private static final ResourceBundle i18n
= ResourceBundle
.getBundle(TApplication
.class.getName());
80 // ------------------------------------------------------------------------
81 // Constants --------------------------------------------------------------
82 // ------------------------------------------------------------------------
85 * If true, emit thread stuff to System.err.
87 private static final boolean debugThreads
= false;
90 * If true, emit events being processed to System.err.
92 private static final boolean debugEvents
= false;
95 * If true, do "smart placement" on new windows that are not specified to
98 private static final boolean smartWindowPlacement
= true;
101 * Two backend types are available.
103 public static enum BackendType
{
110 * An ECMA48 / ANSI X3.64 / XTERM style terminal.
115 * Synonym for ECMA48.
120 // ------------------------------------------------------------------------
121 // Variables --------------------------------------------------------------
122 // ------------------------------------------------------------------------
125 * The primary event handler thread.
127 private volatile WidgetEventHandler primaryEventHandler
;
130 * The secondary event handler thread.
132 private volatile WidgetEventHandler secondaryEventHandler
;
135 * The widget receiving events from the secondary event handler thread.
137 private volatile TWidget secondaryEventReceiver
;
140 * Access to the physical screen, keyboard, and mouse.
142 private Backend backend
;
145 * Actual mouse coordinate X.
150 * Actual mouse coordinate Y.
155 * Old version of mouse coordinate X.
157 private int oldMouseX
;
160 * Old version mouse coordinate Y.
162 private int oldMouseY
;
165 * Old drawn version of mouse coordinate X.
167 private int oldDrawnMouseX
;
170 * Old drawn version mouse coordinate Y.
172 private int oldDrawnMouseY
;
175 * Old drawn version mouse cell.
177 private Cell oldDrawnMouseCell
= new Cell();
180 * The last mouse up click time, used to determine if this is a mouse
183 private long lastMouseUpTime
;
186 * The amount of millis between mouse up events to assume a double-click.
188 private long doubleClickTime
= 250;
191 * Event queue that is filled by run().
193 private List
<TInputEvent
> fillEventQueue
;
196 * Event queue that will be drained by either primary or secondary
199 private List
<TInputEvent
> drainEventQueue
;
202 * Top-level menus in this application.
204 private List
<TMenu
> menus
;
207 * Stack of activated sub-menus in this application.
209 private List
<TMenu
> subMenus
;
212 * The currently active menu.
214 private TMenu activeMenu
= null;
217 * Active keyboard accelerators.
219 private Map
<TKeypress
, TMenuItem
> accelerators
;
224 private List
<TMenuItem
> menuItems
;
227 * Windows and widgets pull colors from this ColorTheme.
229 private ColorTheme theme
;
232 * The top-level windows (but not menus).
234 private List
<TWindow
> windows
;
237 * The currently acive window.
239 private TWindow activeWindow
= null;
242 * Timers that are being ticked.
244 private List
<TTimer
> timers
;
247 * When true, the application has been started.
249 private volatile boolean started
= false;
252 * When true, exit the application.
254 private volatile boolean quit
= false;
257 * When true, repaint the entire screen.
259 private volatile boolean repaint
= true;
262 * Y coordinate of the top edge of the desktop. For now this is a
263 * constant. Someday it would be nice to have a multi-line menu or
266 private static final int desktopTop
= 1;
269 * Y coordinate of the bottom edge of the desktop.
271 private int desktopBottom
;
274 * An optional TDesktop background window that is drawn underneath
277 private TDesktop desktop
;
280 * If true, focus follows mouse: windows automatically raised if the
281 * mouse passes over them.
283 private boolean focusFollowsMouse
= false;
286 * The images that might be displayed. Note package private access.
288 private List
<TImage
> images
;
291 * The list of commands to run before the next I/O check.
293 private List
<Runnable
> invokeLaters
= new LinkedList
<Runnable
>();
296 * WidgetEventHandler is the main event consumer loop. There are at most
297 * two such threads in existence: the primary for normal case and a
298 * secondary that is used for TMessageBox, TInputBox, and similar.
300 private class WidgetEventHandler
implements Runnable
{
302 * The main application.
304 private TApplication application
;
307 * Whether or not this WidgetEventHandler is the primary or secondary
310 private boolean primary
= true;
313 * Public constructor.
315 * @param application the main application
316 * @param primary if true, this is the primary event handler thread
318 public WidgetEventHandler(final TApplication application
,
319 final boolean primary
) {
321 this.application
= application
;
322 this.primary
= primary
;
329 // Wrap everything in a try, so that if we go belly up we can let
330 // the user have their terminal back.
333 } catch (Throwable t
) {
334 this.application
.restoreConsole();
336 this.application
.exit();
343 private void runImpl() {
344 boolean first
= true;
347 while (!application
.quit
) {
349 // Wait until application notifies me
350 while (!application
.quit
) {
352 synchronized (application
.drainEventQueue
) {
353 if (application
.drainEventQueue
.size() > 0) {
362 timeout
= application
.getSleepTime(1000);
366 // A timer needs to fire, break out.
371 System
.err
.printf("%d %s %s %s sleep %d millis\n",
372 System
.currentTimeMillis(), this,
373 primary ?
"primary" : "secondary",
374 Thread
.currentThread(), timeout
);
377 synchronized (this) {
382 System
.err
.printf("%d %s %s %s AWAKE\n",
383 System
.currentTimeMillis(), this,
384 primary ?
"primary" : "secondary",
385 Thread
.currentThread());
389 && (application
.secondaryEventReceiver
== null)
391 // Secondary thread, emergency exit. If we got
392 // here then something went wrong with the
393 // handoff between yield() and closeWindow().
394 synchronized (application
.primaryEventHandler
) {
395 application
.primaryEventHandler
.notify();
397 application
.secondaryEventHandler
= null;
398 throw new RuntimeException("secondary exited " +
402 } catch (InterruptedException e
) {
405 } // while (!application.quit)
407 // Pull all events off the queue
409 TInputEvent event
= null;
410 synchronized (application
.drainEventQueue
) {
411 if (application
.drainEventQueue
.size() == 0) {
414 event
= application
.drainEventQueue
.remove(0);
417 // We will have an event to process, so repaint the
418 // screen at the end.
419 application
.repaint
= true;
422 primaryHandleEvent(event
);
424 secondaryHandleEvent(event
);
427 && (application
.secondaryEventReceiver
== null)
429 // Secondary thread, time to exit.
431 // Eliminate my reference so that wakeEventHandler()
432 // resumes working on the primary.
433 application
.secondaryEventHandler
= null;
435 // DO NOT UNLOCK. Primary thread just came back from
436 // primaryHandleEvent() and will unlock in the else
437 // block below. Just wake it up.
438 synchronized (application
.primaryEventHandler
) {
439 application
.primaryEventHandler
.notify();
448 // Fire timers, update screen.
450 application
.finishEventProcessing();
453 } // while (true) (main runnable loop)
457 // ------------------------------------------------------------------------
458 // Constructors -----------------------------------------------------------
459 // ------------------------------------------------------------------------
462 * Public constructor.
464 * @param backendType BackendType.XTERM, BackendType.ECMA48 or
466 * @param windowWidth the number of text columns to start with
467 * @param windowHeight the number of text rows to start with
468 * @param fontSize the size in points
469 * @throws UnsupportedEncodingException if an exception is thrown when
470 * creating the InputStreamReader
472 public TApplication(final BackendType backendType
, final int windowWidth
,
473 final int windowHeight
, final int fontSize
)
474 throws UnsupportedEncodingException
{
476 switch (backendType
) {
478 backend
= new SwingBackend(this, windowWidth
, windowHeight
,
484 backend
= new ECMA48Backend(this, null, null, windowWidth
,
485 windowHeight
, fontSize
);
488 throw new IllegalArgumentException("Invalid backend type: "
495 * Public constructor.
497 * @param backendType BackendType.XTERM, BackendType.ECMA48 or
499 * @throws UnsupportedEncodingException if an exception is thrown when
500 * creating the InputStreamReader
502 public TApplication(final BackendType backendType
)
503 throws UnsupportedEncodingException
{
505 switch (backendType
) {
507 // The default SwingBackend is 80x25, 20 pt font. If you want to
508 // change that, you can pass the extra arguments to the
509 // SwingBackend constructor here. For example, if you wanted
510 // 90x30, 16 pt font:
512 // backend = new SwingBackend(this, 90, 30, 16);
513 backend
= new SwingBackend(this);
518 backend
= new ECMA48Backend(this, null, null);
521 throw new IllegalArgumentException("Invalid backend type: "
528 * Public constructor. The backend type will be BackendType.ECMA48.
530 * @param input an InputStream connected to the remote user, or null for
531 * System.in. If System.in is used, then on non-Windows systems it will
532 * be put in raw mode; shutdown() will (blindly!) put System.in in cooked
533 * mode. input is always converted to a Reader with UTF-8 encoding.
534 * @param output an OutputStream connected to the remote user, or null
535 * for System.out. output is always converted to a Writer with UTF-8
537 * @throws UnsupportedEncodingException if an exception is thrown when
538 * creating the InputStreamReader
540 public TApplication(final InputStream input
,
541 final OutputStream output
) throws UnsupportedEncodingException
{
543 backend
= new ECMA48Backend(this, input
, output
);
548 * Public constructor. The backend type will be BackendType.ECMA48.
550 * @param input the InputStream underlying 'reader'. Its available()
551 * method is used to determine if reader.read() will block or not.
552 * @param reader a Reader connected to the remote user.
553 * @param writer a PrintWriter connected to the remote user.
554 * @param setRawMode if true, set System.in into raw mode with stty.
555 * This should in general not be used. It is here solely for Demo3,
556 * which uses System.in.
557 * @throws IllegalArgumentException if input, reader, or writer are null.
559 public TApplication(final InputStream input
, final Reader reader
,
560 final PrintWriter writer
, final boolean setRawMode
) {
562 backend
= new ECMA48Backend(this, input
, reader
, writer
, setRawMode
);
567 * Public constructor. The backend type will be BackendType.ECMA48.
569 * @param input the InputStream underlying 'reader'. Its available()
570 * method is used to determine if reader.read() will block or not.
571 * @param reader a Reader connected to the remote user.
572 * @param writer a PrintWriter connected to the remote user.
573 * @throws IllegalArgumentException if input, reader, or writer are null.
575 public TApplication(final InputStream input
, final Reader reader
,
576 final PrintWriter writer
) {
578 this(input
, reader
, writer
, false);
582 * Public constructor. This hook enables use with new non-Jexer
585 * @param backend a Backend that is already ready to go.
587 public TApplication(final Backend backend
) {
588 this.backend
= backend
;
589 backend
.setListener(this);
594 * Finish construction once the backend is set.
596 private void TApplicationImpl() {
597 theme
= new ColorTheme();
598 desktopBottom
= getScreen().getHeight() - 1;
599 fillEventQueue
= new LinkedList
<TInputEvent
>();
600 drainEventQueue
= new LinkedList
<TInputEvent
>();
601 windows
= new LinkedList
<TWindow
>();
602 menus
= new ArrayList
<TMenu
>();
603 subMenus
= new ArrayList
<TMenu
>();
604 timers
= new LinkedList
<TTimer
>();
605 accelerators
= new HashMap
<TKeypress
, TMenuItem
>();
606 menuItems
= new LinkedList
<TMenuItem
>();
607 desktop
= new TDesktop(this);
608 images
= new LinkedList
<TImage
>();
610 // Special case: the Swing backend needs to have a timer to drive its
612 if ((backend
instanceof SwingBackend
)
613 || (backend
instanceof MultiBackend
)
615 // Default to 500 millis, unless a SwingBackend has its own
618 if (backend
instanceof SwingBackend
) {
619 millis
= ((SwingBackend
) backend
).getBlinkMillis();
622 addTimer(millis
, true,
625 TApplication
.this.doRepaint();
633 // ------------------------------------------------------------------------
634 // Runnable ---------------------------------------------------------------
635 // ------------------------------------------------------------------------
638 * Run this application until it exits.
641 // Start the main consumer thread
642 primaryEventHandler
= new WidgetEventHandler(this, true);
643 (new Thread(primaryEventHandler
)).start();
648 synchronized (this) {
649 boolean doWait
= false;
651 if (!backend
.hasEvents()) {
652 synchronized (fillEventQueue
) {
653 if (fillEventQueue
.size() == 0) {
660 // No I/O to dispatch, so wait until the backend
664 System
.err
.println(System
.currentTimeMillis() +
665 " " + Thread
.currentThread() + " MAIN sleep");
671 System
.err
.println(System
.currentTimeMillis() +
672 " " + Thread
.currentThread() + " MAIN AWAKE");
674 } catch (InterruptedException e
) {
675 // I'm awake and don't care why, let's see what's
676 // going on out there.
680 } // synchronized (this)
682 synchronized (fillEventQueue
) {
683 // Pull any pending I/O events
684 backend
.getEvents(fillEventQueue
);
686 // Dispatch each event to the appropriate handler, one at a
689 TInputEvent event
= null;
690 if (fillEventQueue
.size() == 0) {
693 event
= fillEventQueue
.remove(0);
694 metaHandleEvent(event
);
698 // Wake a consumer thread if we have any pending events.
699 if (drainEventQueue
.size() > 0) {
705 // Shutdown the event consumer threads
706 if (secondaryEventHandler
!= null) {
707 synchronized (secondaryEventHandler
) {
708 secondaryEventHandler
.notify();
711 if (primaryEventHandler
!= null) {
712 synchronized (primaryEventHandler
) {
713 primaryEventHandler
.notify();
717 // Shutdown the user I/O thread(s)
720 // Close all the windows. This gives them an opportunity to release
726 // ------------------------------------------------------------------------
727 // Event handlers ---------------------------------------------------------
728 // ------------------------------------------------------------------------
731 * Method that TApplication subclasses can override to handle menu or
732 * posted command events.
734 * @param command command event
735 * @return if true, this event was consumed
737 protected boolean onCommand(final TCommandEvent command
) {
738 // Default: handle cmExit
739 if (command
.equals(cmExit
)) {
740 if (messageBox(i18n
.getString("exitDialogTitle"),
741 i18n
.getString("exitDialogText"),
742 TMessageBox
.Type
.YESNO
).isYes()) {
749 if (command
.equals(cmShell
)) {
750 openTerminal(0, 0, TWindow
.RESIZABLE
);
754 if (command
.equals(cmTile
)) {
758 if (command
.equals(cmCascade
)) {
762 if (command
.equals(cmCloseAll
)) {
767 if (command
.equals(cmMenu
)) {
768 if (!modalWindowActive() && (activeMenu
== null)) {
769 if (menus
.size() > 0) {
770 menus
.get(0).setActive(true);
771 activeMenu
= menus
.get(0);
781 * Method that TApplication subclasses can override to handle menu
784 * @param menu menu event
785 * @return if true, this event was consumed
787 protected boolean onMenu(final TMenuEvent menu
) {
789 // Default: handle MID_EXIT
790 if (menu
.getId() == TMenu
.MID_EXIT
) {
791 if (messageBox(i18n
.getString("exitDialogTitle"),
792 i18n
.getString("exitDialogText"),
793 TMessageBox
.Type
.YESNO
).isYes()) {
800 if (menu
.getId() == TMenu
.MID_SHELL
) {
801 openTerminal(0, 0, TWindow
.RESIZABLE
);
805 if (menu
.getId() == TMenu
.MID_TILE
) {
809 if (menu
.getId() == TMenu
.MID_CASCADE
) {
813 if (menu
.getId() == TMenu
.MID_CLOSE_ALL
) {
817 if (menu
.getId() == TMenu
.MID_ABOUT
) {
821 if (menu
.getId() == TMenu
.MID_REPAINT
) {
822 getScreen().clearPhysical();
826 if (menu
.getId() == TMenu
.MID_VIEW_IMAGE
) {
830 if (menu
.getId() == TMenu
.MID_CHANGE_FONT
) {
831 new TFontChooserWindow(this);
838 * Method that TApplication subclasses can override to handle keystrokes.
840 * @param keypress keystroke event
841 * @return if true, this event was consumed
843 protected boolean onKeypress(final TKeypressEvent keypress
) {
844 // Default: only menu shortcuts
846 // Process Alt-F, Alt-E, etc. menu shortcut keys
847 if (!keypress
.getKey().isFnKey()
848 && keypress
.getKey().isAlt()
849 && !keypress
.getKey().isCtrl()
850 && (activeMenu
== null)
851 && !modalWindowActive()
854 assert (subMenus
.size() == 0);
856 for (TMenu menu
: menus
) {
857 if (Character
.toLowerCase(menu
.getMnemonic().getShortcut())
858 == Character
.toLowerCase(keypress
.getKey().getChar())
861 menu
.setActive(true);
871 * Process background events, and update the screen.
873 private void finishEventProcessing() {
875 System
.err
.printf(System
.currentTimeMillis() + " " +
876 Thread
.currentThread() + " finishEventProcessing()\n");
879 // Process timers and call doIdle()'s
883 synchronized (getScreen()) {
888 System
.err
.printf(System
.currentTimeMillis() + " " +
889 Thread
.currentThread() + " finishEventProcessing() END\n");
894 * Peek at certain application-level events, add to eventQueue, and wake
895 * up the consuming Thread.
897 * @param event the input event to consume
899 private void metaHandleEvent(final TInputEvent event
) {
902 System
.err
.printf(String
.format("metaHandleEvents event: %s\n",
903 event
)); System
.err
.flush();
907 // Do no more processing if the application is already trying
912 // Special application-wide events -------------------------------
915 if (event
instanceof TCommandEvent
) {
916 TCommandEvent command
= (TCommandEvent
) event
;
917 if (command
.getCmd().equals(cmAbort
)) {
923 synchronized (drainEventQueue
) {
925 if (event
instanceof TResizeEvent
) {
926 TResizeEvent resize
= (TResizeEvent
) event
;
927 synchronized (getScreen()) {
928 getScreen().setDimensions(resize
.getWidth(),
930 desktopBottom
= getScreen().getHeight() - 1;
936 if (desktop
!= null) {
937 desktop
.setDimensions(0, 0, resize
.getWidth(),
938 resize
.getHeight() - 1);
941 // Change menu edges if needed.
944 // We are dirty, redraw the screen.
948 System.err.println("New screen: " + resize.getWidth() +
949 " x " + resize.getHeight());
954 // Put into the main queue
955 drainEventQueue
.add(event
);
960 * Dispatch one event to the appropriate widget or application-level
961 * event handler. This is the primary event handler, it has the normal
962 * application-wide event handling.
964 * @param event the input event to consume
965 * @see #secondaryHandleEvent(TInputEvent event)
967 private void primaryHandleEvent(final TInputEvent event
) {
970 System
.err
.printf("%s primaryHandleEvent: %s\n",
971 Thread
.currentThread(), event
);
973 TMouseEvent doubleClick
= null;
975 // Special application-wide events -----------------------------------
977 // Peek at the mouse position
978 if (event
instanceof TMouseEvent
) {
979 TMouseEvent mouse
= (TMouseEvent
) event
;
980 if ((mouseX
!= mouse
.getX()) || (mouseY
!= mouse
.getY())) {
983 mouseX
= mouse
.getX();
984 mouseY
= mouse
.getY();
986 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
987 && (!mouse
.isMouseWheelUp())
988 && (!mouse
.isMouseWheelDown())
990 if ((mouse
.getTime().getTime() - lastMouseUpTime
) <
993 // This is a double-click.
994 doubleClick
= new TMouseEvent(TMouseEvent
.Type
.
996 mouse
.getX(), mouse
.getY(),
997 mouse
.getAbsoluteX(), mouse
.getAbsoluteY(),
998 mouse
.isMouse1(), mouse
.isMouse2(),
1000 mouse
.isMouseWheelUp(), mouse
.isMouseWheelDown());
1003 // The first click of a potential double-click.
1004 lastMouseUpTime
= mouse
.getTime().getTime();
1009 // See if we need to switch focus to another window or the menu
1010 checkSwitchFocus((TMouseEvent
) event
);
1013 // Handle menu events
1014 if ((activeMenu
!= null) && !(event
instanceof TCommandEvent
)) {
1015 TMenu menu
= activeMenu
;
1017 if (event
instanceof TMouseEvent
) {
1018 TMouseEvent mouse
= (TMouseEvent
) event
;
1020 while (subMenus
.size() > 0) {
1021 TMenu subMenu
= subMenus
.get(subMenus
.size() - 1);
1022 if (subMenu
.mouseWouldHit(mouse
)) {
1025 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_MOTION
)
1026 && (!mouse
.isMouse1())
1027 && (!mouse
.isMouse2())
1028 && (!mouse
.isMouse3())
1029 && (!mouse
.isMouseWheelUp())
1030 && (!mouse
.isMouseWheelDown())
1034 // We navigated away from a sub-menu, so close it
1038 // Convert the mouse relative x/y to menu coordinates
1039 assert (mouse
.getX() == mouse
.getAbsoluteX());
1040 assert (mouse
.getY() == mouse
.getAbsoluteY());
1041 if (subMenus
.size() > 0) {
1042 menu
= subMenus
.get(subMenus
.size() - 1);
1044 mouse
.setX(mouse
.getX() - menu
.getX());
1045 mouse
.setY(mouse
.getY() - menu
.getY());
1047 menu
.handleEvent(event
);
1051 if (event
instanceof TKeypressEvent
) {
1052 TKeypressEvent keypress
= (TKeypressEvent
) event
;
1054 // See if this key matches an accelerator, and is not being
1055 // shortcutted by the active window, and if so dispatch the menu
1057 boolean windowWillShortcut
= false;
1058 if (activeWindow
!= null) {
1059 assert (activeWindow
.isShown());
1060 if (activeWindow
.isShortcutKeypress(keypress
.getKey())) {
1061 // We do not process this key, it will be passed to the
1063 windowWillShortcut
= true;
1067 if (!windowWillShortcut
&& !modalWindowActive()) {
1068 TKeypress keypressLowercase
= keypress
.getKey().toLowerCase();
1069 TMenuItem item
= null;
1070 synchronized (accelerators
) {
1071 item
= accelerators
.get(keypressLowercase
);
1074 if (item
.isEnabled()) {
1075 // Let the menu item dispatch
1081 // Handle the keypress
1082 if (onKeypress(keypress
)) {
1088 if (event
instanceof TCommandEvent
) {
1089 if (onCommand((TCommandEvent
) event
)) {
1094 if (event
instanceof TMenuEvent
) {
1095 if (onMenu((TMenuEvent
) event
)) {
1100 // Dispatch events to the active window -------------------------------
1101 boolean dispatchToDesktop
= true;
1102 TWindow window
= activeWindow
;
1103 if (window
!= null) {
1104 assert (window
.isActive());
1105 assert (window
.isShown());
1106 if (event
instanceof TMouseEvent
) {
1107 TMouseEvent mouse
= (TMouseEvent
) event
;
1108 // Convert the mouse relative x/y to window coordinates
1109 assert (mouse
.getX() == mouse
.getAbsoluteX());
1110 assert (mouse
.getY() == mouse
.getAbsoluteY());
1111 mouse
.setX(mouse
.getX() - window
.getX());
1112 mouse
.setY(mouse
.getY() - window
.getY());
1114 if (doubleClick
!= null) {
1115 doubleClick
.setX(doubleClick
.getX() - window
.getX());
1116 doubleClick
.setY(doubleClick
.getY() - window
.getY());
1119 if (window
.mouseWouldHit(mouse
)) {
1120 dispatchToDesktop
= false;
1122 } else if (event
instanceof TKeypressEvent
) {
1123 dispatchToDesktop
= false;
1127 System
.err
.printf("TApplication dispatch event: %s\n",
1130 window
.handleEvent(event
);
1131 if (doubleClick
!= null) {
1132 window
.handleEvent(doubleClick
);
1135 if (dispatchToDesktop
) {
1136 // This event is fair game for the desktop to process.
1137 if (desktop
!= null) {
1138 desktop
.handleEvent(event
);
1139 if (doubleClick
!= null) {
1140 desktop
.handleEvent(doubleClick
);
1147 * Dispatch one event to the appropriate widget or application-level
1148 * event handler. This is the secondary event handler used by certain
1149 * special dialogs (currently TMessageBox and TFileOpenBox).
1151 * @param event the input event to consume
1152 * @see #primaryHandleEvent(TInputEvent event)
1154 private void secondaryHandleEvent(final TInputEvent event
) {
1155 TMouseEvent doubleClick
= null;
1158 System
.err
.printf("%s secondaryHandleEvent: %s\n",
1159 Thread
.currentThread(), event
);
1162 // Peek at the mouse position
1163 if (event
instanceof TMouseEvent
) {
1164 TMouseEvent mouse
= (TMouseEvent
) event
;
1165 if ((mouseX
!= mouse
.getX()) || (mouseY
!= mouse
.getY())) {
1168 mouseX
= mouse
.getX();
1169 mouseY
= mouse
.getY();
1171 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
1172 && (!mouse
.isMouseWheelUp())
1173 && (!mouse
.isMouseWheelDown())
1175 if ((mouse
.getTime().getTime() - lastMouseUpTime
) <
1178 // This is a double-click.
1179 doubleClick
= new TMouseEvent(TMouseEvent
.Type
.
1181 mouse
.getX(), mouse
.getY(),
1182 mouse
.getAbsoluteX(), mouse
.getAbsoluteY(),
1183 mouse
.isMouse1(), mouse
.isMouse2(),
1185 mouse
.isMouseWheelUp(), mouse
.isMouseWheelDown());
1188 // The first click of a potential double-click.
1189 lastMouseUpTime
= mouse
.getTime().getTime();
1195 secondaryEventReceiver
.handleEvent(event
);
1196 // Note that it is possible for secondaryEventReceiver to be null
1197 // now, because its handleEvent() might have finished out on the
1198 // secondary thread. So put any extra processing inside a null
1200 if (secondaryEventReceiver
!= null) {
1201 if (doubleClick
!= null) {
1202 secondaryEventReceiver
.handleEvent(doubleClick
);
1208 * Enable a widget to override the primary event thread.
1210 * @param widget widget that will receive events
1212 public final void enableSecondaryEventReceiver(final TWidget widget
) {
1214 System
.err
.println(System
.currentTimeMillis() +
1215 " enableSecondaryEventReceiver()");
1218 assert (secondaryEventReceiver
== null);
1219 assert (secondaryEventHandler
== null);
1220 assert ((widget
instanceof TMessageBox
)
1221 || (widget
instanceof TFileOpenBox
));
1222 secondaryEventReceiver
= widget
;
1223 secondaryEventHandler
= new WidgetEventHandler(this, false);
1225 (new Thread(secondaryEventHandler
)).start();
1229 * Yield to the secondary thread.
1231 public final void yield() {
1233 System
.err
.printf(System
.currentTimeMillis() + " " +
1234 Thread
.currentThread() + " yield()\n");
1237 assert (secondaryEventReceiver
!= null);
1239 while (secondaryEventReceiver
!= null) {
1240 synchronized (primaryEventHandler
) {
1242 primaryEventHandler
.wait();
1243 } catch (InterruptedException e
) {
1251 * Do stuff when there is no user input.
1253 private void doIdle() {
1255 System
.err
.printf(System
.currentTimeMillis() + " " +
1256 Thread
.currentThread() + " doIdle()\n");
1259 synchronized (timers
) {
1262 System
.err
.printf(System
.currentTimeMillis() + " " +
1263 Thread
.currentThread() + " doIdle() 2\n");
1266 // Run any timers that have timed out
1267 Date now
= new Date();
1268 List
<TTimer
> keepTimers
= new LinkedList
<TTimer
>();
1269 for (TTimer timer
: timers
) {
1270 if (timer
.getNextTick().getTime() <= now
.getTime()) {
1271 // Something might change, so repaint the screen.
1274 if (timer
.recurring
) {
1275 keepTimers
.add(timer
);
1278 keepTimers
.add(timer
);
1282 timers
.addAll(keepTimers
);
1286 for (TWindow window
: windows
) {
1289 if (desktop
!= null) {
1293 // Run any invokeLaters
1294 synchronized (invokeLaters
) {
1295 for (Runnable invoke
: invokeLaters
) {
1298 invokeLaters
.clear();
1304 * Wake the sleeping active event handler.
1306 private void wakeEventHandler() {
1311 if (secondaryEventHandler
!= null) {
1312 synchronized (secondaryEventHandler
) {
1313 secondaryEventHandler
.notify();
1316 assert (primaryEventHandler
!= null);
1317 synchronized (primaryEventHandler
) {
1318 primaryEventHandler
.notify();
1323 // ------------------------------------------------------------------------
1324 // TApplication -----------------------------------------------------------
1325 // ------------------------------------------------------------------------
1328 * Place a command on the run queue, and run it before the next round of
1331 * @param command the command to run later
1333 public void invokeLater(final Runnable command
) {
1334 synchronized (invokeLaters
) {
1335 invokeLaters
.add(command
);
1341 * Restore the console to sane defaults. This is meant to be used for
1342 * improper exits (e.g. a caught exception in main()), and should not be
1343 * necessary for normal program termination.
1345 public void restoreConsole() {
1346 if (backend
!= null) {
1347 if (backend
instanceof ECMA48Backend
) {
1356 * @return the Backend
1358 public final Backend
getBackend() {
1365 * @return the Screen
1367 public final Screen
getScreen() {
1368 if (backend
instanceof TWindowBackend
) {
1369 // We are being rendered to a TWindow. We can't use its
1370 // getScreen() method because that is how it is rendering to a
1371 // hardware backend somewhere. Instead use its getOtherScreen()
1373 return ((TWindowBackend
) backend
).getOtherScreen();
1375 return backend
.getScreen();
1380 * Get the color theme.
1384 public final ColorTheme
getTheme() {
1389 * Repaint the screen on the next update.
1391 public void doRepaint() {
1397 * Get Y coordinate of the top edge of the desktop.
1399 * @return Y coordinate of the top edge of the desktop
1401 public final int getDesktopTop() {
1406 * Get Y coordinate of the bottom edge of the desktop.
1408 * @return Y coordinate of the bottom edge of the desktop
1410 public final int getDesktopBottom() {
1411 return desktopBottom
;
1415 * Set the TDesktop instance.
1417 * @param desktop a TDesktop instance, or null to remove the one that is
1420 public final void setDesktop(final TDesktop desktop
) {
1421 if (this.desktop
!= null) {
1422 this.desktop
.onClose();
1424 this.desktop
= desktop
;
1428 * Get the TDesktop instance.
1430 * @return the desktop, or null if it is not set
1432 public final TDesktop
getDesktop() {
1437 * Get the current active window.
1439 * @return the active window, or null if it is not set
1441 public final TWindow
getActiveWindow() {
1442 return activeWindow
;
1446 * Get a (shallow) copy of the window list.
1448 * @return a copy of the list of windows for this application
1450 public final List
<TWindow
> getAllWindows() {
1451 List
<TWindow
> result
= new ArrayList
<TWindow
>();
1452 result
.addAll(windows
);
1457 * Get focusFollowsMouse flag.
1459 * @return true if focus follows mouse: windows automatically raised if
1460 * the mouse passes over them
1462 public boolean getFocusFollowsMouse() {
1463 return focusFollowsMouse
;
1467 * Set focusFollowsMouse flag.
1469 * @param focusFollowsMouse if true, focus follows mouse: windows
1470 * automatically raised if the mouse passes over them
1472 public void setFocusFollowsMouse(final boolean focusFollowsMouse
) {
1473 this.focusFollowsMouse
= focusFollowsMouse
;
1477 * Display the about dialog.
1479 protected void showAboutDialog() {
1480 String version
= getClass().getPackage().getImplementationVersion();
1481 if (version
== null) {
1482 // This is Java 9+, use a hardcoded string here.
1485 messageBox(i18n
.getString("aboutDialogTitle"),
1486 MessageFormat
.format(i18n
.getString("aboutDialogText"), version
),
1487 TMessageBox
.Type
.OK
);
1491 * Handle the Tool | Open image menu item.
1493 private void openImage() {
1495 List
<String
> filters
= new ArrayList
<String
>();
1496 filters
.add("^.*\\.[Jj][Pp][Gg]$");
1497 filters
.add("^.*\\.[Jj][Pp][Ee][Gg]$");
1498 filters
.add("^.*\\.[Pp][Nn][Gg]$");
1499 filters
.add("^.*\\.[Gg][Ii][Ff]$");
1500 filters
.add("^.*\\.[Bb][Mm][Pp]$");
1501 String filename
= fileOpenBox(".", TFileOpenBox
.Type
.OPEN
, filters
);
1502 if (filename
!= null) {
1503 new TImageWindow(this, new File(filename
));
1505 } catch (IOException e
) {
1506 // Show this exception to the user.
1507 new TExceptionDialog(this, e
);
1511 // ------------------------------------------------------------------------
1512 // Screen refresh loop ----------------------------------------------------
1513 // ------------------------------------------------------------------------
1516 * Invert the cell color at a position. This is used to track the mouse.
1518 * @param x column position
1519 * @param y row position
1521 private void invertCell(final int x
, final int y
) {
1523 System
.err
.printf("%d %s invertCell() %d %d\n",
1524 System
.currentTimeMillis(), Thread
.currentThread(), x
, y
);
1526 if (activeWindow
!= null) {
1527 System
.err
.println("activeWindow.hasHiddenMouse() " +
1528 activeWindow
.hasHiddenMouse());
1532 // If this cell is on top of a visible window that has requested a
1533 // hidden mouse, bail out.
1534 if ((activeWindow
!= null) && (activeMenu
== null)) {
1535 if ((activeWindow
.hasHiddenMouse() == true)
1536 && (x
> activeWindow
.getX())
1537 && (x
< activeWindow
.getX() + activeWindow
.getWidth() - 1)
1538 && (y
> activeWindow
.getY())
1539 && (y
< activeWindow
.getY() + activeWindow
.getHeight() - 1)
1545 Cell cell
= getScreen().getCharXY(x
, y
);
1546 if (cell
.isImage()) {
1549 if (cell
.getForeColorRGB() < 0) {
1550 cell
.setForeColor(cell
.getForeColor().invert());
1552 cell
.setForeColorRGB(cell
.getForeColorRGB() ^
0x00ffffff);
1554 if (cell
.getBackColorRGB() < 0) {
1555 cell
.setBackColor(cell
.getBackColor().invert());
1557 cell
.setBackColorRGB(cell
.getBackColorRGB() ^
0x00ffffff);
1560 getScreen().putCharXY(x
, y
, cell
);
1566 private void drawAll() {
1567 boolean menuIsActive
= false;
1570 System
.err
.printf("%d %s drawAll() enter\n",
1571 System
.currentTimeMillis(), Thread
.currentThread());
1574 // I don't think this does anything useful anymore...
1577 System
.err
.printf("%d %s drawAll() !repaint\n",
1578 System
.currentTimeMillis(), Thread
.currentThread());
1580 if ((oldDrawnMouseX
!= mouseX
) || (oldDrawnMouseY
!= mouseY
)) {
1582 System
.err
.printf("%d %s drawAll() !repaint MOUSE\n",
1583 System
.currentTimeMillis(), Thread
.currentThread());
1586 // The only thing that has happened is the mouse moved.
1588 // Redraw the old cell at that position, and save the cell at
1589 // the new mouse position.
1591 System
.err
.printf("%d %s restoreImage() %d %d\n",
1592 System
.currentTimeMillis(), Thread
.currentThread(),
1593 oldDrawnMouseX
, oldDrawnMouseY
);
1595 oldDrawnMouseCell
.restoreImage();
1596 getScreen().putCharXY(oldDrawnMouseX
, oldDrawnMouseY
,
1598 oldDrawnMouseCell
= getScreen().getCharXY(mouseX
, mouseY
);
1599 if ((images
.size() > 0) && (backend
instanceof ECMA48Backend
)) {
1600 // Special case: the entire row containing the mouse has
1601 // to be re-drawn if it has any image data, AND any rows
1603 if (oldDrawnMouseY
!= mouseY
) {
1604 for (int i
= oldDrawnMouseY
; ;) {
1605 getScreen().unsetImageRow(i
);
1609 if (oldDrawnMouseY
< mouseY
) {
1616 getScreen().unsetImageRow(mouseY
);
1620 // Draw mouse at the new position.
1621 invertCell(mouseX
, mouseY
);
1623 oldDrawnMouseX
= mouseX
;
1624 oldDrawnMouseY
= mouseY
;
1626 if ((images
.size() > 0) || getScreen().isDirty()) {
1627 backend
.flushScreen();
1633 System
.err
.printf("%d %s drawAll() REDRAW\n",
1634 System
.currentTimeMillis(), Thread
.currentThread());
1637 // If true, the cursor is not visible
1638 boolean cursor
= false;
1640 // Start with a clean screen
1641 getScreen().clear();
1644 if (desktop
!= null) {
1645 desktop
.drawChildren();
1648 // Draw each window in reverse Z order
1649 List
<TWindow
> sorted
= new ArrayList
<TWindow
>(windows
);
1650 Collections
.sort(sorted
);
1651 TWindow topLevel
= null;
1652 if (sorted
.size() > 0) {
1653 topLevel
= sorted
.get(0);
1655 Collections
.reverse(sorted
);
1656 for (TWindow window
: sorted
) {
1657 if (window
.isShown()) {
1658 window
.drawChildren();
1662 // Draw the blank menubar line - reset the screen clipping first so
1663 // it won't trim it out.
1664 getScreen().resetClipping();
1665 getScreen().hLineXY(0, 0, getScreen().getWidth(), ' ',
1666 theme
.getColor("tmenu"));
1667 // Now draw the menus.
1669 for (TMenu menu
: menus
) {
1670 CellAttributes menuColor
;
1671 CellAttributes menuMnemonicColor
;
1672 if (menu
.isActive()) {
1673 menuIsActive
= true;
1674 menuColor
= theme
.getColor("tmenu.highlighted");
1675 menuMnemonicColor
= theme
.getColor("tmenu.mnemonic.highlighted");
1678 menuColor
= theme
.getColor("tmenu");
1679 menuMnemonicColor
= theme
.getColor("tmenu.mnemonic");
1681 // Draw the menu title
1682 getScreen().hLineXY(x
, 0, menu
.getTitle().length() + 2, ' ',
1684 getScreen().putStringXY(x
+ 1, 0, menu
.getTitle(), menuColor
);
1685 // Draw the highlight character
1686 getScreen().putCharXY(x
+ 1 + menu
.getMnemonic().getShortcutIdx(),
1687 0, menu
.getMnemonic().getShortcut(), menuMnemonicColor
);
1689 if (menu
.isActive()) {
1690 ((TWindow
) menu
).drawChildren();
1691 // Reset the screen clipping so we can draw the next title.
1692 getScreen().resetClipping();
1694 x
+= menu
.getTitle().length() + 2;
1697 for (TMenu menu
: subMenus
) {
1698 // Reset the screen clipping so we can draw the next sub-menu.
1699 getScreen().resetClipping();
1700 ((TWindow
) menu
).drawChildren();
1702 getScreen().resetClipping();
1704 // Draw the status bar of the top-level window
1705 TStatusBar statusBar
= null;
1706 if (topLevel
!= null) {
1707 statusBar
= topLevel
.getStatusBar();
1709 if (statusBar
!= null) {
1710 getScreen().resetClipping();
1711 statusBar
.setWidth(getScreen().getWidth());
1712 statusBar
.setY(getScreen().getHeight() - topLevel
.getY());
1715 CellAttributes barColor
= new CellAttributes();
1716 barColor
.setTo(getTheme().getColor("tstatusbar.text"));
1717 getScreen().hLineXY(0, desktopBottom
, getScreen().getWidth(), ' ',
1721 // Draw the mouse pointer
1723 System
.err
.printf("%d %s restoreImage() %d %d\n",
1724 System
.currentTimeMillis(), Thread
.currentThread(),
1725 oldDrawnMouseX
, oldDrawnMouseY
);
1727 oldDrawnMouseCell
= getScreen().getCharXY(mouseX
, mouseY
);
1728 if ((images
.size() > 0) && (backend
instanceof ECMA48Backend
)) {
1729 // Special case: the entire row containing the mouse has to be
1730 // re-drawn if it has any image data, AND any rows in between.
1731 if (oldDrawnMouseY
!= mouseY
) {
1732 for (int i
= oldDrawnMouseY
; ;) {
1733 getScreen().unsetImageRow(i
);
1737 if (oldDrawnMouseY
< mouseY
) {
1744 getScreen().unsetImageRow(mouseY
);
1747 invertCell(mouseX
, mouseY
);
1748 oldDrawnMouseX
= mouseX
;
1749 oldDrawnMouseY
= mouseY
;
1751 // Place the cursor if it is visible
1752 if (!menuIsActive
) {
1753 TWidget activeWidget
= null;
1754 if (sorted
.size() > 0) {
1755 activeWidget
= sorted
.get(sorted
.size() - 1).getActiveChild();
1756 if (activeWidget
.isCursorVisible()) {
1757 if ((activeWidget
.getCursorAbsoluteY() < desktopBottom
)
1758 && (activeWidget
.getCursorAbsoluteY() > desktopTop
)
1760 getScreen().putCursor(true,
1761 activeWidget
.getCursorAbsoluteX(),
1762 activeWidget
.getCursorAbsoluteY());
1765 // Turn off the cursor. Also place it at 0,0.
1766 getScreen().putCursor(false, 0, 0);
1775 getScreen().hideCursor();
1778 // Flush the screen contents
1779 if ((images
.size() > 0) || getScreen().isDirty()) {
1780 backend
.flushScreen();
1787 * Force this application to exit.
1789 public void exit() {
1791 synchronized (this) {
1796 // ------------------------------------------------------------------------
1797 // TWindow management -----------------------------------------------------
1798 // ------------------------------------------------------------------------
1801 * Return the total number of windows.
1803 * @return the total number of windows
1805 public final int windowCount() {
1806 return windows
.size();
1810 * Return the number of windows that are showing.
1812 * @return the number of windows that are showing on screen
1814 public final int shownWindowCount() {
1816 for (TWindow w
: windows
) {
1825 * Return the number of windows that are hidden.
1827 * @return the number of windows that are hidden
1829 public final int hiddenWindowCount() {
1831 for (TWindow w
: windows
) {
1840 * Check if a window instance is in this application's window list.
1842 * @param window window to look for
1843 * @return true if this window is in the list
1845 public final boolean hasWindow(final TWindow window
) {
1846 if (windows
.size() == 0) {
1849 for (TWindow w
: windows
) {
1851 assert (window
.getApplication() == this);
1859 * Activate a window: bring it to the top and have it receive events.
1861 * @param window the window to become the new active window
1863 public void activateWindow(final TWindow window
) {
1864 if (hasWindow(window
) == false) {
1866 * Someone has a handle to a window I don't have. Ignore this
1872 // Whatever window might be moving/dragging, stop it now.
1873 for (TWindow w
: windows
) {
1874 if (w
.inMovements()) {
1879 assert (windows
.size() > 0);
1881 if (window
.isHidden()) {
1882 // Unhiding will also activate.
1886 assert (window
.isShown());
1888 if (windows
.size() == 1) {
1889 assert (window
== windows
.get(0));
1890 if (activeWindow
== null) {
1891 activeWindow
= window
;
1893 activeWindow
.setActive(true);
1894 activeWindow
.onFocus();
1897 assert (window
.isActive());
1898 assert (activeWindow
== window
);
1902 if (activeWindow
== window
) {
1903 assert (window
.isActive());
1905 // Window is already active, do nothing.
1909 assert (!window
.isActive());
1910 if (activeWindow
!= null) {
1911 assert (activeWindow
.getZ() == 0);
1913 activeWindow
.setActive(false);
1915 // Increment every window Z that is on top of window
1916 for (TWindow w
: windows
) {
1920 if (w
.getZ() < window
.getZ()) {
1921 w
.setZ(w
.getZ() + 1);
1925 // Unset activeWindow now before unfocus, so that a window
1926 // lifecycle change inside onUnfocus() doesn't call
1927 // switchWindow() and lead to a stack overflow.
1928 TWindow oldActiveWindow
= activeWindow
;
1929 activeWindow
= null;
1930 oldActiveWindow
.onUnfocus();
1932 activeWindow
= window
;
1933 activeWindow
.setZ(0);
1934 activeWindow
.setActive(true);
1935 activeWindow
.onFocus();
1942 * @param window the window to hide
1944 public void hideWindow(final TWindow window
) {
1945 if (hasWindow(window
) == false) {
1947 * Someone has a handle to a window I don't have. Ignore this
1953 // Whatever window might be moving/dragging, stop it now.
1954 for (TWindow w
: windows
) {
1955 if (w
.inMovements()) {
1960 assert (windows
.size() > 0);
1962 if (!window
.hidden
) {
1963 if (window
== activeWindow
) {
1964 if (shownWindowCount() > 1) {
1967 activeWindow
= null;
1968 window
.setActive(false);
1972 window
.hidden
= true;
1980 * @param window the window to show
1982 public void showWindow(final TWindow window
) {
1983 if (hasWindow(window
) == false) {
1985 * Someone has a handle to a window I don't have. Ignore this
1991 // Whatever window might be moving/dragging, stop it now.
1992 for (TWindow w
: windows
) {
1993 if (w
.inMovements()) {
1998 assert (windows
.size() > 0);
2000 if (window
.hidden
) {
2001 window
.hidden
= false;
2003 activateWindow(window
);
2008 * Close window. Note that the window's destructor is NOT called by this
2009 * method, instead the GC is assumed to do the cleanup.
2011 * @param window the window to remove
2013 public final void closeWindow(final TWindow window
) {
2014 if (hasWindow(window
) == false) {
2016 * Someone has a handle to a window I don't have. Ignore this
2022 // Let window know that it is about to be closed, while it is still
2023 // visible on screen.
2024 window
.onPreClose();
2026 synchronized (windows
) {
2027 // Whatever window might be moving/dragging, stop it now.
2028 for (TWindow w
: windows
) {
2029 if (w
.inMovements()) {
2034 int z
= window
.getZ();
2037 windows
.remove(window
);
2038 Collections
.sort(windows
);
2039 activeWindow
= null;
2041 boolean foundNextWindow
= false;
2043 for (TWindow w
: windows
) {
2047 // Do not activate a hidden window.
2052 if (foundNextWindow
== false) {
2053 foundNextWindow
= true;
2056 assert (activeWindow
== null);
2068 // Perform window cleanup
2071 // Check if we are closing a TMessageBox or similar
2072 if (secondaryEventReceiver
!= null) {
2073 assert (secondaryEventHandler
!= null);
2075 // Do not send events to the secondaryEventReceiver anymore, the
2076 // window is closed.
2077 secondaryEventReceiver
= null;
2079 // Wake the secondary thread, it will wake the primary as it
2081 synchronized (secondaryEventHandler
) {
2082 secondaryEventHandler
.notify();
2086 // Permit desktop to be active if it is the only thing left.
2087 if (desktop
!= null) {
2088 if (windows
.size() == 0) {
2089 desktop
.setActive(true);
2095 * Switch to the next window.
2097 * @param forward if true, then switch to the next window in the list,
2098 * otherwise switch to the previous window in the list
2100 public final void switchWindow(final boolean forward
) {
2101 // Only switch if there are multiple visible windows
2102 if (shownWindowCount() < 2) {
2105 assert (activeWindow
!= null);
2107 synchronized (windows
) {
2108 // Whatever window might be moving/dragging, stop it now.
2109 for (TWindow w
: windows
) {
2110 if (w
.inMovements()) {
2115 // Swap z/active between active window and the next in the list
2116 int activeWindowI
= -1;
2117 for (int i
= 0; i
< windows
.size(); i
++) {
2118 if (windows
.get(i
) == activeWindow
) {
2119 assert (activeWindow
.isActive());
2123 assert (!windows
.get(0).isActive());
2126 assert (activeWindowI
>= 0);
2128 // Do not switch if a window is modal
2129 if (activeWindow
.isModal()) {
2133 int nextWindowI
= activeWindowI
;
2137 nextWindowI
%= windows
.size();
2140 if (nextWindowI
< 0) {
2141 nextWindowI
= windows
.size() - 1;
2145 if (windows
.get(nextWindowI
).isShown()) {
2146 activateWindow(windows
.get(nextWindowI
));
2150 } // synchronized (windows)
2155 * Add a window to my window list and make it active. Note package
2158 * @param window new window to add
2160 final void addWindowToApplication(final TWindow window
) {
2162 // Do not add menu windows to the window list.
2163 if (window
instanceof TMenu
) {
2167 // Do not add the desktop to the window list.
2168 if (window
instanceof TDesktop
) {
2172 synchronized (windows
) {
2173 if (windows
.contains(window
)) {
2174 throw new IllegalArgumentException("Window " + window
+
2175 " is already in window list");
2178 // Whatever window might be moving/dragging, stop it now.
2179 for (TWindow w
: windows
) {
2180 if (w
.inMovements()) {
2185 // Do not allow a modal window to spawn a non-modal window. If a
2186 // modal window is active, then this window will become modal
2188 if (modalWindowActive()) {
2189 window
.flags
|= TWindow
.MODAL
;
2190 window
.flags
|= TWindow
.CENTERED
;
2191 window
.hidden
= false;
2193 if (window
.isShown()) {
2194 for (TWindow w
: windows
) {
2199 w
.setZ(w
.getZ() + 1);
2202 windows
.add(window
);
2203 if (window
.isShown()) {
2204 activeWindow
= window
;
2205 activeWindow
.setZ(0);
2206 activeWindow
.setActive(true);
2207 activeWindow
.onFocus();
2210 if (((window
.flags
& TWindow
.CENTERED
) == 0)
2211 && ((window
.flags
& TWindow
.ABSOLUTEXY
) == 0)
2212 && (smartWindowPlacement
== true)
2215 doSmartPlacement(window
);
2219 // Desktop cannot be active over any other window.
2220 if (desktop
!= null) {
2221 desktop
.setActive(false);
2226 * Check if there is a system-modal window on top.
2228 * @return true if the active window is modal
2230 private boolean modalWindowActive() {
2231 if (windows
.size() == 0) {
2235 for (TWindow w
: windows
) {
2245 * Close all open windows.
2247 private void closeAllWindows() {
2248 // Don't do anything if we are in the menu
2249 if (activeMenu
!= null) {
2252 while (windows
.size() > 0) {
2253 closeWindow(windows
.get(0));
2258 * Re-layout the open windows as non-overlapping tiles. This produces
2259 * almost the same results as Turbo Pascal 7.0's IDE.
2261 private void tileWindows() {
2262 synchronized (windows
) {
2263 // Don't do anything if we are in the menu
2264 if (activeMenu
!= null) {
2267 int z
= windows
.size();
2273 a
= (int)(Math
.sqrt(z
));
2277 if (((a
* b
) + c
) == z
) {
2285 int newWidth
= (getScreen().getWidth() / a
);
2286 int newHeight1
= ((getScreen().getHeight() - 1) / b
);
2287 int newHeight2
= ((getScreen().getHeight() - 1) / (b
+ c
));
2289 List
<TWindow
> sorted
= new ArrayList
<TWindow
>(windows
);
2290 Collections
.sort(sorted
);
2291 Collections
.reverse(sorted
);
2292 for (int i
= 0; i
< sorted
.size(); i
++) {
2293 int logicalX
= i
/ b
;
2294 int logicalY
= i
% b
;
2295 if (i
>= ((a
- 1) * b
)) {
2297 logicalY
= i
- ((a
- 1) * b
);
2300 TWindow w
= sorted
.get(i
);
2301 int oldWidth
= w
.getWidth();
2302 int oldHeight
= w
.getHeight();
2304 w
.setX(logicalX
* newWidth
);
2305 w
.setWidth(newWidth
);
2306 if (i
>= ((a
- 1) * b
)) {
2307 w
.setY((logicalY
* newHeight2
) + 1);
2308 w
.setHeight(newHeight2
);
2310 w
.setY((logicalY
* newHeight1
) + 1);
2311 w
.setHeight(newHeight1
);
2313 if ((w
.getWidth() != oldWidth
)
2314 || (w
.getHeight() != oldHeight
)
2316 w
.onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
,
2317 w
.getWidth(), w
.getHeight()));
2324 * Re-layout the open windows as overlapping cascaded windows.
2326 private void cascadeWindows() {
2327 synchronized (windows
) {
2328 // Don't do anything if we are in the menu
2329 if (activeMenu
!= null) {
2334 List
<TWindow
> sorted
= new ArrayList
<TWindow
>(windows
);
2335 Collections
.sort(sorted
);
2336 Collections
.reverse(sorted
);
2337 for (TWindow window
: sorted
) {
2342 if (x
> getScreen().getWidth()) {
2345 if (y
>= getScreen().getHeight()) {
2353 * Place a window to minimize its overlap with other windows.
2355 * @param window the window to place
2357 public final void doSmartPlacement(final TWindow window
) {
2358 // This is a pretty dumb algorithm, but seems to work. The hardest
2359 // part is computing these "overlap" values seeking a minimum average
2362 int yMin
= desktopTop
;
2363 int xMax
= getScreen().getWidth() - window
.getWidth() + 1;
2364 int yMax
= desktopBottom
- window
.getHeight() + 1;
2372 if ((xMin
== xMax
) && (yMin
== yMax
)) {
2373 // No work to do, bail out.
2377 // Compute the overlap matrix without the new window.
2378 int width
= getScreen().getWidth();
2379 int height
= getScreen().getHeight();
2380 int overlapMatrix
[][] = new int[width
][height
];
2381 for (TWindow w
: windows
) {
2385 for (int x
= w
.getX(); x
< w
.getX() + w
.getWidth(); x
++) {
2392 for (int y
= w
.getY(); y
< w
.getY() + w
.getHeight(); y
++) {
2399 overlapMatrix
[x
][y
]++;
2404 long oldOverlapTotal
= 0;
2405 long oldOverlapN
= 0;
2406 for (int x
= 0; x
< width
; x
++) {
2407 for (int y
= 0; y
< height
; y
++) {
2408 oldOverlapTotal
+= overlapMatrix
[x
][y
];
2409 if (overlapMatrix
[x
][y
] > 0) {
2416 double oldOverlapAvg
= (double) oldOverlapTotal
/ (double) oldOverlapN
;
2417 boolean first
= true;
2418 int windowX
= window
.getX();
2419 int windowY
= window
.getY();
2421 // For each possible (x, y) position for the new window, compute a
2422 // new overlap matrix.
2423 for (int x
= xMin
; x
< xMax
; x
++) {
2424 for (int y
= yMin
; y
< yMax
; y
++) {
2426 // Start with the matrix minus this window.
2427 int newMatrix
[][] = new int[width
][height
];
2428 for (int mx
= 0; mx
< width
; mx
++) {
2429 for (int my
= 0; my
< height
; my
++) {
2430 newMatrix
[mx
][my
] = overlapMatrix
[mx
][my
];
2434 // Add this window's values to the new overlap matrix.
2435 long newOverlapTotal
= 0;
2436 long newOverlapN
= 0;
2437 // Start by adding each new cell.
2438 for (int wx
= x
; wx
< x
+ window
.getWidth(); wx
++) {
2442 for (int wy
= y
; wy
< y
+ window
.getHeight(); wy
++) {
2446 newMatrix
[wx
][wy
]++;
2449 // Now figure out the new value for total coverage.
2450 for (int mx
= 0; mx
< width
; mx
++) {
2451 for (int my
= 0; my
< height
; my
++) {
2452 newOverlapTotal
+= newMatrix
[x
][y
];
2453 if (newMatrix
[mx
][my
] > 0) {
2458 double newOverlapAvg
= (double) newOverlapTotal
/ (double) newOverlapN
;
2461 // First time: just record what we got.
2462 oldOverlapAvg
= newOverlapAvg
;
2465 // All other times: pick a new best (x, y) and save the
2467 if (newOverlapAvg
< oldOverlapAvg
) {
2470 oldOverlapAvg
= newOverlapAvg
;
2474 } // for (int x = xMin; x < xMax; x++)
2476 } // for (int y = yMin; y < yMax; y++)
2478 // Finally, set the window's new coordinates.
2479 window
.setX(windowX
);
2480 window
.setY(windowY
);
2483 // ------------------------------------------------------------------------
2484 // TImage management ------------------------------------------------------
2485 // ------------------------------------------------------------------------
2488 * Add an image to the list. Note package private access.
2490 * @param image the image to add
2491 * @throws IllegalArgumentException if the image is already used in
2492 * another TApplication
2494 final void addImage(final TImage image
) {
2495 if ((image
.getApplication() != null)
2496 && (image
.getApplication() != this)
2498 throw new IllegalArgumentException("Image " + image
+
2499 " is already " + "part of application " +
2500 image
.getApplication());
2506 * Remove an image from the list. Note package private access.
2508 * @param image the image to remove
2509 * @throws IllegalArgumentException if the image is already used in
2510 * another TApplication
2512 final void removeImage(final TImage image
) {
2513 if ((image
.getApplication() != null)
2514 && (image
.getApplication() != this)
2516 throw new IllegalArgumentException("Image " + image
+
2517 " is already " + "part of application " +
2518 image
.getApplication());
2520 images
.remove(image
);
2523 // ------------------------------------------------------------------------
2524 // TMenu management -------------------------------------------------------
2525 // ------------------------------------------------------------------------
2528 * Check if a mouse event would hit either the active menu or any open
2531 * @param mouse mouse event
2532 * @return true if the mouse would hit the active menu or an open
2535 private boolean mouseOnMenu(final TMouseEvent mouse
) {
2536 assert (activeMenu
!= null);
2537 List
<TMenu
> menus
= new ArrayList
<TMenu
>(subMenus
);
2538 Collections
.reverse(menus
);
2539 for (TMenu menu
: menus
) {
2540 if (menu
.mouseWouldHit(mouse
)) {
2544 return activeMenu
.mouseWouldHit(mouse
);
2548 * See if we need to switch window or activate the menu based on
2551 * @param mouse mouse event
2553 private void checkSwitchFocus(final TMouseEvent mouse
) {
2555 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
2556 && (activeMenu
!= null)
2557 && (mouse
.getAbsoluteY() != 0)
2558 && (!mouseOnMenu(mouse
))
2560 // They clicked outside the active menu, turn it off
2561 activeMenu
.setActive(false);
2563 for (TMenu menu
: subMenus
) {
2564 menu
.setActive(false);
2570 // See if they hit the menu bar
2571 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
2572 && (mouse
.isMouse1())
2573 && (!modalWindowActive())
2574 && (mouse
.getAbsoluteY() == 0)
2577 for (TMenu menu
: subMenus
) {
2578 menu
.setActive(false);
2582 // They selected the menu, go activate it
2583 for (TMenu menu
: menus
) {
2584 if ((mouse
.getAbsoluteX() >= menu
.getTitleX())
2585 && (mouse
.getAbsoluteX() < menu
.getTitleX()
2586 + menu
.getTitle().length() + 2)
2588 menu
.setActive(true);
2591 menu
.setActive(false);
2597 // See if they hit the menu bar
2598 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_MOTION
)
2599 && (mouse
.isMouse1())
2600 && (activeMenu
!= null)
2601 && (mouse
.getAbsoluteY() == 0)
2604 TMenu oldMenu
= activeMenu
;
2605 for (TMenu menu
: subMenus
) {
2606 menu
.setActive(false);
2610 // See if we should switch menus
2611 for (TMenu menu
: menus
) {
2612 if ((mouse
.getAbsoluteX() >= menu
.getTitleX())
2613 && (mouse
.getAbsoluteX() < menu
.getTitleX()
2614 + menu
.getTitle().length() + 2)
2616 menu
.setActive(true);
2620 if (oldMenu
!= activeMenu
) {
2621 // They switched menus
2622 oldMenu
.setActive(false);
2627 // If a menu is still active, don't switch windows
2628 if (activeMenu
!= null) {
2632 // Only switch if there are multiple windows
2633 if (windows
.size() < 2) {
2637 if (((focusFollowsMouse
== true)
2638 && (mouse
.getType() == TMouseEvent
.Type
.MOUSE_MOTION
))
2639 || (mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
2641 synchronized (windows
) {
2642 Collections
.sort(windows
);
2643 if (windows
.get(0).isModal()) {
2644 // Modal windows don't switch
2648 for (TWindow window
: windows
) {
2649 assert (!window
.isModal());
2651 if (window
.isHidden()) {
2652 assert (!window
.isActive());
2656 if (window
.mouseWouldHit(mouse
)) {
2657 if (window
== windows
.get(0)) {
2658 // Clicked on the same window, nothing to do
2659 assert (window
.isActive());
2663 // We will be switching to another window
2664 assert (windows
.get(0).isActive());
2665 assert (windows
.get(0) == activeWindow
);
2666 assert (!window
.isActive());
2667 if (activeWindow
!= null) {
2668 activeWindow
.onUnfocus();
2669 activeWindow
.setActive(false);
2670 activeWindow
.setZ(window
.getZ());
2672 activeWindow
= window
;
2674 window
.setActive(true);
2681 // Clicked on the background, nothing to do
2685 // Nothing to do: this isn't a mouse up, or focus isn't following
2691 * Turn off the menu.
2693 public final void closeMenu() {
2694 if (activeMenu
!= null) {
2695 activeMenu
.setActive(false);
2697 for (TMenu menu
: subMenus
) {
2698 menu
.setActive(false);
2705 * Get a (shallow) copy of the menu list.
2707 * @return a copy of the menu list
2709 public final List
<TMenu
> getAllMenus() {
2710 return new ArrayList
<TMenu
>(menus
);
2714 * Add a top-level menu to the list.
2716 * @param menu the menu to add
2717 * @throws IllegalArgumentException if the menu is already used in
2718 * another TApplication
2720 public final void addMenu(final TMenu menu
) {
2721 if ((menu
.getApplication() != null)
2722 && (menu
.getApplication() != this)
2724 throw new IllegalArgumentException("Menu " + menu
+ " is already " +
2725 "part of application " + menu
.getApplication());
2733 * Remove a top-level menu from the list.
2735 * @param menu the menu to remove
2736 * @throws IllegalArgumentException if the menu is already used in
2737 * another TApplication
2739 public final void removeMenu(final TMenu menu
) {
2740 if ((menu
.getApplication() != null)
2741 && (menu
.getApplication() != this)
2743 throw new IllegalArgumentException("Menu " + menu
+ " is already " +
2744 "part of application " + menu
.getApplication());
2752 * Turn off a sub-menu.
2754 public final void closeSubMenu() {
2755 assert (activeMenu
!= null);
2756 TMenu item
= subMenus
.get(subMenus
.size() - 1);
2757 assert (item
!= null);
2758 item
.setActive(false);
2759 subMenus
.remove(subMenus
.size() - 1);
2763 * Switch to the next menu.
2765 * @param forward if true, then switch to the next menu in the list,
2766 * otherwise switch to the previous menu in the list
2768 public final void switchMenu(final boolean forward
) {
2769 assert (activeMenu
!= null);
2771 for (TMenu menu
: subMenus
) {
2772 menu
.setActive(false);
2776 for (int i
= 0; i
< menus
.size(); i
++) {
2777 if (activeMenu
== menus
.get(i
)) {
2779 if (i
< menus
.size() - 1) {
2788 i
= menus
.size() - 1;
2791 activeMenu
.setActive(false);
2792 activeMenu
= menus
.get(i
);
2793 activeMenu
.setActive(true);
2800 * Add a menu item to the global list. If it has a keyboard accelerator,
2801 * that will be added the global hash.
2803 * @param item the menu item
2805 public final void addMenuItem(final TMenuItem item
) {
2806 menuItems
.add(item
);
2808 TKeypress key
= item
.getKey();
2810 synchronized (accelerators
) {
2811 assert (accelerators
.get(key
) == null);
2812 accelerators
.put(key
.toLowerCase(), item
);
2818 * Disable one menu item.
2820 * @param id the menu item ID
2822 public final void disableMenuItem(final int id
) {
2823 for (TMenuItem item
: menuItems
) {
2824 if (item
.getId() == id
) {
2825 item
.setEnabled(false);
2831 * Disable the range of menu items with ID's between lower and upper,
2834 * @param lower the lowest menu item ID
2835 * @param upper the highest menu item ID
2837 public final void disableMenuItems(final int lower
, final int upper
) {
2838 for (TMenuItem item
: menuItems
) {
2839 if ((item
.getId() >= lower
) && (item
.getId() <= upper
)) {
2840 item
.setEnabled(false);
2841 item
.getParent().activate(0);
2847 * Enable one menu item.
2849 * @param id the menu item ID
2851 public final void enableMenuItem(final int id
) {
2852 for (TMenuItem item
: menuItems
) {
2853 if (item
.getId() == id
) {
2854 item
.setEnabled(true);
2855 item
.getParent().activate(0);
2861 * Enable the range of menu items with ID's between lower and upper,
2864 * @param lower the lowest menu item ID
2865 * @param upper the highest menu item ID
2867 public final void enableMenuItems(final int lower
, final int upper
) {
2868 for (TMenuItem item
: menuItems
) {
2869 if ((item
.getId() >= lower
) && (item
.getId() <= upper
)) {
2870 item
.setEnabled(true);
2871 item
.getParent().activate(0);
2877 * Recompute menu x positions based on their title length.
2879 public final void recomputeMenuX() {
2881 for (TMenu menu
: menus
) {
2884 x
+= menu
.getTitle().length() + 2;
2886 // Don't let the menu window exceed the screen width
2887 int rightEdge
= menu
.getX() + menu
.getWidth();
2888 if (rightEdge
> getScreen().getWidth()) {
2889 menu
.setX(getScreen().getWidth() - menu
.getWidth());
2895 * Post an event to process.
2897 * @param event new event to add to the queue
2899 public final void postEvent(final TInputEvent event
) {
2900 synchronized (this) {
2901 synchronized (fillEventQueue
) {
2902 fillEventQueue
.add(event
);
2905 System
.err
.println(System
.currentTimeMillis() + " " +
2906 Thread
.currentThread() + " postEvent() wake up main");
2913 * Post an event to process and turn off the menu.
2915 * @param event new event to add to the queue
2917 public final void postMenuEvent(final TInputEvent event
) {
2918 synchronized (this) {
2919 synchronized (fillEventQueue
) {
2920 fillEventQueue
.add(event
);
2923 System
.err
.println(System
.currentTimeMillis() + " " +
2924 Thread
.currentThread() + " postMenuEvent() wake up main");
2932 * Add a sub-menu to the list of open sub-menus.
2934 * @param menu sub-menu
2936 public final void addSubMenu(final TMenu menu
) {
2941 * Convenience function to add a top-level menu.
2943 * @param title menu title
2944 * @return the new menu
2946 public final TMenu
addMenu(final String title
) {
2949 TMenu menu
= new TMenu(this, x
, y
, title
);
2956 * Convenience function to add a default tools (hamburger) menu.
2958 * @return the new menu
2960 public final TMenu
addToolMenu() {
2961 TMenu toolMenu
= addMenu(i18n
.getString("toolMenuTitle"));
2962 toolMenu
.addDefaultItem(TMenu
.MID_REPAINT
);
2963 toolMenu
.addDefaultItem(TMenu
.MID_VIEW_IMAGE
);
2964 toolMenu
.addDefaultItem(TMenu
.MID_CHANGE_FONT
);
2965 TStatusBar toolStatusBar
= toolMenu
.newStatusBar(i18n
.
2966 getString("toolMenuStatus"));
2967 toolStatusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
2972 * Convenience function to add a default "File" menu.
2974 * @return the new menu
2976 public final TMenu
addFileMenu() {
2977 TMenu fileMenu
= addMenu(i18n
.getString("fileMenuTitle"));
2978 fileMenu
.addDefaultItem(TMenu
.MID_OPEN_FILE
);
2979 fileMenu
.addSeparator();
2980 fileMenu
.addDefaultItem(TMenu
.MID_SHELL
);
2981 fileMenu
.addDefaultItem(TMenu
.MID_EXIT
);
2982 TStatusBar statusBar
= fileMenu
.newStatusBar(i18n
.
2983 getString("fileMenuStatus"));
2984 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
2989 * Convenience function to add a default "Edit" menu.
2991 * @return the new menu
2993 public final TMenu
addEditMenu() {
2994 TMenu editMenu
= addMenu(i18n
.getString("editMenuTitle"));
2995 editMenu
.addDefaultItem(TMenu
.MID_CUT
);
2996 editMenu
.addDefaultItem(TMenu
.MID_COPY
);
2997 editMenu
.addDefaultItem(TMenu
.MID_PASTE
);
2998 editMenu
.addDefaultItem(TMenu
.MID_CLEAR
);
2999 TStatusBar statusBar
= editMenu
.newStatusBar(i18n
.
3000 getString("editMenuStatus"));
3001 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
3006 * Convenience function to add a default "Window" menu.
3008 * @return the new menu
3010 public final TMenu
addWindowMenu() {
3011 TMenu windowMenu
= addMenu(i18n
.getString("windowMenuTitle"));
3012 windowMenu
.addDefaultItem(TMenu
.MID_TILE
);
3013 windowMenu
.addDefaultItem(TMenu
.MID_CASCADE
);
3014 windowMenu
.addDefaultItem(TMenu
.MID_CLOSE_ALL
);
3015 windowMenu
.addSeparator();
3016 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_MOVE
);
3017 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_ZOOM
);
3018 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_NEXT
);
3019 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_PREVIOUS
);
3020 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_CLOSE
);
3021 TStatusBar statusBar
= windowMenu
.newStatusBar(i18n
.
3022 getString("windowMenuStatus"));
3023 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
3028 * Convenience function to add a default "Help" menu.
3030 * @return the new menu
3032 public final TMenu
addHelpMenu() {
3033 TMenu helpMenu
= addMenu(i18n
.getString("helpMenuTitle"));
3034 helpMenu
.addDefaultItem(TMenu
.MID_HELP_CONTENTS
);
3035 helpMenu
.addDefaultItem(TMenu
.MID_HELP_INDEX
);
3036 helpMenu
.addDefaultItem(TMenu
.MID_HELP_SEARCH
);
3037 helpMenu
.addDefaultItem(TMenu
.MID_HELP_PREVIOUS
);
3038 helpMenu
.addDefaultItem(TMenu
.MID_HELP_HELP
);
3039 helpMenu
.addDefaultItem(TMenu
.MID_HELP_ACTIVE_FILE
);
3040 helpMenu
.addSeparator();
3041 helpMenu
.addDefaultItem(TMenu
.MID_ABOUT
);
3042 TStatusBar statusBar
= helpMenu
.newStatusBar(i18n
.
3043 getString("helpMenuStatus"));
3044 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
3048 // ------------------------------------------------------------------------
3049 // TTimer management ------------------------------------------------------
3050 // ------------------------------------------------------------------------
3053 * Get the amount of time I can sleep before missing a Timer tick.
3055 * @param timeout = initial (maximum) timeout in millis
3056 * @return number of milliseconds between now and the next timer event
3058 private long getSleepTime(final long timeout
) {
3059 Date now
= new Date();
3060 long nowTime
= now
.getTime();
3061 long sleepTime
= timeout
;
3063 synchronized (timers
) {
3064 for (TTimer timer
: timers
) {
3065 long nextTickTime
= timer
.getNextTick().getTime();
3066 if (nextTickTime
< nowTime
) {
3070 long timeDifference
= nextTickTime
- nowTime
;
3071 if (timeDifference
< sleepTime
) {
3072 sleepTime
= timeDifference
;
3077 assert (sleepTime
>= 0);
3078 assert (sleepTime
<= timeout
);
3083 * Convenience function to add a timer.
3085 * @param duration number of milliseconds to wait between ticks
3086 * @param recurring if true, re-schedule this timer after every tick
3087 * @param action function to call when button is pressed
3090 public final TTimer
addTimer(final long duration
, final boolean recurring
,
3091 final TAction action
) {
3093 TTimer timer
= new TTimer(duration
, recurring
, action
);
3094 synchronized (timers
) {
3101 * Convenience function to remove a timer.
3103 * @param timer timer to remove
3105 public final void removeTimer(final TTimer timer
) {
3106 synchronized (timers
) {
3107 timers
.remove(timer
);
3111 // ------------------------------------------------------------------------
3112 // Other TWindow constructors ---------------------------------------------
3113 // ------------------------------------------------------------------------
3116 * Convenience function to spawn a message box.
3118 * @param title window title, will be centered along the top border
3119 * @param caption message to display. Use embedded newlines to get a
3121 * @return the new message box
3123 public final TMessageBox
messageBox(final String title
,
3124 final String caption
) {
3126 return new TMessageBox(this, title
, caption
, TMessageBox
.Type
.OK
);
3130 * Convenience function to spawn a message box.
3132 * @param title window title, will be centered along the top border
3133 * @param caption message to display. Use embedded newlines to get a
3135 * @param type one of the TMessageBox.Type constants. Default is
3137 * @return the new message box
3139 public final TMessageBox
messageBox(final String title
,
3140 final String caption
, final TMessageBox
.Type type
) {
3142 return new TMessageBox(this, title
, caption
, type
);
3146 * Convenience function to spawn an input box.
3148 * @param title window title, will be centered along the top border
3149 * @param caption message to display. Use embedded newlines to get a
3151 * @return the new input box
3153 public final TInputBox
inputBox(final String title
, final String caption
) {
3155 return new TInputBox(this, title
, caption
);
3159 * Convenience function to spawn an input box.
3161 * @param title window title, will be centered along the top border
3162 * @param caption message to display. Use embedded newlines to get a
3164 * @param text initial text to seed the field with
3165 * @return the new input box
3167 public final TInputBox
inputBox(final String title
, final String caption
,
3168 final String text
) {
3170 return new TInputBox(this, title
, caption
, text
);
3174 * Convenience function to spawn an input box.
3176 * @param title window title, will be centered along the top border
3177 * @param caption message to display. Use embedded newlines to get a
3179 * @param text initial text to seed the field with
3180 * @param type one of the Type constants. Default is Type.OK.
3181 * @return the new input box
3183 public final TInputBox
inputBox(final String title
, final String caption
,
3184 final String text
, final TInputBox
.Type type
) {
3186 return new TInputBox(this, title
, caption
, text
, type
);
3190 * Convenience function to open a terminal window.
3192 * @param x column relative to parent
3193 * @param y row relative to parent
3194 * @return the terminal new window
3196 public final TTerminalWindow
openTerminal(final int x
, final int y
) {
3197 return openTerminal(x
, y
, TWindow
.RESIZABLE
);
3201 * Convenience function to open a terminal window.
3203 * @param x column relative to parent
3204 * @param y row relative to parent
3205 * @param closeOnExit if true, close the window when the command exits
3206 * @return the terminal new window
3208 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3209 final boolean closeOnExit
) {
3211 return openTerminal(x
, y
, TWindow
.RESIZABLE
, closeOnExit
);
3215 * Convenience function to open a terminal window.
3217 * @param x column relative to parent
3218 * @param y row relative to parent
3219 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3220 * @return the terminal new window
3222 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3225 return new TTerminalWindow(this, x
, y
, flags
);
3229 * Convenience function to open a terminal window.
3231 * @param x column relative to parent
3232 * @param y row relative to parent
3233 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3234 * @param closeOnExit if true, close the window when the command exits
3235 * @return the terminal new window
3237 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3238 final int flags
, final boolean closeOnExit
) {
3240 return new TTerminalWindow(this, x
, y
, flags
, closeOnExit
);
3244 * Convenience function to open a terminal window and execute a custom
3245 * command line inside it.
3247 * @param x column relative to parent
3248 * @param y row relative to parent
3249 * @param commandLine the command line to execute
3250 * @return the terminal new window
3252 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3253 final String commandLine
) {
3255 return openTerminal(x
, y
, TWindow
.RESIZABLE
, commandLine
);
3259 * Convenience function to open a terminal window and execute a custom
3260 * command line inside it.
3262 * @param x column relative to parent
3263 * @param y row relative to parent
3264 * @param commandLine the command line to execute
3265 * @param closeOnExit if true, close the window when the command exits
3266 * @return the terminal new window
3268 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3269 final String commandLine
, final boolean closeOnExit
) {
3271 return openTerminal(x
, y
, TWindow
.RESIZABLE
, commandLine
, closeOnExit
);
3275 * Convenience function to open a terminal window and execute a custom
3276 * command line inside it.
3278 * @param x column relative to parent
3279 * @param y row relative to parent
3280 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3281 * @param command the command line to execute
3282 * @return the terminal new window
3284 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3285 final int flags
, final String
[] command
) {
3287 return new TTerminalWindow(this, x
, y
, flags
, command
);
3291 * Convenience function to open a terminal window and execute a custom
3292 * command line inside it.
3294 * @param x column relative to parent
3295 * @param y row relative to parent
3296 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3297 * @param command the command line to execute
3298 * @param closeOnExit if true, close the window when the command exits
3299 * @return the terminal new window
3301 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3302 final int flags
, final String
[] command
, final boolean closeOnExit
) {
3304 return new TTerminalWindow(this, x
, y
, flags
, command
, closeOnExit
);
3308 * Convenience function to open a terminal window and execute a custom
3309 * command line inside it.
3311 * @param x column relative to parent
3312 * @param y row relative to parent
3313 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3314 * @param commandLine the command line to execute
3315 * @return the terminal new window
3317 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3318 final int flags
, final String commandLine
) {
3320 return new TTerminalWindow(this, x
, y
, flags
, commandLine
.split("\\s"));
3324 * Convenience function to open a terminal window and execute a custom
3325 * command line inside it.
3327 * @param x column relative to parent
3328 * @param y row relative to parent
3329 * @param flags mask of CENTERED, MODAL, or RESIZABLE
3330 * @param commandLine the command line to execute
3331 * @param closeOnExit if true, close the window when the command exits
3332 * @return the terminal new window
3334 public final TTerminalWindow
openTerminal(final int x
, final int y
,
3335 final int flags
, final String commandLine
, final boolean closeOnExit
) {
3337 return new TTerminalWindow(this, x
, y
, flags
, commandLine
.split("\\s"),
3342 * Convenience function to spawn an file open box.
3344 * @param path path of selected file
3345 * @return the result of the new file open box
3346 * @throws IOException if java.io operation throws
3348 public final String
fileOpenBox(final String path
) throws IOException
{
3350 TFileOpenBox box
= new TFileOpenBox(this, path
, TFileOpenBox
.Type
.OPEN
);
3351 return box
.getFilename();
3355 * Convenience function to spawn an file open box.
3357 * @param path path of selected file
3358 * @param type one of the Type constants
3359 * @return the result of the new file open box
3360 * @throws IOException if java.io operation throws
3362 public final String
fileOpenBox(final String path
,
3363 final TFileOpenBox
.Type type
) throws IOException
{
3365 TFileOpenBox box
= new TFileOpenBox(this, path
, type
);
3366 return box
.getFilename();
3370 * Convenience function to spawn a file open box.
3372 * @param path path of selected file
3373 * @param type one of the Type constants
3374 * @param filter a string that files must match to be displayed
3375 * @return the result of the new file open box
3376 * @throws IOException of a java.io operation throws
3378 public final String
fileOpenBox(final String path
,
3379 final TFileOpenBox
.Type type
, final String filter
) throws IOException
{
3381 ArrayList
<String
> filters
= new ArrayList
<String
>();
3382 filters
.add(filter
);
3384 TFileOpenBox box
= new TFileOpenBox(this, path
, type
, filters
);
3385 return box
.getFilename();
3389 * Convenience function to spawn a file open box.
3391 * @param path path of selected file
3392 * @param type one of the Type constants
3393 * @param filters a list of strings that files must match to be displayed
3394 * @return the result of the new file open box
3395 * @throws IOException of a java.io operation throws
3397 public final String
fileOpenBox(final String path
,
3398 final TFileOpenBox
.Type type
,
3399 final List
<String
> filters
) throws IOException
{
3401 TFileOpenBox box
= new TFileOpenBox(this, path
, type
, filters
);
3402 return box
.getFilename();
3406 * Convenience function to create a new window and make it active.
3407 * Window will be located at (0, 0).
3409 * @param title window title, will be centered along the top border
3410 * @param width width of window
3411 * @param height height of window
3412 * @return the new window
3414 public final TWindow
addWindow(final String title
, final int width
,
3417 TWindow window
= new TWindow(this, title
, 0, 0, width
, height
);
3422 * Convenience function to create a new window and make it active.
3423 * Window will be located at (0, 0).
3425 * @param title window title, will be centered along the top border
3426 * @param width width of window
3427 * @param height height of window
3428 * @param flags bitmask of RESIZABLE, CENTERED, or MODAL
3429 * @return the new window
3431 public final TWindow
addWindow(final String title
,
3432 final int width
, final int height
, final int flags
) {
3434 TWindow window
= new TWindow(this, title
, 0, 0, width
, height
, flags
);
3439 * Convenience function to create a new window and make it active.
3441 * @param title window title, will be centered along the top border
3442 * @param x column relative to parent
3443 * @param y row relative to parent
3444 * @param width width of window
3445 * @param height height of window
3446 * @return the new window
3448 public final TWindow
addWindow(final String title
,
3449 final int x
, final int y
, final int width
, final int height
) {
3451 TWindow window
= new TWindow(this, title
, x
, y
, width
, height
);
3456 * Convenience function to create a new window and make it active.
3458 * @param title window title, will be centered along the top border
3459 * @param x column relative to parent
3460 * @param y row relative to parent
3461 * @param width width of window
3462 * @param height height of window
3463 * @param flags mask of RESIZABLE, CENTERED, or MODAL
3464 * @return the new window
3466 public final TWindow
addWindow(final String title
,
3467 final int x
, final int y
, final int width
, final int height
,
3470 TWindow window
= new TWindow(this, title
, x
, y
, width
, height
, flags
);