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 // Note that it is possible for secondaryEventReceiver to be null
1129 // now, because its handleEvent() might have finished out on the
1130 // secondary thread. So put any extra processing inside a null
1132 if (secondaryEventReceiver
!= null) {
1133 if (doubleClick
!= null) {
1134 secondaryEventReceiver
.handleEvent(doubleClick
);
1140 * Enable a widget to override the primary event thread.
1142 * @param widget widget that will receive events
1144 public final void enableSecondaryEventReceiver(final TWidget widget
) {
1146 System
.err
.println(System
.currentTimeMillis() +
1147 " enableSecondaryEventReceiver()");
1150 assert (secondaryEventReceiver
== null);
1151 assert (secondaryEventHandler
== null);
1152 assert ((widget
instanceof TMessageBox
)
1153 || (widget
instanceof TFileOpenBox
));
1154 secondaryEventReceiver
= widget
;
1155 secondaryEventHandler
= new WidgetEventHandler(this, false);
1157 (new Thread(secondaryEventHandler
)).start();
1161 * Yield to the secondary thread.
1163 public final void yield() {
1164 assert (secondaryEventReceiver
!= null);
1166 while (secondaryEventReceiver
!= null) {
1167 synchronized (primaryEventHandler
) {
1169 primaryEventHandler
.wait();
1170 } catch (InterruptedException e
) {
1178 * Do stuff when there is no user input.
1180 private void doIdle() {
1182 System
.err
.printf(System
.currentTimeMillis() + " " +
1183 Thread
.currentThread() + " doIdle()\n");
1186 synchronized (timers
) {
1189 System
.err
.printf(System
.currentTimeMillis() + " " +
1190 Thread
.currentThread() + " doIdle() 2\n");
1193 // Run any timers that have timed out
1194 Date now
= new Date();
1195 List
<TTimer
> keepTimers
= new LinkedList
<TTimer
>();
1196 for (TTimer timer
: timers
) {
1197 if (timer
.getNextTick().getTime() <= now
.getTime()) {
1198 // Something might change, so repaint the screen.
1201 if (timer
.recurring
) {
1202 keepTimers
.add(timer
);
1205 keepTimers
.add(timer
);
1208 timers
= keepTimers
;
1212 for (TWindow window
: windows
) {
1215 if (desktop
!= null) {
1221 * Wake the sleeping active event handler.
1223 private void wakeEventHandler() {
1228 if (secondaryEventHandler
!= null) {
1229 synchronized (secondaryEventHandler
) {
1230 secondaryEventHandler
.notify();
1233 assert (primaryEventHandler
!= null);
1234 synchronized (primaryEventHandler
) {
1235 primaryEventHandler
.notify();
1240 // ------------------------------------------------------------------------
1241 // TApplication -----------------------------------------------------------
1242 // ------------------------------------------------------------------------
1247 * @return the Backend
1249 public final Backend
getBackend() {
1256 * @return the Screen
1258 public final Screen
getScreen() {
1259 if (backend
instanceof TWindowBackend
) {
1260 // We are being rendered to a TWindow. We can't use its
1261 // getScreen() method because that is how it is rendering to a
1262 // hardware backend somewhere. Instead use its getOtherScreen()
1264 return ((TWindowBackend
) backend
).getOtherScreen();
1266 return backend
.getScreen();
1271 * Get the color theme.
1275 public final ColorTheme
getTheme() {
1280 * Repaint the screen on the next update.
1282 public void doRepaint() {
1288 * Get Y coordinate of the top edge of the desktop.
1290 * @return Y coordinate of the top edge of the desktop
1292 public final int getDesktopTop() {
1297 * Get Y coordinate of the bottom edge of the desktop.
1299 * @return Y coordinate of the bottom edge of the desktop
1301 public final int getDesktopBottom() {
1302 return desktopBottom
;
1306 * Set the TDesktop instance.
1308 * @param desktop a TDesktop instance, or null to remove the one that is
1311 public final void setDesktop(final TDesktop desktop
) {
1312 if (this.desktop
!= null) {
1313 this.desktop
.onClose();
1315 this.desktop
= desktop
;
1319 * Get the TDesktop instance.
1321 * @return the desktop, or null if it is not set
1323 public final TDesktop
getDesktop() {
1328 * Get the current active window.
1330 * @return the active window, or null if it is not set
1332 public final TWindow
getActiveWindow() {
1333 return activeWindow
;
1337 * Get a (shallow) copy of the window list.
1339 * @return a copy of the list of windows for this application
1341 public final List
<TWindow
> getAllWindows() {
1342 List
<TWindow
> result
= new LinkedList
<TWindow
>();
1343 result
.addAll(windows
);
1348 * Get focusFollowsMouse flag.
1350 * @return true if focus follows mouse: windows automatically raised if
1351 * the mouse passes over them
1353 public boolean getFocusFollowsMouse() {
1354 return focusFollowsMouse
;
1358 * Set focusFollowsMouse flag.
1360 * @param focusFollowsMouse if true, focus follows mouse: windows
1361 * automatically raised if the mouse passes over them
1363 public void setFocusFollowsMouse(final boolean focusFollowsMouse
) {
1364 this.focusFollowsMouse
= focusFollowsMouse
;
1368 * Display the about dialog.
1370 protected void showAboutDialog() {
1371 messageBox(i18n
.getString("aboutDialogTitle"),
1372 MessageFormat
.format(i18n
.getString("aboutDialogText"),
1373 this.getClass().getPackage().getImplementationVersion()),
1374 TMessageBox
.Type
.OK
);
1377 // ------------------------------------------------------------------------
1378 // Screen refresh loop ----------------------------------------------------
1379 // ------------------------------------------------------------------------
1382 * Invert the cell color at a position. This is used to track the mouse.
1384 * @param x column position
1385 * @param y row position
1387 private void invertCell(final int x
, final int y
) {
1389 System
.err
.printf("%d %s invertCell() %d %d\n",
1390 System
.currentTimeMillis(), Thread
.currentThread(), x
, y
);
1392 CellAttributes attr
= getScreen().getAttrXY(x
, y
);
1393 if (attr
.getForeColorRGB() < 0) {
1394 attr
.setForeColor(attr
.getForeColor().invert());
1396 attr
.setForeColorRGB(attr
.getForeColorRGB() ^
0x00ffffff);
1398 if (attr
.getBackColorRGB() < 0) {
1399 attr
.setBackColor(attr
.getBackColor().invert());
1401 attr
.setBackColorRGB(attr
.getBackColorRGB() ^
0x00ffffff);
1403 getScreen().putAttrXY(x
, y
, attr
, false);
1409 private void drawAll() {
1410 boolean menuIsActive
= false;
1413 System
.err
.printf("%d %s drawAll() enter\n",
1414 System
.currentTimeMillis(), Thread
.currentThread());
1419 System
.err
.printf("%d %s drawAll() !repaint\n",
1420 System
.currentTimeMillis(), Thread
.currentThread());
1422 synchronized (getScreen()) {
1423 if ((oldMouseX
!= mouseX
) || (oldMouseY
!= mouseY
)) {
1424 // The only thing that has happened is the mouse moved.
1425 // Clear the old position and draw the new position.
1426 invertCell(oldMouseX
, oldMouseY
);
1427 invertCell(mouseX
, mouseY
);
1431 if (getScreen().isDirty()) {
1432 backend
.flushScreen();
1439 System
.err
.printf("%d %s drawAll() REDRAW\n",
1440 System
.currentTimeMillis(), Thread
.currentThread());
1443 // If true, the cursor is not visible
1444 boolean cursor
= false;
1446 // Start with a clean screen
1447 getScreen().clear();
1450 if (desktop
!= null) {
1451 desktop
.drawChildren();
1454 // Draw each window in reverse Z order
1455 List
<TWindow
> sorted
= new LinkedList
<TWindow
>(windows
);
1456 Collections
.sort(sorted
);
1457 TWindow topLevel
= null;
1458 if (sorted
.size() > 0) {
1459 topLevel
= sorted
.get(0);
1461 Collections
.reverse(sorted
);
1462 for (TWindow window
: sorted
) {
1463 if (window
.isShown()) {
1464 window
.drawChildren();
1468 // Draw the blank menubar line - reset the screen clipping first so
1469 // it won't trim it out.
1470 getScreen().resetClipping();
1471 getScreen().hLineXY(0, 0, getScreen().getWidth(), ' ',
1472 theme
.getColor("tmenu"));
1473 // Now draw the menus.
1475 for (TMenu menu
: menus
) {
1476 CellAttributes menuColor
;
1477 CellAttributes menuMnemonicColor
;
1478 if (menu
.isActive()) {
1479 menuIsActive
= true;
1480 menuColor
= theme
.getColor("tmenu.highlighted");
1481 menuMnemonicColor
= theme
.getColor("tmenu.mnemonic.highlighted");
1484 menuColor
= theme
.getColor("tmenu");
1485 menuMnemonicColor
= theme
.getColor("tmenu.mnemonic");
1487 // Draw the menu title
1488 getScreen().hLineXY(x
, 0, menu
.getTitle().length() + 2, ' ',
1490 getScreen().putStringXY(x
+ 1, 0, menu
.getTitle(), menuColor
);
1491 // Draw the highlight character
1492 getScreen().putCharXY(x
+ 1 + menu
.getMnemonic().getShortcutIdx(),
1493 0, menu
.getMnemonic().getShortcut(), menuMnemonicColor
);
1495 if (menu
.isActive()) {
1496 menu
.drawChildren();
1497 // Reset the screen clipping so we can draw the next title.
1498 getScreen().resetClipping();
1500 x
+= menu
.getTitle().length() + 2;
1503 for (TMenu menu
: subMenus
) {
1504 // Reset the screen clipping so we can draw the next sub-menu.
1505 getScreen().resetClipping();
1506 menu
.drawChildren();
1509 // Draw the status bar of the top-level window
1510 TStatusBar statusBar
= null;
1511 if (topLevel
!= null) {
1512 statusBar
= topLevel
.getStatusBar();
1514 if (statusBar
!= null) {
1515 getScreen().resetClipping();
1516 statusBar
.setWidth(getScreen().getWidth());
1517 statusBar
.setY(getScreen().getHeight() - topLevel
.getY());
1520 CellAttributes barColor
= new CellAttributes();
1521 barColor
.setTo(getTheme().getColor("tstatusbar.text"));
1522 getScreen().hLineXY(0, desktopBottom
, getScreen().getWidth(), ' ',
1526 // Draw the mouse pointer
1527 invertCell(mouseX
, mouseY
);
1531 // Place the cursor if it is visible
1532 if (!menuIsActive
) {
1533 TWidget activeWidget
= null;
1534 if (sorted
.size() > 0) {
1535 activeWidget
= sorted
.get(sorted
.size() - 1).getActiveChild();
1536 if (activeWidget
.isCursorVisible()) {
1537 if ((activeWidget
.getCursorAbsoluteY() < desktopBottom
)
1538 && (activeWidget
.getCursorAbsoluteY() > desktopTop
)
1540 getScreen().putCursor(true,
1541 activeWidget
.getCursorAbsoluteX(),
1542 activeWidget
.getCursorAbsoluteY());
1545 getScreen().putCursor(false,
1546 activeWidget
.getCursorAbsoluteX(),
1547 activeWidget
.getCursorAbsoluteY());
1556 getScreen().hideCursor();
1559 // Flush the screen contents
1560 if (getScreen().isDirty()) {
1561 backend
.flushScreen();
1568 * Force this application to exit.
1570 public void exit() {
1572 synchronized (this) {
1577 // ------------------------------------------------------------------------
1578 // TWindow management -----------------------------------------------------
1579 // ------------------------------------------------------------------------
1582 * Return the total number of windows.
1584 * @return the total number of windows
1586 public final int windowCount() {
1587 return windows
.size();
1591 * Return the number of windows that are showing.
1593 * @return the number of windows that are showing on screen
1595 public final int shownWindowCount() {
1597 for (TWindow w
: windows
) {
1606 * Return the number of windows that are hidden.
1608 * @return the number of windows that are hidden
1610 public final int hiddenWindowCount() {
1612 for (TWindow w
: windows
) {
1621 * Check if a window instance is in this application's window list.
1623 * @param window window to look for
1624 * @return true if this window is in the list
1626 public final boolean hasWindow(final TWindow window
) {
1627 if (windows
.size() == 0) {
1630 for (TWindow w
: windows
) {
1632 assert (window
.getApplication() == this);
1640 * Activate a window: bring it to the top and have it receive events.
1642 * @param window the window to become the new active window
1644 public void activateWindow(final TWindow window
) {
1645 if (hasWindow(window
) == false) {
1647 * Someone has a handle to a window I don't have. Ignore this
1653 // Whatever window might be moving/dragging, stop it now.
1654 for (TWindow w
: windows
) {
1655 if (w
.inMovements()) {
1660 assert (windows
.size() > 0);
1662 if (window
.isHidden()) {
1663 // Unhiding will also activate.
1667 assert (window
.isShown());
1669 if (windows
.size() == 1) {
1670 assert (window
== windows
.get(0));
1671 if (activeWindow
== null) {
1672 activeWindow
= window
;
1674 activeWindow
.setActive(true);
1675 activeWindow
.onFocus();
1678 assert (window
.isActive());
1679 assert (activeWindow
== window
);
1683 if (activeWindow
== window
) {
1684 assert (window
.isActive());
1686 // Window is already active, do nothing.
1690 assert (!window
.isActive());
1691 if (activeWindow
!= null) {
1692 assert (activeWindow
.getZ() == 0);
1694 activeWindow
.setActive(false);
1695 activeWindow
.setZ(window
.getZ());
1697 // Unset activeWindow now before unfocus, so that a window
1698 // lifecycle change inside onUnfocus() doesn't call
1699 // switchWindow() and lead to a stack overflow.
1700 TWindow oldActiveWindow
= activeWindow
;
1701 activeWindow
= null;
1702 oldActiveWindow
.onUnfocus();
1704 activeWindow
= window
;
1705 activeWindow
.setZ(0);
1706 activeWindow
.setActive(true);
1707 activeWindow
.onFocus();
1714 * @param window the window to hide
1716 public void hideWindow(final TWindow window
) {
1717 if (hasWindow(window
) == false) {
1719 * Someone has a handle to a window I don't have. Ignore this
1725 // Whatever window might be moving/dragging, stop it now.
1726 for (TWindow w
: windows
) {
1727 if (w
.inMovements()) {
1732 assert (windows
.size() > 0);
1734 if (!window
.hidden
) {
1735 if (window
== activeWindow
) {
1736 if (shownWindowCount() > 1) {
1739 activeWindow
= null;
1740 window
.setActive(false);
1744 window
.hidden
= true;
1752 * @param window the window to show
1754 public void showWindow(final TWindow window
) {
1755 if (hasWindow(window
) == false) {
1757 * Someone has a handle to a window I don't have. Ignore this
1763 // Whatever window might be moving/dragging, stop it now.
1764 for (TWindow w
: windows
) {
1765 if (w
.inMovements()) {
1770 assert (windows
.size() > 0);
1772 if (window
.hidden
) {
1773 window
.hidden
= false;
1775 activateWindow(window
);
1780 * Close window. Note that the window's destructor is NOT called by this
1781 * method, instead the GC is assumed to do the cleanup.
1783 * @param window the window to remove
1785 public final void closeWindow(final TWindow window
) {
1786 if (hasWindow(window
) == false) {
1788 * Someone has a handle to a window I don't have. Ignore this
1794 synchronized (windows
) {
1795 // Whatever window might be moving/dragging, stop it now.
1796 for (TWindow w
: windows
) {
1797 if (w
.inMovements()) {
1802 int z
= window
.getZ();
1805 Collections
.sort(windows
);
1807 activeWindow
= null;
1808 for (TWindow w
: windows
) {
1810 // Do not activate a hidden window.
1816 w
.setZ(w
.getZ() - 1);
1817 if (w
.getZ() == 0) {
1820 assert (activeWindow
== null);
1832 // Perform window cleanup
1835 // Check if we are closing a TMessageBox or similar
1836 if (secondaryEventReceiver
!= null) {
1837 assert (secondaryEventHandler
!= null);
1839 // Do not send events to the secondaryEventReceiver anymore, the
1840 // window is closed.
1841 secondaryEventReceiver
= null;
1843 // Wake the secondary thread, it will wake the primary as it
1845 synchronized (secondaryEventHandler
) {
1846 secondaryEventHandler
.notify();
1850 // Permit desktop to be active if it is the only thing left.
1851 if (desktop
!= null) {
1852 if (windows
.size() == 0) {
1853 desktop
.setActive(true);
1859 * Switch to the next window.
1861 * @param forward if true, then switch to the next window in the list,
1862 * otherwise switch to the previous window in the list
1864 public final void switchWindow(final boolean forward
) {
1865 // Only switch if there are multiple visible windows
1866 if (shownWindowCount() < 2) {
1869 assert (activeWindow
!= null);
1871 synchronized (windows
) {
1872 // Whatever window might be moving/dragging, stop it now.
1873 for (TWindow w
: windows
) {
1874 if (w
.inMovements()) {
1879 // Swap z/active between active window and the next in the list
1880 int activeWindowI
= -1;
1881 for (int i
= 0; i
< windows
.size(); i
++) {
1882 if (windows
.get(i
) == activeWindow
) {
1883 assert (activeWindow
.isActive());
1887 assert (!windows
.get(0).isActive());
1890 assert (activeWindowI
>= 0);
1892 // Do not switch if a window is modal
1893 if (activeWindow
.isModal()) {
1897 int nextWindowI
= activeWindowI
;
1901 nextWindowI
%= windows
.size();
1904 if (nextWindowI
< 0) {
1905 nextWindowI
= windows
.size() - 1;
1909 if (windows
.get(nextWindowI
).isShown()) {
1910 activateWindow(windows
.get(nextWindowI
));
1914 } // synchronized (windows)
1919 * Add a window to my window list and make it active. Note package
1922 * @param window new window to add
1924 final void addWindowToApplication(final TWindow window
) {
1926 // Do not add menu windows to the window list.
1927 if (window
instanceof TMenu
) {
1931 // Do not add the desktop to the window list.
1932 if (window
instanceof TDesktop
) {
1936 synchronized (windows
) {
1937 if (windows
.contains(window
)) {
1938 throw new IllegalArgumentException("Window " + window
+
1939 " is already in window list");
1942 // Whatever window might be moving/dragging, stop it now.
1943 for (TWindow w
: windows
) {
1944 if (w
.inMovements()) {
1949 // Do not allow a modal window to spawn a non-modal window. If a
1950 // modal window is active, then this window will become modal
1952 if (modalWindowActive()) {
1953 window
.flags
|= TWindow
.MODAL
;
1954 window
.flags
|= TWindow
.CENTERED
;
1955 window
.hidden
= false;
1957 if (window
.isShown()) {
1958 for (TWindow w
: windows
) {
1963 w
.setZ(w
.getZ() + 1);
1966 windows
.add(window
);
1967 if (window
.isShown()) {
1968 activeWindow
= window
;
1969 activeWindow
.setZ(0);
1970 activeWindow
.setActive(true);
1971 activeWindow
.onFocus();
1974 if (((window
.flags
& TWindow
.CENTERED
) == 0)
1975 && ((window
.flags
& TWindow
.ABSOLUTEXY
) == 0)
1976 && (smartWindowPlacement
== true)
1979 doSmartPlacement(window
);
1983 // Desktop cannot be active over any other window.
1984 if (desktop
!= null) {
1985 desktop
.setActive(false);
1990 * Check if there is a system-modal window on top.
1992 * @return true if the active window is modal
1994 private boolean modalWindowActive() {
1995 if (windows
.size() == 0) {
1999 for (TWindow w
: windows
) {
2009 * Close all open windows.
2011 private void closeAllWindows() {
2012 // Don't do anything if we are in the menu
2013 if (activeMenu
!= null) {
2016 while (windows
.size() > 0) {
2017 closeWindow(windows
.get(0));
2022 * Re-layout the open windows as non-overlapping tiles. This produces
2023 * almost the same results as Turbo Pascal 7.0's IDE.
2025 private void tileWindows() {
2026 synchronized (windows
) {
2027 // Don't do anything if we are in the menu
2028 if (activeMenu
!= null) {
2031 int z
= windows
.size();
2037 a
= (int)(Math
.sqrt(z
));
2041 if (((a
* b
) + c
) == z
) {
2049 int newWidth
= (getScreen().getWidth() / a
);
2050 int newHeight1
= ((getScreen().getHeight() - 1) / b
);
2051 int newHeight2
= ((getScreen().getHeight() - 1) / (b
+ c
));
2053 List
<TWindow
> sorted
= new LinkedList
<TWindow
>(windows
);
2054 Collections
.sort(sorted
);
2055 Collections
.reverse(sorted
);
2056 for (int i
= 0; i
< sorted
.size(); i
++) {
2057 int logicalX
= i
/ b
;
2058 int logicalY
= i
% b
;
2059 if (i
>= ((a
- 1) * b
)) {
2061 logicalY
= i
- ((a
- 1) * b
);
2064 TWindow w
= sorted
.get(i
);
2065 w
.setX(logicalX
* newWidth
);
2066 w
.setWidth(newWidth
);
2067 if (i
>= ((a
- 1) * b
)) {
2068 w
.setY((logicalY
* newHeight2
) + 1);
2069 w
.setHeight(newHeight2
);
2071 w
.setY((logicalY
* newHeight1
) + 1);
2072 w
.setHeight(newHeight1
);
2079 * Re-layout the open windows as overlapping cascaded windows.
2081 private void cascadeWindows() {
2082 synchronized (windows
) {
2083 // Don't do anything if we are in the menu
2084 if (activeMenu
!= null) {
2089 List
<TWindow
> sorted
= new LinkedList
<TWindow
>(windows
);
2090 Collections
.sort(sorted
);
2091 Collections
.reverse(sorted
);
2092 for (TWindow window
: sorted
) {
2097 if (x
> getScreen().getWidth()) {
2100 if (y
>= getScreen().getHeight()) {
2108 * Place a window to minimize its overlap with other windows.
2110 * @param window the window to place
2112 public final void doSmartPlacement(final TWindow window
) {
2113 // This is a pretty dumb algorithm, but seems to work. The hardest
2114 // part is computing these "overlap" values seeking a minimum average
2117 int yMin
= desktopTop
;
2118 int xMax
= getScreen().getWidth() - window
.getWidth() + 1;
2119 int yMax
= desktopBottom
- window
.getHeight() + 1;
2127 if ((xMin
== xMax
) && (yMin
== yMax
)) {
2128 // No work to do, bail out.
2132 // Compute the overlap matrix without the new window.
2133 int width
= getScreen().getWidth();
2134 int height
= getScreen().getHeight();
2135 int overlapMatrix
[][] = new int[width
][height
];
2136 for (TWindow w
: windows
) {
2140 for (int x
= w
.getX(); x
< w
.getX() + w
.getWidth(); x
++) {
2147 for (int y
= w
.getY(); y
< w
.getY() + w
.getHeight(); y
++) {
2154 overlapMatrix
[x
][y
]++;
2159 long oldOverlapTotal
= 0;
2160 long oldOverlapN
= 0;
2161 for (int x
= 0; x
< width
; x
++) {
2162 for (int y
= 0; y
< height
; y
++) {
2163 oldOverlapTotal
+= overlapMatrix
[x
][y
];
2164 if (overlapMatrix
[x
][y
] > 0) {
2171 double oldOverlapAvg
= (double) oldOverlapTotal
/ (double) oldOverlapN
;
2172 boolean first
= true;
2173 int windowX
= window
.getX();
2174 int windowY
= window
.getY();
2176 // For each possible (x, y) position for the new window, compute a
2177 // new overlap matrix.
2178 for (int x
= xMin
; x
< xMax
; x
++) {
2179 for (int y
= yMin
; y
< yMax
; y
++) {
2181 // Start with the matrix minus this window.
2182 int newMatrix
[][] = new int[width
][height
];
2183 for (int mx
= 0; mx
< width
; mx
++) {
2184 for (int my
= 0; my
< height
; my
++) {
2185 newMatrix
[mx
][my
] = overlapMatrix
[mx
][my
];
2189 // Add this window's values to the new overlap matrix.
2190 long newOverlapTotal
= 0;
2191 long newOverlapN
= 0;
2192 // Start by adding each new cell.
2193 for (int wx
= x
; wx
< x
+ window
.getWidth(); wx
++) {
2197 for (int wy
= y
; wy
< y
+ window
.getHeight(); wy
++) {
2201 newMatrix
[wx
][wy
]++;
2204 // Now figure out the new value for total coverage.
2205 for (int mx
= 0; mx
< width
; mx
++) {
2206 for (int my
= 0; my
< height
; my
++) {
2207 newOverlapTotal
+= newMatrix
[x
][y
];
2208 if (newMatrix
[mx
][my
] > 0) {
2213 double newOverlapAvg
= (double) newOverlapTotal
/ (double) newOverlapN
;
2216 // First time: just record what we got.
2217 oldOverlapAvg
= newOverlapAvg
;
2220 // All other times: pick a new best (x, y) and save the
2222 if (newOverlapAvg
< oldOverlapAvg
) {
2225 oldOverlapAvg
= newOverlapAvg
;
2229 } // for (int x = xMin; x < xMax; x++)
2231 } // for (int y = yMin; y < yMax; y++)
2233 // Finally, set the window's new coordinates.
2234 window
.setX(windowX
);
2235 window
.setY(windowY
);
2238 // ------------------------------------------------------------------------
2239 // TMenu management -------------------------------------------------------
2240 // ------------------------------------------------------------------------
2243 * Check if a mouse event would hit either the active menu or any open
2246 * @param mouse mouse event
2247 * @return true if the mouse would hit the active menu or an open
2250 private boolean mouseOnMenu(final TMouseEvent mouse
) {
2251 assert (activeMenu
!= null);
2252 List
<TMenu
> menus
= new LinkedList
<TMenu
>(subMenus
);
2253 Collections
.reverse(menus
);
2254 for (TMenu menu
: menus
) {
2255 if (menu
.mouseWouldHit(mouse
)) {
2259 return activeMenu
.mouseWouldHit(mouse
);
2263 * See if we need to switch window or activate the menu based on
2266 * @param mouse mouse event
2268 private void checkSwitchFocus(final TMouseEvent mouse
) {
2270 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
2271 && (activeMenu
!= null)
2272 && (mouse
.getAbsoluteY() != 0)
2273 && (!mouseOnMenu(mouse
))
2275 // They clicked outside the active menu, turn it off
2276 activeMenu
.setActive(false);
2278 for (TMenu menu
: subMenus
) {
2279 menu
.setActive(false);
2285 // See if they hit the menu bar
2286 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_DOWN
)
2287 && (mouse
.isMouse1())
2288 && (!modalWindowActive())
2289 && (mouse
.getAbsoluteY() == 0)
2292 for (TMenu menu
: subMenus
) {
2293 menu
.setActive(false);
2297 // They selected the menu, go activate it
2298 for (TMenu menu
: menus
) {
2299 if ((mouse
.getAbsoluteX() >= menu
.getTitleX())
2300 && (mouse
.getAbsoluteX() < menu
.getTitleX()
2301 + menu
.getTitle().length() + 2)
2303 menu
.setActive(true);
2306 menu
.setActive(false);
2312 // See if they hit the menu bar
2313 if ((mouse
.getType() == TMouseEvent
.Type
.MOUSE_MOTION
)
2314 && (mouse
.isMouse1())
2315 && (activeMenu
!= null)
2316 && (mouse
.getAbsoluteY() == 0)
2319 TMenu oldMenu
= activeMenu
;
2320 for (TMenu menu
: subMenus
) {
2321 menu
.setActive(false);
2325 // See if we should switch menus
2326 for (TMenu menu
: menus
) {
2327 if ((mouse
.getAbsoluteX() >= menu
.getTitleX())
2328 && (mouse
.getAbsoluteX() < menu
.getTitleX()
2329 + menu
.getTitle().length() + 2)
2331 menu
.setActive(true);
2335 if (oldMenu
!= activeMenu
) {
2336 // They switched menus
2337 oldMenu
.setActive(false);
2342 // If a menu is still active, don't switch windows
2343 if (activeMenu
!= null) {
2347 // Only switch if there are multiple windows
2348 if (windows
.size() < 2) {
2352 if (((focusFollowsMouse
== true)
2353 && (mouse
.getType() == TMouseEvent
.Type
.MOUSE_MOTION
))
2354 || (mouse
.getType() == TMouseEvent
.Type
.MOUSE_UP
)
2356 synchronized (windows
) {
2357 Collections
.sort(windows
);
2358 if (windows
.get(0).isModal()) {
2359 // Modal windows don't switch
2363 for (TWindow window
: windows
) {
2364 assert (!window
.isModal());
2366 if (window
.isHidden()) {
2367 assert (!window
.isActive());
2371 if (window
.mouseWouldHit(mouse
)) {
2372 if (window
== windows
.get(0)) {
2373 // Clicked on the same window, nothing to do
2374 assert (window
.isActive());
2378 // We will be switching to another window
2379 assert (windows
.get(0).isActive());
2380 assert (windows
.get(0) == activeWindow
);
2381 assert (!window
.isActive());
2382 activeWindow
.onUnfocus();
2383 activeWindow
.setActive(false);
2384 activeWindow
.setZ(window
.getZ());
2385 activeWindow
= window
;
2387 window
.setActive(true);
2394 // Clicked on the background, nothing to do
2398 // Nothing to do: this isn't a mouse up, or focus isn't following
2404 * Turn off the menu.
2406 public final void closeMenu() {
2407 if (activeMenu
!= null) {
2408 activeMenu
.setActive(false);
2410 for (TMenu menu
: subMenus
) {
2411 menu
.setActive(false);
2418 * Get a (shallow) copy of the menu list.
2420 * @return a copy of the menu list
2422 public final List
<TMenu
> getAllMenus() {
2423 return new LinkedList
<TMenu
>(menus
);
2427 * Add a top-level menu to the list.
2429 * @param menu the menu to add
2430 * @throws IllegalArgumentException if the menu is already used in
2431 * another TApplication
2433 public final void addMenu(final TMenu menu
) {
2434 if ((menu
.getApplication() != null)
2435 && (menu
.getApplication() != this)
2437 throw new IllegalArgumentException("Menu " + menu
+ " is already " +
2438 "part of application " + menu
.getApplication());
2446 * Remove a top-level menu from the list.
2448 * @param menu the menu to remove
2449 * @throws IllegalArgumentException if the menu is already used in
2450 * another TApplication
2452 public final void removeMenu(final TMenu menu
) {
2453 if ((menu
.getApplication() != null)
2454 && (menu
.getApplication() != this)
2456 throw new IllegalArgumentException("Menu " + menu
+ " is already " +
2457 "part of application " + menu
.getApplication());
2465 * Turn off a sub-menu.
2467 public final void closeSubMenu() {
2468 assert (activeMenu
!= null);
2469 TMenu item
= subMenus
.get(subMenus
.size() - 1);
2470 assert (item
!= null);
2471 item
.setActive(false);
2472 subMenus
.remove(subMenus
.size() - 1);
2476 * Switch to the next menu.
2478 * @param forward if true, then switch to the next menu in the list,
2479 * otherwise switch to the previous menu in the list
2481 public final void switchMenu(final boolean forward
) {
2482 assert (activeMenu
!= null);
2484 for (TMenu menu
: subMenus
) {
2485 menu
.setActive(false);
2489 for (int i
= 0; i
< menus
.size(); i
++) {
2490 if (activeMenu
== menus
.get(i
)) {
2492 if (i
< menus
.size() - 1) {
2500 activeMenu
.setActive(false);
2501 activeMenu
= menus
.get(i
);
2502 activeMenu
.setActive(true);
2509 * Add a menu item to the global list. If it has a keyboard accelerator,
2510 * that will be added the global hash.
2512 * @param item the menu item
2514 public final void addMenuItem(final TMenuItem item
) {
2515 menuItems
.add(item
);
2517 TKeypress key
= item
.getKey();
2519 synchronized (accelerators
) {
2520 assert (accelerators
.get(key
) == null);
2521 accelerators
.put(key
.toLowerCase(), item
);
2527 * Disable one menu item.
2529 * @param id the menu item ID
2531 public final void disableMenuItem(final int id
) {
2532 for (TMenuItem item
: menuItems
) {
2533 if (item
.getId() == id
) {
2534 item
.setEnabled(false);
2540 * Disable the range of menu items with ID's between lower and upper,
2543 * @param lower the lowest menu item ID
2544 * @param upper the highest menu item ID
2546 public final void disableMenuItems(final int lower
, final int upper
) {
2547 for (TMenuItem item
: menuItems
) {
2548 if ((item
.getId() >= lower
) && (item
.getId() <= upper
)) {
2549 item
.setEnabled(false);
2555 * Enable one menu item.
2557 * @param id the menu item ID
2559 public final void enableMenuItem(final int id
) {
2560 for (TMenuItem item
: menuItems
) {
2561 if (item
.getId() == id
) {
2562 item
.setEnabled(true);
2568 * Enable the range of menu items with ID's between lower and upper,
2571 * @param lower the lowest menu item ID
2572 * @param upper the highest menu item ID
2574 public final void enableMenuItems(final int lower
, final int upper
) {
2575 for (TMenuItem item
: menuItems
) {
2576 if ((item
.getId() >= lower
) && (item
.getId() <= upper
)) {
2577 item
.setEnabled(true);
2583 * Recompute menu x positions based on their title length.
2585 public final void recomputeMenuX() {
2587 for (TMenu menu
: menus
) {
2590 x
+= menu
.getTitle().length() + 2;
2592 // Don't let the menu window exceed the screen width
2593 int rightEdge
= menu
.getX() + menu
.getWidth();
2594 if (rightEdge
> getScreen().getWidth()) {
2595 menu
.setX(getScreen().getWidth() - menu
.getWidth());
2601 * Post an event to process.
2603 * @param event new event to add to the queue
2605 public final void postEvent(final TInputEvent event
) {
2606 synchronized (this) {
2607 synchronized (fillEventQueue
) {
2608 fillEventQueue
.add(event
);
2611 System
.err
.println(System
.currentTimeMillis() + " " +
2612 Thread
.currentThread() + " postEvent() wake up main");
2619 * Post an event to process and turn off the menu.
2621 * @param event new event to add to the queue
2623 public final void postMenuEvent(final TInputEvent event
) {
2624 synchronized (this) {
2625 synchronized (fillEventQueue
) {
2626 fillEventQueue
.add(event
);
2629 System
.err
.println(System
.currentTimeMillis() + " " +
2630 Thread
.currentThread() + " postMenuEvent() wake up main");
2638 * Add a sub-menu to the list of open sub-menus.
2640 * @param menu sub-menu
2642 public final void addSubMenu(final TMenu menu
) {
2647 * Convenience function to add a top-level menu.
2649 * @param title menu title
2650 * @return the new menu
2652 public final TMenu
addMenu(final String title
) {
2655 TMenu menu
= new TMenu(this, x
, y
, title
);
2662 * Convenience function to add a default "File" menu.
2664 * @return the new menu
2666 public final TMenu
addFileMenu() {
2667 TMenu fileMenu
= addMenu(i18n
.getString("fileMenuTitle"));
2668 fileMenu
.addDefaultItem(TMenu
.MID_OPEN_FILE
);
2669 fileMenu
.addSeparator();
2670 fileMenu
.addDefaultItem(TMenu
.MID_SHELL
);
2671 fileMenu
.addDefaultItem(TMenu
.MID_EXIT
);
2672 TStatusBar statusBar
= fileMenu
.newStatusBar(i18n
.
2673 getString("fileMenuStatus"));
2674 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
2679 * Convenience function to add a default "Edit" menu.
2681 * @return the new menu
2683 public final TMenu
addEditMenu() {
2684 TMenu editMenu
= addMenu(i18n
.getString("editMenuTitle"));
2685 editMenu
.addDefaultItem(TMenu
.MID_CUT
);
2686 editMenu
.addDefaultItem(TMenu
.MID_COPY
);
2687 editMenu
.addDefaultItem(TMenu
.MID_PASTE
);
2688 editMenu
.addDefaultItem(TMenu
.MID_CLEAR
);
2689 TStatusBar statusBar
= editMenu
.newStatusBar(i18n
.
2690 getString("editMenuStatus"));
2691 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
2696 * Convenience function to add a default "Window" menu.
2698 * @return the new menu
2700 public final TMenu
addWindowMenu() {
2701 TMenu windowMenu
= addMenu(i18n
.getString("windowMenuTitle"));
2702 windowMenu
.addDefaultItem(TMenu
.MID_TILE
);
2703 windowMenu
.addDefaultItem(TMenu
.MID_CASCADE
);
2704 windowMenu
.addDefaultItem(TMenu
.MID_CLOSE_ALL
);
2705 windowMenu
.addSeparator();
2706 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_MOVE
);
2707 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_ZOOM
);
2708 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_NEXT
);
2709 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_PREVIOUS
);
2710 windowMenu
.addDefaultItem(TMenu
.MID_WINDOW_CLOSE
);
2711 TStatusBar statusBar
= windowMenu
.newStatusBar(i18n
.
2712 getString("windowMenuStatus"));
2713 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
2718 * Convenience function to add a default "Help" menu.
2720 * @return the new menu
2722 public final TMenu
addHelpMenu() {
2723 TMenu helpMenu
= addMenu(i18n
.getString("helpMenuTitle"));
2724 helpMenu
.addDefaultItem(TMenu
.MID_HELP_CONTENTS
);
2725 helpMenu
.addDefaultItem(TMenu
.MID_HELP_INDEX
);
2726 helpMenu
.addDefaultItem(TMenu
.MID_HELP_SEARCH
);
2727 helpMenu
.addDefaultItem(TMenu
.MID_HELP_PREVIOUS
);
2728 helpMenu
.addDefaultItem(TMenu
.MID_HELP_HELP
);
2729 helpMenu
.addDefaultItem(TMenu
.MID_HELP_ACTIVE_FILE
);
2730 helpMenu
.addSeparator();
2731 helpMenu
.addDefaultItem(TMenu
.MID_ABOUT
);
2732 TStatusBar statusBar
= helpMenu
.newStatusBar(i18n
.
2733 getString("helpMenuStatus"));
2734 statusBar
.addShortcutKeypress(kbF1
, cmHelp
, i18n
.getString("Help"));
2738 // ------------------------------------------------------------------------
2739 // TTimer management ------------------------------------------------------
2740 // ------------------------------------------------------------------------
2743 * Get the amount of time I can sleep before missing a Timer tick.
2745 * @param timeout = initial (maximum) timeout in millis
2746 * @return number of milliseconds between now and the next timer event
2748 private long getSleepTime(final long timeout
) {
2749 Date now
= new Date();
2750 long nowTime
= now
.getTime();
2751 long sleepTime
= timeout
;
2753 synchronized (timers
) {
2754 for (TTimer timer
: timers
) {
2755 long nextTickTime
= timer
.getNextTick().getTime();
2756 if (nextTickTime
< nowTime
) {
2760 long timeDifference
= nextTickTime
- nowTime
;
2761 if (timeDifference
< sleepTime
) {
2762 sleepTime
= timeDifference
;
2767 assert (sleepTime
>= 0);
2768 assert (sleepTime
<= timeout
);
2773 * Convenience function to add a timer.
2775 * @param duration number of milliseconds to wait between ticks
2776 * @param recurring if true, re-schedule this timer after every tick
2777 * @param action function to call when button is pressed
2780 public final TTimer
addTimer(final long duration
, final boolean recurring
,
2781 final TAction action
) {
2783 TTimer timer
= new TTimer(duration
, recurring
, action
);
2784 synchronized (timers
) {
2791 * Convenience function to remove a timer.
2793 * @param timer timer to remove
2795 public final void removeTimer(final TTimer timer
) {
2796 synchronized (timers
) {
2797 timers
.remove(timer
);
2801 // ------------------------------------------------------------------------
2802 // Other TWindow constructors ---------------------------------------------
2803 // ------------------------------------------------------------------------
2806 * Convenience function to spawn a message box.
2808 * @param title window title, will be centered along the top border
2809 * @param caption message to display. Use embedded newlines to get a
2811 * @return the new message box
2813 public final TMessageBox
messageBox(final String title
,
2814 final String caption
) {
2816 return new TMessageBox(this, title
, caption
, TMessageBox
.Type
.OK
);
2820 * Convenience function to spawn a message box.
2822 * @param title window title, will be centered along the top border
2823 * @param caption message to display. Use embedded newlines to get a
2825 * @param type one of the TMessageBox.Type constants. Default is
2827 * @return the new message box
2829 public final TMessageBox
messageBox(final String title
,
2830 final String caption
, final TMessageBox
.Type type
) {
2832 return new TMessageBox(this, title
, caption
, type
);
2836 * Convenience function to spawn an input box.
2838 * @param title window title, will be centered along the top border
2839 * @param caption message to display. Use embedded newlines to get a
2841 * @return the new input box
2843 public final TInputBox
inputBox(final String title
, final String caption
) {
2845 return new TInputBox(this, title
, caption
);
2849 * Convenience function to spawn an input box.
2851 * @param title window title, will be centered along the top border
2852 * @param caption message to display. Use embedded newlines to get a
2854 * @param text initial text to seed the field with
2855 * @return the new input box
2857 public final TInputBox
inputBox(final String title
, final String caption
,
2858 final String text
) {
2860 return new TInputBox(this, title
, caption
, text
);
2864 * Convenience function to open a terminal window.
2866 * @param x column relative to parent
2867 * @param y row relative to parent
2868 * @return the terminal new window
2870 public final TTerminalWindow
openTerminal(final int x
, final int y
) {
2871 return openTerminal(x
, y
, TWindow
.RESIZABLE
);
2875 * Convenience function to open a terminal window.
2877 * @param x column relative to parent
2878 * @param y row relative to parent
2879 * @param flags mask of CENTERED, MODAL, or RESIZABLE
2880 * @return the terminal new window
2882 public final TTerminalWindow
openTerminal(final int x
, final int y
,
2885 return new TTerminalWindow(this, x
, y
, flags
);
2889 * Convenience function to open a terminal window and execute a custom
2890 * command line inside it.
2892 * @param x column relative to parent
2893 * @param y row relative to parent
2894 * @param commandLine the command line to execute
2895 * @return the terminal new window
2897 public final TTerminalWindow
openTerminal(final int x
, final int y
,
2898 final String commandLine
) {
2900 return openTerminal(x
, y
, TWindow
.RESIZABLE
, commandLine
);
2904 * Convenience function to open a terminal window and execute a custom
2905 * command line inside it.
2907 * @param x column relative to parent
2908 * @param y row relative to parent
2909 * @param flags mask of CENTERED, MODAL, or RESIZABLE
2910 * @param command the command line to execute
2911 * @return the terminal new window
2913 public final TTerminalWindow
openTerminal(final int x
, final int y
,
2914 final int flags
, final String
[] command
) {
2916 return new TTerminalWindow(this, x
, y
, flags
, command
);
2920 * Convenience function to open a terminal window and execute a custom
2921 * command line inside it.
2923 * @param x column relative to parent
2924 * @param y row relative to parent
2925 * @param flags mask of CENTERED, MODAL, or RESIZABLE
2926 * @param commandLine the command line to execute
2927 * @return the terminal new window
2929 public final TTerminalWindow
openTerminal(final int x
, final int y
,
2930 final int flags
, final String commandLine
) {
2932 return new TTerminalWindow(this, x
, y
, flags
, commandLine
.split("\\s"));
2936 * Convenience function to spawn an file open box.
2938 * @param path path of selected file
2939 * @return the result of the new file open box
2940 * @throws IOException if java.io operation throws
2942 public final String
fileOpenBox(final String path
) throws IOException
{
2944 TFileOpenBox box
= new TFileOpenBox(this, path
, TFileOpenBox
.Type
.OPEN
);
2945 return box
.getFilename();
2949 * Convenience function to spawn an file open box.
2951 * @param path path of selected file
2952 * @param type one of the Type constants
2953 * @return the result of the new file open box
2954 * @throws IOException if java.io operation throws
2956 public final String
fileOpenBox(final String path
,
2957 final TFileOpenBox
.Type type
) throws IOException
{
2959 TFileOpenBox box
= new TFileOpenBox(this, path
, type
);
2960 return box
.getFilename();
2964 * Convenience function to create a new window and make it active.
2965 * Window will be located at (0, 0).
2967 * @param title window title, will be centered along the top border
2968 * @param width width of window
2969 * @param height height of window
2970 * @return the new window
2972 public final TWindow
addWindow(final String title
, final int width
,
2975 TWindow window
= new TWindow(this, title
, 0, 0, width
, height
);
2980 * Convenience function to create a new window and make it active.
2981 * Window will be located at (0, 0).
2983 * @param title window title, will be centered along the top border
2984 * @param width width of window
2985 * @param height height of window
2986 * @param flags bitmask of RESIZABLE, CENTERED, or MODAL
2987 * @return the new window
2989 public final TWindow
addWindow(final String title
,
2990 final int width
, final int height
, final int flags
) {
2992 TWindow window
= new TWindow(this, title
, 0, 0, width
, height
, flags
);
2997 * Convenience function to create a new window and make it active.
2999 * @param title window title, will be centered along the top border
3000 * @param x column relative to parent
3001 * @param y row relative to parent
3002 * @param width width of window
3003 * @param height height of window
3004 * @return the new window
3006 public final TWindow
addWindow(final String title
,
3007 final int x
, final int y
, final int width
, final int height
) {
3009 TWindow window
= new TWindow(this, title
, x
, y
, width
, height
);
3014 * Convenience function to create a new window and make it active.
3016 * @param title window title, will be centered along the top border
3017 * @param x column relative to parent
3018 * @param y row relative to parent
3019 * @param width width of window
3020 * @param height height of window
3021 * @param flags mask of RESIZABLE, CENTERED, or MODAL
3022 * @return the new window
3024 public final TWindow
addWindow(final String title
,
3025 final int x
, final int y
, final int width
, final int height
,
3028 TWindow window
= new TWindow(this, title
, x
, y
, width
, height
, flags
);
3033 * Convenience function to open a file in an editor window and make it
3036 * @param file the file to open
3037 * @return the new editor window
3038 * @throws IOException if a java.io operation throws
3040 public final TEditorWindow
addEditor(final File file
) throws IOException
{
3042 TEditorWindow editor
= new TEditorWindow(this, file
);