2 * Jexer - Java Text User Interface
4 * The MIT License (MIT)
6 * Copyright (C) 2017 Kevin Lamonte
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 * DEALINGS IN THE SOFTWARE.
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
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
.Collections
;
40 import java
.util
.Date
;
41 import java
.util
.HashMap
;
42 import java
.util
.ArrayList
;
43 import java
.util
.LinkedList
;
44 import java
.util
.List
;
46 import java
.util
.ResourceBundle
;
48 import jexer
.bits
.CellAttributes
;
49 import jexer
.bits
.ColorTheme
;
50 import jexer
.event
.TCommandEvent
;
51 import jexer
.event
.TInputEvent
;
52 import jexer
.event
.TKeypressEvent
;
53 import jexer
.event
.TMenuEvent
;
54 import jexer
.event
.TMouseEvent
;
55 import jexer
.event
.TResizeEvent
;
56 import jexer
.backend
.Backend
;
57 import jexer
.backend
.Screen
;
58 import jexer
.backend
.MultiBackend
;
59 import jexer
.backend
.SwingBackend
;
60 import jexer
.backend
.ECMA48Backend
;
61 import jexer
.backend
.TWindowBackend
;
62 import jexer
.menu
.TMenu
;
63 import jexer
.menu
.TMenuItem
;
64 import static jexer
.TCommand
.*;
65 import static jexer
.TKeypress
.*;
68 * TApplication is the main driver class for a full Text User Interface
69 * application. It manages windows, provides a menu bar and status bar, and
70 * processes events received from the user.
72 public class TApplication
implements Runnable
{
77 private static final ResourceBundle i18n
= ResourceBundle
.getBundle(TApplication
.class.getName());
79 // ------------------------------------------------------------------------
80 // Constants --------------------------------------------------------------
81 // ------------------------------------------------------------------------
84 * If true, emit thread stuff to System.err.
86 private static final boolean debugThreads
= false;
89 * If true, emit events being processed to System.err.
91 private static final boolean debugEvents
= false;
94 * If true, do "smart placement" on new windows that are not specified to
97 private static final boolean smartWindowPlacement
= true;
100 * Two backend types are available.
102 public static enum BackendType
{
109 * An ECMA48 / ANSI X3.64 / XTERM style terminal.
114 * Synonym for ECMA48.
119 // ------------------------------------------------------------------------
120 // Variables --------------------------------------------------------------
121 // ------------------------------------------------------------------------
124 * The primary event handler thread.
126 private volatile WidgetEventHandler primaryEventHandler
;
129 * The secondary event handler thread.
131 private volatile WidgetEventHandler secondaryEventHandler
;
134 * The widget receiving events from the secondary event handler thread.
136 private volatile TWidget secondaryEventReceiver
;
139 * Access to the physical screen, keyboard, and mouse.
141 private Backend backend
;
144 * Actual mouse coordinate X.
149 * Actual mouse coordinate Y.
154 * Old version of mouse coordinate X.
156 private int oldMouseX
;
159 * Old version mouse coordinate Y.
161 private int oldMouseY
;
164 * The last mouse up click time, used to determine if this is a mouse
167 private long lastMouseUpTime
;
170 * The amount of millis between mouse up events to assume a double-click.
172 private long doubleClickTime
= 250;
175 * Event queue that is filled by run().
177 private List
<TInputEvent
> fillEventQueue
;
180 * Event queue that will be drained by either primary or secondary
183 private List
<TInputEvent
> drainEventQueue
;
186 * Top-level menus in this application.
188 private List
<TMenu
> menus
;
191 * Stack of activated sub-menus in this application.
193 private List
<TMenu
> subMenus
;
196 * The currently active menu.
198 private TMenu activeMenu
= null;
201 * Active keyboard accelerators.
203 private Map
<TKeypress
, TMenuItem
> accelerators
;
208 private List
<TMenuItem
> menuItems
;
211 * Windows and widgets pull colors from this ColorTheme.
213 private ColorTheme theme
;
216 * The top-level windows (but not menus).
218 private List
<TWindow
> windows
;
221 * The currently acive window.
223 private TWindow activeWindow
= null;
226 * Timers that are being ticked.
228 private List
<TTimer
> timers
;
231 * When true, the application has been started.
233 private volatile boolean started
= false;
236 * When true, exit the application.
238 private volatile boolean quit
= false;
241 * When true, repaint the entire screen.
243 private volatile boolean repaint
= true;
246 * Y coordinate of the top edge of the desktop. For now this is a
247 * constant. Someday it would be nice to have a multi-line menu or
250 private static final int desktopTop
= 1;
253 * Y coordinate of the bottom edge of the desktop.
255 private int desktopBottom
;
258 * An optional TDesktop background window that is drawn underneath
261 private TDesktop desktop
;
264 * If true, focus follows mouse: windows automatically raised if the
265 * mouse passes over them.
267 private boolean focusFollowsMouse
= false;
270 * WidgetEventHandler is the main event consumer loop. There are at most
271 * two such threads in existence: the primary for normal case and a
272 * secondary that is used for TMessageBox, TInputBox, and similar.
274 private class WidgetEventHandler
implements Runnable
{
276 * The main application.
278 private TApplication application
;
281 * Whether or not this WidgetEventHandler is the primary or secondary
284 private boolean primary
= true;
287 * Public constructor.
289 * @param application the main application
290 * @param primary if true, this is the primary event handler thread
292 public WidgetEventHandler(final TApplication application
,
293 final boolean primary
) {
295 this.application
= application
;
296 this.primary
= primary
;
303 boolean first
= true;
306 while (!application
.quit
) {
308 // Wait until application notifies me
309 while (!application
.quit
) {
311 synchronized (application
.drainEventQueue
) {
312 if (application
.drainEventQueue
.size() > 0) {
321 timeout
= application
.getSleepTime(1000);
325 // A timer needs to fire, break out.
330 System
.err
.printf("%d %s %s sleep %d millis\n",
331 System
.currentTimeMillis(), this,
332 primary ?
"primary" : "secondary", timeout
);
335 synchronized (this) {
340 System
.err
.printf("%d %s %s AWAKE\n",
341 System
.currentTimeMillis(), this,
342 primary ?
"primary" : "secondary");
346 && (application
.secondaryEventReceiver
== null)
348 // Secondary thread, emergency exit. If we got
349 // here then something went wrong with the
350 // handoff between yield() and closeWindow().
351 synchronized (application
.primaryEventHandler
) {
352 application
.primaryEventHandler
.notify();
354 application
.secondaryEventHandler
= null;
355 throw new RuntimeException("secondary exited " +
359 } catch (InterruptedException e
) {
362 } // while (!application.quit)
364 // Pull all events off the queue
366 TInputEvent event
= null;
367 synchronized (application
.drainEventQueue
) {
368 if (application
.drainEventQueue
.size() == 0) {
371 event
= application
.drainEventQueue
.remove(0);
374 // We will have an event to process, so repaint the
375 // screen at the end.
376 application
.repaint
= true;
379 primaryHandleEvent(event
);
381 secondaryHandleEvent(event
);
384 && (application
.secondaryEventReceiver
== null)
386 // Secondary thread, time to exit.
388 // DO NOT UNLOCK. Primary thread just came back from
389 // primaryHandleEvent() and will unlock in the else
390 // block below. Just wake it up.
391 synchronized (application
.primaryEventHandler
) {
392 application
.primaryEventHandler
.notify();
394 // Now eliminate my reference so that
395 // wakeEventHandler() resumes working on the primary.
396 application
.secondaryEventHandler
= null;
404 // Fire timers, update screen.
406 application
.finishEventProcessing();
409 } // while (true) (main runnable loop)
413 // ------------------------------------------------------------------------
414 // Constructors -----------------------------------------------------------
415 // ------------------------------------------------------------------------
418 * Public constructor.
420 * @param backendType BackendType.XTERM, BackendType.ECMA48 or
422 * @param windowWidth the number of text columns to start with
423 * @param windowHeight the number of text rows to start with
424 * @param fontSize the size in points
425 * @throws UnsupportedEncodingException if an exception is thrown when
426 * creating the InputStreamReader
428 public TApplication(final BackendType backendType
, final int windowWidth
,
429 final int windowHeight
, final int fontSize
)
430 throws UnsupportedEncodingException
{
432 switch (backendType
) {
434 backend
= new SwingBackend(this, windowWidth
, windowHeight
,
440 backend
= new ECMA48Backend(this, null, null, windowWidth
,
441 windowHeight
, fontSize
);
444 throw new IllegalArgumentException("Invalid backend type: "
451 * Public constructor.
453 * @param backendType BackendType.XTERM, BackendType.ECMA48 or
455 * @throws UnsupportedEncodingException if an exception is thrown when
456 * creating the InputStreamReader
458 public TApplication(final BackendType backendType
)
459 throws UnsupportedEncodingException
{
461 switch (backendType
) {
463 // The default SwingBackend is 80x25, 20 pt font. If you want to
464 // change that, you can pass the extra arguments to the
465 // SwingBackend constructor here. For example, if you wanted
466 // 90x30, 16 pt font:
468 // backend = new SwingBackend(this, 90, 30, 16);
469 backend
= new SwingBackend(this);
474 backend
= new ECMA48Backend(this, null, null);
477 throw new IllegalArgumentException("Invalid backend type: "
484 * Public constructor. The backend type will be BackendType.ECMA48.
486 * @param input an InputStream connected to the remote user, or null for
487 * System.in. If System.in is used, then on non-Windows systems it will
488 * be put in raw mode; shutdown() will (blindly!) put System.in in cooked
489 * mode. input is always converted to a Reader with UTF-8 encoding.
490 * @param output an OutputStream connected to the remote user, or null
491 * for System.out. output is always converted to a Writer with UTF-8
493 * @throws UnsupportedEncodingException if an exception is thrown when
494 * creating the InputStreamReader
496 public TApplication(final InputStream input
,
497 final OutputStream output
) throws UnsupportedEncodingException
{
499 backend
= new ECMA48Backend(this, input
, output
);
504 * Public constructor. The backend type will be BackendType.ECMA48.
506 * @param input the InputStream underlying 'reader'. Its available()
507 * method is used to determine if reader.read() will block or not.
508 * @param reader a Reader connected to the remote user.
509 * @param writer a PrintWriter connected to the remote user.
510 * @param setRawMode if true, set System.in into raw mode with stty.
511 * This should in general not be used. It is here solely for Demo3,
512 * which uses System.in.
513 * @throws IllegalArgumentException if input, reader, or writer are null.
515 public TApplication(final InputStream input
, final Reader reader
,
516 final PrintWriter writer
, final boolean setRawMode
) {
518 backend
= new ECMA48Backend(this, input
, reader
, writer
, setRawMode
);
523 * Public constructor. The backend type will be BackendType.ECMA48.
525 * @param input the InputStream underlying 'reader'. Its available()
526 * method is used to determine if reader.read() will block or not.
527 * @param reader a Reader connected to the remote user.
528 * @param writer a PrintWriter connected to the remote user.
529 * @throws IllegalArgumentException if input, reader, or writer are null.
531 public TApplication(final InputStream input
, final Reader reader
,
532 final PrintWriter writer
) {
534 this(input
, reader
, writer
, false);
538 * Public constructor. This hook enables use with new non-Jexer
541 * @param backend a Backend that is already ready to go.
543 public TApplication(final Backend backend
) {
544 this.backend
= backend
;
545 backend
.setListener(this);
550 * Finish construction once the backend is set.
552 private void TApplicationImpl() {
553 theme
= new ColorTheme();
554 desktopBottom
= getScreen().getHeight() - 1;
555 fillEventQueue
= new ArrayList
<TInputEvent
>();
556 drainEventQueue
= new ArrayList
<TInputEvent
>();
557 windows
= new LinkedList
<TWindow
>();
558 menus
= new LinkedList
<TMenu
>();
559 subMenus
= new LinkedList
<TMenu
>();
560 timers
= new LinkedList
<TTimer
>();
561 accelerators
= new HashMap
<TKeypress
, TMenuItem
>();
562 menuItems
= new ArrayList
<TMenuItem
>();
563 desktop
= new TDesktop(this);
565 // Special case: the Swing backend needs to have a timer to drive its
567 if ((backend
instanceof SwingBackend
)
568 || (backend
instanceof MultiBackend
)
570 // Default to 500 millis, unless a SwingBackend has its own
573 if (backend
instanceof SwingBackend
) {
574 millis
= ((SwingBackend
) backend
).getBlinkMillis();
577 addTimer(millis
, true,
580 TApplication
.this.doRepaint();
588 // ------------------------------------------------------------------------
589 // Runnable ---------------------------------------------------------------
590 // ------------------------------------------------------------------------
593 * Run this application until it exits.
596 // Start the main consumer thread
597 primaryEventHandler
= new WidgetEventHandler(this, true);
598 (new Thread(primaryEventHandler
)).start();
603 synchronized (this) {
604 boolean doWait
= false;
606 if (!backend
.hasEvents()) {
607 synchronized (fillEventQueue
) {
608 if (fillEventQueue
.size() == 0) {
615 // No I/O to dispatch, so wait until the backend
619 System
.err
.println(System
.currentTimeMillis() +
626 System
.err
.println(System
.currentTimeMillis() +
629 } catch (InterruptedException e
) {
630 // I'm awake and don't care why, let's see what's
631 // going on out there.
635 } // synchronized (this)
637 synchronized (fillEventQueue
) {
638 // Pull any pending I/O events
639 backend
.getEvents(fillEventQueue
);
641 // Dispatch each event to the appropriate handler, one at a
644 TInputEvent event
= null;
645 if (fillEventQueue
.size() == 0) {
648 event
= fillEventQueue
.remove(0);
649 metaHandleEvent(event
);
653 // Wake a consumer thread if we have any pending events.
654 if (drainEventQueue
.size() > 0) {
660 // Shutdown the event consumer threads
661 if (secondaryEventHandler
!= null) {
662 synchronized (secondaryEventHandler
) {
663 secondaryEventHandler
.notify();
666 if (primaryEventHandler
!= null) {
667 synchronized (primaryEventHandler
) {
668 primaryEventHandler
.notify();
672 // Shutdown the user I/O thread(s)
675 // Close all the windows. This gives them an opportunity to release
681 // ------------------------------------------------------------------------
682 // Event handlers ---------------------------------------------------------
683 // ------------------------------------------------------------------------
686 * Method that TApplication subclasses can override to handle menu or
687 * posted command events.
689 * @param command command event
690 * @return if true, this event was consumed
692 protected boolean onCommand(final TCommandEvent command
) {
693 // Default: handle cmExit
694 if (command
.equals(cmExit
)) {
695 if (messageBox(i18n
.getString("exitDialogTitle"),
696 i18n
.getString("exitDialogText"),
697 TMessageBox
.Type
.YESNO
).getResult() == TMessageBox
.Result
.YES
) {
703 if (command
.equals(cmShell
)) {
704 openTerminal(0, 0, TWindow
.RESIZABLE
);
708 if (command
.equals(cmTile
)) {
712 if (command
.equals(cmCascade
)) {
716 if (command
.equals(cmCloseAll
)) {
721 if (command
.equals(cmMenu
)) {
722 if (!modalWindowActive() && (activeMenu
== null)) {
723 if (menus
.size() > 0) {
724 menus
.get(0).setActive(true);
725 activeMenu
= menus
.get(0);
735 * Method that TApplication subclasses can override to handle menu
738 * @param menu menu event
739 * @return if true, this event was consumed
741 protected boolean onMenu(final TMenuEvent menu
) {
743 // Default: handle MID_EXIT
744 if (menu
.getId() == TMenu
.MID_EXIT
) {
745 if (messageBox(i18n
.getString("exitDialogTitle"),
746 i18n
.getString("exitDialogText"),
747 TMessageBox
.Type
.YESNO
).getResult() == TMessageBox
.Result
.YES
) {
753 if (menu
.getId() == TMenu
.MID_SHELL
) {
754 openTerminal(0, 0, TWindow
.RESIZABLE
);
758 if (menu
.getId() == TMenu
.MID_TILE
) {
762 if (menu
.getId() == TMenu
.MID_CASCADE
) {
766 if (menu
.getId() == TMenu
.MID_CLOSE_ALL
) {
770 if (menu
.getId() == TMenu
.MID_ABOUT
) {
774 if (menu
.getId() == TMenu
.MID_REPAINT
) {
782 * Method that TApplication subclasses can override to handle keystrokes.
784 * @param keypress keystroke event
785 * @return if true, this event was consumed
787 protected boolean onKeypress(final TKeypressEvent keypress
) {
788 // Default: only menu shortcuts
790 // Process Alt-F, Alt-E, etc. menu shortcut keys
791 if (!keypress
.getKey().isFnKey()
792 && keypress
.getKey().isAlt()
793 && !keypress
.getKey().isCtrl()
794 && (activeMenu
== null)
795 && !modalWindowActive()
798 assert (subMenus
.size() == 0);
800 for (TMenu menu
: menus
) {
801 if (Character
.toLowerCase(menu
.getMnemonic().getShortcut())
802 == Character
.toLowerCase(keypress
.getKey().getChar())
805 menu
.setActive(true);
815 * Process background events, and update the screen.
817 private void finishEventProcessing() {
819 System
.err
.printf(System
.currentTimeMillis() + " " +
820 Thread
.currentThread() + " finishEventProcessing()\n");
823 // Process timers and call doIdle()'s
827 synchronized (getScreen()) {
832 System
.err
.printf(System
.currentTimeMillis() + " " +
833 Thread
.currentThread() + " finishEventProcessing() END\n");
838 * Peek at certain application-level events, add to eventQueue, and wake
839 * up the consuming Thread.
841 * @param event the input event to consume
843 private void metaHandleEvent(final TInputEvent event
) {
846 System
.err
.printf(String
.format("metaHandleEvents event: %s\n",
847 event
)); System
.err
.flush();
851 // Do no more processing if the application is already trying
856 // Special application-wide events -------------------------------
859 if (event
instanceof TCommandEvent
) {
860 TCommandEvent command
= (TCommandEvent
) event
;
861 if (command
.getCmd().equals(cmAbort
)) {
867 synchronized (drainEventQueue
) {
869 if (event
instanceof TResizeEvent
) {
870 TResizeEvent resize
= (TResizeEvent
) event
;
871 synchronized (getScreen()) {
872 getScreen().setDimensions(resize
.getWidth(),
874 desktopBottom
= getScreen().getHeight() - 1;
880 if (desktop
!= null) {
881 desktop
.setDimensions(0, 0, resize
.getWidth(),
882 resize
.getHeight() - 1);
885 // Change menu edges if needed.
888 // We are dirty, redraw the screen.
892 System.err.println("New screen: " + resize.getWidth() +
893 " x " + resize.getHeight());
898 // Put into the main queue
899 drainEventQueue
.add(event
);
904 * Dispatch one event to the appropriate widget or application-level
905 * event handler. This is the primary event handler, it has the normal
906 * application-wide event handling.
908 * @param event the input event to consume
909 * @see #secondaryHandleEvent(TInputEvent event)
911 private void primaryHandleEvent(final TInputEvent event
) {
914 System
.err
.printf("Handle event: %s\n", event
);
916 TMouseEvent doubleClick
= null;
918 // Special application-wide events -----------------------------------
920 // Peek at the mouse position
921 if (event
instanceof TMouseEvent
) {
922 TMouseEvent mouse
= (TMouseEvent
) event
;
923 if ((mouseX
!= mouse
.getX()) || (mouseY
!= mouse
.getY())) {
926 mouseX
= mouse
.getX();
927 mouseY
= mouse
.getY();
929 if (mouse
.getType() == TMouseEvent
.Type
.MOUSE_UP
) {
930 if ((mouse
.getTime().getTime() - lastMouseUpTime
) <
933 // This is a double-click.
934 doubleClick
= new TMouseEvent(TMouseEvent
.Type
.
936 mouse
.getX(), mouse
.getY(),
937 mouse
.getAbsoluteX(), mouse
.getAbsoluteY(),
938 mouse
.isMouse1(), mouse
.isMouse2(),
940 mouse
.isMouseWheelUp(), mouse
.isMouseWheelDown());
943 // The first click of a potential double-click.
944 lastMouseUpTime
= mouse
.getTime().getTime();
949 // See if we need to switch focus to another window or the menu
950 checkSwitchFocus((TMouseEvent
) event
);
953 // Handle menu events
954 if ((activeMenu
!= null) && !(event
instanceof TCommandEvent
)) {
955 TMenu menu
= activeMenu
;
957 if (event
instanceof TMouseEvent
) {
958 TMouseEvent mouse
= (TMouseEvent
) event
;
960 while (subMenus
.size() > 0) {
961 TMenu subMenu
= subMenus
.get(subMenus
.size() - 1);
962 if (subMenu
.mouseWouldHit(mouse
)) {
965 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_MOTION
)
966 && (!mouse
.isMouse1())
967 && (!mouse
.isMouse2())
968 && (!mouse
.isMouse3())
969 && (!mouse
.isMouseWheelUp())
970 && (!mouse
.isMouseWheelDown())
974 // We navigated away from a sub-menu, so close it
978 // Convert the mouse relative x/y to menu coordinates
979 assert (mouse
.getX() == mouse
.getAbsoluteX());
980 assert (mouse
.getY() == mouse
.getAbsoluteY());
981 if (subMenus
.size() > 0) {
982 menu
= subMenus
.get(subMenus
.size() - 1);
984 mouse
.setX(mouse
.getX() - menu
.getX());
985 mouse
.setY(mouse
.getY() - menu
.getY());
987 menu
.handleEvent(event
);
991 if (event
instanceof TKeypressEvent
) {
992 TKeypressEvent keypress
= (TKeypressEvent
) event
;
994 // See if this key matches an accelerator, and is not being
995 // shortcutted by the active window, and if so dispatch the menu
997 boolean windowWillShortcut
= false;
998 if (activeWindow
!= null) {
999 assert (activeWindow
.isShown());
1000 if (activeWindow
.isShortcutKeypress(keypress
.getKey())) {
1001 // We do not process this key, it will be passed to the
1003 windowWillShortcut
= true;
1007 if (!windowWillShortcut
&& !modalWindowActive()) {
1008 TKeypress keypressLowercase
= keypress
.getKey().toLowerCase();
1009 TMenuItem item
= null;
1010 synchronized (accelerators
) {
1011 item
= accelerators
.get(keypressLowercase
);
1014 if (item
.isEnabled()) {
1015 // Let the menu item dispatch
1021 // Handle the keypress
1022 if (onKeypress(keypress
)) {
1028 if (event
instanceof TCommandEvent
) {
1029 if (onCommand((TCommandEvent
) event
)) {
1034 if (event
instanceof TMenuEvent
) {
1035 if (onMenu((TMenuEvent
) event
)) {
1040 // Dispatch events to the active window -------------------------------
1041 boolean dispatchToDesktop
= true;
1042 TWindow window
= activeWindow
;
1043 if (window
!= null) {
1044 assert (window
.isActive());
1045 assert (window
.isShown());
1046 if (event
instanceof TMouseEvent
) {
1047 TMouseEvent mouse
= (TMouseEvent
) event
;
1048 // Convert the mouse relative x/y to window coordinates
1049 assert (mouse
.getX() == mouse
.getAbsoluteX());
1050 assert (mouse
.getY() == mouse
.getAbsoluteY());
1051 mouse
.setX(mouse
.getX() - window
.getX());
1052 mouse
.setY(mouse
.getY() - window
.getY());
1054 if (doubleClick
!= null) {
1055 doubleClick
.setX(doubleClick
.getX() - window
.getX());
1056 doubleClick
.setY(doubleClick
.getY() - window
.getY());
1059 if (window
.mouseWouldHit(mouse
)) {
1060 dispatchToDesktop
= false;
1062 } else if (event
instanceof TKeypressEvent
) {
1063 dispatchToDesktop
= false;
1067 System
.err
.printf("TApplication dispatch event: %s\n",
1070 window
.handleEvent(event
);
1071 if (doubleClick
!= null) {
1072 window
.handleEvent(doubleClick
);
1075 if (dispatchToDesktop
) {
1076 // This event is fair game for the desktop to process.
1077 if (desktop
!= null) {
1078 desktop
.handleEvent(event
);
1079 if (doubleClick
!= null) {
1080 desktop
.handleEvent(doubleClick
);
1087 * Dispatch one event to the appropriate widget or application-level
1088 * event handler. This is the secondary event handler used by certain
1089 * special dialogs (currently TMessageBox and TFileOpenBox).
1091 * @param event the input event to consume
1092 * @see #primaryHandleEvent(TInputEvent event)
1094 private void secondaryHandleEvent(final TInputEvent event
) {
1095 TMouseEvent doubleClick
= null;
1097 // Peek at the mouse position
1098 if (event
instanceof TMouseEvent
) {
1099 TMouseEvent mouse
= (TMouseEvent
) event
;
1100 if ((mouseX
!= mouse
.getX()) || (mouseY
!= mouse
.getY())) {
1103 mouseX
= mouse
.getX();
1104 mouseY
= mouse
.getY();
1106 if (mouse
.getType() == TMouseEvent
.Type
.MOUSE_UP
) {
1107 if ((mouse
.getTime().getTime() - lastMouseUpTime
) <
1110 // This is a double-click.
1111 doubleClick
= new TMouseEvent(TMouseEvent
.Type
.
1113 mouse
.getX(), mouse
.getY(),
1114 mouse
.getAbsoluteX(), mouse
.getAbsoluteY(),
1115 mouse
.isMouse1(), mouse
.isMouse2(),
1117 mouse
.isMouseWheelUp(), mouse
.isMouseWheelDown());
1120 // The first click of a potential double-click.
1121 lastMouseUpTime
= mouse
.getTime().getTime();
1127 secondaryEventReceiver
.handleEvent(event
);
1128 if (doubleClick
!= null) {
1129 secondaryEventReceiver
.handleEvent(doubleClick
);
1134 * Enable a widget to override the primary event thread.
1136 * @param widget widget that will receive events
1138 public final void enableSecondaryEventReceiver(final TWidget widget
) {
1140 System
.err
.println(System
.currentTimeMillis() +
1141 " enableSecondaryEventReceiver()");
1144 assert (secondaryEventReceiver
== null);
1145 assert (secondaryEventHandler
== null);
1146 assert ((widget
instanceof TMessageBox
)
1147 || (widget
instanceof TFileOpenBox
));
1148 secondaryEventReceiver
= widget
;
1149 secondaryEventHandler
= new WidgetEventHandler(this, false);
1151 (new Thread(secondaryEventHandler
)).start();
1155 * Yield to the secondary thread.
1157 public final void yield() {
1158 assert (secondaryEventReceiver
!= null);
1160 while (secondaryEventReceiver
!= null) {
1161 synchronized (primaryEventHandler
) {
1163 primaryEventHandler
.wait();
1164 } catch (InterruptedException e
) {
1172 * Do stuff when there is no user input.
1174 private void doIdle() {
1176 System
.err
.printf(System
.currentTimeMillis() + " " +
1177 Thread
.currentThread() + " doIdle()\n");
1180 synchronized (timers
) {
1183 System
.err
.printf(System
.currentTimeMillis() + " " +
1184 Thread
.currentThread() + " doIdle() 2\n");
1187 // Run any timers that have timed out
1188 Date now
= new Date();
1189 List
<TTimer
> keepTimers
= new LinkedList
<TTimer
>();
1190 for (TTimer timer
: timers
) {
1191 if (timer
.getNextTick().getTime() <= now
.getTime()) {
1192 // Something might change, so repaint the screen.
1195 if (timer
.recurring
) {
1196 keepTimers
.add(timer
);
1199 keepTimers
.add(timer
);
1202 timers
= keepTimers
;
1206 for (TWindow window
: windows
) {
1209 if (desktop
!= null) {
1215 * Wake the sleeping active event handler.
1217 private void wakeEventHandler() {
1222 if (secondaryEventHandler
!= null) {
1223 synchronized (secondaryEventHandler
) {
1224 secondaryEventHandler
.notify();
1227 assert (primaryEventHandler
!= null);
1228 synchronized (primaryEventHandler
) {
1229 primaryEventHandler
.notify();
1234 // ------------------------------------------------------------------------
1235 // TApplication -----------------------------------------------------------
1236 // ------------------------------------------------------------------------
1241 * @return the Backend
1243 public final Backend
getBackend() {
1250 * @return the Screen
1252 public final Screen
getScreen() {
1253 if (backend
instanceof TWindowBackend
) {
1254 // We are being rendered to a TWindow. We can't use its
1255 // getScreen() method because that is how it is rendering to a
1256 // hardware backend somewhere. Instead use its getOtherScreen()
1258 return ((TWindowBackend
) backend
).getOtherScreen();
1260 return backend
.getScreen();
1265 * Get the color theme.
1269 public final ColorTheme
getTheme() {
1274 * Repaint the screen on the next update.
1276 public void doRepaint() {
1282 * Get Y coordinate of the top edge of the desktop.
1284 * @return Y coordinate of the top edge of the desktop
1286 public final int getDesktopTop() {
1291 * Get Y coordinate of the bottom edge of the desktop.
1293 * @return Y coordinate of the bottom edge of the desktop
1295 public final int getDesktopBottom() {
1296 return desktopBottom
;
1300 * Set the TDesktop instance.
1302 * @param desktop a TDesktop instance, or null to remove the one that is
1305 public final void setDesktop(final TDesktop desktop
) {
1306 if (this.desktop
!= null) {
1307 this.desktop
.onClose();
1309 this.desktop
= desktop
;
1313 * Get the TDesktop instance.
1315 * @return the desktop, or null if it is not set
1317 public final TDesktop
getDesktop() {
1322 * Get the current active window.
1324 * @return the active window, or null if it is not set
1326 public final TWindow
getActiveWindow() {
1327 return activeWindow
;
1331 * Get a (shallow) copy of the window list.
1333 * @return a copy of the list of windows for this application
1335 public final List
<TWindow
> getAllWindows() {
1336 List
<TWindow
> result
= new LinkedList
<TWindow
>();
1337 result
.addAll(windows
);
1342 * Get focusFollowsMouse flag.
1344 * @return true if focus follows mouse: windows automatically raised if
1345 * the mouse passes over them
1347 public boolean getFocusFollowsMouse() {
1348 return focusFollowsMouse
;
1352 * Set focusFollowsMouse flag.
1354 * @param focusFollowsMouse if true, focus follows mouse: windows
1355 * automatically raised if the mouse passes over them
1357 public void setFocusFollowsMouse(final boolean focusFollowsMouse
) {
1358 this.focusFollowsMouse
= focusFollowsMouse
;
1362 * Display the about dialog.
1364 protected void showAboutDialog() {
1365 messageBox(i18n
.getString("aboutDialogTitle"),
1366 MessageFormat
.format(i18n
.getString("aboutDialogText"),
1367 this.getClass().getPackage().getImplementationVersion()),
1368 TMessageBox
.Type
.OK
);
1371 // ------------------------------------------------------------------------
1372 // Screen refresh loop ----------------------------------------------------
1373 // ------------------------------------------------------------------------
1376 * Invert the cell color at a position. This is used to track the mouse.
1378 * @param x column position
1379 * @param y row position
1381 private void invertCell(final int x
, final int y
) {
1383 System
.err
.printf("%d %s invertCell() %d %d\n",
1384 System
.currentTimeMillis(), Thread
.currentThread(), x
, y
);
1386 CellAttributes attr
= getScreen().getAttrXY(x
, y
);
1387 if (attr
.getForeColorRGB() < 0) {
1388 attr
.setForeColor(attr
.getForeColor().invert());
1390 attr
.setForeColorRGB(attr
.getForeColorRGB() ^
0x00ffffff);
1392 if (attr
.getBackColorRGB() < 0) {
1393 attr
.setBackColor(attr
.getBackColor().invert());
1395 attr
.setBackColorRGB(attr
.getBackColorRGB() ^
0x00ffffff);
1397 getScreen().putAttrXY(x
, y
, attr
, false);
1403 private void drawAll() {
1404 boolean menuIsActive
= false;
1407 System
.err
.printf("%d %s drawAll() enter\n",
1408 System
.currentTimeMillis(), Thread
.currentThread());
1413 System
.err
.printf("%d %s drawAll() !repaint\n",
1414 System
.currentTimeMillis(), Thread
.currentThread());
1416 synchronized (getScreen()) {
1417 if ((oldMouseX
!= mouseX
) || (oldMouseY
!= mouseY
)) {
1418 // The only thing that has happened is the mouse moved.
1419 // Clear the old position and draw the new position.
1420 invertCell(oldMouseX
, oldMouseY
);
1421 invertCell(mouseX
, mouseY
);
1425 if (getScreen().isDirty()) {
1426 backend
.flushScreen();
1433 System
.err
.printf("%d %s drawAll() REDRAW\n",
1434 System
.currentTimeMillis(), Thread
.currentThread());
1437 // If true, the cursor is not visible
1438 boolean cursor
= false;
1440 // Start with a clean screen
1441 getScreen().clear();
1444 if (desktop
!= null) {
1445 desktop
.drawChildren();
1448 // Draw each window in reverse Z order
1449 List
<TWindow
> sorted
= new LinkedList
<TWindow
>(windows
);
1450 Collections
.sort(sorted
);
1451 TWindow topLevel
= null;
1452 if (sorted
.size() > 0) {
1453 topLevel
= sorted
.get(0);
1455 Collections
.reverse(sorted
);
1456 for (TWindow window
: sorted
) {
1457 if (window
.isShown()) {
1458 window
.drawChildren();
1462 // Draw the blank menubar line - reset the screen clipping first so
1463 // it won't trim it out.
1464 getScreen().resetClipping();
1465 getScreen().hLineXY(0, 0, getScreen().getWidth(), ' ',
1466 theme
.getColor("tmenu"));
1467 // Now draw the menus.
1469 for (TMenu menu
: menus
) {
1470 CellAttributes menuColor
;
1471 CellAttributes menuMnemonicColor
;
1472 if (menu
.isActive()) {
1473 menuIsActive
= true;
1474 menuColor
= theme
.getColor("tmenu.highlighted");
1475 menuMnemonicColor
= theme
.getColor("tmenu.mnemonic.highlighted");
1478 menuColor
= theme
.getColor("tmenu");
1479 menuMnemonicColor
= theme
.getColor("tmenu.mnemonic");
1481 // Draw the menu title
1482 getScreen().hLineXY(x
, 0, menu
.getTitle().length() + 2, ' ',
1484 getScreen().putStringXY(x
+ 1, 0, menu
.getTitle(), menuColor
);
1485 // Draw the highlight character
1486 getScreen().putCharXY(x
+ 1 + menu
.getMnemonic().getShortcutIdx(),
1487 0, menu
.getMnemonic().getShortcut(), menuMnemonicColor
);
1489 if (menu
.isActive()) {
1490 menu
.drawChildren();
1491 // Reset the screen clipping so we can draw the next title.
1492 getScreen().resetClipping();
1494 x
+= menu
.getTitle().length() + 2;
1497 for (TMenu menu
: subMenus
) {
1498 // Reset the screen clipping so we can draw the next sub-menu.
1499 getScreen().resetClipping();
1500 menu
.drawChildren();
1503 // Draw the status bar of the top-level window
1504 TStatusBar statusBar
= null;
1505 if (topLevel
!= null) {
1506 statusBar
= topLevel
.getStatusBar();
1508 if (statusBar
!= null) {
1509 getScreen().resetClipping();
1510 statusBar
.setWidth(getScreen().getWidth());
1511 statusBar
.setY(getScreen().getHeight() - topLevel
.getY());
1514 CellAttributes barColor
= new CellAttributes();
1515 barColor
.setTo(getTheme().getColor("tstatusbar.text"));
1516 getScreen().hLineXY(0, desktopBottom
, getScreen().getWidth(), ' ',
1520 // Draw the mouse pointer
1521 invertCell(mouseX
, mouseY
);
1525 // Place the cursor if it is visible
1526 if (!menuIsActive
) {
1527 TWidget activeWidget
= null;
1528 if (sorted
.size() > 0) {
1529 activeWidget
= sorted
.get(sorted
.size() - 1).getActiveChild();
1530 if (activeWidget
.isCursorVisible()) {
1531 if ((activeWidget
.getCursorAbsoluteY() < desktopBottom
)
1532 && (activeWidget
.getCursorAbsoluteY() > desktopTop
)
1534 getScreen().putCursor(true,
1535 activeWidget
.getCursorAbsoluteX(),
1536 activeWidget
.getCursorAbsoluteY());
1539 getScreen().putCursor(false,
1540 activeWidget
.getCursorAbsoluteX(),
1541 activeWidget
.getCursorAbsoluteY());
1550 getScreen().hideCursor();
1553 // Flush the screen contents
1554 if (getScreen().isDirty()) {
1555 backend
.flushScreen();
1562 * Force this application to exit.
1564 public void exit() {
1566 synchronized (this) {
1571 // ------------------------------------------------------------------------
1572 // TWindow management -----------------------------------------------------
1573 // ------------------------------------------------------------------------
1576 * Return the total number of windows.
1578 * @return the total number of windows
1580 public final int windowCount() {
1581 return windows
.size();
1585 * Return the number of windows that are showing.
1587 * @return the number of windows that are showing on screen
1589 public final int shownWindowCount() {
1591 for (TWindow w
: windows
) {
1600 * Return the number of windows that are hidden.
1602 * @return the number of windows that are hidden
1604 public final int hiddenWindowCount() {
1606 for (TWindow w
: windows
) {
1615 * Check if a window instance is in this application's window list.
1617 * @param window window to look for
1618 * @return true if this window is in the list
1620 public final boolean hasWindow(final TWindow window
) {
1621 if (windows
.size() == 0) {
1624 for (TWindow w
: windows
) {
1626 assert (window
.getApplication() == this);
1634 * Activate a window: bring it to the top and have it receive events.
1636 * @param window the window to become the new active window
1638 public void activateWindow(final TWindow window
) {
1639 if (hasWindow(window
) == false) {
1641 * Someone has a handle to a window I don't have. Ignore this
1647 // Whatever window might be moving/dragging, stop it now.
1648 for (TWindow w
: windows
) {
1649 if (w
.inMovements()) {
1654 assert (windows
.size() > 0);
1656 if (window
.isHidden()) {
1657 // Unhiding will also activate.
1661 assert (window
.isShown());
1663 if (windows
.size() == 1) {
1664 assert (window
== windows
.get(0));
1665 if (activeWindow
== null) {
1666 activeWindow
= window
;
1668 activeWindow
.setActive(true);
1669 activeWindow
.onFocus();
1672 assert (window
.isActive());
1673 assert (activeWindow
== window
);
1677 if (activeWindow
== window
) {
1678 assert (window
.isActive());
1680 // Window is already active, do nothing.
1684 assert (!window
.isActive());
1685 if (activeWindow
!= null) {
1686 assert (activeWindow
.getZ() == 0);
1688 activeWindow
.setActive(false);
1689 activeWindow
.setZ(window
.getZ());
1691 // Unset activeWindow now before unfocus, so that a window
1692 // lifecycle change inside onUnfocus() doesn't call
1693 // switchWindow() and lead to a stack overflow.
1694 TWindow oldActiveWindow
= activeWindow
;
1695 activeWindow
= null;
1696 oldActiveWindow
.onUnfocus();
1698 activeWindow
= window
;
1699 activeWindow
.setZ(0);
1700 activeWindow
.setActive(true);
1701 activeWindow
.onFocus();
1708 * @param window the window to hide
1710 public void hideWindow(final TWindow window
) {
1711 if (hasWindow(window
) == false) {
1713 * Someone has a handle to a window I don't have. Ignore this
1719 // Whatever window might be moving/dragging, stop it now.
1720 for (TWindow w
: windows
) {
1721 if (w
.inMovements()) {
1726 assert (windows
.size() > 0);
1728 if (!window
.hidden
) {
1729 if (window
== activeWindow
) {
1730 if (shownWindowCount() > 1) {
1733 activeWindow
= null;
1734 window
.setActive(false);
1738 window
.hidden
= true;
1746 * @param window the window to show
1748 public void showWindow(final TWindow window
) {
1749 if (hasWindow(window
) == false) {
1751 * Someone has a handle to a window I don't have. Ignore this
1757 // Whatever window might be moving/dragging, stop it now.
1758 for (TWindow w
: windows
) {
1759 if (w
.inMovements()) {
1764 assert (windows
.size() > 0);
1766 if (window
.hidden
) {
1767 window
.hidden
= false;
1769 activateWindow(window
);
1774 * Close window. Note that the window's destructor is NOT called by this
1775 * method, instead the GC is assumed to do the cleanup.
1777 * @param window the window to remove
1779 public final void closeWindow(final TWindow window
) {
1780 if (hasWindow(window
) == false) {
1782 * Someone has a handle to a window I don't have. Ignore this
1788 synchronized (windows
) {
1789 // Whatever window might be moving/dragging, stop it now.
1790 for (TWindow w
: windows
) {
1791 if (w
.inMovements()) {
1796 int z
= window
.getZ();
1799 Collections
.sort(windows
);
1801 activeWindow
= null;
1802 for (TWindow w
: windows
) {
1804 // Do not activate a hidden window.
1810 w
.setZ(w
.getZ() - 1);
1811 if (w
.getZ() == 0) {
1814 assert (activeWindow
== null);
1826 // Perform window cleanup
1829 // Check if we are closing a TMessageBox or similar
1830 if (secondaryEventReceiver
!= null) {
1831 assert (secondaryEventHandler
!= null);
1833 // Do not send events to the secondaryEventReceiver anymore, the
1834 // window is closed.
1835 secondaryEventReceiver
= null;
1837 // Wake the secondary thread, it will wake the primary as it
1839 synchronized (secondaryEventHandler
) {
1840 secondaryEventHandler
.notify();
1844 // Permit desktop to be active if it is the only thing left.
1845 if (desktop
!= null) {
1846 if (windows
.size() == 0) {
1847 desktop
.setActive(true);
1853 * Switch to the next window.
1855 * @param forward if true, then switch to the next window in the list,
1856 * otherwise switch to the previous window in the list
1858 public final void switchWindow(final boolean forward
) {
1859 // Only switch if there are multiple visible windows
1860 if (shownWindowCount() < 2) {
1863 assert (activeWindow
!= null);
1865 synchronized (windows
) {
1866 // Whatever window might be moving/dragging, stop it now.
1867 for (TWindow w
: windows
) {
1868 if (w
.inMovements()) {
1873 // Swap z/active between active window and the next in the list
1874 int activeWindowI
= -1;
1875 for (int i
= 0; i
< windows
.size(); i
++) {
1876 if (windows
.get(i
) == activeWindow
) {
1877 assert (activeWindow
.isActive());
1881 assert (!windows
.get(0).isActive());
1884 assert (activeWindowI
>= 0);
1886 // Do not switch if a window is modal
1887 if (activeWindow
.isModal()) {
1891 int nextWindowI
= activeWindowI
;
1895 nextWindowI
%= windows
.size();
1898 if (nextWindowI
< 0) {
1899 nextWindowI
= windows
.size() - 1;
1903 if (windows
.get(nextWindowI
).isShown()) {
1904 activateWindow(windows
.get(nextWindowI
));
1908 } // synchronized (windows)
1913 * Add a window to my window list and make it active. Note package
1916 * @param window new window to add
1918 final void addWindowToApplication(final TWindow window
) {
1920 // Do not add menu windows to the window list.
1921 if (window
instanceof TMenu
) {
1925 // Do not add the desktop to the window list.
1926 if (window
instanceof TDesktop
) {
1930 synchronized (windows
) {
1931 if (windows
.contains(window
)) {
1932 throw new IllegalArgumentException("Window " + window
+
1933 " is already in window list");
1936 // Whatever window might be moving/dragging, stop it now.
1937 for (TWindow w
: windows
) {
1938 if (w
.inMovements()) {
1943 // Do not allow a modal window to spawn a non-modal window. If a
1944 // modal window is active, then this window will become modal
1946 if (modalWindowActive()) {
1947 window
.flags
|= TWindow
.MODAL
;
1948 window
.flags
|= TWindow
.CENTERED
;
1949 window
.hidden
= false;
1951 if (window
.isShown()) {
1952 for (TWindow w
: windows
) {
1957 w
.setZ(w
.getZ() + 1);
1960 windows
.add(window
);
1961 if (window
.isShown()) {
1962 activeWindow
= window
;
1963 activeWindow
.setZ(0);
1964 activeWindow
.setActive(true);
1965 activeWindow
.onFocus();
1968 if (((window
.flags
& TWindow
.CENTERED
) == 0)
1969 && ((window
.flags
& TWindow
.ABSOLUTEXY
) == 0)
1970 && (smartWindowPlacement
== true)
1973 doSmartPlacement(window
);
1977 // Desktop cannot be active over any other window.
1978 if (desktop
!= null) {
1979 desktop
.setActive(false);
1984 * Check if there is a system-modal window on top.
1986 * @return true if the active window is modal
1988 private boolean modalWindowActive() {
1989 if (windows
.size() == 0) {
1993 for (TWindow w
: windows
) {
2003 * Close all open windows.
2005 private void closeAllWindows() {
2006 // Don't do anything if we are in the menu
2007 if (activeMenu
!= null) {
2010 while (windows
.size() > 0) {
2011 closeWindow(windows
.get(0));
2016 * Re-layout the open windows as non-overlapping tiles. This produces
2017 * almost the same results as Turbo Pascal 7.0's IDE.
2019 private void tileWindows() {
2020 synchronized (windows
) {
2021 // Don't do anything if we are in the menu
2022 if (activeMenu
!= null) {
2025 int z
= windows
.size();
2031 a
= (int)(Math
.sqrt(z
));
2035 if (((a
* b
) + c
) == z
) {
2043 int newWidth
= (getScreen().getWidth() / a
);
2044 int newHeight1
= ((getScreen().getHeight() - 1) / b
);
2045 int newHeight2
= ((getScreen().getHeight() - 1) / (b
+ c
));
2047 List
<TWindow
> sorted
= new LinkedList
<TWindow
>(windows
);
2048 Collections
.sort(sorted
);
2049 Collections
.reverse(sorted
);
2050 for (int i
= 0; i
< sorted
.size(); i
++) {
2051 int logicalX
= i
/ b
;
2052 int logicalY
= i
% b
;
2053 if (i
>= ((a
- 1) * b
)) {
2055 logicalY
= i
- ((a
- 1) * b
);
2058 TWindow w
= sorted
.get(i
);
2059 w
.setX(logicalX
* newWidth
);
2060 w
.setWidth(newWidth
);
2061 if (i
>= ((a
- 1) * b
)) {
2062 w
.setY((logicalY
* newHeight2
) + 1);
2063 w
.setHeight(newHeight2
);
2065 w
.setY((logicalY
* newHeight1
) + 1);
2066 w
.setHeight(newHeight1
);
2073 * Re-layout the open windows as overlapping cascaded windows.
2075 private void cascadeWindows() {
2076 synchronized (windows
) {
2077 // Don't do anything if we are in the menu
2078 if (activeMenu
!= null) {
2083 List
<TWindow
> sorted
= new LinkedList
<TWindow
>(windows
);
2084 Collections
.sort(sorted
);
2085 Collections
.reverse(sorted
);
2086 for (TWindow window
: sorted
) {
2091 if (x
> getScreen().getWidth()) {
2094 if (y
>= getScreen().getHeight()) {
2102 * Place a window to minimize its overlap with other windows.
2104 * @param window the window to place
2106 public final void doSmartPlacement(final TWindow window
) {
2107 // This is a pretty dumb algorithm, but seems to work. The hardest
2108 // part is computing these "overlap" values seeking a minimum average
2111 int yMin
= desktopTop
;
2112 int xMax
= getScreen().getWidth() - window
.getWidth() + 1;
2113 int yMax
= desktopBottom
- window
.getHeight() + 1;
2121 if ((xMin
== xMax
) && (yMin
== yMax
)) {
2122 // No work to do, bail out.
2126 // Compute the overlap matrix without the new window.
2127 int width
= getScreen().getWidth();
2128 int height
= getScreen().getHeight();
2129 int overlapMatrix
[][] = new int[width
][height
];
2130 for (TWindow w
: windows
) {
2134 for (int x
= w
.getX(); x
< w
.getX() + w
.getWidth(); x
++) {
2141 for (int y
= w
.getY(); y
< w
.getY() + w
.getHeight(); y
++) {
2148 overlapMatrix
[x
][y
]++;
2153 long oldOverlapTotal
= 0;
2154 long oldOverlapN
= 0;
2155 for (int x
= 0; x
< width
; x
++) {
2156 for (int y
= 0; y
< height
; y
++) {
2157 oldOverlapTotal
+= overlapMatrix
[x
][y
];
2158 if (overlapMatrix
[x
][y
] > 0) {
2165 double oldOverlapAvg
= (double) oldOverlapTotal
/ (double) oldOverlapN
;
2166 boolean first
= true;
2167 int windowX
= window
.getX();
2168 int windowY
= window
.getY();
2170 // For each possible (x, y) position for the new window, compute a
2171 // new overlap matrix.
2172 for (int x
= xMin
; x
< xMax
; x
++) {
2173 for (int y
= yMin
; y
< yMax
; y
++) {
2175 // Start with the matrix minus this window.
2176 int newMatrix
[][] = new int[width
][height
];
2177 for (int mx
= 0; mx
< width
; mx
++) {
2178 for (int my
= 0; my
< height
; my
++) {
2179 newMatrix
[mx
][my
] = overlapMatrix
[mx
][my
];
2183 // Add this window's values to the new overlap matrix.
2184 long newOverlapTotal
= 0;
2185 long newOverlapN
= 0;
2186 // Start by adding each new cell.
2187 for (int wx
= x
; wx
< x
+ window
.getWidth(); wx
++) {
2191 for (int wy
= y
; wy
< y
+ window
.getHeight(); wy
++) {
2195 newMatrix
[wx
][wy
]++;
2198 // Now figure out the new value for total coverage.
2199 for (int mx
= 0; mx
< width
; mx
++) {
2200 for (int my
= 0; my
< height
; my
++) {
2201 newOverlapTotal
+= newMatrix
[x
][y
];
2202 if (newMatrix
[mx
][my
] > 0) {
2207 double newOverlapAvg
= (double) newOverlapTotal
/ (double) newOverlapN
;
2210 // First time: just record what we got.
2211 oldOverlapAvg
= newOverlapAvg
;
2214 // All other times: pick a new best (x, y) and save the
2216 if (newOverlapAvg
< oldOverlapAvg
) {
2219 oldOverlapAvg
= newOverlapAvg
;
2223 } // for (int x = xMin; x < xMax; x++)
2225 } // for (int y = yMin; y < yMax; y++)
2227 // Finally, set the window's new coordinates.
2228 window
.setX(windowX
);
2229 window
.setY(windowY
);
2232 // ------------------------------------------------------------------------
2233 // TMenu management -------------------------------------------------------
2234 // ------------------------------------------------------------------------
2237 * Check if a mouse event would hit either the active menu or any open
2240 * @param mouse mouse event
2241 * @return true if the mouse would hit the active menu or an open
2244 private boolean mouseOnMenu(final TMouseEvent mouse
) {
2245 assert (activeMenu
!= null);
2246 List
<TMenu
> menus
= new LinkedList
<TMenu
>(subMenus
);
2247 Collections
.reverse(menus
);
2248 for (TMenu menu
: menus
) {
2249 if (menu
.mouseWouldHit(mouse
)) {
2253 return activeMenu
.mouseWouldHit(mouse
);
2257 * See if we need to switch window or activate the menu based on
2260 * @param mouse mouse event
2262 private void checkSwitchFocus(final TMouseEvent mouse
) {
2264 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
2265 && (activeMenu
!= null)
2266 && (mouse
.getAbsoluteY() != 0)
2267 && (!mouseOnMenu(mouse
))
2269 // They clicked outside the active menu, turn it off
2270 activeMenu
.setActive(false);
2272 for (TMenu menu
: subMenus
) {
2273 menu
.setActive(false);
2279 // See if they hit the menu bar
2280 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
2281 && (mouse
.isMouse1())
2282 && (!modalWindowActive())
2283 && (mouse
.getAbsoluteY() == 0)
2286 for (TMenu menu
: subMenus
) {
2287 menu
.setActive(false);
2291 // They selected the menu, go activate it
2292 for (TMenu menu
: menus
) {
2293 if ((mouse
.getAbsoluteX() >= menu
.getTitleX())
2294 && (mouse
.getAbsoluteX() < menu
.getTitleX()
2295 + menu
.getTitle().length() + 2)
2297 menu
.setActive(true);
2300 menu
.setActive(false);
2306 // See if they hit the menu bar
2307 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_MOTION
)
2308 && (mouse
.isMouse1())
2309 && (activeMenu
!= null)
2310 && (mouse
.getAbsoluteY() == 0)
2313 TMenu oldMenu
= activeMenu
;
2314 for (TMenu menu
: subMenus
) {
2315 menu
.setActive(false);
2319 // See if we should switch menus
2320 for (TMenu menu
: menus
) {
2321 if ((mouse
.getAbsoluteX() >= menu
.getTitleX())
2322 && (mouse
.getAbsoluteX() < menu
.getTitleX()
2323 + menu
.getTitle().length() + 2)
2325 menu
.setActive(true);
2329 if (oldMenu
!= activeMenu
) {
2330 // They switched menus
2331 oldMenu
.setActive(false);
2336 // If a menu is still active, don't switch windows
2337 if (activeMenu
!= null) {
2341 // Only switch if there are multiple windows
2342 if (windows
.size() < 2) {
2346 if (((focusFollowsMouse
== true)
2347 && (mouse
.getType() == TMouseEvent
.Type
.MOUSE_MOTION
))
2348 || (mouse
.getType() == TMouseEvent
.Type
.MOUSE_UP
)
2350 synchronized (windows
) {
2351 Collections
.sort(windows
);
2352 if (windows
.get(0).isModal()) {
2353 // Modal windows don't switch
2357 for (TWindow window
: windows
) {
2358 assert (!window
.isModal());
2360 if (window
.isHidden()) {
2361 assert (!window
.isActive());
2365 if (window
.mouseWouldHit(mouse
)) {
2366 if (window
== windows
.get(0)) {
2367 // Clicked on the same window, nothing to do
2368 assert (window
.isActive());
2372 // We will be switching to another window
2373 assert (windows
.get(0).isActive());
2374 assert (windows
.get(0) == activeWindow
);
2375 assert (!window
.isActive());
2376 activeWindow
.onUnfocus();
2377 activeWindow
.setActive(false);
2378 activeWindow
.setZ(window
.getZ());
2379 activeWindow
= window
;
2381 window
.setActive(true);
2388 // Clicked on the background, nothing to do
2392 // Nothing to do: this isn't a mouse up, or focus isn't following
2398 * Turn off the menu.
2400 public final void closeMenu() {
2401 if (activeMenu
!= null) {
2402 activeMenu
.setActive(false);
2404 for (TMenu menu
: subMenus
) {
2405 menu
.setActive(false);
2412 * Get a (shallow) copy of the menu list.
2414 * @return a copy of the menu list
2416 public final List
<TMenu
> getAllMenus() {
2417 return new LinkedList
<TMenu
>(menus
);
2421 * Add a top-level menu to the list.
2423 * @param menu the menu to add
2424 * @throws IllegalArgumentException if the menu is already used in
2425 * another TApplication
2427 public final void addMenu(final TMenu menu
) {
2428 if ((menu
.getApplication() != null)
2429 && (menu
.getApplication() != this)
2431 throw new IllegalArgumentException("Menu " + menu
+ " is already " +
2432 "part of application " + menu
.getApplication());
2440 * Remove a top-level menu from the list.
2442 * @param menu the menu to remove
2443 * @throws IllegalArgumentException if the menu is already used in
2444 * another TApplication
2446 public final void removeMenu(final TMenu menu
) {
2447 if ((menu
.getApplication() != null)
2448 && (menu
.getApplication() != this)
2450 throw new IllegalArgumentException("Menu " + menu
+ " is already " +
2451 "part of application " + menu
.getApplication());
2459 * Turn off a sub-menu.
2461 public final void closeSubMenu() {
2462 assert (activeMenu
!= null);
2463 TMenu item
= subMenus
.get(subMenus
.size() - 1);
2464 assert (item
!= null);
2465 item
.setActive(false);
2466 subMenus
.remove(subMenus
.size() - 1);
2470 * Switch to the next menu.
2472 * @param forward if true, then switch to the next menu in the list,
2473 * otherwise switch to the previous menu in the list
2475 public final void switchMenu(final boolean forward
) {
2476 assert (activeMenu
!= null);
2478 for (TMenu menu
: subMenus
) {
2479 menu
.setActive(false);
2483 for (int i
= 0; i
< menus
.size(); i
++) {
2484 if (activeMenu
== menus
.get(i
)) {
2486 if (i
< menus
.size() - 1) {
2494 activeMenu
.setActive(false);
2495 activeMenu
= menus
.get(i
);
2496 activeMenu
.setActive(true);
2503 * Add a menu item to the global list. If it has a keyboard accelerator,
2504 * that will be added the global hash.
2506 * @param item the menu item
2508 public final void addMenuItem(final TMenuItem item
) {
2509 menuItems
.add(item
);
2511 TKeypress key
= item
.getKey();
2513 synchronized (accelerators
) {
2514 assert (accelerators
.get(key
) == null);
2515 accelerators
.put(key
.toLowerCase(), item
);
2521 * Disable one menu item.
2523 * @param id the menu item ID
2525 public final void disableMenuItem(final int id
) {
2526 for (TMenuItem item
: menuItems
) {
2527 if (item
.getId() == id
) {
2528 item
.setEnabled(false);
2534 * Disable the range of menu items with ID's between lower and upper,
2537 * @param lower the lowest menu item ID
2538 * @param upper the highest menu item ID
2540 public final void disableMenuItems(final int lower
, final int upper
) {
2541 for (TMenuItem item
: menuItems
) {
2542 if ((item
.getId() >= lower
) && (item
.getId() <= upper
)) {
2543 item
.setEnabled(false);
2549 * Enable one menu item.
2551 * @param id the menu item ID
2553 public final void enableMenuItem(final int id
) {
2554 for (TMenuItem item
: menuItems
) {
2555 if (item
.getId() == id
) {
2556 item
.setEnabled(true);
2562 * Enable the range of menu items with ID's between lower and upper,
2565 * @param lower the lowest menu item ID
2566 * @param upper the highest menu item ID
2568 public final void enableMenuItems(final int lower
, final int upper
) {
2569 for (TMenuItem item
: menuItems
) {
2570 if ((item
.getId() >= lower
) && (item
.getId() <= upper
)) {
2571 item
.setEnabled(true);
2577 * Recompute menu x positions based on their title length.
2579 public final void recomputeMenuX() {
2581 for (TMenu menu
: menus
) {
2584 x
+= menu
.getTitle().length() + 2;
2586 // Don't let the menu window exceed the screen width
2587 int rightEdge
= menu
.getX() + menu
.getWidth();
2588 if (rightEdge
> getScreen().getWidth()) {
2589 menu
.setX(getScreen().getWidth() - menu
.getWidth());
2595 * Post an event to process.
2597 * @param event new event to add to the queue
2599 public final void postEvent(final TInputEvent event
) {
2600 synchronized (this) {
2601 synchronized (fillEventQueue
) {
2602 fillEventQueue
.add(event
);
2605 System
.err
.println(System
.currentTimeMillis() + " " +
2606 Thread
.currentThread() + " postEvent() wake up main");
2613 * Post an event to process and turn off the menu.
2615 * @param event new event to add to the queue
2617 public final void postMenuEvent(final TInputEvent event
) {
2618 synchronized (this) {
2619 synchronized (fillEventQueue
) {
2620 fillEventQueue
.add(event
);
2623 System
.err
.println(System
.currentTimeMillis() + " " +
2624 Thread
.currentThread() + " postMenuEvent() wake up main");
2632 * Add a sub-menu to the list of open sub-menus.
2634 * @param menu sub-menu
2636 public final void addSubMenu(final TMenu menu
) {
2641 * Convenience function to add a top-level menu.
2643 * @param title menu title
2644 * @return the new menu
2646 public final TMenu
addMenu(final String title
) {
2649 TMenu menu
= new TMenu(this, x
, y
, title
);
2656 * Convenience function to add a default "File" menu.
2658 * @return the new menu
2660 public final TMenu
addFileMenu() {
2661 TMenu fileMenu
= addMenu(i18n
.getString("fileMenuTitle"));
2662 fileMenu
.addDefaultItem(TMenu
.MID_OPEN_FILE
);
2663 fileMenu
.addSeparator();
2664 fileMenu
.addDefaultItem(TMenu
.MID_SHELL
);
2665 fileMenu
.addDefaultItem(TMenu
.MID_EXIT
);
2666 TStatusBar statusBar
= fileMenu
.newStatusBar(i18n
.
2667 getString("fileMenuStatus"));
2668 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
2673 * Convenience function to add a default "Edit" menu.
2675 * @return the new menu
2677 public final TMenu
addEditMenu() {
2678 TMenu editMenu
= addMenu(i18n
.getString("editMenuTitle"));
2679 editMenu
.addDefaultItem(TMenu
.MID_CUT
);
2680 editMenu
.addDefaultItem(TMenu
.MID_COPY
);
2681 editMenu
.addDefaultItem(TMenu
.MID_PASTE
);
2682 editMenu
.addDefaultItem(TMenu
.MID_CLEAR
);
2683 TStatusBar statusBar
= editMenu
.newStatusBar(i18n
.
2684 getString("editMenuStatus"));
2685 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
2690 * Convenience function to add a default "Window" menu.
2692 * @return the new menu
2694 public final TMenu
addWindowMenu() {
2695 TMenu windowMenu
= addMenu(i18n
.getString("windowMenuTitle"));
2696 windowMenu
.addDefaultItem(TMenu
.MID_TILE
);
2697 windowMenu
.addDefaultItem(TMenu
.MID_CASCADE
);
2698 windowMenu
.addDefaultItem(TMenu
.MID_CLOSE_ALL
);
2699 windowMenu
.addSeparator();
2700 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_MOVE
);
2701 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_ZOOM
);
2702 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_NEXT
);
2703 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_PREVIOUS
);
2704 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_CLOSE
);
2705 TStatusBar statusBar
= windowMenu
.newStatusBar(i18n
.
2706 getString("windowMenuStatus"));
2707 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
2712 * Convenience function to add a default "Help" menu.
2714 * @return the new menu
2716 public final TMenu
addHelpMenu() {
2717 TMenu helpMenu
= addMenu(i18n
.getString("helpMenuTitle"));
2718 helpMenu
.addDefaultItem(TMenu
.MID_HELP_CONTENTS
);
2719 helpMenu
.addDefaultItem(TMenu
.MID_HELP_INDEX
);
2720 helpMenu
.addDefaultItem(TMenu
.MID_HELP_SEARCH
);
2721 helpMenu
.addDefaultItem(TMenu
.MID_HELP_PREVIOUS
);
2722 helpMenu
.addDefaultItem(TMenu
.MID_HELP_HELP
);
2723 helpMenu
.addDefaultItem(TMenu
.MID_HELP_ACTIVE_FILE
);
2724 helpMenu
.addSeparator();
2725 helpMenu
.addDefaultItem(TMenu
.MID_ABOUT
);
2726 TStatusBar statusBar
= helpMenu
.newStatusBar(i18n
.
2727 getString("helpMenuStatus"));
2728 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
2732 // ------------------------------------------------------------------------
2733 // TTimer management ------------------------------------------------------
2734 // ------------------------------------------------------------------------
2737 * Get the amount of time I can sleep before missing a Timer tick.
2739 * @param timeout = initial (maximum) timeout in millis
2740 * @return number of milliseconds between now and the next timer event
2742 private long getSleepTime(final long timeout
) {
2743 Date now
= new Date();
2744 long nowTime
= now
.getTime();
2745 long sleepTime
= timeout
;
2747 synchronized (timers
) {
2748 for (TTimer timer
: timers
) {
2749 long nextTickTime
= timer
.getNextTick().getTime();
2750 if (nextTickTime
< nowTime
) {
2754 long timeDifference
= nextTickTime
- nowTime
;
2755 if (timeDifference
< sleepTime
) {
2756 sleepTime
= timeDifference
;
2761 assert (sleepTime
>= 0);
2762 assert (sleepTime
<= timeout
);
2767 * Convenience function to add a timer.
2769 * @param duration number of milliseconds to wait between ticks
2770 * @param recurring if true, re-schedule this timer after every tick
2771 * @param action function to call when button is pressed
2774 public final TTimer
addTimer(final long duration
, final boolean recurring
,
2775 final TAction action
) {
2777 TTimer timer
= new TTimer(duration
, recurring
, action
);
2778 synchronized (timers
) {
2785 * Convenience function to remove a timer.
2787 * @param timer timer to remove
2789 public final void removeTimer(final TTimer timer
) {
2790 synchronized (timers
) {
2791 timers
.remove(timer
);
2795 // ------------------------------------------------------------------------
2796 // Other TWindow constructors ---------------------------------------------
2797 // ------------------------------------------------------------------------
2800 * Convenience function to spawn a message box.
2802 * @param title window title, will be centered along the top border
2803 * @param caption message to display. Use embedded newlines to get a
2805 * @return the new message box
2807 public final TMessageBox
messageBox(final String title
,
2808 final String caption
) {
2810 return new TMessageBox(this, title
, caption
, TMessageBox
.Type
.OK
);
2814 * Convenience function to spawn a message box.
2816 * @param title window title, will be centered along the top border
2817 * @param caption message to display. Use embedded newlines to get a
2819 * @param type one of the TMessageBox.Type constants. Default is
2821 * @return the new message box
2823 public final TMessageBox
messageBox(final String title
,
2824 final String caption
, final TMessageBox
.Type type
) {
2826 return new TMessageBox(this, title
, caption
, type
);
2830 * Convenience function to spawn an input box.
2832 * @param title window title, will be centered along the top border
2833 * @param caption message to display. Use embedded newlines to get a
2835 * @return the new input box
2837 public final TInputBox
inputBox(final String title
, final String caption
) {
2839 return new TInputBox(this, title
, caption
);
2843 * Convenience function to spawn an input box.
2845 * @param title window title, will be centered along the top border
2846 * @param caption message to display. Use embedded newlines to get a
2848 * @param text initial text to seed the field with
2849 * @return the new input box
2851 public final TInputBox
inputBox(final String title
, final String caption
,
2852 final String text
) {
2854 return new TInputBox(this, title
, caption
, text
);
2858 * Convenience function to open a terminal window.
2860 * @param x column relative to parent
2861 * @param y row relative to parent
2862 * @return the terminal new window
2864 public final TTerminalWindow
openTerminal(final int x
, final int y
) {
2865 return openTerminal(x
, y
, TWindow
.RESIZABLE
);
2869 * Convenience function to open a terminal window.
2871 * @param x column relative to parent
2872 * @param y row relative to parent
2873 * @param flags mask of CENTERED, MODAL, or RESIZABLE
2874 * @return the terminal new window
2876 public final TTerminalWindow
openTerminal(final int x
, final int y
,
2879 return new TTerminalWindow(this, x
, y
, flags
);
2883 * Convenience function to open a terminal window and execute a custom
2884 * command line inside it.
2886 * @param x column relative to parent
2887 * @param y row relative to parent
2888 * @param commandLine the command line to execute
2889 * @return the terminal new window
2891 public final TTerminalWindow
openTerminal(final int x
, final int y
,
2892 final String commandLine
) {
2894 return openTerminal(x
, y
, TWindow
.RESIZABLE
, commandLine
);
2898 * Convenience function to open a terminal window and execute a custom
2899 * command line inside it.
2901 * @param x column relative to parent
2902 * @param y row relative to parent
2903 * @param flags mask of CENTERED, MODAL, or RESIZABLE
2904 * @param command the command line to execute
2905 * @return the terminal new window
2907 public final TTerminalWindow
openTerminal(final int x
, final int y
,
2908 final int flags
, final String
[] command
) {
2910 return new TTerminalWindow(this, x
, y
, flags
, command
);
2914 * Convenience function to open a terminal window and execute a custom
2915 * command line inside it.
2917 * @param x column relative to parent
2918 * @param y row relative to parent
2919 * @param flags mask of CENTERED, MODAL, or RESIZABLE
2920 * @param commandLine the command line to execute
2921 * @return the terminal new window
2923 public final TTerminalWindow
openTerminal(final int x
, final int y
,
2924 final int flags
, final String commandLine
) {
2926 return new TTerminalWindow(this, x
, y
, flags
, commandLine
.split("\\s"));
2930 * Convenience function to spawn an file open box.
2932 * @param path path of selected file
2933 * @return the result of the new file open box
2934 * @throws IOException if java.io operation throws
2936 public final String
fileOpenBox(final String path
) throws IOException
{
2938 TFileOpenBox box
= new TFileOpenBox(this, path
, TFileOpenBox
.Type
.OPEN
);
2939 return box
.getFilename();
2943 * Convenience function to spawn an file open box.
2945 * @param path path of selected file
2946 * @param type one of the Type constants
2947 * @return the result of the new file open box
2948 * @throws IOException if java.io operation throws
2950 public final String
fileOpenBox(final String path
,
2951 final TFileOpenBox
.Type type
) throws IOException
{
2953 TFileOpenBox box
= new TFileOpenBox(this, path
, type
);
2954 return box
.getFilename();
2958 * Convenience function to create a new window and make it active.
2959 * Window will be located at (0, 0).
2961 * @param title window title, will be centered along the top border
2962 * @param width width of window
2963 * @param height height of window
2964 * @return the new window
2966 public final TWindow
addWindow(final String title
, final int width
,
2969 TWindow window
= new TWindow(this, title
, 0, 0, width
, height
);
2974 * Convenience function to create a new window and make it active.
2975 * Window will be located at (0, 0).
2977 * @param title window title, will be centered along the top border
2978 * @param width width of window
2979 * @param height height of window
2980 * @param flags bitmask of RESIZABLE, CENTERED, or MODAL
2981 * @return the new window
2983 public final TWindow
addWindow(final String title
,
2984 final int width
, final int height
, final int flags
) {
2986 TWindow window
= new TWindow(this, title
, 0, 0, width
, height
, flags
);
2991 * Convenience function to create a new window and make it active.
2993 * @param title window title, will be centered along the top border
2994 * @param x column relative to parent
2995 * @param y row relative to parent
2996 * @param width width of window
2997 * @param height height of window
2998 * @return the new window
3000 public final TWindow
addWindow(final String title
,
3001 final int x
, final int y
, final int width
, final int height
) {
3003 TWindow window
= new TWindow(this, title
, x
, y
, width
, height
);
3008 * Convenience function to create a new window and make it active.
3010 * @param title window title, will be centered along the top border
3011 * @param x column relative to parent
3012 * @param y row relative to parent
3013 * @param width width of window
3014 * @param height height of window
3015 * @param flags mask of RESIZABLE, CENTERED, or MODAL
3016 * @return the new window
3018 public final TWindow
addWindow(final String title
,
3019 final int x
, final int y
, final int width
, final int height
,
3022 TWindow window
= new TWindow(this, title
, x
, y
, width
, height
, flags
);
3027 * Convenience function to open a file in an editor window and make it
3030 * @param file the file to open
3031 * @return the new editor window
3032 * @throws IOException if a java.io operation throws
3034 public final TEditorWindow
addEditor(final File file
) throws IOException
{
3036 TEditorWindow editor
= new TEditorWindow(this, file
);