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 // Public 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 // Primary/secondary event handlers ---------------------------------------
121 // ------------------------------------------------------------------------
124 * WidgetEventHandler is the main event consumer loop. There are at most
125 * two such threads in existence: the primary for normal case and a
126 * secondary that is used for TMessageBox, TInputBox, and similar.
128 private class WidgetEventHandler
implements Runnable
{
130 * The main application.
132 private TApplication application
;
135 * Whether or not this WidgetEventHandler is the primary or secondary
138 private boolean primary
= true;
141 * Public constructor.
143 * @param application the main application
144 * @param primary if true, this is the primary event handler thread
146 public WidgetEventHandler(final TApplication application
,
147 final boolean primary
) {
149 this.application
= application
;
150 this.primary
= primary
;
157 boolean first
= true;
160 while (!application
.quit
) {
162 // Wait until application notifies me
163 while (!application
.quit
) {
165 synchronized (application
.drainEventQueue
) {
166 if (application
.drainEventQueue
.size() > 0) {
175 timeout
= application
.getSleepTime(1000);
179 // A timer needs to fire, break out.
184 System
.err
.printf("%d %s %s sleep %d millis\n",
185 System
.currentTimeMillis(), this,
186 primary ?
"primary" : "secondary", timeout
);
189 synchronized (this) {
194 System
.err
.printf("%d %s %s AWAKE\n",
195 System
.currentTimeMillis(), this,
196 primary ?
"primary" : "secondary");
200 && (application
.secondaryEventReceiver
== null)
202 // Secondary thread, emergency exit. If we got
203 // here then something went wrong with the
204 // handoff between yield() and closeWindow().
205 synchronized (application
.primaryEventHandler
) {
206 application
.primaryEventHandler
.notify();
208 application
.secondaryEventHandler
= null;
209 throw new RuntimeException("secondary exited " +
213 } catch (InterruptedException e
) {
216 } // while (!application.quit)
218 // Pull all events off the queue
220 TInputEvent event
= null;
221 synchronized (application
.drainEventQueue
) {
222 if (application
.drainEventQueue
.size() == 0) {
225 event
= application
.drainEventQueue
.remove(0);
228 // We will have an event to process, so repaint the
229 // screen at the end.
230 application
.repaint
= true;
233 primaryHandleEvent(event
);
235 secondaryHandleEvent(event
);
238 && (application
.secondaryEventReceiver
== null)
240 // Secondary thread, time to exit.
242 // DO NOT UNLOCK. Primary thread just came back from
243 // primaryHandleEvent() and will unlock in the else
244 // block below. Just wake it up.
245 synchronized (application
.primaryEventHandler
) {
246 application
.primaryEventHandler
.notify();
248 // Now eliminate my reference so that
249 // wakeEventHandler() resumes working on the primary.
250 application
.secondaryEventHandler
= null;
258 // Fire timers, update screen.
260 application
.finishEventProcessing();
263 } // while (true) (main runnable loop)
268 * The primary event handler thread.
270 private volatile WidgetEventHandler primaryEventHandler
;
273 * The secondary event handler thread.
275 private volatile WidgetEventHandler secondaryEventHandler
;
278 * The widget receiving events from the secondary event handler thread.
280 private volatile TWidget secondaryEventReceiver
;
283 * Wake the sleeping active event handler.
285 private void wakeEventHandler() {
286 if (secondaryEventHandler
!= null) {
287 synchronized (secondaryEventHandler
) {
288 secondaryEventHandler
.notify();
291 assert (primaryEventHandler
!= null);
292 synchronized (primaryEventHandler
) {
293 primaryEventHandler
.notify();
298 // ------------------------------------------------------------------------
299 // TApplication attributes ------------------------------------------------
300 // ------------------------------------------------------------------------
303 * Access to the physical screen, keyboard, and mouse.
305 private Backend backend
;
310 * @return the Backend
312 public final Backend
getBackend() {
321 public final Screen
getScreen() {
322 if (backend
instanceof TWindowBackend
) {
323 // We are being rendered to a TWindow. We can't use its
324 // getScreen() method because that is how it is rendering to a
325 // hardware backend somewhere. Instead use its getOtherScreen()
327 return ((TWindowBackend
) backend
).getOtherScreen();
329 return backend
.getScreen();
334 * Actual mouse coordinate X.
339 * Actual mouse coordinate Y.
344 * Old version of mouse coordinate X.
346 private int oldMouseX
;
349 * Old version mouse coordinate Y.
351 private int oldMouseY
;
354 * The last mouse up click time, used to determine if this is a mouse
357 private long lastMouseUpTime
;
360 * The amount of millis between mouse up events to assume a double-click.
362 private long doubleClickTime
= 250;
365 * Event queue that is filled by run().
367 private List
<TInputEvent
> fillEventQueue
;
370 * Event queue that will be drained by either primary or secondary
373 private List
<TInputEvent
> drainEventQueue
;
376 * Top-level menus in this application.
378 private List
<TMenu
> menus
;
381 * Stack of activated sub-menus in this application.
383 private List
<TMenu
> subMenus
;
386 * The currently active menu.
388 private TMenu activeMenu
= null;
391 * Active keyboard accelerators.
393 private Map
<TKeypress
, TMenuItem
> accelerators
;
398 private List
<TMenuItem
> menuItems
;
401 * Windows and widgets pull colors from this ColorTheme.
403 private ColorTheme theme
;
406 * Get the color theme.
410 public final ColorTheme
getTheme() {
415 * The top-level windows (but not menus).
417 private List
<TWindow
> windows
;
420 * The currently acive window.
422 private TWindow activeWindow
= null;
425 * Timers that are being ticked.
427 private List
<TTimer
> timers
;
430 * When true, exit the application.
432 private volatile boolean quit
= false;
435 * When true, repaint the entire screen.
437 private volatile boolean repaint
= true;
440 * Repaint the screen on the next update.
442 public void doRepaint() {
448 * Y coordinate of the top edge of the desktop. For now this is a
449 * constant. Someday it would be nice to have a multi-line menu or
452 private static final int desktopTop
= 1;
455 * Get Y coordinate of the top edge of the desktop.
457 * @return Y coordinate of the top edge of the desktop
459 public final int getDesktopTop() {
464 * Y coordinate of the bottom edge of the desktop.
466 private int desktopBottom
;
469 * Get Y coordinate of the bottom edge of the desktop.
471 * @return Y coordinate of the bottom edge of the desktop
473 public final int getDesktopBottom() {
474 return desktopBottom
;
478 * An optional TDesktop background window that is drawn underneath
481 private TDesktop desktop
;
484 * Set the TDesktop instance.
486 * @param desktop a TDesktop instance, or null to remove the one that is
489 public final void setDesktop(final TDesktop desktop
) {
490 if (this.desktop
!= null) {
491 this.desktop
.onClose();
493 this.desktop
= desktop
;
497 * Get the TDesktop instance.
499 * @return the desktop, or null if it is not set
501 public final TDesktop
getDesktop() {
506 * Get the current active window.
508 * @return the active window, or null if it is not set
510 public final TWindow
getActiveWindow() {
515 * Get a (shallow) copy of the window list.
517 * @return a copy of the list of windows for this application
519 public final List
<TWindow
> getAllWindows() {
520 List
<TWindow
> result
= new LinkedList
<TWindow
>();
521 result
.addAll(windows
);
526 * If true, focus follows mouse: windows automatically raised if the
527 * mouse passes over them.
529 private boolean focusFollowsMouse
= false;
532 * Get focusFollowsMouse flag.
534 * @return true if focus follows mouse: windows automatically raised if
535 * the mouse passes over them
537 public boolean getFocusFollowsMouse() {
538 return focusFollowsMouse
;
542 * Set focusFollowsMouse flag.
544 * @param focusFollowsMouse if true, focus follows mouse: windows
545 * automatically raised if the mouse passes over them
547 public void setFocusFollowsMouse(final boolean focusFollowsMouse
) {
548 this.focusFollowsMouse
= focusFollowsMouse
;
551 // ------------------------------------------------------------------------
552 // General behavior -------------------------------------------------------
553 // ------------------------------------------------------------------------
556 * Display the about dialog.
558 protected void showAboutDialog() {
559 messageBox(i18n
.getString("aboutDialogTitle"),
560 MessageFormat
.format(i18n
.getString("aboutDialogText"),
561 this.getClass().getPackage().getImplementationVersion()),
562 TMessageBox
.Type
.OK
);
565 // ------------------------------------------------------------------------
566 // Constructors -----------------------------------------------------------
567 // ------------------------------------------------------------------------
570 * Public constructor.
572 * @param backendType BackendType.XTERM, BackendType.ECMA48 or
574 * @throws UnsupportedEncodingException if an exception is thrown when
575 * creating the InputStreamReader
577 public TApplication(final BackendType backendType
)
578 throws UnsupportedEncodingException
{
580 switch (backendType
) {
582 // The default SwingBackend is 80x25, 20 pt font. If you want to
583 // change that, you can pass the extra arguments to the
584 // SwingBackend constructor here. For example, if you wanted
585 // 90x30, 16 pt font:
587 // backend = new SwingBackend(this, 90, 30, 16);
588 backend
= new SwingBackend(this);
593 backend
= new ECMA48Backend(this, null, null);
596 throw new IllegalArgumentException("Invalid backend type: "
603 * Public constructor. The backend type will be BackendType.ECMA48.
605 * @param input an InputStream connected to the remote user, or null for
606 * System.in. If System.in is used, then on non-Windows systems it will
607 * be put in raw mode; shutdown() will (blindly!) put System.in in cooked
608 * mode. input is always converted to a Reader with UTF-8 encoding.
609 * @param output an OutputStream connected to the remote user, or null
610 * for System.out. output is always converted to a Writer with UTF-8
612 * @throws UnsupportedEncodingException if an exception is thrown when
613 * creating the InputStreamReader
615 public TApplication(final InputStream input
,
616 final OutputStream output
) throws UnsupportedEncodingException
{
618 backend
= new ECMA48Backend(this, input
, output
);
623 * Public constructor. The backend type will be BackendType.ECMA48.
625 * @param input the InputStream underlying 'reader'. Its available()
626 * method is used to determine if reader.read() will block or not.
627 * @param reader a Reader connected to the remote user.
628 * @param writer a PrintWriter connected to the remote user.
629 * @param setRawMode if true, set System.in into raw mode with stty.
630 * This should in general not be used. It is here solely for Demo3,
631 * which uses System.in.
632 * @throws IllegalArgumentException if input, reader, or writer are null.
634 public TApplication(final InputStream input
, final Reader reader
,
635 final PrintWriter writer
, final boolean setRawMode
) {
637 backend
= new ECMA48Backend(this, input
, reader
, writer
, setRawMode
);
642 * Public constructor. The backend type will be BackendType.ECMA48.
644 * @param input the InputStream underlying 'reader'. Its available()
645 * method is used to determine if reader.read() will block or not.
646 * @param reader a Reader connected to the remote user.
647 * @param writer a PrintWriter connected to the remote user.
648 * @throws IllegalArgumentException if input, reader, or writer are null.
650 public TApplication(final InputStream input
, final Reader reader
,
651 final PrintWriter writer
) {
653 this(input
, reader
, writer
, false);
657 * Public constructor. This hook enables use with new non-Jexer
660 * @param backend a Backend that is already ready to go.
662 public TApplication(final Backend backend
) {
663 this.backend
= backend
;
664 backend
.setListener(this);
669 * Finish construction once the backend is set.
671 private void TApplicationImpl() {
672 theme
= new ColorTheme();
673 desktopBottom
= getScreen().getHeight() - 1;
674 fillEventQueue
= new ArrayList
<TInputEvent
>();
675 drainEventQueue
= new ArrayList
<TInputEvent
>();
676 windows
= new LinkedList
<TWindow
>();
677 menus
= new LinkedList
<TMenu
>();
678 subMenus
= new LinkedList
<TMenu
>();
679 timers
= new LinkedList
<TTimer
>();
680 accelerators
= new HashMap
<TKeypress
, TMenuItem
>();
681 menuItems
= new ArrayList
<TMenuItem
>();
682 desktop
= new TDesktop(this);
684 // Special case: the Swing backend needs to have a timer to drive its
686 if ((backend
instanceof SwingBackend
)
687 || (backend
instanceof MultiBackend
)
689 // Default to 500 millis, unless a SwingBackend has its own
692 if (backend
instanceof SwingBackend
) {
693 millis
= ((SwingBackend
) backend
).getBlinkMillis();
696 addTimer(millis
, true,
699 TApplication
.this.doRepaint();
707 // ------------------------------------------------------------------------
708 // Screen refresh loop ----------------------------------------------------
709 // ------------------------------------------------------------------------
712 * Process background events, and update the screen.
714 private void finishEventProcessing() {
716 System
.err
.printf(System
.currentTimeMillis() + " " +
717 Thread
.currentThread() + " finishEventProcessing()\n");
720 // Process timers and call doIdle()'s
724 synchronized (getScreen()) {
729 System
.err
.printf(System
.currentTimeMillis() + " " +
730 Thread
.currentThread() + " finishEventProcessing() END\n");
735 * Invert the cell color at a position. This is used to track the mouse.
737 * @param x column position
738 * @param y row position
740 private void invertCell(final int x
, final int y
) {
742 System
.err
.printf("%d %s invertCell() %d %d\n",
743 System
.currentTimeMillis(), Thread
.currentThread(), x
, y
);
745 CellAttributes attr
= getScreen().getAttrXY(x
, y
);
746 attr
.setForeColor(attr
.getForeColor().invert());
747 attr
.setBackColor(attr
.getBackColor().invert());
748 getScreen().putAttrXY(x
, y
, attr
, false);
754 private void drawAll() {
755 boolean menuIsActive
= false;
758 System
.err
.printf("%d %s drawAll() enter\n",
759 System
.currentTimeMillis(), Thread
.currentThread());
764 System
.err
.printf("%d %s drawAll() !repaint\n",
765 System
.currentTimeMillis(), Thread
.currentThread());
767 synchronized (getScreen()) {
768 if ((oldMouseX
!= mouseX
) || (oldMouseY
!= mouseY
)) {
769 // The only thing that has happened is the mouse moved.
770 // Clear the old position and draw the new position.
771 invertCell(oldMouseX
, oldMouseY
);
772 invertCell(mouseX
, mouseY
);
776 if (getScreen().isDirty()) {
777 backend
.flushScreen();
784 System
.err
.printf("%d %s drawAll() REDRAW\n",
785 System
.currentTimeMillis(), Thread
.currentThread());
788 // If true, the cursor is not visible
789 boolean cursor
= false;
791 // Start with a clean screen
795 if (desktop
!= null) {
796 desktop
.drawChildren();
799 // Draw each window in reverse Z order
800 List
<TWindow
> sorted
= new LinkedList
<TWindow
>(windows
);
801 Collections
.sort(sorted
);
802 TWindow topLevel
= null;
803 if (sorted
.size() > 0) {
804 topLevel
= sorted
.get(0);
806 Collections
.reverse(sorted
);
807 for (TWindow window
: sorted
) {
808 if (window
.isShown()) {
809 window
.drawChildren();
813 // Draw the blank menubar line - reset the screen clipping first so
814 // it won't trim it out.
815 getScreen().resetClipping();
816 getScreen().hLineXY(0, 0, getScreen().getWidth(), ' ',
817 theme
.getColor("tmenu"));
818 // Now draw the menus.
820 for (TMenu menu
: menus
) {
821 CellAttributes menuColor
;
822 CellAttributes menuMnemonicColor
;
823 if (menu
.isActive()) {
825 menuColor
= theme
.getColor("tmenu.highlighted");
826 menuMnemonicColor
= theme
.getColor("tmenu.mnemonic.highlighted");
829 menuColor
= theme
.getColor("tmenu");
830 menuMnemonicColor
= theme
.getColor("tmenu.mnemonic");
832 // Draw the menu title
833 getScreen().hLineXY(x
, 0, menu
.getTitle().length() + 2, ' ',
835 getScreen().putStringXY(x
+ 1, 0, menu
.getTitle(), menuColor
);
836 // Draw the highlight character
837 getScreen().putCharXY(x
+ 1 + menu
.getMnemonic().getShortcutIdx(),
838 0, menu
.getMnemonic().getShortcut(), menuMnemonicColor
);
840 if (menu
.isActive()) {
842 // Reset the screen clipping so we can draw the next title.
843 getScreen().resetClipping();
845 x
+= menu
.getTitle().length() + 2;
848 for (TMenu menu
: subMenus
) {
849 // Reset the screen clipping so we can draw the next sub-menu.
850 getScreen().resetClipping();
854 // Draw the status bar of the top-level window
855 TStatusBar statusBar
= null;
856 if (topLevel
!= null) {
857 statusBar
= topLevel
.getStatusBar();
859 if (statusBar
!= null) {
860 getScreen().resetClipping();
861 statusBar
.setWidth(getScreen().getWidth());
862 statusBar
.setY(getScreen().getHeight() - topLevel
.getY());
865 CellAttributes barColor
= new CellAttributes();
866 barColor
.setTo(getTheme().getColor("tstatusbar.text"));
867 getScreen().hLineXY(0, desktopBottom
, getScreen().getWidth(), ' ',
871 // Draw the mouse pointer
872 invertCell(mouseX
, mouseY
);
876 // Place the cursor if it is visible
878 TWidget activeWidget
= null;
879 if (sorted
.size() > 0) {
880 activeWidget
= sorted
.get(sorted
.size() - 1).getActiveChild();
881 if (activeWidget
.isCursorVisible()) {
882 if ((activeWidget
.getCursorAbsoluteY() < desktopBottom
)
883 && (activeWidget
.getCursorAbsoluteY() > desktopTop
)
885 getScreen().putCursor(true,
886 activeWidget
.getCursorAbsoluteX(),
887 activeWidget
.getCursorAbsoluteY());
890 getScreen().putCursor(false,
891 activeWidget
.getCursorAbsoluteX(),
892 activeWidget
.getCursorAbsoluteY());
901 getScreen().hideCursor();
904 // Flush the screen contents
905 if (getScreen().isDirty()) {
906 backend
.flushScreen();
912 // ------------------------------------------------------------------------
913 // Main loop --------------------------------------------------------------
914 // ------------------------------------------------------------------------
917 * Force this application to exit.
921 synchronized (this) {
927 * Run this application until it exits.
930 // Start the main consumer thread
931 primaryEventHandler
= new WidgetEventHandler(this, true);
932 (new Thread(primaryEventHandler
)).start();
935 synchronized (this) {
936 boolean doWait
= false;
938 synchronized (fillEventQueue
) {
939 if (fillEventQueue
.size() == 0) {
945 // No I/O to dispatch, so wait until the backend
949 System
.err
.println(System
.currentTimeMillis() +
956 System
.err
.println(System
.currentTimeMillis() +
959 } catch (InterruptedException e
) {
960 // I'm awake and don't care why, let's see what's
961 // going on out there.
965 } // synchronized (this)
967 synchronized (fillEventQueue
) {
968 // Pull any pending I/O events
969 backend
.getEvents(fillEventQueue
);
971 // Dispatch each event to the appropriate handler, one at a
974 TInputEvent event
= null;
975 if (fillEventQueue
.size() == 0) {
978 event
= fillEventQueue
.remove(0);
979 metaHandleEvent(event
);
983 // Wake a consumer thread if we have any pending events.
984 if (drainEventQueue
.size() > 0) {
990 // Shutdown the event consumer threads
991 if (secondaryEventHandler
!= null) {
992 synchronized (secondaryEventHandler
) {
993 secondaryEventHandler
.notify();
996 if (primaryEventHandler
!= null) {
997 synchronized (primaryEventHandler
) {
998 primaryEventHandler
.notify();
1002 // Shutdown the user I/O thread(s)
1005 // Close all the windows. This gives them an opportunity to release
1012 * Peek at certain application-level events, add to eventQueue, and wake
1013 * up the consuming Thread.
1015 * @param event the input event to consume
1017 private void metaHandleEvent(final TInputEvent event
) {
1020 System
.err
.printf(String
.format("metaHandleEvents event: %s\n",
1021 event
)); System
.err
.flush();
1025 // Do no more processing if the application is already trying
1030 // Special application-wide events -------------------------------
1033 if (event
instanceof TCommandEvent
) {
1034 TCommandEvent command
= (TCommandEvent
) event
;
1035 if (command
.getCmd().equals(cmAbort
)) {
1041 synchronized (drainEventQueue
) {
1043 if (event
instanceof TResizeEvent
) {
1044 TResizeEvent resize
= (TResizeEvent
) event
;
1045 synchronized (getScreen()) {
1046 getScreen().setDimensions(resize
.getWidth(),
1047 resize
.getHeight());
1048 desktopBottom
= getScreen().getHeight() - 1;
1054 if (desktop
!= null) {
1055 desktop
.setDimensions(0, 0, resize
.getWidth(),
1056 resize
.getHeight() - 1);
1059 // Change menu edges if needed.
1062 // We are dirty, redraw the screen.
1067 // Put into the main queue
1068 drainEventQueue
.add(event
);
1073 * Dispatch one event to the appropriate widget or application-level
1074 * event handler. This is the primary event handler, it has the normal
1075 * application-wide event handling.
1077 * @param event the input event to consume
1078 * @see #secondaryHandleEvent(TInputEvent event)
1080 private void primaryHandleEvent(final TInputEvent event
) {
1083 System
.err
.printf("Handle event: %s\n", event
);
1085 TMouseEvent doubleClick
= null;
1087 // Special application-wide events -----------------------------------
1089 // Peek at the mouse position
1090 if (event
instanceof TMouseEvent
) {
1091 TMouseEvent mouse
= (TMouseEvent
) event
;
1092 if ((mouseX
!= mouse
.getX()) || (mouseY
!= mouse
.getY())) {
1095 mouseX
= mouse
.getX();
1096 mouseY
= mouse
.getY();
1098 if (mouse
.getType() == TMouseEvent
.Type
.MOUSE_UP
) {
1099 if ((mouse
.getTime().getTime() - lastMouseUpTime
) <
1102 // This is a double-click.
1103 doubleClick
= new TMouseEvent(TMouseEvent
.Type
.
1105 mouse
.getX(), mouse
.getY(),
1106 mouse
.getAbsoluteX(), mouse
.getAbsoluteY(),
1107 mouse
.isMouse1(), mouse
.isMouse2(),
1109 mouse
.isMouseWheelUp(), mouse
.isMouseWheelDown());
1112 // The first click of a potential double-click.
1113 lastMouseUpTime
= mouse
.getTime().getTime();
1118 // See if we need to switch focus to another window or the menu
1119 checkSwitchFocus((TMouseEvent
) event
);
1122 // Handle menu events
1123 if ((activeMenu
!= null) && !(event
instanceof TCommandEvent
)) {
1124 TMenu menu
= activeMenu
;
1126 if (event
instanceof TMouseEvent
) {
1127 TMouseEvent mouse
= (TMouseEvent
) event
;
1129 while (subMenus
.size() > 0) {
1130 TMenu subMenu
= subMenus
.get(subMenus
.size() - 1);
1131 if (subMenu
.mouseWouldHit(mouse
)) {
1134 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_MOTION
)
1135 && (!mouse
.isMouse1())
1136 && (!mouse
.isMouse2())
1137 && (!mouse
.isMouse3())
1138 && (!mouse
.isMouseWheelUp())
1139 && (!mouse
.isMouseWheelDown())
1143 // We navigated away from a sub-menu, so close it
1147 // Convert the mouse relative x/y to menu coordinates
1148 assert (mouse
.getX() == mouse
.getAbsoluteX());
1149 assert (mouse
.getY() == mouse
.getAbsoluteY());
1150 if (subMenus
.size() > 0) {
1151 menu
= subMenus
.get(subMenus
.size() - 1);
1153 mouse
.setX(mouse
.getX() - menu
.getX());
1154 mouse
.setY(mouse
.getY() - menu
.getY());
1156 menu
.handleEvent(event
);
1160 if (event
instanceof TKeypressEvent
) {
1161 TKeypressEvent keypress
= (TKeypressEvent
) event
;
1163 // See if this key matches an accelerator, and is not being
1164 // shortcutted by the active window, and if so dispatch the menu
1166 boolean windowWillShortcut
= false;
1167 if (activeWindow
!= null) {
1168 assert (activeWindow
.isShown());
1169 if (activeWindow
.isShortcutKeypress(keypress
.getKey())) {
1170 // We do not process this key, it will be passed to the
1172 windowWillShortcut
= true;
1176 if (!windowWillShortcut
&& !modalWindowActive()) {
1177 TKeypress keypressLowercase
= keypress
.getKey().toLowerCase();
1178 TMenuItem item
= null;
1179 synchronized (accelerators
) {
1180 item
= accelerators
.get(keypressLowercase
);
1183 if (item
.isEnabled()) {
1184 // Let the menu item dispatch
1190 // Handle the keypress
1191 if (onKeypress(keypress
)) {
1197 if (event
instanceof TCommandEvent
) {
1198 if (onCommand((TCommandEvent
) event
)) {
1203 if (event
instanceof TMenuEvent
) {
1204 if (onMenu((TMenuEvent
) event
)) {
1209 // Dispatch events to the active window -------------------------------
1210 boolean dispatchToDesktop
= true;
1211 TWindow window
= activeWindow
;
1212 if (window
!= null) {
1213 assert (window
.isActive());
1214 assert (window
.isShown());
1215 if (event
instanceof TMouseEvent
) {
1216 TMouseEvent mouse
= (TMouseEvent
) event
;
1217 // Convert the mouse relative x/y to window coordinates
1218 assert (mouse
.getX() == mouse
.getAbsoluteX());
1219 assert (mouse
.getY() == mouse
.getAbsoluteY());
1220 mouse
.setX(mouse
.getX() - window
.getX());
1221 mouse
.setY(mouse
.getY() - window
.getY());
1223 if (doubleClick
!= null) {
1224 doubleClick
.setX(doubleClick
.getX() - window
.getX());
1225 doubleClick
.setY(doubleClick
.getY() - window
.getY());
1228 if (window
.mouseWouldHit(mouse
)) {
1229 dispatchToDesktop
= false;
1231 } else if (event
instanceof TKeypressEvent
) {
1232 dispatchToDesktop
= false;
1236 System
.err
.printf("TApplication dispatch event: %s\n",
1239 window
.handleEvent(event
);
1240 if (doubleClick
!= null) {
1241 window
.handleEvent(doubleClick
);
1244 if (dispatchToDesktop
) {
1245 // This event is fair game for the desktop to process.
1246 if (desktop
!= null) {
1247 desktop
.handleEvent(event
);
1248 if (doubleClick
!= null) {
1249 desktop
.handleEvent(doubleClick
);
1256 * Dispatch one event to the appropriate widget or application-level
1257 * event handler. This is the secondary event handler used by certain
1258 * special dialogs (currently TMessageBox and TFileOpenBox).
1260 * @param event the input event to consume
1261 * @see #primaryHandleEvent(TInputEvent event)
1263 private void secondaryHandleEvent(final TInputEvent event
) {
1264 TMouseEvent doubleClick
= null;
1266 // Peek at the mouse position
1267 if (event
instanceof TMouseEvent
) {
1268 TMouseEvent mouse
= (TMouseEvent
) event
;
1269 if ((mouseX
!= mouse
.getX()) || (mouseY
!= mouse
.getY())) {
1272 mouseX
= mouse
.getX();
1273 mouseY
= mouse
.getY();
1275 if (mouse
.getType() == TMouseEvent
.Type
.MOUSE_UP
) {
1276 if ((mouse
.getTime().getTime() - lastMouseUpTime
) <
1279 // This is a double-click.
1280 doubleClick
= new TMouseEvent(TMouseEvent
.Type
.
1282 mouse
.getX(), mouse
.getY(),
1283 mouse
.getAbsoluteX(), mouse
.getAbsoluteY(),
1284 mouse
.isMouse1(), mouse
.isMouse2(),
1286 mouse
.isMouseWheelUp(), mouse
.isMouseWheelDown());
1289 // The first click of a potential double-click.
1290 lastMouseUpTime
= mouse
.getTime().getTime();
1296 secondaryEventReceiver
.handleEvent(event
);
1297 if (doubleClick
!= null) {
1298 secondaryEventReceiver
.handleEvent(doubleClick
);
1303 * Enable a widget to override the primary event thread.
1305 * @param widget widget that will receive events
1307 public final void enableSecondaryEventReceiver(final TWidget widget
) {
1309 System
.err
.println(System
.currentTimeMillis() +
1310 " enableSecondaryEventReceiver()");
1313 assert (secondaryEventReceiver
== null);
1314 assert (secondaryEventHandler
== null);
1315 assert ((widget
instanceof TMessageBox
)
1316 || (widget
instanceof TFileOpenBox
));
1317 secondaryEventReceiver
= widget
;
1318 secondaryEventHandler
= new WidgetEventHandler(this, false);
1320 (new Thread(secondaryEventHandler
)).start();
1324 * Yield to the secondary thread.
1326 public final void yield() {
1327 assert (secondaryEventReceiver
!= null);
1329 while (secondaryEventReceiver
!= null) {
1330 synchronized (primaryEventHandler
) {
1332 primaryEventHandler
.wait();
1333 } catch (InterruptedException e
) {
1341 * Do stuff when there is no user input.
1343 private void doIdle() {
1345 System
.err
.printf(System
.currentTimeMillis() + " " +
1346 Thread
.currentThread() + " doIdle()\n");
1349 synchronized (timers
) {
1352 System
.err
.printf(System
.currentTimeMillis() + " " +
1353 Thread
.currentThread() + " doIdle() 2\n");
1356 // Run any timers that have timed out
1357 Date now
= new Date();
1358 List
<TTimer
> keepTimers
= new LinkedList
<TTimer
>();
1359 for (TTimer timer
: timers
) {
1360 if (timer
.getNextTick().getTime() <= now
.getTime()) {
1361 // Something might change, so repaint the screen.
1364 if (timer
.recurring
) {
1365 keepTimers
.add(timer
);
1368 keepTimers
.add(timer
);
1371 timers
= keepTimers
;
1375 for (TWindow window
: windows
) {
1378 if (desktop
!= null) {
1383 // ------------------------------------------------------------------------
1384 // TWindow management -----------------------------------------------------
1385 // ------------------------------------------------------------------------
1388 * Return the total number of windows.
1390 * @return the total number of windows
1392 public final int windowCount() {
1393 return windows
.size();
1397 * Return the number of windows that are showing.
1399 * @return the number of windows that are showing on screen
1401 public final int shownWindowCount() {
1403 for (TWindow w
: windows
) {
1412 * Return the number of windows that are hidden.
1414 * @return the number of windows that are hidden
1416 public final int hiddenWindowCount() {
1418 for (TWindow w
: windows
) {
1427 * Check if a window instance is in this application's window list.
1429 * @param window window to look for
1430 * @return true if this window is in the list
1432 public final boolean hasWindow(final TWindow window
) {
1433 if (windows
.size() == 0) {
1436 for (TWindow w
: windows
) {
1438 assert (window
.getApplication() == this);
1446 * Activate a window: bring it to the top and have it receive events.
1448 * @param window the window to become the new active window
1450 public void activateWindow(final TWindow window
) {
1451 if (hasWindow(window
) == false) {
1453 * Someone has a handle to a window I don't have. Ignore this
1459 // Whatever window might be moving/dragging, stop it now.
1460 for (TWindow w
: windows
) {
1461 if (w
.inMovements()) {
1466 assert (windows
.size() > 0);
1468 if (window
.isHidden()) {
1469 // Unhiding will also activate.
1473 assert (window
.isShown());
1475 if (windows
.size() == 1) {
1476 assert (window
== windows
.get(0));
1477 if (activeWindow
== null) {
1478 activeWindow
= window
;
1480 activeWindow
.setActive(true);
1481 activeWindow
.onFocus();
1484 assert (window
.isActive());
1485 assert (activeWindow
== window
);
1489 if (activeWindow
== window
) {
1490 assert (window
.isActive());
1492 // Window is already active, do nothing.
1496 assert (!window
.isActive());
1497 if (activeWindow
!= null) {
1498 assert (activeWindow
.getZ() == 0);
1500 activeWindow
.setActive(false);
1501 activeWindow
.setZ(window
.getZ());
1503 // Unset activeWindow now before unfocus, so that a window
1504 // lifecycle change inside onUnfocus() doesn't call
1505 // switchWindow() and lead to a stack overflow.
1506 TWindow oldActiveWindow
= activeWindow
;
1507 activeWindow
= null;
1508 oldActiveWindow
.onUnfocus();
1510 activeWindow
= window
;
1511 activeWindow
.setZ(0);
1512 activeWindow
.setActive(true);
1513 activeWindow
.onFocus();
1520 * @param window the window to hide
1522 public void hideWindow(final TWindow window
) {
1523 if (hasWindow(window
) == false) {
1525 * Someone has a handle to a window I don't have. Ignore this
1531 // Whatever window might be moving/dragging, stop it now.
1532 for (TWindow w
: windows
) {
1533 if (w
.inMovements()) {
1538 assert (windows
.size() > 0);
1540 if (!window
.hidden
) {
1541 if (window
== activeWindow
) {
1542 if (shownWindowCount() > 1) {
1545 activeWindow
= null;
1546 window
.setActive(false);
1550 window
.hidden
= true;
1558 * @param window the window to show
1560 public void showWindow(final TWindow window
) {
1561 if (hasWindow(window
) == false) {
1563 * Someone has a handle to a window I don't have. Ignore this
1569 // Whatever window might be moving/dragging, stop it now.
1570 for (TWindow w
: windows
) {
1571 if (w
.inMovements()) {
1576 assert (windows
.size() > 0);
1578 if (window
.hidden
) {
1579 window
.hidden
= false;
1581 activateWindow(window
);
1586 * Close window. Note that the window's destructor is NOT called by this
1587 * method, instead the GC is assumed to do the cleanup.
1589 * @param window the window to remove
1591 public final void closeWindow(final TWindow window
) {
1592 if (hasWindow(window
) == false) {
1594 * Someone has a handle to a window I don't have. Ignore this
1600 synchronized (windows
) {
1601 // Whatever window might be moving/dragging, stop it now.
1602 for (TWindow w
: windows
) {
1603 if (w
.inMovements()) {
1608 int z
= window
.getZ();
1611 Collections
.sort(windows
);
1613 activeWindow
= null;
1614 for (TWindow w
: windows
) {
1616 w
.setZ(w
.getZ() - 1);
1617 if (w
.getZ() == 0) {
1620 assert (activeWindow
== null);
1632 // Perform window cleanup
1635 // Check if we are closing a TMessageBox or similar
1636 if (secondaryEventReceiver
!= null) {
1637 assert (secondaryEventHandler
!= null);
1639 // Do not send events to the secondaryEventReceiver anymore, the
1640 // window is closed.
1641 secondaryEventReceiver
= null;
1643 // Wake the secondary thread, it will wake the primary as it
1645 synchronized (secondaryEventHandler
) {
1646 secondaryEventHandler
.notify();
1650 // Permit desktop to be active if it is the only thing left.
1651 if (desktop
!= null) {
1652 if (windows
.size() == 0) {
1653 desktop
.setActive(true);
1659 * Switch to the next window.
1661 * @param forward if true, then switch to the next window in the list,
1662 * otherwise switch to the previous window in the list
1664 public final void switchWindow(final boolean forward
) {
1665 // Only switch if there are multiple visible windows
1666 if (shownWindowCount() < 2) {
1669 assert (activeWindow
!= null);
1671 synchronized (windows
) {
1672 // Whatever window might be moving/dragging, stop it now.
1673 for (TWindow w
: windows
) {
1674 if (w
.inMovements()) {
1679 // Swap z/active between active window and the next in the list
1680 int activeWindowI
= -1;
1681 for (int i
= 0; i
< windows
.size(); i
++) {
1682 if (windows
.get(i
) == activeWindow
) {
1683 assert (activeWindow
.isActive());
1687 assert (!windows
.get(0).isActive());
1690 assert (activeWindowI
>= 0);
1692 // Do not switch if a window is modal
1693 if (activeWindow
.isModal()) {
1697 int nextWindowI
= activeWindowI
;
1701 nextWindowI
%= windows
.size();
1704 if (nextWindowI
< 0) {
1705 nextWindowI
= windows
.size() - 1;
1709 if (windows
.get(nextWindowI
).isShown()) {
1710 activateWindow(windows
.get(nextWindowI
));
1714 } // synchronized (windows)
1719 * Add a window to my window list and make it active.
1721 * @param window new window to add
1723 public final void addWindow(final TWindow window
) {
1725 // Do not add menu windows to the window list.
1726 if (window
instanceof TMenu
) {
1730 // Do not add the desktop to the window list.
1731 if (window
instanceof TDesktop
) {
1735 synchronized (windows
) {
1736 // Whatever window might be moving/dragging, stop it now.
1737 for (TWindow w
: windows
) {
1738 if (w
.inMovements()) {
1743 // Do not allow a modal window to spawn a non-modal window. If a
1744 // modal window is active, then this window will become modal
1746 if (modalWindowActive()) {
1747 window
.flags
|= TWindow
.MODAL
;
1748 window
.flags
|= TWindow
.CENTERED
;
1749 window
.hidden
= false;
1751 if (window
.isShown()) {
1752 for (TWindow w
: windows
) {
1757 w
.setZ(w
.getZ() + 1);
1760 windows
.add(window
);
1761 if (window
.isShown()) {
1762 activeWindow
= window
;
1763 activeWindow
.setZ(0);
1764 activeWindow
.setActive(true);
1765 activeWindow
.onFocus();
1768 if (((window
.flags
& TWindow
.CENTERED
) == 0)
1769 && smartWindowPlacement
) {
1771 doSmartPlacement(window
);
1775 // Desktop cannot be active over any other window.
1776 if (desktop
!= null) {
1777 desktop
.setActive(false);
1782 * Check if there is a system-modal window on top.
1784 * @return true if the active window is modal
1786 private boolean modalWindowActive() {
1787 if (windows
.size() == 0) {
1791 for (TWindow w
: windows
) {
1801 * Close all open windows.
1803 private void closeAllWindows() {
1804 // Don't do anything if we are in the menu
1805 if (activeMenu
!= null) {
1808 while (windows
.size() > 0) {
1809 closeWindow(windows
.get(0));
1814 * Re-layout the open windows as non-overlapping tiles. This produces
1815 * almost the same results as Turbo Pascal 7.0's IDE.
1817 private void tileWindows() {
1818 synchronized (windows
) {
1819 // Don't do anything if we are in the menu
1820 if (activeMenu
!= null) {
1823 int z
= windows
.size();
1829 a
= (int)(Math
.sqrt(z
));
1833 if (((a
* b
) + c
) == z
) {
1841 int newWidth
= (getScreen().getWidth() / a
);
1842 int newHeight1
= ((getScreen().getHeight() - 1) / b
);
1843 int newHeight2
= ((getScreen().getHeight() - 1) / (b
+ c
));
1845 List
<TWindow
> sorted
= new LinkedList
<TWindow
>(windows
);
1846 Collections
.sort(sorted
);
1847 Collections
.reverse(sorted
);
1848 for (int i
= 0; i
< sorted
.size(); i
++) {
1849 int logicalX
= i
/ b
;
1850 int logicalY
= i
% b
;
1851 if (i
>= ((a
- 1) * b
)) {
1853 logicalY
= i
- ((a
- 1) * b
);
1856 TWindow w
= sorted
.get(i
);
1857 w
.setX(logicalX
* newWidth
);
1858 w
.setWidth(newWidth
);
1859 if (i
>= ((a
- 1) * b
)) {
1860 w
.setY((logicalY
* newHeight2
) + 1);
1861 w
.setHeight(newHeight2
);
1863 w
.setY((logicalY
* newHeight1
) + 1);
1864 w
.setHeight(newHeight1
);
1871 * Re-layout the open windows as overlapping cascaded windows.
1873 private void cascadeWindows() {
1874 synchronized (windows
) {
1875 // Don't do anything if we are in the menu
1876 if (activeMenu
!= null) {
1881 List
<TWindow
> sorted
= new LinkedList
<TWindow
>(windows
);
1882 Collections
.sort(sorted
);
1883 Collections
.reverse(sorted
);
1884 for (TWindow window
: sorted
) {
1889 if (x
> getScreen().getWidth()) {
1892 if (y
>= getScreen().getHeight()) {
1900 * Place a window to minimize its overlap with other windows.
1902 * @param window the window to place
1904 public final void doSmartPlacement(final TWindow window
) {
1905 // This is a pretty dumb algorithm, but seems to work. The hardest
1906 // part is computing these "overlap" values seeking a minimum average
1909 int yMin
= desktopTop
;
1910 int xMax
= getScreen().getWidth() - window
.getWidth() + 1;
1911 int yMax
= desktopBottom
- window
.getHeight() + 1;
1919 if ((xMin
== xMax
) && (yMin
== yMax
)) {
1920 // No work to do, bail out.
1924 // Compute the overlap matrix without the new window.
1925 int width
= getScreen().getWidth();
1926 int height
= getScreen().getHeight();
1927 int overlapMatrix
[][] = new int[width
][height
];
1928 for (TWindow w
: windows
) {
1932 for (int x
= w
.getX(); x
< w
.getX() + w
.getWidth(); x
++) {
1936 for (int y
= w
.getY(); y
< w
.getY() + w
.getHeight(); y
++) {
1940 overlapMatrix
[x
][y
]++;
1945 long oldOverlapTotal
= 0;
1946 long oldOverlapN
= 0;
1947 for (int x
= 0; x
< width
; x
++) {
1948 for (int y
= 0; y
< height
; y
++) {
1949 oldOverlapTotal
+= overlapMatrix
[x
][y
];
1950 if (overlapMatrix
[x
][y
] > 0) {
1957 double oldOverlapAvg
= (double) oldOverlapTotal
/ (double) oldOverlapN
;
1958 boolean first
= true;
1959 int windowX
= window
.getX();
1960 int windowY
= window
.getY();
1962 // For each possible (x, y) position for the new window, compute a
1963 // new overlap matrix.
1964 for (int x
= xMin
; x
< xMax
; x
++) {
1965 for (int y
= yMin
; y
< yMax
; y
++) {
1967 // Start with the matrix minus this window.
1968 int newMatrix
[][] = new int[width
][height
];
1969 for (int mx
= 0; mx
< width
; mx
++) {
1970 for (int my
= 0; my
< height
; my
++) {
1971 newMatrix
[mx
][my
] = overlapMatrix
[mx
][my
];
1975 // Add this window's values to the new overlap matrix.
1976 long newOverlapTotal
= 0;
1977 long newOverlapN
= 0;
1978 // Start by adding each new cell.
1979 for (int wx
= x
; wx
< x
+ window
.getWidth(); wx
++) {
1983 for (int wy
= y
; wy
< y
+ window
.getHeight(); wy
++) {
1987 newMatrix
[wx
][wy
]++;
1990 // Now figure out the new value for total coverage.
1991 for (int mx
= 0; mx
< width
; mx
++) {
1992 for (int my
= 0; my
< height
; my
++) {
1993 newOverlapTotal
+= newMatrix
[x
][y
];
1994 if (newMatrix
[mx
][my
] > 0) {
1999 double newOverlapAvg
= (double) newOverlapTotal
/ (double) newOverlapN
;
2002 // First time: just record what we got.
2003 oldOverlapAvg
= newOverlapAvg
;
2006 // All other times: pick a new best (x, y) and save the
2008 if (newOverlapAvg
< oldOverlapAvg
) {
2011 oldOverlapAvg
= newOverlapAvg
;
2015 } // for (int x = xMin; x < xMax; x++)
2017 } // for (int y = yMin; y < yMax; y++)
2019 // Finally, set the window's new coordinates.
2020 window
.setX(windowX
);
2021 window
.setY(windowY
);
2024 // ------------------------------------------------------------------------
2025 // TMenu management -------------------------------------------------------
2026 // ------------------------------------------------------------------------
2029 * Check if a mouse event would hit either the active menu or any open
2032 * @param mouse mouse event
2033 * @return true if the mouse would hit the active menu or an open
2036 private boolean mouseOnMenu(final TMouseEvent mouse
) {
2037 assert (activeMenu
!= null);
2038 List
<TMenu
> menus
= new LinkedList
<TMenu
>(subMenus
);
2039 Collections
.reverse(menus
);
2040 for (TMenu menu
: menus
) {
2041 if (menu
.mouseWouldHit(mouse
)) {
2045 return activeMenu
.mouseWouldHit(mouse
);
2049 * See if we need to switch window or activate the menu based on
2052 * @param mouse mouse event
2054 private void checkSwitchFocus(final TMouseEvent mouse
) {
2056 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
2057 && (activeMenu
!= null)
2058 && (mouse
.getAbsoluteY() != 0)
2059 && (!mouseOnMenu(mouse
))
2061 // They clicked outside the active menu, turn it off
2062 activeMenu
.setActive(false);
2064 for (TMenu menu
: subMenus
) {
2065 menu
.setActive(false);
2071 // See if they hit the menu bar
2072 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
2073 && (mouse
.isMouse1())
2074 && (!modalWindowActive())
2075 && (mouse
.getAbsoluteY() == 0)
2078 for (TMenu menu
: subMenus
) {
2079 menu
.setActive(false);
2083 // They selected the menu, go activate it
2084 for (TMenu menu
: menus
) {
2085 if ((mouse
.getAbsoluteX() >= menu
.getTitleX())
2086 && (mouse
.getAbsoluteX() < menu
.getTitleX()
2087 + menu
.getTitle().length() + 2)
2089 menu
.setActive(true);
2092 menu
.setActive(false);
2098 // See if they hit the menu bar
2099 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_MOTION
)
2100 && (mouse
.isMouse1())
2101 && (activeMenu
!= null)
2102 && (mouse
.getAbsoluteY() == 0)
2105 TMenu oldMenu
= activeMenu
;
2106 for (TMenu menu
: subMenus
) {
2107 menu
.setActive(false);
2111 // See if we should switch menus
2112 for (TMenu menu
: menus
) {
2113 if ((mouse
.getAbsoluteX() >= menu
.getTitleX())
2114 && (mouse
.getAbsoluteX() < menu
.getTitleX()
2115 + menu
.getTitle().length() + 2)
2117 menu
.setActive(true);
2121 if (oldMenu
!= activeMenu
) {
2122 // They switched menus
2123 oldMenu
.setActive(false);
2128 // If a menu is still active, don't switch windows
2129 if (activeMenu
!= null) {
2133 // Only switch if there are multiple windows
2134 if (windows
.size() < 2) {
2138 if (((focusFollowsMouse
== true)
2139 && (mouse
.getType() == TMouseEvent
.Type
.MOUSE_MOTION
))
2140 || (mouse
.getType() == TMouseEvent
.Type
.MOUSE_UP
)
2142 synchronized (windows
) {
2143 Collections
.sort(windows
);
2144 if (windows
.get(0).isModal()) {
2145 // Modal windows don't switch
2149 for (TWindow window
: windows
) {
2150 assert (!window
.isModal());
2152 if (window
.isHidden()) {
2153 assert (!window
.isActive());
2157 if (window
.mouseWouldHit(mouse
)) {
2158 if (window
== windows
.get(0)) {
2159 // Clicked on the same window, nothing to do
2160 assert (window
.isActive());
2164 // We will be switching to another window
2165 assert (windows
.get(0).isActive());
2166 assert (windows
.get(0) == activeWindow
);
2167 assert (!window
.isActive());
2168 activeWindow
.onUnfocus();
2169 activeWindow
.setActive(false);
2170 activeWindow
.setZ(window
.getZ());
2171 activeWindow
= window
;
2173 window
.setActive(true);
2180 // Clicked on the background, nothing to do
2184 // Nothing to do: this isn't a mouse up, or focus isn't following
2190 * Turn off the menu.
2192 public final void closeMenu() {
2193 if (activeMenu
!= null) {
2194 activeMenu
.setActive(false);
2196 for (TMenu menu
: subMenus
) {
2197 menu
.setActive(false);
2204 * Get a (shallow) copy of the menu list.
2206 * @return a copy of the menu list
2208 public final List
<TMenu
> getAllMenus() {
2209 return new LinkedList
<TMenu
>(menus
);
2213 * Add a top-level menu to the list.
2215 * @param menu the menu to add
2216 * @throws IllegalArgumentException if the menu is already used in
2217 * another TApplication
2219 public final void addMenu(final TMenu menu
) {
2220 if ((menu
.getApplication() != null)
2221 && (menu
.getApplication() != this)
2223 throw new IllegalArgumentException("Menu " + menu
+ " is already " +
2224 "part of application " + menu
.getApplication());
2232 * Remove a top-level menu from the list.
2234 * @param menu the menu to remove
2235 * @throws IllegalArgumentException if the menu is already used in
2236 * another TApplication
2238 public final void removeMenu(final TMenu menu
) {
2239 if ((menu
.getApplication() != null)
2240 && (menu
.getApplication() != this)
2242 throw new IllegalArgumentException("Menu " + menu
+ " is already " +
2243 "part of application " + menu
.getApplication());
2251 * Turn off a sub-menu.
2253 public final void closeSubMenu() {
2254 assert (activeMenu
!= null);
2255 TMenu item
= subMenus
.get(subMenus
.size() - 1);
2256 assert (item
!= null);
2257 item
.setActive(false);
2258 subMenus
.remove(subMenus
.size() - 1);
2262 * Switch to the next menu.
2264 * @param forward if true, then switch to the next menu in the list,
2265 * otherwise switch to the previous menu in the list
2267 public final void switchMenu(final boolean forward
) {
2268 assert (activeMenu
!= null);
2270 for (TMenu menu
: subMenus
) {
2271 menu
.setActive(false);
2275 for (int i
= 0; i
< menus
.size(); i
++) {
2276 if (activeMenu
== menus
.get(i
)) {
2278 if (i
< menus
.size() - 1) {
2286 activeMenu
.setActive(false);
2287 activeMenu
= menus
.get(i
);
2288 activeMenu
.setActive(true);
2295 * Add a menu item to the global list. If it has a keyboard accelerator,
2296 * that will be added the global hash.
2298 * @param item the menu item
2300 public final void addMenuItem(final TMenuItem item
) {
2301 menuItems
.add(item
);
2303 TKeypress key
= item
.getKey();
2305 synchronized (accelerators
) {
2306 assert (accelerators
.get(key
) == null);
2307 accelerators
.put(key
.toLowerCase(), item
);
2313 * Disable one menu item.
2315 * @param id the menu item ID
2317 public final void disableMenuItem(final int id
) {
2318 for (TMenuItem item
: menuItems
) {
2319 if (item
.getId() == id
) {
2320 item
.setEnabled(false);
2326 * Disable the range of menu items with ID's between lower and upper,
2329 * @param lower the lowest menu item ID
2330 * @param upper the highest menu item ID
2332 public final void disableMenuItems(final int lower
, final int upper
) {
2333 for (TMenuItem item
: menuItems
) {
2334 if ((item
.getId() >= lower
) && (item
.getId() <= upper
)) {
2335 item
.setEnabled(false);
2341 * Enable one menu item.
2343 * @param id the menu item ID
2345 public final void enableMenuItem(final int id
) {
2346 for (TMenuItem item
: menuItems
) {
2347 if (item
.getId() == id
) {
2348 item
.setEnabled(true);
2354 * Enable the range of menu items with ID's between lower and upper,
2357 * @param lower the lowest menu item ID
2358 * @param upper the highest menu item ID
2360 public final void enableMenuItems(final int lower
, final int upper
) {
2361 for (TMenuItem item
: menuItems
) {
2362 if ((item
.getId() >= lower
) && (item
.getId() <= upper
)) {
2363 item
.setEnabled(true);
2369 * Recompute menu x positions based on their title length.
2371 public final void recomputeMenuX() {
2373 for (TMenu menu
: menus
) {
2376 x
+= menu
.getTitle().length() + 2;
2378 // Don't let the menu window exceed the screen width
2379 int rightEdge
= menu
.getX() + menu
.getWidth();
2380 if (rightEdge
> getScreen().getWidth()) {
2381 menu
.setX(getScreen().getWidth() - menu
.getWidth());
2387 * Post an event to process and turn off the menu.
2389 * @param event new event to add to the queue
2391 public final void postMenuEvent(final TInputEvent event
) {
2392 synchronized (this) {
2393 synchronized (fillEventQueue
) {
2394 fillEventQueue
.add(event
);
2397 System
.err
.println(System
.currentTimeMillis() + " " +
2398 Thread
.currentThread() + " postMenuEvent() wake up main");
2406 * Add a sub-menu to the list of open sub-menus.
2408 * @param menu sub-menu
2410 public final void addSubMenu(final TMenu menu
) {
2415 * Convenience function to add a top-level menu.
2417 * @param title menu title
2418 * @return the new menu
2420 public final TMenu
addMenu(final String title
) {
2423 TMenu menu
= new TMenu(this, x
, y
, title
);
2430 * Convenience function to add a default "File" menu.
2432 * @return the new menu
2434 public final TMenu
addFileMenu() {
2435 TMenu fileMenu
= addMenu(i18n
.getString("fileMenuTitle"));
2436 fileMenu
.addDefaultItem(TMenu
.MID_OPEN_FILE
);
2437 fileMenu
.addSeparator();
2438 fileMenu
.addDefaultItem(TMenu
.MID_SHELL
);
2439 fileMenu
.addDefaultItem(TMenu
.MID_EXIT
);
2440 TStatusBar statusBar
= fileMenu
.newStatusBar(i18n
.
2441 getString("fileMenuStatus"));
2442 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
2447 * Convenience function to add a default "Edit" menu.
2449 * @return the new menu
2451 public final TMenu
addEditMenu() {
2452 TMenu editMenu
= addMenu(i18n
.getString("editMenuTitle"));
2453 editMenu
.addDefaultItem(TMenu
.MID_CUT
);
2454 editMenu
.addDefaultItem(TMenu
.MID_COPY
);
2455 editMenu
.addDefaultItem(TMenu
.MID_PASTE
);
2456 editMenu
.addDefaultItem(TMenu
.MID_CLEAR
);
2457 TStatusBar statusBar
= editMenu
.newStatusBar(i18n
.
2458 getString("editMenuStatus"));
2459 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
2464 * Convenience function to add a default "Window" menu.
2466 * @return the new menu
2468 public final TMenu
addWindowMenu() {
2469 TMenu windowMenu
= addMenu(i18n
.getString("windowMenuTitle"));
2470 windowMenu
.addDefaultItem(TMenu
.MID_TILE
);
2471 windowMenu
.addDefaultItem(TMenu
.MID_CASCADE
);
2472 windowMenu
.addDefaultItem(TMenu
.MID_CLOSE_ALL
);
2473 windowMenu
.addSeparator();
2474 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_MOVE
);
2475 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_ZOOM
);
2476 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_NEXT
);
2477 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_PREVIOUS
);
2478 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_CLOSE
);
2479 TStatusBar statusBar
= windowMenu
.newStatusBar(i18n
.
2480 getString("windowMenuStatus"));
2481 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
2486 * Convenience function to add a default "Help" menu.
2488 * @return the new menu
2490 public final TMenu
addHelpMenu() {
2491 TMenu helpMenu
= addMenu(i18n
.getString("helpMenuTitle"));
2492 helpMenu
.addDefaultItem(TMenu
.MID_HELP_CONTENTS
);
2493 helpMenu
.addDefaultItem(TMenu
.MID_HELP_INDEX
);
2494 helpMenu
.addDefaultItem(TMenu
.MID_HELP_SEARCH
);
2495 helpMenu
.addDefaultItem(TMenu
.MID_HELP_PREVIOUS
);
2496 helpMenu
.addDefaultItem(TMenu
.MID_HELP_HELP
);
2497 helpMenu
.addDefaultItem(TMenu
.MID_HELP_ACTIVE_FILE
);
2498 helpMenu
.addSeparator();
2499 helpMenu
.addDefaultItem(TMenu
.MID_ABOUT
);
2500 TStatusBar statusBar
= helpMenu
.newStatusBar(i18n
.
2501 getString("helpMenuStatus"));
2502 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
2506 // ------------------------------------------------------------------------
2507 // Event handlers ---------------------------------------------------------
2508 // ------------------------------------------------------------------------
2511 * Method that TApplication subclasses can override to handle menu or
2512 * posted command events.
2514 * @param command command event
2515 * @return if true, this event was consumed
2517 protected boolean onCommand(final TCommandEvent command
) {
2518 // Default: handle cmExit
2519 if (command
.equals(cmExit
)) {
2520 if (messageBox(i18n
.getString("exitDialogTitle"),
2521 i18n
.getString("exitDialogText"),
2522 TMessageBox
.Type
.YESNO
).getResult() == TMessageBox
.Result
.YES
) {
2528 if (command
.equals(cmShell
)) {
2529 openTerminal(0, 0, TWindow
.RESIZABLE
);
2533 if (command
.equals(cmTile
)) {
2537 if (command
.equals(cmCascade
)) {
2541 if (command
.equals(cmCloseAll
)) {
2546 if (command
.equals(cmMenu
)) {
2547 if (!modalWindowActive() && (activeMenu
== null)) {
2548 if (menus
.size() > 0) {
2549 menus
.get(0).setActive(true);
2550 activeMenu
= menus
.get(0);
2560 * Method that TApplication subclasses can override to handle menu
2563 * @param menu menu event
2564 * @return if true, this event was consumed
2566 protected boolean onMenu(final TMenuEvent menu
) {
2568 // Default: handle MID_EXIT
2569 if (menu
.getId() == TMenu
.MID_EXIT
) {
2570 if (messageBox(i18n
.getString("exitDialogTitle"),
2571 i18n
.getString("exitDialogText"),
2572 TMessageBox
.Type
.YESNO
).getResult() == TMessageBox
.Result
.YES
) {
2578 if (menu
.getId() == TMenu
.MID_SHELL
) {
2579 openTerminal(0, 0, TWindow
.RESIZABLE
);
2583 if (menu
.getId() == TMenu
.MID_TILE
) {
2587 if (menu
.getId() == TMenu
.MID_CASCADE
) {
2591 if (menu
.getId() == TMenu
.MID_CLOSE_ALL
) {
2595 if (menu
.getId() == TMenu
.MID_ABOUT
) {
2599 if (menu
.getId() == TMenu
.MID_REPAINT
) {
2607 * Method that TApplication subclasses can override to handle keystrokes.
2609 * @param keypress keystroke event
2610 * @return if true, this event was consumed
2612 protected boolean onKeypress(final TKeypressEvent keypress
) {
2613 // Default: only menu shortcuts
2615 // Process Alt-F, Alt-E, etc. menu shortcut keys
2616 if (!keypress
.getKey().isFnKey()
2617 && keypress
.getKey().isAlt()
2618 && !keypress
.getKey().isCtrl()
2619 && (activeMenu
== null)
2620 && !modalWindowActive()
2623 assert (subMenus
.size() == 0);
2625 for (TMenu menu
: menus
) {
2626 if (Character
.toLowerCase(menu
.getMnemonic().getShortcut())
2627 == Character
.toLowerCase(keypress
.getKey().getChar())
2630 menu
.setActive(true);
2639 // ------------------------------------------------------------------------
2640 // TTimer management ------------------------------------------------------
2641 // ------------------------------------------------------------------------
2644 * Get the amount of time I can sleep before missing a Timer tick.
2646 * @param timeout = initial (maximum) timeout in millis
2647 * @return number of milliseconds between now and the next timer event
2649 private long getSleepTime(final long timeout
) {
2650 Date now
= new Date();
2651 long nowTime
= now
.getTime();
2652 long sleepTime
= timeout
;
2654 synchronized (timers
) {
2655 for (TTimer timer
: timers
) {
2656 long nextTickTime
= timer
.getNextTick().getTime();
2657 if (nextTickTime
< nowTime
) {
2661 long timeDifference
= nextTickTime
- nowTime
;
2662 if (timeDifference
< sleepTime
) {
2663 sleepTime
= timeDifference
;
2668 assert (sleepTime
>= 0);
2669 assert (sleepTime
<= timeout
);
2674 * Convenience function to add a timer.
2676 * @param duration number of milliseconds to wait between ticks
2677 * @param recurring if true, re-schedule this timer after every tick
2678 * @param action function to call when button is pressed
2681 public final TTimer
addTimer(final long duration
, final boolean recurring
,
2682 final TAction action
) {
2684 TTimer timer
= new TTimer(duration
, recurring
, action
);
2685 synchronized (timers
) {
2692 * Convenience function to remove a timer.
2694 * @param timer timer to remove
2696 public final void removeTimer(final TTimer timer
) {
2697 synchronized (timers
) {
2698 timers
.remove(timer
);
2702 // ------------------------------------------------------------------------
2703 // Other TWindow constructors ---------------------------------------------
2704 // ------------------------------------------------------------------------
2707 * Convenience function to spawn a message box.
2709 * @param title window title, will be centered along the top border
2710 * @param caption message to display. Use embedded newlines to get a
2712 * @return the new message box
2714 public final TMessageBox
messageBox(final String title
,
2715 final String caption
) {
2717 return new TMessageBox(this, title
, caption
, TMessageBox
.Type
.OK
);
2721 * Convenience function to spawn a message box.
2723 * @param title window title, will be centered along the top border
2724 * @param caption message to display. Use embedded newlines to get a
2726 * @param type one of the TMessageBox.Type constants. Default is
2728 * @return the new message box
2730 public final TMessageBox
messageBox(final String title
,
2731 final String caption
, final TMessageBox
.Type type
) {
2733 return new TMessageBox(this, title
, caption
, type
);
2737 * Convenience function to spawn an input box.
2739 * @param title window title, will be centered along the top border
2740 * @param caption message to display. Use embedded newlines to get a
2742 * @return the new input box
2744 public final TInputBox
inputBox(final String title
, final String caption
) {
2746 return new TInputBox(this, title
, caption
);
2750 * Convenience function to spawn an input box.
2752 * @param title window title, will be centered along the top border
2753 * @param caption message to display. Use embedded newlines to get a
2755 * @param text initial text to seed the field with
2756 * @return the new input box
2758 public final TInputBox
inputBox(final String title
, final String caption
,
2759 final String text
) {
2761 return new TInputBox(this, title
, caption
, text
);
2765 * Convenience function to open a terminal window.
2767 * @param x column relative to parent
2768 * @param y row relative to parent
2769 * @return the terminal new window
2771 public final TTerminalWindow
openTerminal(final int x
, final int y
) {
2772 return openTerminal(x
, y
, TWindow
.RESIZABLE
);
2776 * Convenience function to open a terminal window.
2778 * @param x column relative to parent
2779 * @param y row relative to parent
2780 * @param flags mask of CENTERED, MODAL, or RESIZABLE
2781 * @return the terminal new window
2783 public final TTerminalWindow
openTerminal(final int x
, final int y
,
2786 return new TTerminalWindow(this, x
, y
, flags
);
2790 * Convenience function to open a terminal window and execute a custom
2791 * command line inside it.
2793 * @param x column relative to parent
2794 * @param y row relative to parent
2795 * @param commandLine the command line to execute
2796 * @return the terminal new window
2798 public final TTerminalWindow
openTerminal(final int x
, final int y
,
2799 final String commandLine
) {
2801 return openTerminal(x
, y
, TWindow
.RESIZABLE
, commandLine
);
2805 * Convenience function to open a terminal window and execute a custom
2806 * command line inside it.
2808 * @param x column relative to parent
2809 * @param y row relative to parent
2810 * @param flags mask of CENTERED, MODAL, or RESIZABLE
2811 * @param commandLine the command line to execute
2812 * @return the terminal new window
2814 public final TTerminalWindow
openTerminal(final int x
, final int y
,
2815 final int flags
, final String commandLine
) {
2817 return new TTerminalWindow(this, x
, y
, flags
, commandLine
);
2821 * Convenience function to spawn an file open box.
2823 * @param path path of selected file
2824 * @return the result of the new file open box
2825 * @throws IOException if java.io operation throws
2827 public final String
fileOpenBox(final String path
) throws IOException
{
2829 TFileOpenBox box
= new TFileOpenBox(this, path
, TFileOpenBox
.Type
.OPEN
);
2830 return box
.getFilename();
2834 * Convenience function to spawn an file open box.
2836 * @param path path of selected file
2837 * @param type one of the Type constants
2838 * @return the result of the new file open box
2839 * @throws IOException if java.io operation throws
2841 public final String
fileOpenBox(final String path
,
2842 final TFileOpenBox
.Type type
) throws IOException
{
2844 TFileOpenBox box
= new TFileOpenBox(this, path
, type
);
2845 return box
.getFilename();
2849 * Convenience function to create a new window and make it active.
2850 * Window will be located at (0, 0).
2852 * @param title window title, will be centered along the top border
2853 * @param width width of window
2854 * @param height height of window
2856 public final TWindow
addWindow(final String title
, final int width
,
2859 TWindow window
= new TWindow(this, title
, 0, 0, width
, height
);
2864 * Convenience function to create a new window and make it active.
2865 * Window will be located at (0, 0).
2867 * @param title window title, will be centered along the top border
2868 * @param width width of window
2869 * @param height height of window
2870 * @param flags bitmask of RESIZABLE, CENTERED, or MODAL
2872 public final TWindow
addWindow(final String title
,
2873 final int width
, final int height
, final int flags
) {
2875 TWindow window
= new TWindow(this, title
, 0, 0, width
, height
, flags
);
2880 * Convenience function to create a new window and make it active.
2882 * @param title window title, will be centered along the top border
2883 * @param x column relative to parent
2884 * @param y row relative to parent
2885 * @param width width of window
2886 * @param height height of window
2888 public final TWindow
addWindow(final String title
,
2889 final int x
, final int y
, final int width
, final int height
) {
2891 TWindow window
= new TWindow(this, title
, x
, y
, width
, height
);
2896 * Convenience function to create a new window and make it active.
2898 * @param title window title, will be centered along the top border
2899 * @param x column relative to parent
2900 * @param y row relative to parent
2901 * @param width width of window
2902 * @param height height of window
2903 * @param flags mask of RESIZABLE, CENTERED, or MODAL
2905 public final TWindow
addWindow(final String title
,
2906 final int x
, final int y
, final int width
, final int height
,
2909 TWindow window
= new TWindow(this, title
, x
, y
, width
, height
, flags
);
2914 * Convenience function to open a file in an editor window and make it
2917 * @param file the file to open
2918 * @throws IOException if a java.io operation throws
2920 public final TEditorWindow
addEditor(final File file
) throws IOException
{
2922 TEditorWindow editor
= new TEditorWindow(this, file
);